Struct DiscoveryConfig

pub struct DiscoveryConfig { /* private fields */ }

DiscoveryBehaviour configuration.

Note: In order to discover nodes or load and store values via Kademlia one has to add Kademlia protocol via DiscoveryConfig::with_kademlia.

Implementations

impl DiscoveryConfig

pub fn new(local_peer_id: PeerId) -> Self

Create a default configuration with the given public key.

pub fn discovery_limit(&mut self, limit: u64) -> &mut Self

Set the number of active connections at which we pause discovery.

pub fn with_permanent_addresses<I>( &mut self, permanent_addresses: I, ) -> &mut Self

where I: IntoIterator<Item = (PeerId, Multiaddr)>,

Set custom nodes which never expire, e.g. bootstrap or reserved nodes.

pub fn with_dht_random_walk(&mut self, value: bool) -> &mut Self

Whether the discovery behaviour should periodically perform a random walk on the DHT to discover peers.

pub fn allow_private_ip(&mut self, value: bool) -> &mut Self

Should private IPv4/IPv6 addresses be reported?

pub fn allow_non_globals_in_dht(&mut self, value: bool) -> &mut Self

Should non-global addresses be inserted to the DHT?

pub fn with_mdns(&mut self, value: bool) -> &mut Self

Should MDNS discovery be supported?

pub fn with_kademlia<Hash: AsRef<[u8]>>( &mut self, genesis_hash: Hash, fork_id: Option<&str>, protocol_id: &ProtocolId, ) -> &mut Self

Add discovery via Kademlia for the given protocol.

Currently accepts protocol_id. This should be removed once all the nodes are upgraded to genesis hash- and fork ID-based Kademlia protocol name.

pub fn use_kademlia_disjoint_query_paths(&mut self, value: bool) -> &mut Self

Require iterative Kademlia DHT queries to use disjoint paths for increased resiliency in the presence of potentially adversarial nodes.

pub fn with_kademlia_replication_factor( &mut self, value: NonZeroUsize, ) -> &mut Self

Sets Kademlia replication factor.

pub fn finish(self) -> DiscoveryBehaviour

Create a DiscoveryBehaviour from this config.