Struct PingTracker 

pub struct PingTracker { /* private fields */ }

Tracks pings on a single relay connection.

Only the last ping needs is useful, any previously sent ping is forgotten and ignored.

Implementations

impl PingTracker

pub fn new(max_timeout: Duration) -> Self

Creates a new ping tracker with the given maximum ping timeout.

pub fn max_timeout(&self) -> Duration

Returns the maximum ping timeout.

pub fn new_ping(&mut self) -> [u8; 8]

Starts a new ping with an RTT-based timeout.

pub fn new_ping_with_timeout(&mut self, timeout: Duration) -> [u8; 8]

Starts a new ping with a custom timeout.

pub fn pong_received(&mut self, data: [u8; 8])

Updates the ping tracker with a received pong.

Only the pong of the most recent ping will do anything. There is no harm feeding any pong however.

pub fn ping_timeout(&self) -> Duration

Returns the timeout for the next ping.

Uses 3x the last measured RTT (to account for jitter), falling back to the default timeout if no RTT has been measured yet.

pub async fn timeout(&mut self)

Cancel-safe waiting for a ping timeout.

Unless the most recent sent ping times out, this will never return.

Trait Implementations

impl Debug for PingTracker

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

Formats the value using the given formatter.

impl Default for PingTracker

fn default() -> Self

Returns the “default value” for a type.