Struct sc_network::request_responses::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>, peerset: PeersetHandle ) -> 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: &str, request: Vec<u8>, pending_response: Sender<Result<Vec<u8>, 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, <RequestResponse<GenericCodec> as NetworkBehaviour>::ConnectionHandler>

Handler for all the protocols the network behaviour supports.

type OutEvent = Event

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

fn new_handler(&mut self) -> Self::ConnectionHandler

Creates a new [ConnectionHandler] for a connection with a peer.

fn addresses_of_peer(&mut self, _: &PeerId) -> Vec<Multiaddr>

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

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, (p_name, event): <<Self::ConnectionHandler as IntoConnectionHandler>::Handler as ConnectionHandler>::OutEvent )

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<NetworkBehaviourAction<Self::OutEvent, Self::ConnectionHandler>>

Polls for things that swarm should do.

fn inject_connection_established( &mut self, peer_id: &PeerId, connection_id: &ConnectionId, endpoint: &ConnectedPoint, failed_addresses: Option<&Vec<Multiaddr, Global>>, other_established: usize )

👎Deprecated since 0.40.2: Handle FromSwarm::ConnectionEstablished in NetworkBehaviour::on_swarm_event instead. The default implementation of this inject_* method delegates to it.

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

fn inject_connection_closed( &mut self, peer_id: &PeerId, connection_id: &ConnectionId, endpoint: &ConnectedPoint, handler: <Self::ConnectionHandler as IntoConnectionHandler>::Handler, remaining_established: usize )

👎Deprecated since 0.40.2: Handle FromSwarm::ConnectionClosed in NetworkBehaviour::on_swarm_event instead. The default implementation of this inject_* method delegates to it.

Informs the behaviour about a closed connection to a peer.

fn inject_address_change( &mut self, peer_id: &PeerId, connection_id: &ConnectionId, old: &ConnectedPoint, new: &ConnectedPoint )

👎Deprecated since 0.40.2: Handle FromSwarm::AddressChange in NetworkBehaviour::on_swarm_event instead. The default implementation of this inject_* method delegates to it.

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

fn inject_event( &mut self, peer_id: PeerId, connection: ConnectionId, event: <<Self::ConnectionHandler as IntoConnectionHandler>::Handler as ConnectionHandler>::OutEvent )

👎Deprecated since 0.40.2: Implement NetworkBehaviour::on_connection_handler_event instead. The default implementation of this inject_* method delegates to it.

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

fn inject_dial_failure( &mut self, peer_id: Option<PeerId>, handler: Self::ConnectionHandler, error: &DialError )

👎Deprecated since 0.40.2: Handle InEvent::DialFailure in NetworkBehaviour::on_swarm_event instead. The default implementation of this inject_* method delegates to it.

Indicates to the behaviour that the dial to a known or unknown node failed.

fn inject_listen_failure( &mut self, local_addr: &Multiaddr, send_back_addr: &Multiaddr, handler: Self::ConnectionHandler )

👎Deprecated since 0.40.2: Handle FromSwarm::ListenFailure in NetworkBehaviour::on_swarm_event instead. The default implementation of this inject_* method delegates to it.

Indicates to the behaviour that an error happened on an incoming connection during its initial handshake.

fn inject_new_listener(&mut self, id: ListenerId)

👎Deprecated since 0.40.2: Handle FromSwarm::NewListener in NetworkBehaviour::on_swarm_event instead. The default implementation of this inject_* method delegates to it.

Indicates to the behaviour that a new listener was created.

fn inject_new_listen_addr(&mut self, id: ListenerId, addr: &Multiaddr)

👎Deprecated since 0.40.2: Handle FromSwarm::NewListenAddr in NetworkBehaviour::on_swarm_event instead. The default implementation of this inject_* method delegates to it.

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

fn inject_expired_listen_addr(&mut self, id: ListenerId, addr: &Multiaddr)

👎Deprecated since 0.40.2: Handle FromSwarm::ExpiredListenAddr in NetworkBehaviour::on_swarm_event instead. The default implementation of this inject_* method delegates to it.

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

fn inject_listener_error(&mut self, id: ListenerId, err: &(dyn Error + 'static))

👎Deprecated since 0.40.2: Handle FromSwarm::ListenerError in NetworkBehaviour::on_swarm_event instead. The default implementation of this inject_* method delegates to it.

A listener experienced an error.

fn inject_listener_closed(&mut self, id: ListenerId, reason: Result<(), &Error>)

👎Deprecated since 0.40.2: Handle FromSwarm::ListenerClosed in NetworkBehaviour::on_swarm_event instead. The default implementation of this inject_* method delegates to it.

A listener closed.

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

👎Deprecated since 0.40.2: Handle FromSwarm::NewExternalAddr in NetworkBehaviour::on_swarm_event instead. The default implementation of this inject_* method delegates to it.

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

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

👎Deprecated since 0.40.2: Handle FromSwarm::ExpiredExternalAddr in NetworkBehaviour::on_swarm_event instead. The default implementation of this inject_* method delegates to it.

Indicates to the behaviour that an external address was removed.