Struct DynamicRouter 

pub struct DynamicRouter { /* private fields */ }

A routing table whose size is chosen when it is built, rather than at compile time.

Router fixes its capacity in the type, which suits a microcontroller that knows its own limits. A gateway, or any caller reaching this through a language binding, does not know the size until it runs, and a const generic cannot cross a foreign function boundary at all. This is the same table with its slots on the heap, so both share one implementation and answer identically.

Requires the alloc feature.

Examples

use pamoja_routing::{DynamicRouter, Forward};

// A gateway sizes its table for the mesh it is actually serving.
let mut router = DynamicRouter::new(0x01, 512);
router.observe(0x09, 0x05, 2);
assert_eq!(router.forward(0x09), Forward::Relay(0x05));
assert_eq!(router.capacity(), 512);

Implementations

impl DynamicRouter

pub fn new(me: u32, capacity: usize) -> Self

Creates an empty router holding up to capacity routes.

Arguments

• me - this node’s address.
• capacity - how many routes to make room for. A capacity of zero is allowed and makes every unknown destination flood, which is the behaviour with no table.

Returns

A router holding no routes.

pub fn address(&self) -> u32

Returns this node’s address.

Returns

The address the router was created with.

pub fn capacity(&self) -> usize

Returns how many routes this table can hold.

Returns

The capacity it was created with.

pub fn observe(&mut self, origin: u32, via: u32, cost: u16) -> bool

Learns the way to a node from a packet heard from it.

Arguments

• origin - the node the packet came from, the destination this route reaches.
• via - the neighbour the packet arrived through, the next hop for this route.
• cost - the cost the packet reports for reaching origin through via.

Returns

true if the table changed, false if the observation taught it nothing new.

pub fn next_hop(&self, dst: u32) -> Option<u32>

Returns the next hop to reach a destination, if a route is known.

Arguments

• dst - the destination to reach.

Returns

The next-hop address, or None if no route is known.

pub fn cost(&self, dst: u32) -> Option<u16>

Returns the cost of the known route to a destination, if any.

Arguments

• dst - the destination to reach.

Returns

The route cost, or None if no route is known.

pub fn route(&self, dst: u32) -> Option<Route>

Returns the known route to a destination, if any.

Arguments

• dst - the destination to reach.

Returns

The Route, or None if no route is known.

pub fn forward(&self, dst: u32) -> Forward

Decides what to do with a packet bound for a destination.

Arguments

• dst - the packet’s destination.

Returns

Forward::Deliver if the packet is for this node, Forward::Relay with the next hop if a route is known, or Forward::Flood otherwise.

pub fn forget(&mut self, dst: u32)

Forgets the route to a destination, if one is held.

Arguments

• dst - the destination whose route to drop.

pub fn len(&self) -> usize

Returns how many routes the table currently holds.

Returns

The number of routes.

pub fn is_empty(&self) -> bool

Reports whether the table holds no routes.

Returns

true if no routes are held.

Trait Implementations

impl Clone for DynamicRouter

fn clone(&self) -> DynamicRouter

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DynamicRouter

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

Formats the value using the given formatter.