Struct PeerManager 

pub struct PeerManager {
    peers: RwLock<PeerSets>,
    avg_global_time: RwLock<Duration>,
    peer_ops_tx: Sender<PeerOperation>,
    peer_ops_rx: Receiver<PeerOperation>,
    peer_ban_list: RwLock<HashMap<PeerId, Option<Instant>>>,
    protected_peers: RwLock<HashSet<PeerId>>,
}

Thread safe peer manager which handles peer management for the ChainExchange protocol.

Fields

peers: RwLock<PeerSets>

Full and bad peer sets.

avg_global_time: RwLock<Duration>

Average response time from peers.

peer_ops_tx: Sender<PeerOperation>

Peer operation sender

peer_ops_rx: Receiver<PeerOperation>

Peer operation receiver

peer_ban_list: RwLock<HashMap<PeerId, Option<Instant>>>

Peer ban list, key is peer id, value is expiration time

protected_peers: RwLock<HashSet<PeerId>>

A set of peers that won’t be proactively banned or disconnected from

Implementations

impl PeerManager

pub fn is_peer_new(&self, peer_id: &PeerId) -> bool

Returns true if peer is not marked as bad or not already in set.

pub(super) fn sorted_peers(&self) -> Vec<PeerId>

Sort peers based on a score function with the success rate and latency of requests.

pub fn top_peers_shuffled(&self) -> Vec<PeerId>

Return shuffled slice of ordered peers from the peer manager. Ordering is based on failure rate and latency of the peer.

pub fn log_global_success(&self, dur: Duration)

Logs a global request success. This just updates the average for the peer manager.

pub fn log_success(&self, peer: &PeerId, dur: Duration)

Logs a success for the given peer, and updates the average request duration.

pub fn log_failure(&self, peer: &PeerId, dur: Duration)

Logs a failure for the given peer, and updates the average request duration.

pub fn mark_peer_bad(&self, peer_id: PeerId, reason: impl Into<String>)

Removes a peer from the set and returns true if the value was present previously

pub fn unmark_peer_bad(&self, peer_id: &PeerId)

pub fn remove_peer(&self, peer_id: &PeerId)

Remove peer from managed set, does not mark as bad

pub fn peer_ops_rx(&self) -> &Receiver<PeerOperation>

Gets peer operation receiver

pub async fn ban_peer( &self, peer: PeerId, reason: impl Into<String>, duration: Option<Duration>, get_user_agent: impl Fn(&PeerId) -> Option<String>, )

Bans a peer with an optional duration

pub async fn ban_peer_with_default_duration( &self, peer: PeerId, reason: impl Into<String>, get_user_agent: impl Fn(&PeerId) -> Option<String>, )

Bans a peer with the default duration(1h)

pub async fn peer_operation_event_loop_task(self: Arc<Self>) -> Result<()>

pub fn peer_count(&self) -> usize

pub fn protect_peer(&self, peer_id: PeerId)

pub fn unprotect_peer(&self, peer_id: &PeerId)

pub fn list_protected_peers(&self) -> HashSet<PeerId>

pub fn is_peer_protected(&self, peer_id: &PeerId) -> bool

Trait Implementations

impl Default for PeerManager

fn default() -> Self

Returns the “default value” for a type.