Struct RouteHold 

pub struct RouteHold {
    pub until_ms: u64,
    pub flood_hops: u8,
    pub fallback_acks: u8,
    pub candidate: Option<RouteCandidate>,
}

A route the application chose for a peer, kept in place until a deadline.

While the hold is in force no learned path replaces the route and no failure retires it. A send that misses its acknowledgment still falls back to a flood, and what that teaches is kept beside the route as a candidate the application may adopt.

Fields

until_ms: u64

When the hold ends, on the MAC’s clock.

flood_hops: u8

Flood budget past the end of the held route: what a send on it spends once its hints are consumed, or from the start for a direct route. Replaces the slack crate::established_route_slack would grant while the hold lasts; zero floods nothing. An ack along the route spends whichever of the two is larger.

fallback_acks: u8

Consecutive sends on the held route that missed their acknowledgment and were then acknowledged through the flood fallback.

candidate: Option<RouteCandidate>

The best path learned while the hold was in force.

Trait Implementations

impl Clone for RouteHold

fn clone(&self) -> RouteHold

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RouteHold

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

Formats the value using the given formatter.

impl PartialEq for RouteHold

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for RouteHold

impl StructuralPartialEq for RouteHold