Struct Network 

pub struct Network<T>
where
    T: HoprDbPeersOperations + Sync + Send + Debug,
{ /* private fields */ }

The network object storing information about the running observed state of the network, including peers, connection qualities and updates for other parts of the system.

Implementations

impl<T> Network<T>

where T: HoprDbPeersOperations + Sync + Send + Debug,

pub fn new( my_peer_id: PeerId, my_multiaddresses: Vec<Multiaddr>, cfg: NetworkConfig, db: T, ) -> Self

pub async fn has(&self, peer: &PeerId) -> bool

Check whether the PeerId is present in the network.

pub async fn add( &self, peer: &PeerId, origin: PeerOrigin, addrs: Vec<Multiaddr>, ) -> Result<()>

Add a new peer into the network.

Each peer must have an origin specification.

pub async fn get(&self, peer: &PeerId) -> Result<Option<PeerStatus>>

Get peer information and status.

pub async fn remove(&self, peer: &PeerId) -> Result<()>

Remove peer from the network

pub async fn update( &self, peer: &PeerId, ping_result: Result<Duration, UpdateFailure>, ) -> Result<()>

Updates a peer’s record with the result of a heartbeat ping.

Adjusts the peer’s quality, backoff, and ignore status based on the ping outcome. If the peer’s quality drops below configured thresholds, may trigger a connection close or quality update event. Returns an error if called on the local peer.

Returns

• Ok(Some(NetworkTriggeredEvent)) if the peer’s status changed and an event should be triggered.
• Ok(None) if the peer is unknown.
• Err(NetworkingError) if the operation is disallowed or a database error occurs.

pub async fn health(&self) -> Health

Returns the quality of the network as a network health indicator.

pub async fn connected_peers(&self) -> Result<Vec<PeerId>>

pub async fn find_peers_to_ping( &self, threshold: SystemTime, ) -> Result<Vec<PeerId>>

Returns a list of peer IDs eligible for pinging based on last-seen time, ignore status, and backoff delay.

Peers are filtered to exclude self, those currently within their ignore timeframe, and those whose backoff-adjusted delay has not yet elapsed. The resulting peers are sorted by last seen time in ascending order.

Parameters

• threshold: The cutoff SystemTime; only peers whose next ping is due before this time are considered.

Returns

A vector of peer IDs that should be pinged.

Trait Implementations

impl<T> Debug for Network<T>

where T: HoprDbPeersOperations + Sync + Send + Debug + Debug,

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

Formats the value using the given formatter.