rotonda 0.4.0

composable, programmable BGP engine
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
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91

use std::{
    fmt::{Debug, Display},
    num::NonZeroUsize,
    sync::Arc,
};

use log::{debug, error, trace};

use crate::{comms::GateStatus, manager::TargetCommand, metrics};

macro_rules! sr_log {
    ($log_fn:ident: $self:ident, $msg:expr) => (
        #[cfg(test)]
        let _ = env_logger::builder().is_test(true).try_init();
        $log_fn!(concat!("{}: ", $msg), $self.name());
    );

    ($log_fn:ident: $self:ident, $fmt:expr, $($args:expr),*) => (
        #[cfg(test)]
        let _ = env_logger::builder().is_test(true).try_init();
        $log_fn!(concat!("{}: ", $fmt), $self.name(), $($args),*);
    );
}

pub(crate) use sr_log;

pub trait Named {
    fn name(&self) -> &str;
}

pub trait Chainable: Named {
    fn add_child<T: Display>(&self, child_name: T) -> Self;

    fn link_names<T: Display>(&self, child_name: T) -> String {
        format!("{}::{}", self.name(), child_name)
    }
}

pub trait AnyStatusReporter: Chainable {
    fn metrics(&self) -> Option<Arc<dyn metrics::Source>>;

    fn input_mismatch<T: Display, U: Debug>(&self, expected: T, received: U) {
        sr_log!(
            error: self,
            "Configuration error: Received {:#?} but expected {}",
            received,
            expected
        );
    }

    fn upstream_sources_changed(
        &self,
        num_old_sources: NonZeroUsize,
        num_new_sources: NonZeroUsize,
    ) {
        sr_log!(
            debug: self,
            "Replacing {} old sources with {} new sources",
            num_old_sources,
            num_new_sources
        );
    }
}

pub trait UnitStatusReporter: AnyStatusReporter {
    fn gate_status_announced(&self, status: &GateStatus) {
        sr_log!(trace: self, "Gate status announced: {}", status);
    }

    fn terminated(&self) {
        sr_log!(trace: self, "Unit terminated");
    }

    fn reconfigured(&self) {
        sr_log!(trace: self, "Unit reconfiguration notice received");
    }
}

pub trait TargetStatusReporter: AnyStatusReporter {
    fn command_received(&self, cmd: &TargetCommand) {
        sr_log!(trace: self, "Target received command: {}", cmd);
    }

    fn terminated(&self) {
        sr_log!(trace: self, "Target terminated");
    }

    fn reconfigured(&self) {
        sr_log!(trace: self, "Target reconfiguration notice received");
    }
}