Struct fidl_fuchsia_net_neighbor::UnreachabilityConfig

pub struct UnreachabilityConfig {
    pub base_reachable_time: Option<i64>,
    pub learn_base_reachable_time: Option<bool>,
    pub min_random_factor: Option<f32>,
    pub max_random_factor: Option<f32>,
    pub retransmit_timer: Option<i64>,
    pub learn_retransmit_timer: Option<bool>,
    pub delay_first_probe_time: Option<i64>,
    pub max_multicast_probes: Option<u32>,
    pub max_unicast_probes: Option<u32>,
    pub max_anycast_delay_time: Option<i64>,
    pub max_reachability_confirmations: Option<u32>,
    /* private fields */
}

Configuration options related to the operation of Neighbor Unreachability Detection (NUD), as defined by RFC 4861 section 7.3.

Field names loosely follow RFC 4861 sections 6.3.2 and 10, any deviations are noted. Descriptions are kept implementation-independent by using a set of generic terminology.

,—————————————————————––. | Generic Term | ARP Protocol | NDP Protocol | |—————————+–––––––+————————| | Reachability Probe | ARP Request | Neighbor Solicitation | | Reachability Confirmation | ARP Reply | Neighbor Advertisement | `—————————+–––––––+————————’

Fields

base_reachable_time: Option<i64>

A base duration for computing the random reachable time.

Reachable time is the duration for which a neighbor is considered reachable after a positive reachability confirmation is received. It is a function of a uniformly distributed random value between [min_random_factor] and [max_random_factor] multiplied by [base_reachable_time]. Using a random component eliminates the possibility that Neighbor Unreachability Detection messages will synchronize with each other.

After this time, an entry will transition from REACHABLE to STALE state.

Referred to as “BaseReachableTime” by RFC 4861.

Must be greater than 0.

learn_base_reachable_time: Option<bool>

Learn [base_reachable_time] during runtime from the neighbor discovery protocol, if supported.

min_random_factor: Option<f32>

The minimum value of the random factor used for computing reachable time.

See [base_reachable_time] for more information on computing the reachable time.

Must be greater than 0.

max_random_factor: Option<f32>

The maximum value of the random factor used for computing reachable time.

See [base_reachable_time] for more information on computing the reachable time.

Must be greater than or equal to [min_random_factor].

retransmit_timer: Option<i64>

Duration between retransmissions of reachability probes in the PROBE state.

Referred to as “RetransTimer” by RFC 4861.

Must be greater than 0.

learn_retransmit_timer: Option<bool>

Learn [retransmit_timer] during runtime from the neighbor discovery protocol, if supported.

delay_first_probe_time: Option<i64>

Duration to wait for a non-Neighbor-Discovery related protocol to reconfirm reachability after entering the DELAY state. After this time, a reachability probe will be sent and the entry will transition to the PROBE state.

Must be greater than 0.

max_multicast_probes: Option<u32>

The number of reachability probes to send before concluding negative reachability and deleting the entry from the INCOMPLETE state.

Referred to as “MAX_MULTICAST_SOLICIT” by RFC 4861.

Must be greater than 0.

max_unicast_probes: Option<u32>

The number of reachability probes to send before concluding retransmissions from within the PROBE state should cease and the entry SHOULD be deleted.

Referred to as “MAX_UNICAST_SOLICIT” by RFC 4861.

Must be greater than 0.

max_anycast_delay_time: Option<i64>

If the target address is an anycast address, the stack SHOULD delay sending a response for a random time between 0 and this duration.

max_reachability_confirmations: Option<u32>

A node MAY send up to this amount of unsolicited reachability confirmations messages to all-nodes multicast address when a node determines its link-layer address has changed.

Referred to as “MAX_NEIGHBOR_ADVERTISEMENT” by RFC 4861.

Implementations

impl UnreachabilityConfig

pub const EMPTY: Self = _

An empty table with every field set to None.

Trait Implementations

impl Clone for UnreachabilityConfig

fn clone(&self) -> UnreachabilityConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UnreachabilityConfig

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

Formats the value using the given formatter.

impl Decode<UnreachabilityConfig> for UnreachabilityConfig

fn new_empty() -> Self

Creates a valid instance of Self. The specific value does not matter, since it will be overwritten by decode.

unsafe fn decode( &mut self, decoder: &mut Decoder<'_>, offset: usize, depth: Depth ) -> Result<()>

Decodes an object of type T from the decoder’s buffers into self.

impl Encode<UnreachabilityConfig> for &UnreachabilityConfig

unsafe fn encode( self, encoder: &mut Encoder<'_>, offset: usize, depth: Depth ) -> Result<()>

Encodes the object into the encoder’s buffers. Any handles stored in the object are swapped for Handle::INVALID.

impl Encode<UnreachabilityConfig> for UnreachabilityConfig

unsafe fn encode( self, encoder: &mut Encoder<'_>, offset: usize, depth: Depth ) -> Result<()>

Encodes the object into the encoder’s buffers. Any handles stored in the object are swapped for Handle::INVALID.

impl PartialEq<UnreachabilityConfig> for UnreachabilityConfig

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl TypeMarker for UnreachabilityConfig

type Owned = UnreachabilityConfig

The owned Rust type which this FIDL type decodes into.

fn inline_align(_context: Context) -> usize

Returns the minimum required alignment of the inline portion of the encoded object. It must be a (nonzero) power of two.

fn inline_size(_context: Context) -> usize

Returns the size of the inline portion of the encoded object, including padding for alignment. Must be a multiple of inline_align.

fn encode_is_copy() -> bool

Returns true if the memory layout of Self::Owned matches the FIDL wire format and encoding requires no validation. When true, we can optimize encoding arrays and vectors of Self::Owned to a single memcpy.

fn decode_is_copy() -> bool

Returns true if the memory layout of Self::Owned matches the FIDL wire format and decoding requires no validation. When true, we can optimize decoding arrays and vectors of Self::Owned to a single memcpy.

impl ValueTypeMarker for UnreachabilityConfig

type Borrowed<'a> = &'a <UnreachabilityConfig as TypeMarker>::Owned

The Rust type to use for encoding. This is a particular Encode<Self> type cheaply obtainable from &Self::Owned. There are three cases:

fn borrow<'a>(value: &'a <Self as TypeMarker>::Owned) -> Self::Borrowed<'a>

Cheaply converts from &Self::Owned to Self::Borrowed.

impl StructuralPartialEq for UnreachabilityConfig

impl TopLevel for UnreachabilityConfig