Skip to content

Commit 938c497

Browse files
authored
Added more doc for HeartbeatService, fixed typo in FileService doc (#875)
1 parent c4ce6db commit 938c497

File tree

2 files changed

+6
-2
lines changed

2 files changed

+6
-2
lines changed

services-gateway/src/main/java/io/scalecube/services/gateway/websocket/HeartbeatService.java

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,14 @@
44
import io.scalecube.services.annotations.ServiceMethod;
55
import reactor.core.publisher.Mono;
66

7+
/**
8+
* Service interface for handling custom ping/pong service messages for websocket - service is
9+
* echoing back ping message to the client. Used (optionally) as part of {@link WebsocketGateway}.
10+
*/
711
@Service(HeartbeatService.NAMESPACE)
812
public interface HeartbeatService {
913

10-
String NAMESPACE = "v1/scalecube.websocket.heartbeat";
14+
String NAMESPACE = "v1/scalecube.websocket";
1115

1216
@ServiceMethod
1317
Mono<Long> ping(long value);

services/src/main/java/io/scalecube/services/files/FileService.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
import reactor.core.publisher.Mono;
66

77
/**
8-
* System service interface for adding files locally, those added files will be accessible by {@link
8+
* Service interface for adding files locally, those added files will be accessible by {@link
99
* FileStreamer}. Typical usage: client generates a file in the app service, then calls {@link
1010
* #addFile(AddFileRequest)}, then returns result (file path qualifier) all the way back to the
1111
* caller of app service. On the caller side file path qualifier gets combined with http-gateway

0 commit comments

Comments
 (0)