Module pea2pea::protocols[][src]

Opt-in protocols available to the Node; each protocol is expected to spawn its own task that runs throughout the Node's lifetime and handles a specific functionality. The communication with these tasks is done via ProtocolHandlers.

Structs

ProtocolHandler

An object dedicated to managing a protocol; it contains a Sender whose other side is owned by the protocol's task, a handle to which is also held by the ProtocolHandler.

Traits

Handshaking

Can be used to specify and enable network handshakes. Upon establishing a connection, both sides will need to adhere to the specified handshake rules in order to finalize the connection and be able to send or receive any messages.

Reading

Can be used to specify and enable reading, i.e. receiving inbound messages. If handshaking is enabled too, it goes into force only after the handshake has been concluded.

Writing

Can be used to specify and enable writing, i.e. sending outbound messages. If handshaking is enabled too, it goes into force only after the handshake has been concluded.

Type Definitions

ReturnableConnection

An object allowing a Connection to be "borrowed" from the owning Node to enable a protocol and to be sent back to it once it's done its job.