Struct VrrpAdvertisement 

pub struct VrrpAdvertisement {
    pub version: u8,
    pub vrid: u8,
    pub priority: u8,
    pub advert_interval_seconds: f64,
    pub auth_type: u8,
    pub addresses: Vec<Ipv4Addr>,
    pub checksum: u16,
}

One VRRP advertisement, version 2 or version 3.

The interval is held in seconds because that is what a person and a model reason in; Self::interval_field does the version-dependent scaling in exactly one place, and the codec test pins its output at the wire offsets for both versions.

Fields

version: u8

2 or 3.

vrid: u8

Virtual Router Identifier, 1..=255. 0 is not a valid VRID.

priority: u8

0 resigns, 255 claims address ownership, higher wins the election.

advert_interval_seconds: f64

Advertisement interval in seconds. VRRPv2 carries whole seconds in one octet; VRRPv3 carries centiseconds in a 12-bit field.

auth_type: u8

VRRPv2 only. RFC 3768 defines no method, so this is 0 in anything conformant; it is surfaced rather than discarded because a non-zero value on the wire says the sender is running RFC 2338-era authentication.

addresses: Vec<Ipv4Addr>

The virtual IPv4 addresses this router is advertising. May be empty on the wire, but a real advertisement always carries at least one.

checksum: u16

The checksum as it appeared on the wire. Ignored by Self::encode, which always recomputes.

Implementations

impl VrrpAdvertisement

pub fn is_resignation(&self) -> bool

True when this advertisement is the master resigning (RFC 3768 §6.4.3).

pub fn is_address_owner(&self) -> bool

True when the sender claims to own the virtual addresses (RFC 3768 §5.3.4).

pub fn checksum_scope(&self) -> ChecksumScope

Which bytes this version’s checksum covers.

pub fn interval_field(&self) -> Result<u16>

The raw interval field for this version.

This is the seconds-versus-centiseconds trap. VRRPv2 puts whole seconds in one octet (RFC 3768 §5.3.7); VRRPv3 puts centiseconds in twelve bits (RFC 5798 §5.2.7). One second is 1 under v2 and 100 under v3.

pub fn validate(&self) -> Result<()>

Validate every field without needing a pseudo-header.

Separate from Self::encode so execute_action can reject a bad action where the error reaches the model, rather than in the transport where it reaches only a log.

pub fn encode(&self, pseudo: Option<&PseudoHeader>) -> Result<Vec<u8>>

Serialise, computing the checksum.

pseudo must be Some for version 3 and is ignored for version 2. A v3 encode with None is an error rather than a message-only checksum, because a silently-wrong checksum is discarded by every real peer and looks exactly like the server being down.

pub fn decode(data: &[u8]) -> Result<Self>

Parse an advertisement. The caller has already decided this is VRRP and not CARP.

Trait Implementations

impl Clone for VrrpAdvertisement

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 VrrpAdvertisement

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

Formats the value using the given formatter.

impl PartialEq for VrrpAdvertisement

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for VrrpAdvertisement