Struct GatewayEvent 

pub struct GatewayEvent {
    pub timestamp: SystemTime,
    pub meshif: u32,
    pub meshif_name: String,
    pub action: GatewayEventAction,
    pub gateway_mac: Option<MacAddr>,
}

Gateway change event emitted by batman-adv kernel module.

When a batman-adv node is in gateway client mode, it emits uevents when the selected gateway changes. Applications can subscribe to these events to perform actions like starting/renewing DHCP leases.

Examples

let client = batman_robin::Client::new();
let mut events = client
    .subscribe_gateway_events(batman_robin::MeshSelector::with_name("bat0"))
    .await?;

while let Some(event) = events.next().await {
    match event?.action {
        GatewayEventAction::Add => println!("Gateway selected: {:?}", event?.gateway_mac),
        GatewayEventAction::Change => println!("Better gateway found"),
        GatewayEventAction::Delete => println!("Gateway lost"),
    }
}

Fields

timestamp: SystemTime

Timestamp when the event was received

meshif: u32

Mesh interface index (e.g. from if_nametoindex("bat0"))

meshif_name: String

Mesh interface name (e.g. “bat0”)

action: GatewayEventAction

Type of gateway change event

gateway_mac: Option<MacAddr>

MAC address of the selected gateway (present for ADD/CHANGE, absent for DELETE)

Implementations

impl GatewayEvent

pub fn new( meshif: u32, meshif_name: String, action: GatewayEventAction, gateway_mac: Option<MacAddr>, ) -> Self

Create a new gateway event

pub fn has_gateway(&self) -> bool

Check if this event has a valid associated gateway MAC

Trait Implementations

impl Clone for GatewayEvent

fn clone(&self) -> GatewayEvent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GatewayEvent

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

Formats the value using the given formatter.

impl Eq for GatewayEvent

impl PartialEq for GatewayEvent

fn eq(&self, other: &GatewayEvent) -> 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 StructuralPartialEq for GatewayEvent