Struct libp2p_request_response::RequestResponse
source · [−]pub struct RequestResponse<TCodec> where
TCodec: RequestResponseCodec, { /* private fields */ }
Expand description
A request/response protocol for some message codec.
Implementations
sourceimpl<TCodec> RequestResponse<TCodec> where
TCodec: RequestResponseCodec + Clone,
impl<TCodec> RequestResponse<TCodec> where
TCodec: RequestResponseCodec + Clone,
sourcepub fn new<I>(codec: TCodec, protocols: I, cfg: RequestResponseConfig) -> Self where
I: IntoIterator<Item = (TCodec::Protocol, ProtocolSupport)>,
pub fn new<I>(codec: TCodec, protocols: I, cfg: RequestResponseConfig) -> Self where
I: IntoIterator<Item = (TCodec::Protocol, ProtocolSupport)>,
Creates a new RequestResponse
behaviour for the given
protocols, codec and configuration.
sourcepub fn throttled<I>(
c: TCodec,
protos: I,
cfg: RequestResponseConfig
) -> Throttled<TCodec> where
I: IntoIterator<Item = (TCodec::Protocol, ProtocolSupport)>,
TCodec: Send,
TCodec::Protocol: Sync,
pub fn throttled<I>(
c: TCodec,
protos: I,
cfg: RequestResponseConfig
) -> Throttled<TCodec> where
I: IntoIterator<Item = (TCodec::Protocol, ProtocolSupport)>,
TCodec: Send,
TCodec::Protocol: Sync,
Creates a RequestResponse
which limits requests per peer.
The behaviour is wrapped in Throttled
and detects the limits
per peer at runtime which are then enforced.
sourcepub fn send_request(
&mut self,
peer: &PeerId,
request: TCodec::Request
) -> RequestId
pub fn send_request(
&mut self,
peer: &PeerId,
request: TCodec::Request
) -> RequestId
Initiates sending a request.
If the targeted peer is currently not connected, a dialing attempt is initiated and the request is sent as soon as a connection is established.
Note: In order for such a dialing attempt to succeed, the
RequestResonse
protocol must either be embedded in anotherNetworkBehaviour
that provides peer and address discovery, or known addresses of peers must be managed viaRequestResponse::add_address
andRequestResponse::remove_address
.
sourcepub fn send_response(
&mut self,
ch: ResponseChannel<TCodec::Response>,
rs: TCodec::Response
) -> Result<(), TCodec::Response>
pub fn send_response(
&mut self,
ch: ResponseChannel<TCodec::Response>,
rs: TCodec::Response
) -> Result<(), TCodec::Response>
Initiates sending a response to an inbound request.
If the ResponseChannel
is already closed due to a timeout or the
connection being closed, the response is returned as an Err
for
further handling. Once the response has been successfully sent on the
corresponding connection, RequestResponseEvent::ResponseSent
is
emitted. In all other cases RequestResponseEvent::InboundFailure
will be or has been emitted.
The provided ResponseChannel
is obtained from an inbound
RequestResponseMessage::Request
.
sourcepub fn add_address(&mut self, peer: &PeerId, address: Multiaddr)
pub fn add_address(&mut self, peer: &PeerId, address: Multiaddr)
Adds a known address for a peer that can be used for
dialing attempts by the Swarm
, i.e. is returned
by NetworkBehaviour::addresses_of_peer
.
Addresses added in this way are only removed by remove_address
.
sourcepub fn remove_address(&mut self, peer: &PeerId, address: &Multiaddr)
pub fn remove_address(&mut self, peer: &PeerId, address: &Multiaddr)
Removes an address of a peer previously added via add_address
.
sourcepub fn is_connected(&self, peer: &PeerId) -> bool
pub fn is_connected(&self, peer: &PeerId) -> bool
Checks whether a peer is currently connected.
sourcepub fn is_pending_outbound(&self, peer: &PeerId, request_id: &RequestId) -> bool
pub fn is_pending_outbound(&self, peer: &PeerId, request_id: &RequestId) -> bool
Checks whether an outbound request to the peer with the provided
PeerId
initiated by RequestResponse::send_request
is still
pending, i.e. waiting for a response.
sourcepub fn is_pending_inbound(&self, peer: &PeerId, request_id: &RequestId) -> bool
pub fn is_pending_inbound(&self, peer: &PeerId, request_id: &RequestId) -> bool
Checks whether an inbound request from the peer with the provided
PeerId
is still pending, i.e. waiting for a response by the local
node through RequestResponse::send_response
.
Trait Implementations
sourceimpl<TCodec> NetworkBehaviour for RequestResponse<TCodec> where
TCodec: RequestResponseCodec + Send + Clone + 'static,
impl<TCodec> NetworkBehaviour for RequestResponse<TCodec> where
TCodec: RequestResponseCodec + Send + Clone + 'static,
type ProtocolsHandler = RequestResponseHandler<TCodec>
type ProtocolsHandler = RequestResponseHandler<TCodec>
Handler for all the protocols the network behaviour supports.
type OutEvent = RequestResponseEvent<TCodec::Request, TCodec::Response>
type OutEvent = RequestResponseEvent<TCodec::Request, TCodec::Response>
Event generated by the NetworkBehaviour
and that the swarm will report back.
sourcefn new_handler(&mut self) -> Self::ProtocolsHandler
fn new_handler(&mut self) -> Self::ProtocolsHandler
Creates a new ProtocolsHandler
for a connection with a peer. Read more
sourcefn addresses_of_peer(&mut self, peer: &PeerId) -> Vec<Multiaddr>ⓘNotable traits for Vec<u8, A>impl<A> Write for Vec<u8, A> where
A: Allocator,
fn addresses_of_peer(&mut self, peer: &PeerId) -> Vec<Multiaddr>ⓘNotable traits for Vec<u8, A>impl<A> Write for Vec<u8, A> where
A: Allocator,
A: Allocator,
Addresses that this behaviour is aware of for this specific peer, and that may allow reaching the peer. Read more
sourcefn inject_connected(&mut self, peer: &PeerId)
fn inject_connected(&mut self, peer: &PeerId)
Indicates the behaviour that we connected to the node with the given peer id. Read more
sourcefn inject_connection_established(
&mut self,
peer: &PeerId,
conn: &ConnectionId,
endpoint: &ConnectedPoint
)
fn inject_connection_established(
&mut self,
peer: &PeerId,
conn: &ConnectionId,
endpoint: &ConnectedPoint
)
Informs the behaviour about a newly established connection to a peer.
sourcefn inject_connection_closed(
&mut self,
peer_id: &PeerId,
conn: &ConnectionId,
_: &ConnectedPoint
)
fn inject_connection_closed(
&mut self,
peer_id: &PeerId,
conn: &ConnectionId,
_: &ConnectedPoint
)
Informs the behaviour about a closed connection to a peer. Read more
sourcefn inject_disconnected(&mut self, peer: &PeerId)
fn inject_disconnected(&mut self, peer: &PeerId)
Indicates the behaviour that we disconnected from the node with the given peer id. Read more
sourcefn inject_dial_failure(&mut self, peer: &PeerId)
fn inject_dial_failure(&mut self, peer: &PeerId)
Indicates to the behaviour that we tried to dial all the addresses known for a node, but failed. Read more
sourcefn inject_event(
&mut self,
peer: PeerId,
connection: ConnectionId,
event: RequestResponseHandlerEvent<TCodec>
)
fn inject_event(
&mut self,
peer: PeerId,
connection: ConnectionId,
event: RequestResponseHandlerEvent<TCodec>
)
Informs the behaviour about an event generated by the handler dedicated to the peer identified by peer_id
.
for the behaviour. Read more
sourcefn poll(
&mut self,
_: &mut Context<'_>,
_: &mut impl PollParameters
) -> Poll<NetworkBehaviourAction<RequestProtocol<TCodec>, RequestResponseEvent<TCodec::Request, TCodec::Response>>>
fn poll(
&mut self,
_: &mut Context<'_>,
_: &mut impl PollParameters
) -> Poll<NetworkBehaviourAction<RequestProtocol<TCodec>, RequestResponseEvent<TCodec::Request, TCodec::Response>>>
Polls for things that swarm should do. Read more
sourcefn inject_address_change(
&mut self,
&PeerId,
&ConnectionId,
_old: &ConnectedPoint,
_new: &ConnectedPoint
)
fn inject_address_change(
&mut self,
&PeerId,
&ConnectionId,
_old: &ConnectedPoint,
_new: &ConnectedPoint
)
Informs the behaviour that the ConnectedPoint
of an existing connection has changed.
sourcefn inject_addr_reach_failure(
&mut self,
_peer_id: Option<&PeerId>,
_addr: &Multiaddr,
_error: &dyn Error
)
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. Read more
sourcefn inject_new_listen_addr(&mut self, _addr: &Multiaddr)
fn inject_new_listen_addr(&mut self, _addr: &Multiaddr)
Indicates to the behaviour that we have started listening on a new multiaddr.
sourcefn inject_expired_listen_addr(&mut self, _addr: &Multiaddr)
fn inject_expired_listen_addr(&mut self, _addr: &Multiaddr)
Indicates to the behaviour that a new multiaddr we were listening on has expired, which means that we are no longer listening in it. Read more
sourcefn inject_new_external_addr(&mut self, _addr: &Multiaddr)
fn inject_new_external_addr(&mut self, _addr: &Multiaddr)
Indicates to the behaviour that we have discovered a new external address for us.
sourcefn inject_listener_error(
&mut self,
_id: ListenerId,
_err: &(dyn Error + 'static)
)
fn inject_listener_error(
&mut self,
_id: ListenerId,
_err: &(dyn Error + 'static)
)
A listener experienced an error.
sourcefn inject_listener_closed(
&mut self,
_id: ListenerId,
_reason: Result<(), &Error>
)
fn inject_listener_closed(
&mut self,
_id: ListenerId,
_reason: Result<(), &Error>
)
A listener closed.
Auto Trait Implementations
impl<TCodec> !RefUnwindSafe for RequestResponse<TCodec>
impl<TCodec> Send for RequestResponse<TCodec> where
TCodec: Send,
impl<TCodec> Sync for RequestResponse<TCodec> where
TCodec: Sync,
<TCodec as RequestResponseCodec>::Protocol: Sync,
<TCodec as RequestResponseCodec>::Request: Sync,
<TCodec as RequestResponseCodec>::Response: Sync,
impl<TCodec> Unpin for RequestResponse<TCodec> where
TCodec: Unpin,
<TCodec as RequestResponseCodec>::Protocol: Unpin,
<TCodec as RequestResponseCodec>::Request: Unpin,
<TCodec as RequestResponseCodec>::Response: Unpin,
impl<TCodec> !UnwindSafe for RequestResponse<TCodec>
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcepub fn borrow_mut(&mut self) -> &mut T
pub fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more