Struct libp2p::request_response::Throttled

pub struct Throttled<C> where
    C: RequestResponseCodec + Send,
    <C as RequestResponseCodec>::Protocol: Sync,  { /* fields omitted */ }

A wrapper around RequestResponse which adds request limits per peer.

Implementations

impl<C> Throttled<C> where
    C: RequestResponseCodec + Send + Clone,
    <C as RequestResponseCodec>::Protocol: Sync, 

pub fn new<I>(c: C, protos: I, cfg: RequestResponseConfig) -> Throttled<C> where
    C: Send,
    I: IntoIterator<Item = (<C as RequestResponseCodec>::Protocol, ProtocolSupport)>,
    <C as RequestResponseCodec>::Protocol: Sync, 

Create a new throttled request-response behaviour.

pub fn from(behaviour: RequestResponse<Codec<C>>) -> Throttled<C>

Wrap an existing RequestResponse behaviour and apply send/recv limits.

pub fn set_receive_limit(&mut self, limit: NonZeroU16)

Set the global default receive limit per peer.

pub fn override_receive_limit(&mut self, p: &PeerId, limit: NonZeroU16)

Override the receive limit of a single peer.

pub fn remove_override(&mut self, p: &PeerId)

Remove any limit overrides for the given peer.

pub fn can_send(&mut self, p: &PeerId) -> bool

Has the limit of outbound requests been reached for the given peer?

pub fn send_request(
    &mut self,
    p: &PeerId,
    req: <C as RequestResponseCodec>::Request
) -> Result<RequestId, <C as RequestResponseCodec>::Request>

Send a request to a peer.

If the limit of outbound requests has been reached, the request is returned. Sending more outbound requests should only be attempted once Event::ResumeSending has been received from NetworkBehaviour::poll.

pub fn send_response(
    &mut self,
    ch: ResponseChannel<Message<<C as RequestResponseCodec>::Response>>,
    res: <C as RequestResponseCodec>::Response
) -> Result<(), <C as RequestResponseCodec>::Response>

Answer an inbound request with a response.

See RequestResponse::send_response for details.

pub fn add_address(&mut self, p: &PeerId, a: Multiaddr)

Add a known peer address.

See RequestResponse::add_address for details.

pub fn remove_address(&mut self, p: &PeerId, a: &Multiaddr)

Remove a previously added peer address.

See RequestResponse::remove_address for details.

pub fn is_connected(&self, p: &PeerId) -> bool

Are we connected to the given peer?

See RequestResponse::is_connected for details.

pub fn is_pending_outbound(&self, p: &PeerId, r: &RequestId) -> bool

Are we waiting for a response to the given request?

See RequestResponse::is_pending_outbound for details.

pub fn is_pending_inbound(&self, p: &PeerId, r: &RequestId) -> bool

Is the remote waiting for the local node to respond to the given request?

See RequestResponse::is_pending_inbound for details.

Trait Implementations

impl<C> NetworkBehaviour for Throttled<C> where
    C: RequestResponseCodec + Send + Clone + 'static,
    <C as RequestResponseCodec>::Protocol: Sync, 

type ProtocolsHandler = RequestResponseHandler<Codec<C>>

Handler for all the protocols the network behaviour supports.

type OutEvent = Event<<C as RequestResponseCodec>::Request, <C as RequestResponseCodec>::Response, Message<<C as RequestResponseCodec>::Response>>

Event generated by the NetworkBehaviour and that the swarm will report back.

pub fn new_handler(
    &mut self
) -> <Throttled<C> as NetworkBehaviour>::ProtocolsHandler

Creates a new ProtocolsHandler for a connection with a peer.

pub fn addresses_of_peer(&mut self, p: &PeerId) -> Vec<Multiaddr, Global>

Addresses that this behaviour is aware of for this specific peer, and that may allow reaching the peer.

pub fn inject_connection_established(
    &mut self,
    p: &PeerId,
    id: &ConnectionId,
    end: &ConnectedPoint
)

Informs the behaviour about a newly established connection to a peer.

pub fn inject_connection_closed(
    &mut self,
    peer: &PeerId,
    id: &ConnectionId,
    end: &ConnectedPoint
)

Informs the behaviour about a closed connection to a peer.

pub fn inject_connected(&mut self, p: &PeerId)

Indicate to the behaviour that we connected to the node with the given peer id.

pub fn inject_disconnected(&mut self, p: &PeerId)

Indicates to the behaviour that we disconnected from the node with the given peer id.

pub fn inject_dial_failure(&mut self, p: &PeerId)

Indicates to the behaviour that we tried to dial all the addresses known for a node, but failed.

pub fn inject_event(
    &mut self,
    p: PeerId,
    i: ConnectionId,
    e: RequestResponseHandlerEvent<Codec<C>>
)

Informs the behaviour about an event generated by the handler dedicated to the peer identified by peer_id. for the behaviour.

pub fn poll(
    &mut self,
    cx: &mut Context<'_>,
    params: &mut impl PollParameters
) -> Poll<NetworkBehaviourAction<RequestProtocol<Codec<C>>, <Throttled<C> as NetworkBehaviour>::OutEvent>>

Polls for things that swarm should do.

fn inject_address_change(
    &mut self,
    &PeerId,
    &ConnectionId,
    _old: &ConnectedPoint,
    _new: &ConnectedPoint
)

Informs the behaviour that the ConnectedPoint of an existing connection has changed.

fn inject_addr_reach_failure(
    &mut self,
    _peer_id: Option<&PeerId>,
    _addr: &Multiaddr,
    _error: &dyn Error
)

Indicates to the behaviour that we tried to reach an address, but failed.

fn inject_new_listener(&mut self, _id: ListenerId)

Indicates to the behaviour that a new listener was created.

fn inject_new_listen_addr(&mut self, _id: ListenerId, _addr: &Multiaddr)

Indicates to the behaviour that we have started listening on a new multiaddr.

fn inject_expired_listen_addr(&mut self, _id: ListenerId, _addr: &Multiaddr)

Indicates to the behaviour that a multiaddr we were listening on has expired, which means that we are no longer listening in it.

fn inject_listener_error(
    &mut self,
    _id: ListenerId,
    _err: &(dyn Error + 'static)
)

A listener experienced an error.

fn inject_listener_closed(
    &mut self,
    _id: ListenerId,
    _reason: Result<(), &Error>
)

A listener closed.

fn inject_new_external_addr(&mut self, _addr: &Multiaddr)

Indicates to the behaviour that we have discovered a new external address for us.

fn inject_expired_external_addr(&mut self, _addr: &Multiaddr)

Indicates to the behaviour that an external address was removed.