GroupHandlerService
Attributes
- Graph
-
- Supertypes
-
class Objecttrait Matchableclass Any
- Known subtypes
-
class GroupService
Members list
Value members
Abstract methods
Connect a client to the group. Note that the client must be a member of the group, therefore, GroupHandlerService.join should be called first.
Connect a client to the group. Note that the client must be a member of the group, therefore, GroupHandlerService.join should be called first.
Value parameters
- channel
-
An ActorRef that communicates directly with the client
- clientID
-
The ID of the client that should be connected
- groupID
-
The ID of the group of the client
Attributes
- Returns
-
A Future with the ClientID that connected to the group
Delete the group
Delete the group
Value parameters
- groupID
-
The ID of the group to delete
Attributes
- Returns
-
A F representing the completion of the operation
Disconnects a client from the group. Note that the client must be a member of the group, therefore, GroupHandlerService.join should be called first.
Disconnects a client from the group. Note that the client must be a member of the group, therefore, GroupHandlerService.join should be called first.
Value parameters
- clientID
-
The ID of the client that should be connected
- groupID
-
The ID of the group of the client
Attributes
- Returns
-
A Future with the ClientID that have disconnected from the group
Join a client to a specific group
Join a client to a specific group
Value parameters
- clientID
-
The ID of the client joining
- groupID
-
The ID of the group to join
Attributes
- Returns
-
A F with List of ClientID that are currently connected to the service
Remove a client to a specific group
Remove a client to a specific group
Value parameters
- clientID
-
The ID of the client that should be removed
- groupID
-
The ID of the group to join
Attributes
- Returns
-
A Future with the ClientID that left the group
Send a message in a group. All client in connected status will receive this.
Send a message in a group. All client in connected status will receive this.
Value parameters
- groupID
-
The ID of the group of the client
- message
-
The message that should be broadcast
Attributes
- Returns
-
A Future wit the ClientID that have disconnected from the group