Skip to main content

DhtRoutingOptimizer

Struct DhtRoutingOptimizer 

Source
pub struct DhtRoutingOptimizer {
    pub stale_threshold_secs: u64,
    pub target_bucket_fill: usize,
    pub k_bucket_capacity: usize,
}
Expand description

Analyzes Kademlia routing table snapshots and emits remediation suggestions.

§Example

use ipfrs_network::dht_optimizer::{DhtRoutingOptimizer, RoutingEntry};

let optimizer = DhtRoutingOptimizer::new(600, 8);
let entries = vec![
    RoutingEntry::new("peer-1", 5, 1_700_000_000, 12.0, true),
    RoutingEntry::new("peer-2", 5, 1_700_000_010, 18.5, true),
];
let report = optimizer.optimize(&entries, 1_700_000_600);
assert!(!report.has_issues());

Fields§

§stale_threshold_secs: u64

Seconds of inactivity before a peer is considered stale.

§target_bucket_fill: usize

Target number of responsive peers per bucket.

§k_bucket_capacity: usize

Maximum number of entries allowed per bucket (Kademlia k).

Implementations§

Source§

impl DhtRoutingOptimizer

Source

pub fn new(stale_threshold_secs: u64, target_bucket_fill: usize) -> Self

Creates a new optimizer with the given thresholds.

§Arguments
Source

pub fn analyze_bucket( &self, entries: &[RoutingEntry], now_secs: u64, ) -> BucketAnalysis

Analyzes a slice of entries that all belong to the same bucket.

The bucket_index field of the returned BucketAnalysis is taken from the first entry; callers should ensure all entries share the same bucket index (as guaranteed by optimize).

§Health classification order
  1. Saturatedentry_count > k_bucket_capacity
  2. Stale — any non-responsive entries present
  3. Sparseresponsive_count < target_bucket_fill
  4. Healthy — otherwise
Source

pub fn optimize( &self, all_entries: &[RoutingEntry], now_secs: u64, ) -> OptimizationReport

Analyzes all routing entries and returns a full OptimizationReport.

§Algorithm
  1. Group entries by bucket_index.
  2. Run analyze_bucket on each group.
  3. For each bucket produce recommendations:
    • Stale entries: emit PingPeer (or EvictPeer if age > 2× stale_threshold_secs), capped at MAX_PINGS_PER_BUCKET per bucket.
    • Sparse bucket: emit RefreshBucket.
  4. Collate bucket-health counts and return the report.
Source

pub fn top_latency_peers<'a>( &self, entries: &'a [RoutingEntry], n: usize, ) -> Vec<&'a RoutingEntry>

Returns the n responsive peers with the highest latency, sorted descending. These are candidates for replacement by lower-latency peers discovered during bucket refresh.

Source

pub fn coverage_score(&self, entries: &[RoutingEntry]) -> f64

Returns the fraction of the 256 possible Kademlia bucket indices that have at least one responsive entry.

Returns 0.0 for an empty entry list.

Trait Implementations§

Source§

impl Clone for DhtRoutingOptimizer

Source§

fn clone(&self) -> DhtRoutingOptimizer

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 DhtRoutingOptimizer

Source§

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

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

impl Default for DhtRoutingOptimizer

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

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