Struct DiscoveryBehaviour 

pub struct DiscoveryBehaviour {
    pub mdns: Behaviour,
    pub kademlia: Behaviour<MemoryStore>,
}

The libp2p network behaviour for peer discovery.

Fields

mdns: Behaviour

The mDNS behaviour for local peer discovery.

kademlia: Behaviour<MemoryStore>

The Kademlia behaviour for decentralized peer discovery.

Implementations

impl DiscoveryBehaviour

pub fn new(local_peer_id: PeerId) -> Result<Self>

Creates a new DiscoveryBehaviour.

Arguments

• local_peer_id - The PeerId of the local node.

Errors

This function will return an error if the mDNS behaviour cannot be created.

pub fn bootstrap(&mut self) -> Result<()>

Bootstraps the Kademlia DHT.

This will start the process of finding other peers in the network.

Errors

This function will return an error if the bootstrap process fails.

pub fn start_providing(&mut self, key: RecordKey) -> Result<()>

Starts providing a key in the Kademlia DHT.

This announces to the network that the local node can provide information about the given key.

Arguments

• key - The key to start providing.

Errors

This function will return an error if the providing process fails to start.

pub fn get_providers(&mut self, key: RecordKey) -> QueryId

Gets the providers for a given key from the Kademlia DHT.

Arguments

• key - The key to get providers for.

Returns

A QueryId for the get providers query.

pub fn add_peer_address(&mut self, peer_id: PeerId, address: Multiaddr)

Adds a known address for a peer to the Kademlia DHT.

Arguments

• peer_id - The PeerId of the peer.
• address - The Multiaddr of the peer.

Trait Implementations

impl NetworkBehaviour for DiscoveryBehaviour

where Behaviour: NetworkBehaviour, Behaviour<MemoryStore>: NetworkBehaviour,

type ConnectionHandler = ConnectionHandlerSelect<<Behaviour<Tokio> as NetworkBehaviour>::ConnectionHandler, <Behaviour<MemoryStore> as NetworkBehaviour>::ConnectionHandler>

Handler for all the protocols the network behaviour supports.

type ToSwarm = DiscoveryBehaviourEvent

Event generated by the NetworkBehaviour and that the swarm will report back.

fn handle_pending_inbound_connection( &mut self, connection_id: ConnectionId, local_addr: &Multiaddr, remote_addr: &Multiaddr, ) -> Result<(), ConnectionDenied>

Callback that is invoked for every new inbound connection.

fn handle_established_inbound_connection( &mut self, connection_id: ConnectionId, peer: PeerId, local_addr: &Multiaddr, remote_addr: &Multiaddr, ) -> Result<THandler<Self>, ConnectionDenied>

Callback that is invoked for every established inbound connection.

fn handle_pending_outbound_connection( &mut self, connection_id: ConnectionId, maybe_peer: Option<PeerId>, addresses: &[Multiaddr], effective_role: Endpoint, ) -> Result<Vec<Multiaddr>, ConnectionDenied>

Callback that is invoked for every outbound connection attempt.

fn handle_established_outbound_connection( &mut self, connection_id: ConnectionId, peer: PeerId, addr: &Multiaddr, role_override: Endpoint, ) -> Result<THandler<Self>, ConnectionDenied>

Callback that is invoked for every established outbound connection.

fn on_connection_handler_event( &mut self, peer_id: PeerId, connection_id: ConnectionId, event: THandlerOutEvent<Self>, )

Informs the behaviour about an event generated by the ConnectionHandler dedicated to the peer identified by peer_id. for the behaviour.

fn poll( &mut self, cx: &mut Context<'_>, ) -> Poll<ToSwarm<Self::ToSwarm, THandlerInEvent<Self>>>

Polls for things that swarm should do.

fn on_swarm_event(&mut self, event: FromSwarm<'_>)

Informs the behaviour about an event from the Swarm.