Struct ConnectionHealth 

pub struct ConnectionHealth {
    pub last_rx: Instant,
    pub rtt: Option<Duration>,
    pub seq_gaps: u64,
}

Receive-side health signals of one connection.

Examples

use std::time::{Duration, Instant};
use brokapi_runtime::{ConnectionHealth, HealthClass};

let t0 = Instant::now();
let mut health = ConnectionHealth::new(t0);
let (degraded_after, dead_after) = (Duration::from_secs(15), Duration::from_secs(60));

assert_eq!(health.classify(t0 + Duration::from_secs(5), dead_after, degraded_after), HealthClass::Healthy);
assert_eq!(health.classify(t0 + Duration::from_secs(20), dead_after, degraded_after), HealthClass::Degraded);
assert_eq!(health.classify(t0 + Duration::from_secs(60), dead_after, degraded_after), HealthClass::Dead);

// A frame arrives: the silence timer restarts.
health.on_rx(t0 + Duration::from_secs(61));
assert_eq!(health.classify(t0 + Duration::from_secs(62), dead_after, degraded_after), HealthClass::Healthy);

Fields

last_rx: Instant

When the last frame arrived. Starts at the creation time.

rtt: Option<Duration>

Round-trip time of the last ping, if the owner measures it. The runtime does not fill it.

seq_gaps: u64

Number of sequence gaps seen on this connection. The runtime does not count them by itself.

Implementations

impl ConnectionHealth

pub fn new(now: Instant) -> Self

Creates the health record of a connection that is considered just heard from at now.

pub fn on_rx(&mut self, now: Instant)

Records that a frame arrived at now.

pub fn classify( &self, now: Instant, dead_after: Duration, degraded_after: Duration, ) -> HealthClass

Classifies the connection by the time since the last frame.

Silence of dead_after or more gives HealthClass::Dead. Silence of degraded_after or more gives HealthClass::Degraded. Otherwise HealthClass::Healthy. The caller should pass degraded_after < dead_after, otherwise a connection is never reported as degraded. A now earlier than last_rx counts as no silence.

Trait Implementations

impl Clone for ConnectionHealth

fn clone(&self) -> ConnectionHealth

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ConnectionHealth

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

Formats the value using the given formatter.