Skip to main content

CapabilityRegistry

Struct CapabilityRegistry 

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

Central registry for peer capability advertisements.

The registry enforces:

  • Requirement filtering — peers must satisfy require_all and require_any from the CapabilityConfig to be accepted.
  • Capacity limiting — at most max_peers entries are held.
  • TTL expiry — stale entries can be purged via CapabilityRegistry::purge_expired.

All methods take &mut self; the registry is not internally synchronised. Wrap in an Arc<Mutex<_>> for concurrent access.

Implementations§

Source§

impl CapabilityRegistry

Source

pub fn new(config: CapabilityConfig) -> Self

Create a new registry with the given configuration.

Source

pub fn register(&mut self, peer: PeerCapabilitySet) -> bool

Register peer in the registry.

Returns true on success, false when:

  • The peer does not meet the configured requirements (meets_requirements), or
  • The registry is at capacity (max_peers).

If the same peer_id is already present the old entry is replaced (the stats counters still increment as if it were a new registration).

Source

pub fn meets_requirements(&self, peer: &PeerCapabilitySet) -> bool

Returns true if peer satisfies the configured require_all and require_any constraints.

  • require_all: the peer must possess every listed capability.
  • require_any: the peer must possess at least one listed capability (no constraint when the list is empty).
Source

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

Remove the peer identified by peer_id from the registry.

Returns true if the peer was present and removed, false otherwise.

Source

pub fn get_peer(&self, peer_id: &str) -> Option<&PeerCapabilitySet>

Retrieve the PeerCapabilitySet for peer_id, if present.

Source

pub fn peers_with_capability( &self, cap: &PeerCapability, ) -> Vec<&PeerCapabilitySet>

Return all peers that advertise cap.

Source

pub fn peers_with_all(&self, caps: &[PeerCapability]) -> Vec<&PeerCapabilitySet>

Return all peers that advertise every capability in caps.

Source

pub fn peers_with_any(&self, caps: &[PeerCapability]) -> Vec<&PeerCapabilitySet>

Return all peers that advertise at least one capability in caps.

Source

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

Remove all peers whose advertised_at is older than now - ttl_ms.

Returns the number of entries purged.

Source

pub fn capability_name(cap: &PeerCapability) -> &'static str

Returns a &'static str label for well-known capability variants.

For PeerCapability::Custom the returned string is always "custom". Use PeerCapability::key when you need the full dynamic key including the custom payload.

Source

pub fn peer_count(&self) -> usize

Returns the number of peers currently in the registry.

Source

pub fn stats(&self) -> &CapabilityStats

Returns a reference to the runtime statistics snapshot.

The snapshot reflects the live state of the registry; the histogram entries are decremented on removal, so they track currently registered peers rather than lifetime totals.

Source

pub fn local_capabilities(&self) -> &[PeerCapability]

Returns the local capabilities configured for this node.

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