Skip to main content

PeerCapabilityRegistry

Struct PeerCapabilityRegistry 

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

Tick-based registry tracking which protocol-level Capability set each peer advertises.

This is the primary data structure for capability-based peer selection. Advertisements carry a TTL expressed in ticks; callers must supply the current tick to all query operations so that expired entries are correctly filtered out without requiring a background eviction task.

§Example

use ipfrs_network::capability_registry::{
    Capability, PeerCapabilityRegistry,
};

let mut registry = PeerCapabilityRegistry::new();
registry.advertise(
    "peer-a".to_string(),
    vec![Capability::Kademlia, Capability::Bitswap { version: 1 }],
    /*current_tick=*/ 0,
    /*ttl_ticks=*/ 100,
);

let peers = registry.peers_with_capability(&Capability::Kademlia, 0);
assert_eq!(peers, vec!["peer-a"]);

Implementations§

Source§

impl PeerCapabilityRegistry

Source

pub fn new() -> Self

Create an empty registry.

Source

pub fn advertise( &mut self, peer_id: String, capabilities: Vec<Capability>, current_tick: u64, ttl_ticks: u64, )

Insert or replace the advertisement for peer_id.

The advertisement expires at tick current_tick + ttl_ticks.

Source

pub fn peers_with_capability( &self, cap: &Capability, current_tick: u64, ) -> Vec<&str>

Return a sorted list of peer IDs whose valid advertisements include cap.

Only advertisements that pass CapabilityAdvertisement::is_valid at current_tick are considered. The result is sorted alphabetically.

Source

pub fn peer_capabilities( &self, peer_id: &str, current_tick: u64, ) -> Option<&[Capability]>

Return the capability slice for peer_id if its advertisement is valid at current_tick, or None otherwise.

Returns None when:

  • the peer is not in the registry, or
  • the peer’s advertisement has expired.
Source

pub fn remove_peer(&mut self, peer_id: &str) -> bool

Remove the advertisement for peer_id.

Returns true if the peer was found and removed, false if the peer was not registered.

Source

pub fn evict_expired(&mut self, current_tick: u64) -> usize

Remove all expired advertisements from the registry.

Returns the number of advertisements that were removed.

Source

pub fn stats(&self, current_tick: u64) -> CapabilityRegistryStats

Return a CapabilityRegistryStats snapshot evaluated at current_tick.

Trait Implementations§

Source§

impl Debug for PeerCapabilityRegistry

Source§

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

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

impl Default for PeerCapabilityRegistry

Source§

fn default() -> PeerCapabilityRegistry

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