Struct libp2p::autonat::Config

pub struct Config {
    pub timeout: Duration,
    pub boot_delay: Duration,
    pub refresh_interval: Duration,
    pub retry_interval: Duration,
    pub throttle_server_period: Duration,
    pub use_connected: bool,
    pub confidence_max: usize,
    pub max_peer_addresses: usize,
    pub throttle_clients_global_max: usize,
    pub throttle_clients_peer_max: usize,
    pub throttle_clients_period: Duration,
    pub only_global_ips: bool,
}

Available on crate feature autonat only.

Config for the Behaviour.

Fields

timeout: Duration

Timeout for requests.

boot_delay: Duration

Delay on init before starting the fist probe.

refresh_interval: Duration

Interval in which the NAT should be tested again if max confidence was reached in a status.

retry_interval: Duration

Interval in which the NAT status should be re-tried if it is currently unknown or max confidence was not reached yet.

throttle_server_period: Duration

Throttle period for re-using a peer as server for a dial-request.

use_connected: bool

Use connected peers as servers for probes.

confidence_max: usize

Max confidence that can be reached in a public / private NAT status. Note: for NatStatus::Unknown the confidence is always 0.

max_peer_addresses: usize

Max addresses that are tried per peer.

throttle_clients_global_max: usize

Max total dial requests done in [Config::throttle_clients_period].

throttle_clients_peer_max: usize

Max dial requests done in [Config::throttle_clients_period] for a peer.

throttle_clients_period: Duration

Period for throttling clients requests.

only_global_ips: bool

As a server reject probes for clients that are observed at a non-global ip address. Correspondingly as a client only pick peers as server that are not observed at a private ip address. Note that this does not apply for servers that are added via Behaviour::add_server.

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Config

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

Formats the value using the given formatter.

impl Default for Config

fn default() -> Config

Returns the “default value” for a type.

impl PartialEq for Config

fn eq(&self, other: &Config) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Config

impl StructuralPartialEq for Config