Struct DiscoveryBehaviour

pub struct DiscoveryBehaviour<K: KeyType> {
    pub discovery: DerivedDiscoveryBehaviour,
    pub next_kad_random_query: Interval,
    pub duration_to_next_kad: Duration,
    pub pending_events: VecDeque<DiscoveryEvent>,
    pub n_node_connected: u32,
    pub peers: HashSet<PeerId>,
    pub peer_info: HashMap<PeerId, PeerInfo>,
    pub target_peer_count: u32,
    pub pending_dial_opts: VecDeque<DialOpts>,
    pub _marker: PhantomData<K>,
}

Fields

discovery: DerivedDiscoveryBehaviour

Discovery behaviour

next_kad_random_query: Interval

Stream that fires when we need to perform the next random Kademlia query.

duration_to_next_kad: Duration

After next_kad_random_query triggers, the next one triggers after this duration.

pending_events: VecDeque<DiscoveryEvent>

Events to return in priority when polled.

n_node_connected: u32

Number of nodes we’re currently connected to.

peers: HashSet<PeerId>

Peers

peer_info: HashMap<PeerId, PeerInfo>

Peer info

target_peer_count: u32

Target peer count

pending_dial_opts: VecDeque<DialOpts>

Options to configure dials to known peers.

_marker: PhantomData<K>

Phantom key type

Implementations

impl<K: KeyType> DiscoveryBehaviour<K>

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

Bootstrap Kademlia network

Errors

• If Kademlia is not activated

pub fn get_peers(&self) -> &HashSet<PeerId>

pub fn get_peer_info(&self, peer_id: &PeerId) -> Option<&PeerInfo>

pub fn nat_status(&self) -> NatStatus

pub fn get_peer_addresses(&self) -> HashMap<PeerId, HashSet<Multiaddr>>

Trait Implementations

impl<K: KeyType> NetworkBehaviour for DiscoveryBehaviour<K>

type ConnectionHandler = <DerivedDiscoveryBehaviour as NetworkBehaviour>::ConnectionHandler

Handler for all the protocols the network behaviour supports.

type ToSwarm = DiscoveryEvent

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

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_established_outbound_connection( &mut self, connection_id: ConnectionId, peer: PeerId, addr: &Multiaddr, role_override: Endpoint, port_use: PortUse, ) -> Result<THandler<Self>, ConnectionDenied>

Callback that is invoked for every established outbound connection.

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

Informs the behaviour about an event from the Swarm.

fn on_connection_handler_event( &mut self, peer_id: PeerId, connection: 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 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_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.