Struct splinter::peer::PeerManagerBuilder

pub struct PeerManagerBuilder { /* private fields */ }

Implementations

impl PeerManagerBuilder

Constructs new PeerManager instances.

This builder is used to construct new PeerManager instances. The PeerManager requires a Connector to request connections from the ConnectionManageer and the unique ID of the node this PeerManager is for. It also has several optional configuration values, such as max_retry_attempts and retry_interval.

pub fn new() -> Self

Construct a new builder.

pub fn with_connector(self, connector: Connector) -> Self

Set the connector instance to use with the resulting PeerManager.

This is the Connector to the ConnectionManager that will handle the connections requested by the PeerManager.

pub fn with_max_retry_attempts(self, max_retry_attempts: u64) -> Self

Set the max_retry_attempts instance to use with the resulting PeerManager.

The number of retry attempts for an active endpoint before the PeerManager will try other endpoints associated with a peer

pub fn with_retry_interval(self, retry_interval: u64) -> Self

Set the retry_interval to use with the resulting PeerManager.

How often (in seconds) the Pacemaker should notify the PeerManager to retry pending peers.

pub fn with_retry_frequency(self, retry_frequency: u64) -> Self

Set the initial retry_frequency to use with the resulting PeerManager.

How often (in seconds) the PeerManager will wait before retrying a pending peer’s endpoints

pub fn with_max_retry_frequency(self, retry_frequency: u64) -> Self

Set the max_retry_frequency to use with the resulting PeerManager.

The maximum time (in seconds) the PeerManager will wait before retrying a pending peer’s endpoints

pub fn with_endpoint_retry_frequency(self, retry_frequency: u64) -> Self

Set the initial endpoint_retry_frequency to use with the resulting PeerManager.

How often (in seconds) the PeerManager will wait before retrying a pending requested endpoint that does not have an ID

pub fn with_identity(self, identity: String) -> Self

Set the identity to use with the resulting PeerManager.

The unique ID of the node this PeerManager belongs to.

pub fn with_strict_ref_counts(self, strict_ref_counts: bool) -> Self

Set strict_ref_counts in the the resulting PeerManager.

Determines whether or not to panic when attempting to remove a reference to a peer that is not referenced.

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

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.

Trait Implementations

impl Default for PeerManagerBuilder

fn default() -> PeerManagerBuilder

Returns the “default value” for a type.