Struct Foreign 

#[non_exhaustive]
pub struct Foreign {
    pub bbmd: SocketAddrV4,
    pub ttl: u16,
    pub renewal: Duration,
    pub response_timeout: Duration,
    pub retry: Retry,
    pub hold: u16,
    pub trust: ForwardedTrust,
}

A foreign device’s registration with its BBMD (Annex J.5.2).

It is #[non_exhaustive], so a new setting isn’t a breaking change: outside this crate, start from Foreign::new and set the fields to change.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

bbmd: SocketAddrV4

The BBMD, at its B/IP address. Replies are matched against this address and port.

ttl: u16

The time-to-live sent with each registration, in seconds; above 0.

renewal: Duration

How often to register again: above zero and below the time-to-live. A shorter one than MIN_RENEWAL is raised to it. Registering more often than the time-to-live needs keeps a NAT mapping open (Annex J.7.5).

response_timeout: Duration

How long an attempt waits for its result: above zero. One longer than the renewal interval is cut to it. It also sets the answer window the lease counts on (Lease).

retry: Retry

When a failed attempt is tried again.

hold: u16

How many broadcasts the caller can keep while the first attempt is outstanding. Node::admit_broadcast asks it to hold them until that attempt is answered or times out. With 0 they are sent at once.

trust: ForwardedTrust

Which Forwarded-NPDUs are taken.

Implementations

impl Foreign

pub const fn new(bbmd: SocketAddrV4, ttl: u16) -> Self

Registration with bbmd for ttl seconds: renewed every half time-to-live (at least MIN_RENEWAL), a response timeout of that or DEFAULT_RESPONSE_TIMEOUT if shorter, Retry::Backoff, no broadcasts held, and Forwarded-NPDUs taken only from bbmd.

pub const fn ttl_duration(&self) -> Duration

The time-to-live as a duration.

pub const fn effective_renewal(&self) -> Duration

The renewal interval in use: renewal, at least MIN_RENEWAL.

pub const fn effective_response_timeout(&self) -> Duration

The response timeout in use: response_timeout, at most the effective renewal.

Trait Implementations

impl Clone for Foreign

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Foreign

impl Debug for Foreign

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

Formats the value using the given formatter.

impl Eq for Foreign

impl PartialEq for Foreign

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Foreign