Struct MeshRelayStats 

pub struct MeshRelayStats {

    pub forwarded: u64,
    pub transmissions: u64,
    pub queued: u64,
    pub awaiting_transmission: usize,
    pub duplicates_suppressed: u64,
    pub covered_by_a_neighbor: u64,
    pub peer_rate_limited: u64,
    pub refused_queue_full: u64,
    pub rate_deferred: u64,
    pub abandoned_overdue: u64,
    pub hop_limit_reached: u64,
    pub reach_clamped: u64,
    pub dropped_for_capacity: u64,
}

What this device has carried for other people.

A snapshot, safe to poll. Every field is cumulative since start-up except Self::awaiting_transmission, which is a gauge: it is the queue depth right now, and it goes down as well as up.

Fields

forwarded: u64

Frames carried onward on someone else’s behalf, counted once each.

transmissions: u64

Times this device put a frame on a link, counting each link separately and including hand-offs of its own messages.

This is what the per-second forwarding budget bounds, so it is the number to compare against that ceiling — Self::forwarded is the contribution figure to show a user.

queued: u64

Frames accepted for forwarding.

awaiting_transmission: usize

Frames waiting to go out right now.

duplicates_suppressed: u64

Arrivals ignored because the frame had already been handled.

covered_by_a_neighbor: u64

Forwards dropped because every neighbor they could go to had already handed this device the same frame, the saving that keeps a crowded room from repeating itself.

peer_rate_limited: u64

Frames refused because the neighbor sending them was over its share.

refused_queue_full: u64

Frames refused admission, or refused room on their way back to the queue, because the pending queue was full.

This is a real loss: the frame reached nobody, and only a copy behind it or the sender’s own retransmission will carry it now. A rising value means forwards are arriving faster than this device can transmit them, so the queue is the thing to raise, or the rate ceiling that is filling it — see Self::rate_deferred.

rate_deferred: u64

Transmissions held back because this device was at its forwarding rate.

A frame counted here is delayed, not dropped: it goes back on the queue and is tried again on the next tick, until it is either sent or has waited so long past its turn that carrying it no longer helps.

abandoned_overdue: u64

Queued forwards given up on after waiting too long past their due time.

The other end of Self::rate_deferred: this is where a frame that kept being delayed finally stops being carried. Deferral is free to look healthy while this climbs, so it is the pair that says whether back-pressure is costing anything.

hop_limit_reached: u64

Frames that had travelled as far as they were allowed to.

reach_clamped: u64

Frames whose claimed reach was cut down to local policy.

dropped_for_capacity: u64

Ids forgotten for lack of room rather than age.

Expected to stay at zero. A non-zero value means this device is seeing more traffic than it can remember having handled, and a frame it forgets can be forwarded a second time.

Trait Implementations

impl Clone for MeshRelayStats

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MeshRelayStats

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

Formats the value using the given formatter.

impl Default for MeshRelayStats

fn default() -> Self

Returns the “default value” for a type.

impl Eq for MeshRelayStats

impl PartialEq for MeshRelayStats

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for MeshRelayStats