Struct polkadot_node_network_protocol::request_response::outgoing::OutgoingRequest

pub struct OutgoingRequest<Req> {
    pub peer: Recipient,
    pub payload: Req,
    pub pending_response: ResponseSender,
}

A request to be sent to the network bridge, including a sender for sending responses/failures.

The network implementation will make use of that sender for informing the requesting subsystem about responses/errors.

When using Recipient::Peer, keep in mind that no address (as in IP address and port) might be known for that specific peer. You are encouraged to use Peer for peers that you are expected to be already connected to. When using Recipient::Authority, the addresses can be found thanks to the authority discovery system.

Fields

peer: Recipient

Intended recipient of this request.

payload: Req

The actual request to send over the wire.

pending_response: ResponseSender

Sender which is used by networking to get us back a response.

Implementations

impl<Req> OutgoingRequest<Req>where Req: IsRequest + Encode, Req::Response: Decode,

pub fn new( peer: Recipient, payload: Req ) -> (Self, impl Future<Output = OutgoingResult<Req::Response>>)

Create a new OutgoingRequest.

It will contain a sender that is used by the networking for sending back responses. The connected receiver is returned as the second element in the returned tuple.

pub fn encode_request(self) -> (Protocol, OutgoingRequest<Vec<u8>>)

Encode a request into a Vec<u8>.

As this throws away type information, we also return the Protocol this encoded request adheres to.

Trait Implementations

impl<Req: Debug> Debug for OutgoingRequest<Req>

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

Formats the value using the given formatter.