Struct KnownPeersManager

pub struct KnownPeersManager { /* private fields */ }

Handles networking parameters. It manages network parameters set and its persistence.

Implementations

impl KnownPeersManager

pub fn new( config: KnownPeersManagerConfig, ) -> Result<Self, KnownPeersManagerPersistenceError>

Object constructor.

pub fn file_size(cache_size: u32) -> usize

Size of the backing file on disk

pub fn boxed(self) -> Box<dyn KnownPeersRegistry>

Creates a reference to the NetworkingParametersRegistry trait implementation.

Trait Implementations

impl Drop for KnownPeersManager

fn drop(&mut self)

Executes the destructor for this type.

impl KnownPeersRegistry for KnownPeersManager

fn add_known_peer<'life0, 'async_trait>( &'life0 mut self, peer_id: PeerId, addresses: Vec<Multiaddr>, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Registers a peer ID and associated addresses

fn remove_known_peer_addresses<'life0, 'async_trait>( &'life0 mut self, peer_id: PeerId, addresses: Vec<Multiaddr>, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Unregisters associated addresses for peer ID.

fn remove_all_known_peer_addresses(&mut self, peer_id: PeerId)

Unregisters associated addresses for peer ID.

fn all_known_peers<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = Vec<(PeerId, Vec<Multiaddr>)>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Returns all known peers and their addresses without P2P suffix at the end

fn count_known_peers(&mut self) -> (usize, usize)

Returns the number of known peers, and the number of addresses known for those peers.

fn run<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Drive async work in the persistence provider

fn on_unreachable_address( &mut self, handler: Arc<dyn Fn(&PeerAddressRemovedEvent) + Send + Sync + 'static>, ) -> Option<HandlerId>

Triggers when we removed the peer address from the permanent storage. Returns optional event HandlerId. Option enables stub implementation. One of the usages is to notify Kademlia about the expired(unreachable) address when it check for how long address was unreachable.