[−][src]Module libp2p::core
Transport, protocol upgrade and swarm systems of libp2p.
This crate contains all the core traits and mechanisms of the transport and swarm systems of libp2p.
Overview
This documentation focuses on the concepts of libp2p-core, and is interesting mostly if you want to extend libp2p with new protocols. If you only want to use libp2p, you might find the documentation of the main libp2p crate more interesting.
The main concepts of libp2p are:
- A
PeerId
is a unique global identifier for a node on the network. Each node must have a differentPeerId
. Normally, aPeerId
is the hash of the public key used to negotiate encryption on the communication channel, thereby guaranteeing that they cannot be spoofed. - The
Transport
trait defines how to reach a remote node or listen for incoming remote connections. See thetransport
module. - 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. - Use the
NetworkBehaviour
trait to customize the behaviour of aSwarm
. It is theNetworkBehaviour
that controls what happens on the network. Multiple types that implementNetworkBehaviour
can be composed into a single behaviour. - The
Topology
trait is implemented for types that hold the layout of a network. When other components need the network layout to operate, they are passed an instance of aTopology
. - The
StreamMuxer
trait is implemented on structs that hold a connection to a remote and can subdivide this connection into multiple substreams. See themuxing
module. - The
UpgradeInfo
,InboundUpgrade
andOutboundUpgrade
traits define how to upgrade each individual substream to use a protocol. See theupgrade
module. - 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. See theprotocols_handler
trait.
High-level APIs vs low-level APIs
This crate provides two sets of APIs:
- The low-level APIs are contained within the
nodes
module. See the documentation for more information. - The high-level APIs include the concepts of
Swarm
,ProtocolsHandler
,NetworkBehaviour
andTopology
.
Modules
either | |
multiaddr | |
muxing | Muxing is the process of splitting a connection into multiple substreams. |
nodes | Low-level networking primitives. |
protocols_handler | Once we are connected to a node, a protocols handler handles one or more specific protocols on this connection. |
swarm | High level manager of the network. |
topology | A network topology is a collection of nodes that are part of the network or that we think are part of the network. In other words, it is essentially a container whose layout is optimized for certain operations. |
transport | Handles entering a connection with a peer. |
upgrade | Contains everything related to upgrading a connection or a substream to use a protocol. |
Structs
PeerId | Identifier of a peer of the network. |
Enums
Endpoint | |
PublicKey | Public key used by the remote. |