Struct RequestResponsesBehaviour

pub struct RequestResponsesBehaviour { /* private fields */ }

Implementation of NetworkBehaviour that provides support for request-response protocols.

Implementations

impl RequestResponsesBehaviour

pub fn new( list: impl Iterator<Item = ProtocolConfig>, peer_store: Arc<dyn PeerStoreProvider>, ) -> Result<Self, RegisterError>

Creates a new behaviour. Must be passed a list of supported protocols. Returns an error if the same protocol is passed twice.

pub fn send_request( &mut self, target: &PeerId, protocol_name: ProtocolName, request: Vec<u8>, fallback_request: Option<(Vec<u8>, ProtocolName)>, pending_response: Sender<Result<(Vec<u8>, ProtocolName), RequestFailure>>, connect: IfDisconnected, )

Initiates sending a request.

If there is no established connection to the target peer, the behavior is determined by the choice of connect.

An error is returned if the protocol doesn’t match one that has been registered.

Trait Implementations

impl NetworkBehaviour for RequestResponsesBehaviour

type ConnectionHandler = MultiHandler<String, <Behaviour<GenericCodec> as NetworkBehaviour>::ConnectionHandler>

Handler for all the protocols the network behaviour supports.

type ToSwarm = Event

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

fn handle_pending_inbound_connection( &mut self, _connection_id: ConnectionId, _local_addr: &Multiaddr, _remote_addr: &Multiaddr, ) -> Result<(), ConnectionDenied>

Callback that is invoked for every new inbound connection.

fn handle_pending_outbound_connection( &mut self, _connection_id: ConnectionId, _maybe_peer: Option<PeerId>, _addresses: &[Multiaddr], _effective_role: Endpoint, ) -> Result<Vec<Multiaddr>, ConnectionDenied>

Callback that is invoked for every outbound connection attempt.

fn handle_established_inbound_connection( &mut self, connection_id: ConnectionId, peer: PeerId, local_addr: &Multiaddr, remote_addr: &Multiaddr, ) -> Result<THandler<Self>, ConnectionDenied>

Callback that is invoked for every established inbound connection.

fn handle_established_outbound_connection( &mut self, connection_id: ConnectionId, peer: PeerId, addr: &Multiaddr, role_override: Endpoint, ) -> Result<THandler<Self>, ConnectionDenied>

Callback that is invoked for every established outbound connection.

fn on_swarm_event(&mut self, event: FromSwarm<'_, Self::ConnectionHandler>)

Informs the behaviour about an event from the Swarm.

fn on_connection_handler_event( &mut self, peer_id: PeerId, connection_id: ConnectionId, event: THandlerOutEvent<Self>, )

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

fn poll( &mut self, cx: &mut Context<'_>, params: &mut impl PollParameters, ) -> Poll<ToSwarm<Self::ToSwarm, THandlerInEvent<Self>>>

Polls for things that swarm should do.