chat-service 3.7.0 API
API
Generated with
chat-service 3.7.0 API/io.github.positionpal/io.github.positionpal.group

io.github.positionpal.group

package io.github.positionpal.group

Members list

Type members

Classlikes

case class ClientConnected(clientID: ClientID, communicationChannel: ActorRef[CommunicationProtocol]) extends GroupEvent

Event triggered when a client connects to the group

Event triggered when a client connects to the group

Value parameters

clientID

the reference of the client

communicationChannel

The communication channel of the client

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait GroupEvent
class Object
trait Matchable
class Any
Show all
case class ClientConnects(clientID: ClientID, commChannel: ActorRef[CommunicationProtocol], replyTo: ActorRef[StatusReply[Reply]]) extends GroupCommand

Client connecting to the group it belongs to.

Client connecting to the group it belongs to.

Value parameters

clientID

The client reference to pass to the group

commChannel

Reference of the actual communication channel that is in charge of sending back messages to the group

replyTo

Who receives the response of the command

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait GroupCommand
class Object
trait Matchable
class Any
Show all
case class ClientDisconnected(clientID: ClientID) extends GroupEvent

Event triggered when a client connects to the group

Event triggered when a client connects to the group

Value parameters

clientID

the reference of the client

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait GroupEvent
class Object
trait Matchable
class Any
Show all
case class ClientDisconnects(clientID: ClientID, replyTo: ActorRef[StatusReply[Reply]]) extends GroupCommand

Client disconnecting to the group it belongs to.

Client disconnecting to the group it belongs to.

Value parameters

clientID

The client reference to pass to the group

replyTo

Who receives the response of the command

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait GroupCommand
class Object
trait Matchable
class Any
Show all
case class ClientJoinedToGroup(clientID: ClientID) extends GroupEvent

Event triggered when a client joins to the group.

Event triggered when a client joins to the group.

Value parameters

clientID

the reference of the client

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait GroupEvent
class Object
trait Matchable
class Any
Show all
case class ClientJoinsGroup(clientID: ClientID, replyTo: ActorRef[StatusReply[Reply]]) extends GroupCommand

Client that join a group.

Client that join a group.

Value parameters

clientID

The client reference to pass to the group

replyTo

Who receives the response of the command

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait GroupCommand
class Object
trait Matchable
class Any
Show all
case class ClientLeavedFromGroup(clientID: ClientID) extends GroupEvent

Event triggered when a client leaves from the group.

Event triggered when a client leaves from the group.

Value parameters

clientID

the reference of the client

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait GroupEvent
class Object
trait Matchable
class Any
Show all
case class ClientLeavesGroup(clientID: ClientID, replyTo: ActorRef[StatusReply[Reply]]) extends GroupCommand

Client that leaves a group.

Client that leaves a group.

Value parameters

clientID

The client reference to pass to the group

replyTo

Who receives the response of the command

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait GroupCommand
class Object
trait Matchable
class Any
Show all
case class ClientSuccessfullyConnected(clientID: ClientID) extends Reply

The response that is currently sent back when a client connects to the group

The response that is currently sent back when a client connects to the group

Value parameters

clientID

the ClientID that connects into the group

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Reply
trait CborSerializable
class Object
trait Matchable
class Any
Show all
case class ClientSuccessfullyDisconnected(clientID: ClientID) extends Reply

The response that is currently sent back when a client disconnects from the group

The response that is currently sent back when a client disconnects from the group

Value parameters

clientID

the ClientID that connects into the group

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Reply
trait CborSerializable
class Object
trait Matchable
class Any
Show all
case class ClientSuccessfullyJoined(users: List[ClientID]) extends Reply

The response that is currently sent back when a new client joins the group

The response that is currently sent back when a new client joins the group

Value parameters

users

is the List of ClientID that are currently connected to the group

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Reply
trait CborSerializable
class Object
trait Matchable
class Any
Show all
case class ClientSuccessfullyLeaved(clientID: ClientID) extends Reply

The response that is currently sent back when a client leaves the group

The response that is currently sent back when a client leaves the group

Value parameters

clientID

the ClientID that leaves the group

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Reply
trait CborSerializable
class Object
trait Matchable
class Any
Show all
case class DeleteGroup() extends GroupCommand

Command for deleting the group. This is a poison pill for the group event source entity.

Command for deleting the group. This is a poison pill for the group event source entity.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait GroupCommand
class Object
trait Matchable
class Any
Show all
enum ErrorValues(value: String) extends FormatCodes

Attributes

Supertypes
trait Enum
trait Serializable
trait Product
trait Equals
trait FormatCodes
class Object
trait Matchable
class Any
Show all
trait FormatCodes(value: String)

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
object GroupADT

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
GroupADT.type
sealed trait GroupCommand extends BorerSerialization

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
class DeleteGroup
class SendMessage
Show all
object GroupDSL

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
GroupDSL.type
sealed trait GroupEvent extends BorerSerialization

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
class Message
object GroupEventSourceHandler

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
enum InformationValues(value: String) extends FormatCodes

Attributes

Supertypes
trait Enum
trait Serializable
trait Product
trait Equals
trait FormatCodes
class Object
trait Matchable
class Any
Show all
case class Message(from: ClientID, text: String, time: Instant) extends GroupEvent

Event triggered when a client send a message in the group

Event triggered when a client send a message in the group

Value parameters

from

The message sender id

text

The body of the message that is sent in the group

time

The message timestamp

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait GroupEvent
class Object
trait Matchable
class Any
Show all
sealed trait Reply extends CborSerializable

Attributes

Supertypes
trait CborSerializable
class Object
trait Matchable
class Any
Known subtypes
case class SendMessage(message: Message[ClientID, String], replyTo: ActorRef[StatusReply[Done]]) extends GroupCommand

Send a message to the clients inside the group

Send a message to the clients inside the group

Value parameters

message

The message to broadcast

replyTo

Who receives the response of the command

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait GroupCommand
class Object
trait Matchable
class Any
Show all
Generated with