Struct libp2p_ping::handler::PingConfig

pub struct PingConfig { /* fields omitted */ }

The configuration for outbound pings.

Methods

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

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.

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.

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.