Struct sc_network::config::RequestResponseConfig

pub struct RequestResponseConfig {
    pub name: Cow<'static, str>,
    pub max_request_size: u64,
    pub max_response_size: u64,
    pub request_timeout: Duration,
    pub inbound_queue: Option<Sender<IncomingRequest>>,
}

Configuration for a single request-response protocol.

Fields

name: Cow<'static, str>

Name of the protocol on the wire. Should be something like /foo/bar.

max_request_size: u64

Maximum allowed size, in bytes, of a request.

Any request larger than this value will be declined as a way to avoid allocating too much memory for it.

max_response_size: u64

Maximum allowed size, in bytes, of a response.

Any response larger than this value will be declined as a way to avoid allocating too much memory for it.

request_timeout: Duration

Duration after which emitted requests are considered timed out.

If you expect the response to come back quickly, you should set this to a smaller duration.

inbound_queue: Option<Sender<IncomingRequest>>

Channel on which the networking service will send incoming requests.

Every time a peer sends a request to the local node using this protocol, the networking service will push an element on this channel. The receiving side of this channel then has to pull this element, process the request, and send back the response to send back to the peer.

The size of the channel has to be carefully chosen. If the channel is full, the networking service will discard the incoming request send back an error to the peer. Consequently, the channel being full is an indicator that the node is overloaded.

You can typically set the size of the channel to T / d, where T is the request_timeout and d is the expected average duration of CPU and I/O it takes to build a response.

Can be None if the local node does not support answering incoming requests. If this is None, then the local node will not advertise support for this protocol towards other peers. If this is Some but the channel is closed, then the local node will advertise support for this protocol, but any incoming request will lead to an error being sent back.

Trait Implementations

impl Clone for ProtocolConfig

fn clone(&self) -> ProtocolConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ProtocolConfig

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

Formats the value using the given formatter.