Expand description

Once a connection to a remote peer is established, a ConnectionHandler negotiates and handles one or more specific protocols on the connection.

Protocols are negotiated and used on individual substreams of the connection. Thus a ConnectionHandler defines the inbound and outbound upgrades to apply when creating a new inbound or outbound substream, respectively, and is notified by a Swarm when these upgrades have been successfully applied, including the final output of the upgrade. A ConnectionHandler can then continue communicating with the peer over the substream using the negotiated protocol(s).

Two ConnectionHandlers can be composed with ConnectionHandler::select() in order to build a new handler supporting the combined set of protocols, with methods being dispatched to the appropriate handler according to the used protocol(s) determined by the associated types of the handlers.

Note: A ConnectionHandler handles one or more protocols in the context of a single connection with a remote. In order to handle a protocol that requires knowledge of the network as a whole, see the NetworkBehaviour trait.

Modules

A ConnectionHandler implementation that combines multiple other ConnectionHandlers indexed by some key.

Structs

Implementation of ConnectionHandler that combines two protocols into one.

Implementation of ConnectionHandler that doesn’t handle anything.

Implementation of IntoConnectionHandler that combines two protocols into one.

Wrapper around a protocol handler that turns the input event into something else.

Wrapper around a protocol handler that turns the output event into something else.

A ConnectionHandler that opens a new substream for each request.

Configuration parameters for the OneShotHandler

Wraps around a type that implements OutboundUpgradeSend, InboundUpgradeSend, or both, and implements OutboundUpgrade and/or InboundUpgrade.

Configuration of inbound or outbound substream protocol(s) for a ConnectionHandler.

Enums

Event produced by a handler.

Error that can happen on an outbound substream opening attempt.

How long the connection should be kept alive.

Traits

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

Implemented automatically on all types that implement InboundUpgrade and Send + 'static.

Implemented automatically on all types that implement OutboundUpgrade and Send + 'static.

Implemented automatically on all types that implement UpgradeInfo and Send + 'static.