Skip to main content

CoordCache

Struct CoordCache 

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

Coordinate cache for routing decisions.

Maps node addresses to their tree coordinates, enabling data packets to be routed without carrying coordinates in every packet. Populated by SessionSetup packets.

Implementations§

Source§

impl CoordCache

Source

pub fn new(max_entries: usize, default_ttl_ms: u64) -> Self

Create a new coordinate cache.

Source

pub fn with_defaults() -> Self

Create a cache with default parameters.

Source

pub fn max_entries(&self) -> usize

Get the maximum capacity.

Source

pub fn default_ttl_ms(&self) -> u64

Get the default TTL.

Source

pub fn set_default_ttl_ms(&mut self, ttl_ms: u64)

Set the default TTL.

Source

pub fn insert( &mut self, addr: NodeAddr, coords: TreeCoordinate, current_time_ms: u64, )

Insert or update a cache entry.

Source

pub fn insert_with_path_mtu( &mut self, addr: NodeAddr, coords: TreeCoordinate, current_time_ms: u64, path_mtu: u16, )

Insert or update a cache entry with path MTU information.

Used by discovery response handling to store the discovered path MTU alongside the target’s coordinates.

Source

pub fn insert_with_ttl( &mut self, addr: NodeAddr, coords: TreeCoordinate, current_time_ms: u64, ttl_ms: u64, )

Insert with a custom TTL.

Source

pub fn get( &self, addr: &NodeAddr, current_time_ms: u64, ) -> Option<&TreeCoordinate>

Look up coordinates for an address (without touching).

Source

pub fn get_and_touch( &mut self, addr: &NodeAddr, current_time_ms: u64, ) -> Option<&TreeCoordinate>

Look up coordinates and refresh (update last_used and extend TTL).

Source

pub fn get_entry(&self, addr: &NodeAddr) -> Option<&CacheEntry>

Get the full cache entry.

Source

pub fn remove(&mut self, addr: &NodeAddr) -> Option<CacheEntry>

Remove an entry.

Source

pub fn contains(&self, addr: &NodeAddr, current_time_ms: u64) -> bool

Check if an address is cached (and not expired).

Source

pub fn len(&self) -> usize

Number of entries (including expired).

Source

pub fn is_empty(&self) -> bool

Check if empty.

Source

pub fn iter( &self, current_time_ms: u64, ) -> impl Iterator<Item = (&NodeAddr, &CacheEntry)>

Iterate over non-expired entries.

Source

pub fn purge_expired(&mut self, current_time_ms: u64) -> usize

Remove all expired entries.

Source

pub fn clear(&mut self)

Clear all entries.

Source

pub fn stats(&self, current_time_ms: u64) -> CacheStats

Get cache statistics.

Trait Implementations§

Source§

impl Clone for CoordCache

Source§

fn clone(&self) -> CoordCache

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for CoordCache

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for CoordCache

Source§

fn default() -> Self

Returns the “default value” for a 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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

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

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

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.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.
Source§

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

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

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
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

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