[−][src]Module libp2prs_swarm::protocol_handler

A handler for a set of protocols used on a connection with a remote.

This trait should be implemented for a type that maintains the server side state for the execution of a specific protocol.

Note:: ProtocolHandler is an async trait and can be made into a trait object.

UpgradeInfo

The trait ProtocolHandler derives from UpgradeInfo, which provides a list of protocols that are supported, e.g. '/foo/1.0.0' and '/foo/2.0.0'.

Communication with a remote over a set of protocols is initiated in one of two ways:

Dialing by initiating a new outbound substream. In order to do so, Swarm::control::new_stream() must be invoked with the specified protocols to create a sub-stream. A protocol negotiation procedure will done for the protocols, in which one might be finally selected. Upon success, a Swarm::Substream will be returned by Swarm::control::new_stream(), and the protocol will be then handled by the owner of the Substream.
Listening by accepting a new inbound substream. When a new inbound substream is created on a connection, Swarm::muxer is called to negotiate the protocol(s). Upon success, ProtocolHandler::handle is called with the final output of the upgrade.

In general, multiple protocol handlers should be made into trait objects and then added to Swarm::muxer.

Dummy protocol handler, test purpose

Notifiee	Notifiee is an trait for an object wishing to receive notifications from swarm.
ProtocolHandler	Common trait for upgrades that can be applied on inbound substreams, outbound substreams, or both. Possible upgrade on a connection or substream.