Struct tari_comms::CommsBuilder

pub struct CommsBuilder { /* fields omitted */ }

The CommsBuilder provides a simple builder API for getting Tari comms p2p messaging up and running.

Implementations

impl CommsBuilder

pub fn new() -> Self

Create a new CommsBuilder instance

pub fn with_node_identity(
    mut self: Self,
    node_identity: Arc<NodeIdentity>
) -> Self

Set the NodeIdentity for this comms instance. This is required.

pub fn with_shutdown_signal(
    mut self: Self,
    shutdown_signal: ShutdownSignal
) -> Self

Set the shutdown signal for this comms instance

pub fn with_user_agent<T: ToString>(mut self: Self, user_agent: T) -> Self

Set the user agent string for this comms node. This string is sent once when establishing a connection.

pub fn allow_test_addresses(mut self: Self) -> Self

Allow test addresses (memory addresses, local loopback etc). This should only be activated for tests.

pub fn with_listener_address(
    mut self: Self,
    listener_address: Multiaddr
) -> Self

pub fn with_listener_liveness_max_sessions(
    mut self: Self,
    max_sessions: usize
) -> Self

pub fn with_listener_liveness_allowlist_cidrs(
    mut self: Self,
    cidrs: Vec<AnyIpCidr>
) -> Self

pub fn with_max_simultaneous_inbound_connects(
    mut self: Self,
    max_simultaneous_inbound_connects: usize
) -> Self

The maximum number of connection tasks that will be spawned at the same time. Once this limit is reached, peers attempting to connect will have to wait for another connection attempt to complete.

pub fn with_max_dial_attempts(mut self: Self, max_dial_attempts: usize) -> Self

The number of dial attempts to make before giving up.

pub fn with_min_connectivity(mut self: Self, min_connectivity: f32) -> Self

Sets the minimum required connectivity as a percentage of peers added to the connectivity manager peer set.

pub fn disable_connection_reaping(mut self: Self) -> Self

Call to disable connection reaping. Usually you would want to have this enabled, however there are some test cases where disabling this is desirable.

pub fn with_peer_storage(
    mut self: Self,
    peer_storage: CommsDatabase,
    file_lock: Option<File>
) -> Self

Set the peer storage database to use.

pub fn with_dial_backoff<T>(mut self: Self, backoff: T) -> Self where
    T: Backoff + Send + Sync + 'static, 

Set the backoff that [ConnectionManager] uses when dialing peers. This is optional. If omitted the default ExponentialBackoff is used. [ConnectionManager]: crate::connection_manager::next::ConnectionManager

pub fn build(mut self: Self) -> Result<UnspawnedCommsNode, CommsBuilderError>

Build comms services and handles. Services will not be started.

Trait Implementations

impl Default for CommsBuilder

fn default() -> Self

Returns the "default value" for a type.