Crate tet_libp2p_swarm[−][src]
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 thetransport
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 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 |
toggle |
Structs
AddressRecord | An record in a prioritised list of addresses. |
DummyBehaviour | Dummy implementation of |
ExpandedSwarm | Contains the state of the network, plus the way it should behave. |
IntoProtocolsHandlerSelect | Implementation of |
OneShotHandler | A |
OneShotHandlerConfig | Configuration parameters for the |
ProtocolsHandlerSelect | Implementation of |
SwarmBuilder | A |
SwarmPollParameters | Parameters passed to |
Enums
AddAddressResult | The result of adding an address to an ordered list of addresses with associated scores. |
AddressScore | The “score” of an address w.r.t. an ordered collection of addresses. |
DialError | The possible failures of |
DialPeerCondition | The available conditions under which a new dialing attempt to
a peer is initiated when requested by |
NetworkBehaviourAction | An action that a |
NotifyHandler | The options w.r.t. which connection handler to notify of an event. |
SwarmEvent | Event generated by the |
Traits
NetworkBehaviour | A behaviour for the network. Allows customizing the swarm. |
NetworkBehaviourEventProcess | When deriving |
PollParameters | Parameters passed to |
Type Definitions
NegotiatedSubstream | Substream for which a protocol has been chosen. |
Swarm | Contains the state of the network, plus the way it should behave. |