Struct network::peer_manager::PeerManagerRequestSender

pub struct PeerManagerRequestSender { /* fields omitted */ }

Convenience wrapper which makes it easy to issue communication requests and await the responses from PeerManager.

Implementations

impl PeerManagerRequestSender

pub fn new(inner: Sender<(PeerId, ProtocolId), PeerManagerRequest>) -> Self

Construct a new PeerManagerRequestSender with a raw channel::Sender

pub fn send_to(
    &self,
    peer_id: PeerId,
    protocol_id: ProtocolId,
    mdata: Bytes
) -> Result<(), PeerManagerError>

Send a fire-and-forget direct-send message to remote peer.

The function returns when the message has been enqueued on the network actor’s event queue. It therefore makes no reliable delivery guarantees. An error is returned if the event queue is unexpectedly shutdown.

pub fn send_to_many(
    &self,
    recipients: impl Iterator<Item = PeerId>,
    protocol_id: ProtocolId,
    mdata: Bytes
) -> Result<(), PeerManagerError>

Send the same message to many recipients using the direct-send protocol.

This method is an optimization so that we can avoid serializing and copying the same message many times when we want to sent a single message to many peers. Note that the Bytes the messages is serialized into is a ref-counted byte buffer, so we can avoid excess copies as all direct-sends will share the same underlying byte buffer.

The function returns when all send requests have been enqueued on the network actor’s event queue. It therefore makes no reliable delivery guarantees. An error is returned if the event queue is unexpectedly shutdown.

pub async fn send_rpc(
    &self,
    peer_id: PeerId,
    protocol_id: ProtocolId,
    req: Bytes,
    timeout: Duration
) -> Result<Bytes, RpcError>

Sends a unary RPC to a remote peer and waits to either receive a response or times out.

Trait Implementations

impl Clone for PeerManagerRequestSender

fn clone(&self) -> PeerManagerRequestSender

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PeerManagerRequestSender

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.