Crate libp2p_swarm

source · [−]

Expand description

High level manager of the network.

A Swarm contains the state of the network as a whole. The entire behaviour of a libp2p network can be controlled through the Swarm. The Swarm struct contains all active and pending connections to remotes and manages the state of all the substreams that have been opened, and all the upgrades that were built upon these substreams.

Initializing a Swarm

Creating a Swarm requires three things:

A network identity of the local node in form of a PeerId.
An implementation of the Transport trait. This is the type that will be used in order to reach nodes on the network based on their address. See the transport module for more information.
An implementation of the NetworkBehaviour trait. This is a state machine that defines how the swarm should behave once it is connected to a node.

Network Behaviour

The NetworkBehaviour trait is implemented on types that indicate to the swarm how it should behave. This includes which protocols are supported and which nodes to try to connect to. It is the NetworkBehaviour that controls what happens on the network. Multiple types that implement NetworkBehaviour can be composed into a single behaviour.

Protocols Handler

The ProtocolsHandler trait defines how each active connection to a remote should behave: how to handle incoming substreams, which protocols are supported, when to open a new outbound substream, etc.

Re-exports

pub use behaviour::CloseConnection;

pub use behaviour::NetworkBehaviour;

pub use behaviour::NetworkBehaviourAction;

pub use behaviour::NetworkBehaviourEventProcess;

pub use behaviour::NotifyHandler;

pub use behaviour::PollParameters;

pub use protocols_handler::IntoProtocolsHandler;

pub use protocols_handler::KeepAlive;

pub use protocols_handler::ProtocolsHandler;

pub use protocols_handler::ProtocolsHandlerEvent;

pub use protocols_handler::ProtocolsHandlerUpgrErr;

pub use protocols_handler::SubstreamProtocol;

Modules

protocols_handler

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

Structs

An record in a prioritised list of addresses.

Dummy implementation of NetworkBehaviour that doesn’t do anything.

IntoProtocolsHandlerSelect

Implementation of IntoProtocolsHandler that combines two protocols into one.

A ProtocolsHandler that opens a new substream for each request.

OneShotHandlerConfig

Configuration parameters for the OneShotHandler

ProtocolsHandlerSelect

Implementation of ProtocolsHandler that combines two protocols into one.

Contains the state of the network, plus the way it should behave.

A SwarmBuilder provides an API for configuring and constructing a Swarm, including the underlying Network.

SwarmPollParameters

Parameters passed to poll(), that the NetworkBehaviour has access to.

Enums

AddAddressResult

The result of adding an address to an ordered list of addresses with associated scores.

The “score” of an address w.r.t. an ordered collection of addresses.

The possible failures of dialing.

Event generated by the Swarm.

Type Definitions

NegotiatedSubstream

Substream for which a protocol has been chosen.