package protocol
- Alphabetic
- Public
- Protected
Type Members
- trait CommandProtocol[ID, Alg[_[_]]] extends AnyRef
CommandProtocol
represents the transport aspects of the entity cluster.CommandProtocol
represents the transport aspects of the entity cluster.client
provides an implementation of the algebra which sends commands for each defined function in the algebra and decodes the reply, andserver
is a decoder for instances ofIncomingCommand[F, Alg]
that represent incoming commands that can be run and contain their own reply encoder.- Alg
the entity algebra
- trait CommandSender[F[_], ID] extends AnyRef
CommandSender[F, ID]
provides a natural transformation to deliver an outgoing command to where the entity resides and decode the reply as a simple value in theF
context.CommandSender[F, ID]
provides a natural transformation to deliver an outgoing command to where the entity resides and decode the reply as a simple value in theF
context.- F
context
- ID
entity ID
- trait Decoder[+A] extends AnyRef
Generic binary decoder
Generic binary decoder
- A
value
- trait Encoder[-A] extends AnyRef
Generic binary encoder
Generic binary encoder
- A
value
- trait EntityIDCodec[ID] extends EntityIDEncoder[ID] with EntityIDDecoder[ID]
Encode/decode entity IDs to/from strings
Encode/decode entity IDs to/from strings
- ID
entity id
- trait EntityIDDecoder[+ID] extends AnyRef
Decode a string into an entity ID
Decode a string into an entity ID
- ID
entity id
- trait EntityIDEncoder[-ID] extends AnyRef
Encode an entity ID into a string
Encode an entity ID into a string
- ID
entity id
- trait IncomingCommand[F[_], Alg[_[_]]] extends AnyRef
Represents an incoming entity command.
Represents an incoming entity command. Embeds the
Reply
type, the ability to run it on the entity algebra inF
context and specifies the encoder to be used to encode the reply.- F
context
- Alg
entity algebra
- trait OutgoingCommand[+R] extends AnyRef
Represents an outgoing command.
Represents an outgoing command. Embeds the binary payload and indicates the decoder to use for the reply of type
R
.- R
reply
Value Members
- object CommandProtocol
- object CommandSender
- object EntityIDCodec