Struct Config

pub struct Config { /* private fields */ }

Available on crate feature tcp only.

The configuration for a TCP/IP transport capability for libp2p.

Implementations

impl Config

pub fn new() -> Config

Creates a new configuration for a TCP/IP transport:

• Nagle’s algorithm, i.e. TCP_NODELAY, is enabled. See Config::nodelay.
• Reuse of listening ports is disabled. See Config::port_reuse.
• No custom IP_TTL is set. The default of the OS TCP stack applies. See Config::ttl.
• The size of the listen backlog for new listening sockets is 1024. See Config::listen_backlog.

pub fn ttl(self, value: u32) -> Config

Configures the IP_TTL option for new sockets.

pub fn nodelay(self, value: bool) -> Config

Configures the TCP_NODELAY option for new sockets.

pub fn listen_backlog(self, backlog: u32) -> Config

Configures the listen backlog for new listen sockets.

pub fn port_reuse(self, _port_reuse: bool) -> Config

👎Deprecated since 0.42.0: This option does nothing now, since the port reuse policy is now decided on a per-connection basis by the behaviour. The function will be removed in a future release.

Configures port reuse for local sockets, which implies reuse of listening ports for outgoing connections to enhance NAT traversal capabilities.

Deprecation Notice

The new implementation works on a per-connaction basis, defined by the behaviour. This removes the necessaity to configure the transport for port reuse, instead the behaviour requiring this behaviour can decide whether to use port reuse or not.

The API to configure port reuse is part of Transport and the option can be found in libp2p_core::transport::DialOpts.

If PortUse::Reuse is enabled, the transport will try to reuse the local port of the listener. If that’s not possible, i.e. there is no listener or the transport doesn’t allow a direct control over ports, a new port (or the default behaviour) is used. If port reuse is enabled for a connection, this option will be treated on a best-effor basis.

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.