Struct tari_comms::connectivity::ConnectivityRequester

pub struct ConnectivityRequester { /* fields omitted */ }

Implementations

impl ConnectivityRequester

pub fn new(
    sender: Sender<ConnectivityRequest>,
    event_tx: ConnectivityEventTx
) -> Self

pub fn subscribe_event_stream(&self) -> ConnectivityEventRx

pub async fn dial_peer<'_>(
    &'_ mut self,
    peer: NodeId
) -> Result<PeerConnection, ConnectivityError>

pub async fn add_managed_peers<'_>(
    &'_ mut self,
    peers: Vec<NodeId>
) -> Result<(), ConnectivityError>

pub async fn remove_peer<'_>(
    &'_ mut self,
    peer: NodeId
) -> Result<(), ConnectivityError>

pub async fn select_connections<'_>(
    &'_ mut self,
    selection: ConnectivitySelection
) -> Result<Vec<PeerConnection>, ConnectivityError>

pub async fn get_connection<'_>(
    &'_ mut self,
    node_id: NodeId
) -> Result<Option<PeerConnection>, ConnectivityError>

Get an active connection to the given node id if one exists. This will return None if the peer is not connected.

pub async fn get_connectivity_status<'_>(
    &'_ mut self
) -> Result<ConnectivityStatus, ConnectivityError>

pub async fn get_all_connection_states<'_>(
    &'_ mut self
) -> Result<Vec<PeerConnectionState>, ConnectivityError>

pub async fn ban_peer<'_>(
    &'_ mut self,
    node_id: NodeId,
    duration: Duration
) -> Result<(), ConnectivityError>

pub async fn wait_for_connectivity<'_>(
    &'_ mut self,
    timeout: Duration
) -> Result<(), ConnectivityError>

Waits for the node to get at least one connection. This is useful for testing and is not typically be needed in application code.

Trait Implementations

impl Clone for ConnectivityRequester

fn clone(&self) -> ConnectivityRequester

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.