Struct libp2p_ping::handler::PingConfig

pub struct PingConfig { /* private fields */ }

The configuration for outbound pings.

Implementations

impl PingConfig

pub fn new() -> Self

Creates a new PingConfig with the following default settings:

• PingConfig::with_interval 15s
• PingConfig::with_timeout 20s
• PingConfig::with_max_failures 1
• PingConfig::with_keep_alive false

These settings have the following effect:

• A ping is sent every 15 seconds on a healthy connection.
• Every ping sent must yield a response within 20 seconds in order to be successful.
• A single ping failure is sufficient for the connection to be subject to being closed.
• The connection may be closed at any time as far as the ping protocol is concerned, i.e. the ping protocol itself does not keep the connection alive.

pub fn with_timeout(self, d: Duration) -> Self

Sets the ping timeout.

pub fn with_interval(self, d: Duration) -> Self

Sets the ping interval.

pub fn with_max_failures(self, n: NonZeroU32) -> Self

Sets the maximum number of consecutive ping failures upon which the remote peer is considered unreachable and the connection closed.

pub fn with_keep_alive(self, b: bool) -> Self

Sets whether the ping protocol itself should keep the connection alive, apart from the maximum allowed failures.

By default, the ping protocol itself allows the connection to be closed at any time, i.e. in the absence of ping failures the connection lifetime is determined by other protocol handlers.

If the maximum number of allowed ping failures is reached, the connection is always terminated as a result of ProtocolsHandler::poll returning an error, regardless of the keep-alive setting.

Trait Implementations

impl Clone for PingConfig

fn clone(&self) -> PingConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PingConfig

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

Formats the value using the given formatter.