package protocol
- Alphabetic
- Public
- Protected
Type Members
- trait CommandProtocol[Alg[_[_]]] extends AnyRef
CommandProtocol
represents the serialization aspects of the entity.CommandProtocol
represents the serialization aspects of the entity.client
provides an interpretation of the algebra withOutgoingCommand[*]
for issuing commands for each defined function in the algebra, andserver
is a decoder for an instance ofIncomingCommand[F, Alg]
which represents an incoming command that can be directly run and contains its own reply encoder as well.- Alg
the entity algebra
- trait CommandRouter[F[_], ID] extends AnyRef
CommandRouter[F, ID]
provides a natural transformation to route an outgoing command to where the entity resides and decode the reply as a simple value in theF
context.CommandRouter[F, ID]
provides a natural transformation to route 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 EntityIDCodec