Struct litep2p::protocol::libp2p::kademlia::ConfigBuilder

pub struct ConfigBuilder { /* private fields */ }

Configuration builder for Kademlia.

Implementations

impl ConfigBuilder

pub fn new() -> Self

Create new ConfigBuilder.

pub fn with_replication_factor(self, replication_factor: usize) -> Self

Set replication factor.

pub fn with_known_peers(self, peers: HashMap<PeerId, Vec<Multiaddr>>) -> Self

Seed Kademlia with one or more known peers.

pub fn with_routing_table_update_mode( self, mode: RoutingTableUpdateMode, ) -> Self

Set routing table update mode.

pub fn with_incoming_records_validation_mode( self, mode: IncomingRecordValidationMode, ) -> Self

Set incoming records validation mode.

pub fn with_protocol_names(self, protocol_names: Vec<ProtocolName>) -> Self

Set Kademlia protocol names, overriding the default protocol name.

The order of the protocol names signifies preference so if, for example, there are two protocols:

• /kad/2.0.0
• /kad/1.0.0

Where /kad/2.0.0 is the preferred version, then that should be in protocol_names before /kad/1.0.0.

pub fn with_record_ttl(self, record_ttl: Duration) -> Self

Set default TTL for the records.

If unspecified, the default TTL is 36 hours.

pub fn with_provider_record_ttl(self, provider_record_ttl: Duration) -> Self

Set default TTL for the provider records. Recommended value is 2 * (refresh interval) + 20%.

If unspecified, the default TTL is 48 hours.

pub fn build(self) -> (Config, KademliaHandle)

Build Kademlia Config.

Trait Implementations

impl Debug for ConfigBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ConfigBuilder

fn default() -> Self

Returns the “default value” for a type.