endless-core
API
Generated with
endless-core/endless/endless.core/endless.core.protocol

endless.core.protocol

package endless.core.protocol

Members list

Type members

Classlikes

trait CommandProtocol[ID, Alg[_[_]]]

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, and server is a decoder for instances of IncomingCommand[F, Alg] that represent incoming commands that can be run and contain their own reply encoder.

Type parameters

Alg

the entity algebra

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
object CommandProtocol

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
trait CommandSender[F[_], ID]

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 the F 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 the F context.

Type parameters

F

context

ID

entity ID

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
object CommandSender

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
trait Decoder[+A]

Generic binary decoder

Generic binary decoder

Type parameters

A

value

Attributes

Supertypes
class Object
trait Matchable
class Any
trait Encoder[-A]

Generic binary encoder

Generic binary encoder

Type parameters

A

value

Attributes

Supertypes
class Object
trait Matchable
class Any
trait EntityIDCodec[ID] extends EntityIDEncoder[ID], EntityIDDecoder[ID]

Encode/decode entity IDs to/from strings

Encode/decode entity IDs to/from strings

Type parameters

ID

entity id

Attributes

Companion
object
Supertypes
trait EntityIDDecoder[ID]
trait EntityIDEncoder[ID]
class Object
trait Matchable
class Any
object EntityIDCodec

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
trait EntityIDDecoder[+ID]

Decode a string into an entity ID

Decode a string into an entity ID

Type parameters

ID

entity id

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
trait EntityIDCodec[ID]
trait EntityIDEncoder[-ID]

Encode an entity ID into a string

Encode an entity ID into a string

Type parameters

ID

entity id

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
trait EntityIDCodec[ID]
trait IncomingCommand[F[_], Alg[_[_]]]

Represents an incoming entity command. Embeds the Reply type, the ability to run it on the entity algebra in F context and specifies the encoder to be used to encode the reply.

Represents an incoming entity command. Embeds the Reply type, the ability to run it on the entity algebra in F context and specifies the encoder to be used to encode the reply.

Type parameters

Alg

entity algebra

F

context

Attributes

Supertypes
class Object
trait Matchable
class Any
trait OutgoingCommand[+R]

Represents an outgoing command. Embeds the binary payload and indicates the decoder to use for the reply of type R.

Represents an outgoing command. Embeds the binary payload and indicates the decoder to use for the reply of type R.

Type parameters

R

reply

Attributes

Supertypes
class Object
trait Matchable
class Any
Generated with