Struct NeighborMap 

pub struct NeighborMap { /* private fields */ }

Thread-safe map of discovered gossip peers with automatic staleness expiry.

Tracks which peers are actively participating in a gossip topic. A background cleanup task removes peers whose last_seen exceeds the expiration timeout. This handles the case where a peer crashes silently without sending NeighborDown.

Implementations

impl NeighborMap

pub fn new(expiration_timeout: Duration) -> Self

Create a new neighbor map and spawn a background cleanup task.

The cleanup task runs every expiration_timeout / 3 and removes peers not seen within the timeout.

pub fn new_without_cleanup(expiration_timeout: Duration) -> Self

Create a neighbor map without automatic cleanup (for testing).

pub fn touch(&self, node_id: PublicKey, name: Option<&str>)

Record a peer as seen, resetting its staleness timer.

pub fn mark_disconnected(&self, node_id: &PublicKey)

Mark a peer as disconnected (without removing it).

pub fn remove(&self, node_id: &PublicKey) -> Option<PeerInfo>

Remove a peer (e.g. on explicit NeighborDown).

pub fn list(&self) -> Vec<PeerInfo>

List all non-expired peers.

pub fn list_connected(&self) -> Vec<PeerInfo>

List all non-expired, currently connected peers.

pub const fn inner(&self) -> &Arc<DashMap<PublicKey, PeerInfo>>

Return a reference to the underlying peer map.

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

pub fn cleanup(&self) -> usize

Manually trigger cleanup of all expired peers.

Returns the number of removed entries.

Trait Implementations

impl Clone for NeighborMap

fn clone(&self) -> NeighborMap

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for NeighborMap

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

Formats the value using the given formatter.