filament-transport · routing_table

#[derive(Debug, Clone)]
pub struct PathEntry {
/// Destination hash this path leads to.

pub destination: DestinationHash,
/// Next hop destination (intermediate node).

pub next_hop: DestinationHash,
/// Number of hops to destination.

pub hops: u8,
/// Interface this path uses.

pub interface: InterfaceId,
/// When this path was learned.

pub timestamp: Instant,
/// When this path expires.

pub expires_at: Instant,
/// Interface mode when path was learned.

pub interface_mode: InterfaceMode,
/// Round-trip time estimate (if available).

pub rtt: Option<Duration>,
/// Number of successful packets sent via this path.

pub packets_sent: u64,
/// Number of failed packets on this path.

pub packets_failed: u64
}

#[must_use]
pub fn new(
        destination: DestinationHash,
        next_hop: DestinationHash,
        hops: u8,
        interface: InterfaceId,
        interface_mode: InterfaceMode,
    ) -> Self;

#[must_use]
pub fn is_expired(&self) -> bool;

#[must_use]
pub fn remaining_lifetime(&self) -> Option<Duration>;

pub fn update_rtt(&mut self, rtt: Duration);

pub fn record_success(&mut self);

pub fn record_failure(&mut self);

#[must_use]
pub fn success_rate(&self) -> f64;

#[derive(Debug, Default)]
pub struct RoutingStats {
/// Total number of lookups.

pub lookups: AtomicU64,
/// Number of successful lookups (path found).

pub hits: AtomicU64,
/// Number of failed lookups (path not found).

pub misses: AtomicU64,
/// Number of paths added.

pub paths_added: AtomicU64,
/// Number of paths removed.

pub paths_removed: AtomicU64,
/// Number of paths expired.

pub paths_expired: AtomicU64
}

#[must_use]
pub const fn new() -> Self;

#[must_use]
pub fn hit_rate(&self) -> f64;

pub struct RoutingTable {

}

#[must_use]
pub fn new() -> Self;

#[must_use]
pub fn with_capacity(max_entries: usize) -> Self;

pub fn lookup(&self, destination: &DestinationHash) -> Option<PathEntry>;

pub fn insert(&self, entry: PathEntry) -> Result<()>;

pub fn remove(&self, destination: &DestinationHash) -> Option<PathEntry>;

pub fn update_rtt(&self, destination: &DestinationHash, rtt: Duration);

pub fn record_success(&self, destination: &DestinationHash);

pub fn record_failure(&self, destination: &DestinationHash);

#[must_use]
pub fn len(&self) -> usize;

#[must_use]
pub fn is_empty(&self) -> bool;

#[must_use]
pub fn capacity(&self) -> usize;

#[must_use]
pub fn stats(&self) -> &RoutingStats;

pub fn cleanup_expired(&self) -> usize;

#[must_use]
pub fn paths_for_interface(&self, interface: &InterfaceId) -> Vec<PathEntry>;

pub fn clear(&self);

#[must_use]
pub fn memory_usage(&self) -> usize;