RoutingManager

Struct RoutingManager 

Source
pub struct RoutingManager { /* private fields */ }
Expand description

Manages a set of concurrently-running routing protocols.

§How it works

Each protocol is assigned a unique origin value. When enabled, the manager starts the protocol as an independent Tokio task with a child cancellation token. When disabled, the child token is cancelled (stopping the task at its next cancel.cancelled().await) and all routes the protocol registered are flushed from the RIB; the FIB is recomputed for affected prefixes from any remaining protocols’ routes.

§Multiple protocols

Running two protocols simultaneously is the normal case: for example, DVR (origin 128) discovering routes for /ndn/edu/… and autoconf (origin 66) advertising link-local routes. Both write to the RIB under their origin; the RIB selects the lowest-cost nexthop per face when building FIB entries.

Implementations§

Source§

impl RoutingManager

Source

pub fn new( rib: Arc<Rib>, fib: Arc<Fib>, faces: Arc<FaceTable>, neighbors: Arc<NeighborTable>, engine_cancel: CancellationToken, ) -> Self

Source

pub fn enable(&self, proto: Arc<dyn RoutingProtocol>)

Start a routing protocol.

Creates a child cancellation token from the engine token so the protocol is automatically stopped when the engine shuts down. If a protocol with the same origin is already running, it is stopped and its routes flushed before the new one starts.

Source

pub fn disable(&self, origin: u64) -> bool

Stop a routing protocol and flush all routes it registered.

Cancels the protocol’s task (the task exits at its next cancellation checkpoint) and removes all routes registered under origin from the RIB. FIB entries for affected prefixes are recomputed from any remaining protocols’ routes.

Returns true if a protocol with that origin was running.

Source

pub fn running_origins(&self) -> Vec<u64>

Returns the origin values of all currently-running protocols.

Source

pub fn running_count(&self) -> usize

Returns the number of currently-running protocols.

Trait Implementations§

Source§

impl Drop for RoutingManager

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more