Struct splinter::peer::PeerManager

pub struct PeerManager { /* private fields */ }

The PeerManager is in charge of keeping track of peers and their reference counts, as well as requesting connections from the ConnectionManager. If a peer has disconnected, the PeerManager will also try the peer’s other endpoints until one is successful.

Implementations

impl PeerManager

pub fn new(
    connector: Connector,
    max_retry_attempts: Option<u64>,
    retry_interval: Option<u64>,
    identity: String,
    strict_ref_counts: bool
) -> Self

👎 Deprecated since 0.5.1:

Please use PeerManagerBuilder instead

Creates a new PeerManager

Arguments

• connector - The Connector to the ConnectionManager that will handle the connections requested by the PeerManager
• max_retry_attempts - The number of retry attempts for an active endpoint before the PeerManager will try other endpoints associated with a peer
• retry_interval - How often (in seconds) the Pacemaker should notify the PeerManager to retry pending peers
• identity - The unique ID of the node this PeerManager belongs to
• strict_ref_counts - Determines whether or not to panic when attempting to remove a reference to peer that is not referenced.

pub fn builder() -> PeerManagerBuilder

Construct a new PeerManagerBuilder for creating a new PeerManager instance.

pub fn start(&mut self) -> Result<PeerManagerConnector, PeerManagerError>

👎 Deprecated since 0.5.1:

Please use connector() instead. The PeerManagerBuilder starts up the PeerManager now

Starts the PeerManager

Starts up a thread that will handle incoming requests to add, remove and get peers. Also handles notifications from the ConnectionManager.

Returns a PeerManagerConnector that can be used to send requests to the PeerManager.

pub fn connector(&self) -> PeerManagerConnector

Trait Implementations

impl ShutdownHandle for PeerManager

fn signal_shutdown(&mut self)

Instructs the component to begin shutting down.

fn wait_for_shutdown(self) -> Result<(), InternalError>

Waits until the the component has completely shutdown.