Struct DiscoveryBehaviour

pub struct DiscoveryBehaviour { /* private fields */ }

Implementation of NetworkBehaviour that discovers the nodes on the network.

Implementations

impl DiscoveryBehaviour

pub fn known_peers(&mut self) -> HashSet<PeerId>

Returns the list of nodes that we know exist in the network.

pub fn add_known_address(&mut self, peer_id: PeerId, addr: Multiaddr)

Adds a hard-coded address for the given peer, that never expires.

This adds an entry to the parameter that was passed to new.

If we didn’t know this address before, also generates a Discovered event.

pub fn add_self_reported_address( &mut self, peer_id: &PeerId, supported_protocols: &[StreamProtocol], addr: Multiaddr, )

Add a self-reported address of a remote peer to the k-buckets of the DHT if it has compatible supported_protocols.

Note: It is important that you call this method. The discovery mechanism will not automatically add connecting peers to the Kademlia k-buckets.

pub fn get_value(&mut self, key: RecordKey)

Start fetching a record from the DHT.

A corresponding ValueFound or ValueNotFound event will later be generated.

pub fn put_value(&mut self, key: RecordKey, value: Vec<u8>)

Start putting a record into the DHT. Other nodes can later fetch that value with get_value.

A corresponding ValuePut or ValuePutFailed event will later be generated.

pub fn put_record_to( &mut self, record: Record, peers: HashSet<PeerId>, update_local_storage: bool, )

Puts a record into the DHT on the provided peers

If update_local_storage is true, the local storage is update as well.

pub fn store_record( &mut self, record_key: RecordKey, record_value: Vec<u8>, publisher: Option<PeerId>, expires: Option<Instant>, )

Store a record in the Kademlia record store.

pub fn num_entries_per_kbucket(&mut self) -> Option<Vec<(u32, usize)>>

Returns the number of nodes in each Kademlia kbucket for each Kademlia instance.

Identifies Kademlia instances by their ProtocolId and kbuckets by the base 2 logarithm of their lower bound.

pub fn num_kademlia_records(&mut self) -> Option<usize>

Returns the number of records in the Kademlia record stores.

pub fn kademlia_records_total_size(&mut self) -> Option<usize>

Returns the total size in bytes of all the records in the Kademlia record stores.

pub fn can_add_to_dht(addr: &Multiaddr) -> bool

Can the given Multiaddr be put into the DHT?

This test is successful only for global IP addresses and DNS names.

Trait Implementations

impl NetworkBehaviour for DiscoveryBehaviour

type ConnectionHandler = ToggleConnectionHandler<<Behaviour<MemoryStore> as NetworkBehaviour>::ConnectionHandler>

Handler for all the protocols the network behaviour supports.

type ToSwarm = DiscoveryOut

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, ) -> Result<THandler<Self>, ConnectionDenied>

Callback that is invoked for every established outbound connection.

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.

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

Informs the behaviour about an event from the Swarm.

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<'_>, params: &mut impl PollParameters, ) -> Poll<ToSwarm<Self::ToSwarm, THandlerInEvent<Self>>>

Polls for things that swarm should do.