Struct network::peer_manager::PeerManagerRequestSender

source · [−]

pub struct PeerManagerRequestSender { /* private fields */ }

Expand description

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. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

impl Debug for PeerManagerRequestSender

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

Formats the value using the given formatter. Read more

Auto Trait Implementations

impl RefUnwindSafe for PeerManagerRequestSender

impl Send for PeerManagerRequestSender

impl Sync for PeerManagerRequestSender

impl Unpin for PeerManagerRequestSender

impl UnwindSafe for PeerManagerRequestSender

Blanket Implementations

impl<T> Any for T where
T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> Pointable for T

const ALIGN: usize = mem::align_of::()

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

impl<T> Same<T> for T

type Output = T

Should always be Self

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more