Skip to main content

PeerDiscoveryProtocol

Struct PeerDiscoveryProtocol 

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

Multi-strategy peer discovery protocol.

Maintains a bounded peer table with TTL expiry, verification tracking, capability filtering, and per-method statistics. All state transitions emit PdpDiscoveryEvent values buffered internally and drained by the caller.

Implementations§

Source§

impl PeerDiscoveryProtocol

Source

pub fn new(config: PdpDiscoveryConfig) -> Result<Self, PdpDiscoveryError>

Create a new protocol instance with the given configuration.

§Errors

Returns PdpDiscoveryError::ConfigurationError if max_peers is 0 or peer_ttl_us is 0.

Source

pub fn with_defaults() -> Self

Create a new protocol instance with the default configuration.

Source

pub fn add_peer( &mut self, peer: PdpDiscoveredPeer, ) -> Result<PdpDiscoveryEvent, PdpDiscoveryError>

Add a peer to the table.

Source

pub fn remove_peer(&mut self, id: &str) -> Result<(), PdpDiscoveryError>

Remove a peer by id.

§Errors

Returns PdpDiscoveryError::PeerNotFound if the peer does not exist.

Source

pub fn verify_peer( &mut self, id: &str, current_ts: u64, ) -> Result<PdpDiscoveryEvent, PdpDiscoveryError>

Mark a peer as verified and record the current timestamp.

Emits PdpDiscoveryEvent::PeerVerified on success.

§Errors

Returns PdpDiscoveryError::PeerNotFound if the peer does not exist.

Source

pub fn expire_peers(&mut self, current_ts: u64) -> Vec<PdpDiscoveryEvent>

Remove all peers whose TTL has elapsed relative to current_ts.

Returns one PdpDiscoveryEvent::PeerExpired per removed peer.

Source

pub fn refresh_peer( &mut self, id: &str, current_ts: u64, ) -> Result<(), PdpDiscoveryError>

Reset the TTL of a known peer to current_ts + config.peer_ttl_us.

§Errors

Returns PdpDiscoveryError::PeerNotFound if the peer does not exist.

Source

pub fn get_peer( &self, id: &str, ) -> Result<&PdpDiscoveredPeer, PdpDiscoveryError>

Retrieve an immutable reference to a peer by id.

§Errors

Returns PdpDiscoveryError::PeerNotFound if the peer does not exist.

Source

pub fn peers_by_method(&self, method: &str) -> Vec<&PdpDiscoveredPeer>

Return all peers discovered by the given method variant name.

The method string must match one of the values returned by PdpDiscoveryMethod::variant_name (e.g., "bootstrap", "mdns").

Source

pub fn peers_with_capability(&self, capability: &str) -> Vec<&PdpDiscoveredPeer>

Return all peers that have the given capability string.

Source

pub fn random_peers(&self, n: usize, seed: u64) -> Vec<&PdpDiscoveredPeer>

Return up to n randomly selected peers using an xorshift64-based Fisher-Yates shuffle seeded with seed.

If the table has fewer than n peers, all peers are returned in shuffled order.

Source

pub fn merge_peer_table( &mut self, other: Vec<PdpDiscoveredPeer>, current_ts: u64, ) -> Vec<PdpDiscoveryEvent>

Bulk-import peers from a PeerExchange handshake.

For each peer in other:

  • Skip if already expired (discovered_at + ttl_us < current_ts).
  • If the peer is already known, merge addresses + capabilities and refresh TTL.
  • If the peer is new, insert it (subject to capacity).

Returns the list of events generated.

Source

pub fn stats(&self) -> PdpDiscoveryStats

Return a snapshot of current statistics.

Source

pub fn drain_events(&mut self) -> Vec<PdpDiscoveryEvent>

Drain and return all buffered events.

After this call the internal event buffer is empty.

Source

pub fn peer_count(&self) -> usize

Return the current number of peers in the table.

Source

pub fn all_peers(&self) -> impl Iterator<Item = &PdpDiscoveredPeer>

Return an iterator over all peers currently in the table.

Source

pub fn record_method_failure( &mut self, method: impl Into<String>, reason: impl Into<String>, )

Record a discovery method failure, emitting PdpDiscoveryEvent::DiscoveryMethodFailed.

Trait Implementations§

Source§

impl Debug for PeerDiscoveryProtocol

Source§

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

Formats the value using the given formatter. 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