Skip to main content

RoutingTableManager

Struct RoutingTableManager 

Source
pub struct RoutingTableManager {
    pub buckets: Vec<KBucket>,
    pub local_id: NodeId,
    pub k: usize,
    pub alpha: usize,
}
Expand description

Kademlia-style XOR-metric routing table manager.

Manages 256 k-buckets (one per bit of the 256-bit node-ID space). Bucket i holds nodes whose XOR distance to the local node starts with exactly i leading zero bits.

§Parameters

  • k — maximum number of active entries per bucket (default: 20).
  • alpha — concurrency factor for parallel lookups (default: 3; stored but not used internally — callers read it when launching lookups).

Fields§

§buckets: Vec<KBucket>

The 256 k-buckets.

§local_id: NodeId

This node’s own identifier.

§k: usize

Maximum entries per bucket.

§alpha: usize

Lookup concurrency parameter.

Implementations§

Source§

impl RoutingTableManager

Source

pub fn new(local_id: NodeId, k: usize, alpha: usize) -> Self

Create a new routing table manager.

§Arguments
  • local_id — this node’s 256-bit identifier.
  • k — k-bucket size (use DEFAULT_K for the standard Kademlia value).
  • alpha — concurrency factor (use DEFAULT_ALPHA for the standard value).
Source

pub fn with_defaults(local_id: NodeId) -> Self

Create a routing table manager with default parameters (k=20, alpha=3).

Source

pub fn add_node( &mut self, node_id: NodeId, address: String, rtt_ms: u64, now: u64, )

Insert or refresh a node in the routing table.

  • If the node already appears in its bucket → LRU update (move to tail).
  • If the bucket is not full → append.
  • If the bucket is full → put into the replacement cache.

Silently ignores attempts to add the local node itself.

Source

pub fn remove_node(&mut self, node_id: &NodeId) -> bool

Remove a node from the routing table.

If the node was in a bucket’s active list a replacement from the cache is promoted automatically.

Returns true if the node was found in an active bucket.

Source

pub fn mark_failed(&mut self, node_id: &NodeId, now: u64)

Record a failed query for a node.

After MAX_FAILED_QUERIES (3) consecutive failures the node is evicted and a replacement is promoted from the cache.

Source

pub fn update_rtt(&mut self, node_id: &NodeId, rtt_ms: u64, now: u64)

Update the RTT observation and last-seen timestamp for a node.

Source

pub fn find_closest(&self, target: &NodeId, count: usize) -> Vec<BucketEntry>

Return up to count entries closest to target measured by XOR distance.

The result is sorted ascending by XOR distance (closest first).

Source

pub fn bucket_sizes(&self) -> Vec<usize>

Return the number of active entries in each of the 256 buckets.

Source

pub fn total_nodes(&self) -> usize

Return the total number of active entries across all buckets.

Source

pub fn stats(&self) -> RoutingTableStats

Compute aggregate statistics for the routing table.

Source

pub fn bucket_index_for(&self, target: &NodeId) -> usize

Return the k-bucket index for a given target node ID.

Source

pub fn iter_entries(&self) -> impl Iterator<Item = &BucketEntry>

Iterate over all active BucketEntry records.

Source

pub fn is_empty(&self) -> bool

Return true if the routing table contains no active entries.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,

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<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

Source§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

Source§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

Source§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

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

Initializes a with the given initializer. Read more
Source§

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

Dereferences the given pointer. Read more
Source§

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

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

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

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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.
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