Struct DHTBuilder

pub struct DHTBuilder { /* private fields */ }

Helps to configure and create new DHT instances.

Implementations

impl DHTBuilder

pub fn new() -> DHTBuilder

Creates a new DHTBuilder

pub fn initial_id(self, id: Id) -> Self

Set the initial Id for your DHT node.

If you don’t specify one, DHT will try to generate one based on its external IPv4 address (if known). If it doesn’t know its external IPv4 address, DHT will generate a random Id and change it later if it learns that it’s not valid for its IPv4 address.

pub fn listen_addr(self, listen_addr: SocketAddrV4) -> Self

Sets the IPv4 address and port that the DHT should bind its UDP socket to.

If not specified, it will default to 0.0.0.0:6881

pub fn ip_source(self, ip_source: Box<dyn IPV4AddrSource + Send>) -> Self

Provides an IPV4AddrSource implementation to the DHT.

DHT will use this object to learn its external IPv4 address and keep up to date when the IP changes. If unspecified, the default implementation is IPV4Consensus.

pub fn route_table(self, route_table: Box<dyn NodeStorage + Send>) -> Self

Provides a NodeStorage implementation to the DHT.

DHT will use this to store its routing tables. If unspecified, the default implementation is NodeBucketStorage which works roughly the BEP0005 describes.

pub fn settings(self, settings: DHTSettings) -> Self

Provides a DHTSettings object to the DHT.

DHTSettings can be built with DHTSettingsBuilder but the defaults should work fine in most cases.

pub fn build(self, shutdown_rx: ShutdownReceiver) -> Result<DHT, RustyDHTError>

Build a DHT

This must be called from within a tokio Runtime context because it constructs a tokio UdpSocket. See tokio::net::UdpSocket.

Trait Implementations

impl Clone for DHTBuilder

fn clone(&self) -> DHTBuilder

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Default for DHTBuilder

fn default() -> DHTBuilder

Returns the “default value” for a type.