Struct OverlayNetworkManager 

pub struct OverlayNetworkManager { /* private fields */ }

Manages a logical overlay network of nodes with topology-aware routing.

The manager is intentionally synchronous and allocation-light: it keeps a flat HashMap of nodes and computes routes on demand without spawning tasks or doing I/O.

Example

use ipfrs_network::{OverlayNetworkManager, OverlayTopology, OverlayNode};

let mut mgr = OverlayNetworkManager::new(1, OverlayTopology::FullMesh, 128);
let node = OverlayNode::new(2, "127.0.0.1:4001", 0);
mgr.join(node).expect("join should succeed in example");
let route = mgr.route(1, 2, 0).expect("route should succeed in example");
assert_eq!(route.hop_count, 1);

Implementations

impl OverlayNetworkManager

pub fn new(local_id: u64, topology: OverlayTopology, max_nodes: usize) -> Self

Create a new overlay network manager.

The local node (identified by local_id) is implicitly part of the overlay but is not inserted into nodes; callers should join it if they want it visible to routing queries.

pub fn join(&mut self, node: OverlayNode) -> Result<(), OverlayError>

Add a node to the overlay.

Returns OverlayError::NetworkFull if max_nodes has been reached. If the node is already present its record is silently updated.

pub fn leave(&mut self, node_id: u64) -> Result<(), OverlayError>

Remove a node from the overlay.

Returns OverlayError::NodeNotFound if the node is not present.

pub fn heartbeat(&mut self, node_id: u64, now: u64) -> Result<(), OverlayError>

Record a heartbeat for a node, updating its last_heartbeat timestamp.

pub fn evict_stale(&mut self, max_age_ms: u64, now: u64) -> usize

Remove nodes whose last_heartbeat is older than max_age_ms milliseconds.

Returns the number of nodes evicted.

pub fn node_count(&self) -> usize

Return the total number of nodes in the overlay.

pub fn route( &self, from: u64, to: u64, now: u64, ) -> Result<OverlayRoute, OverlayError>

Compute a route from from to to using the active topology.

Returns OverlayError::SelfRoute when from == to, and OverlayError::NodeNotFound when either endpoint is absent.

pub fn neighbors(&self, node_id: u64) -> Vec<u64>

Return the set of logical neighbors for node_id under the active topology.

Returns an empty Vec if the node is not present.

pub fn diameter_estimate(&self) -> f64

Estimate the maximum path length (diameter) across the overlay.

Topology	Formula
FullMesh	1.0
Chord / Kademlia / Pastry	log₂(max(n, 2))
Tree	log_{bf}(max(n, 2))

pub fn stats(&self, now: u64) -> OverlayStats

Return a snapshot of statistics at the given wall-clock timestamp now.

pub fn get_node(&self, node_id: u64) -> Option<&OverlayNode>

Return a reference to the node record for node_id, if present.

pub fn local_id(&self) -> u64

Return the local node ID.

pub fn topology(&self) -> &OverlayTopology

Return a reference to the active topology.

Trait Implementations

impl Debug for OverlayNetworkManager

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

Formats the value using the given formatter.