batman-robin 1.0.1

Rust library and CLI tool for interacting with the BATMAN-adv kernel module for mesh networking
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71

use macaddr::MacAddr6;

/// Represents a gateway in the batman-adv mesh.
///
/// This struct contains information about a gateway node, including its MAC address,
/// the router it is associated with, interface used, bandwidth, throughput, and
/// quality metrics.
#[derive(Debug, Clone)]
pub struct Gateway {
    /// MAC address of the gateway (BATADV_ATTR_ORIG_ADDRESS).
    pub mac_addr: MacAddr6,

    /// MAC address of the associated router (BATADV_ATTR_ROUTER).
    pub router: MacAddr6,

    /// Outgoing interface used to reach this gateway.
    /// Usually from BATADV_ATTR_HARD_IFNAME; if not available, falls back to interface index.
    pub outgoing_if: String,

    /// Optional downstream bandwidth in kbps (BATADV_ATTR_BANDWIDTH_DOWN).
    pub bandwidth_down: Option<u32>,

    /// Optional upstream bandwidth in kbps (BATADV_ATTR_BANDWIDTH_UP).
    pub bandwidth_up: Option<u32>,

    /// Optional throughput in kbps (BATADV_ATTR_THROUGHPUT).
    pub throughput: Option<u32>,

    /// Optional transmission quality (TQ) of the gateway (BATADV_ATTR_TQ).
    pub tq: Option<u8>,

    /// Whether this gateway is considered the best among alternatives (BATADV_ATTR_FLAG_BEST).
    pub is_best: bool,
}

/// Contains configuration information about a mesh gateway.
///
/// This struct is used when querying or setting the gateway mode and associated parameters.
#[derive(Debug)]
pub struct GatewayInfo {
    /// Current gateway mode (BATADV_ATTR_GW_MODE).
    pub mode: GwMode,

    /// Selection class for the gateway (BATADV_ATTR_GW_SEL_CLASS).
    pub sel_class: u32,

    /// Downstream bandwidth in kbps (BATADV_ATTR_GW_BANDWIDTH_DOWN).
    pub bandwidth_down: u32,

    /// Upstream bandwidth in kbps (BATADV_ATTR_GW_BANDWIDTH_UP).
    pub bandwidth_up: u32,

    /// Routing algorithm in use (BATADV_ATTR_ALGO_NAME).
    pub algo: String,
}

/// Represents the mode of a batman-adv gateway.
#[derive(Debug, Copy, Clone)]
pub enum GwMode {
    /// Gateway mode is turned off.
    Off,

    /// Node is operating as a gateway client.
    Client,

    /// Node is operating as a gateway server.
    Server,

    /// Unknown or unsupported mode.
    Unknown,
}