Struct libp2p::swarm::handler::OneShotHandler

pub struct OneShotHandler<TInbound, TOutbound, TEvent>where
    TOutbound: OutboundUpgradeSend,{ /* private fields */ }

A ConnectionHandler that opens a new substream for each request.

Implementations

impl<TInbound, TOutbound, TEvent> OneShotHandler<TInbound, TOutbound, TEvent>where TOutbound: OutboundUpgradeSend,

pub fn new( listen_protocol: SubstreamProtocol<TInbound, ()>, config: OneShotHandlerConfig ) -> OneShotHandler<TInbound, TOutbound, TEvent>

Creates a OneShotHandler.

pub fn pending_requests(&self) -> u32

Returns the number of pending requests.

pub fn listen_protocol_ref(&self) -> &SubstreamProtocol<TInbound, ()>

Returns a reference to the listen protocol configuration.

Note: If you modify the protocol, modifications will only applies to future inbound substreams, not the ones already being negotiated.

pub fn listen_protocol_mut(&mut self) -> &mut SubstreamProtocol<TInbound, ()>

Returns a mutable reference to the listen protocol configuration.

Note: If you modify the protocol, modifications will only applies to future inbound substreams, not the ones already being negotiated.

pub fn send_request(&mut self, upgrade: TOutbound)

Opens an outbound substream with upgrade.

Trait Implementations

impl<TInbound, TOutbound, TEvent> ConnectionHandler for OneShotHandler<TInbound, TOutbound, TEvent>where TInbound: InboundUpgradeSend + Send + 'static, TOutbound: Debug + OutboundUpgradeSend, <TInbound as InboundUpgradeSend>::Output: Into<TEvent>, <TOutbound as OutboundUpgradeSend>::Output: Into<TEvent>, <TOutbound as OutboundUpgradeSend>::Error: Error + Send + 'static, SubstreamProtocol<TInbound, ()>: Clone, TEvent: Debug + Send + 'static,

type InEvent = TOutbound

Custom event that can be received from the outside.

type OutEvent = TEvent

Custom event that can be produced by the handler and that will be returned to the outside.

type Error = ConnectionHandlerUpgrErr<<<OneShotHandler<TInbound, TOutbound, TEvent> as ConnectionHandler>::OutboundProtocol as OutboundUpgradeSend>::Error>

The type of errors returned by ConnectionHandler::poll.

type InboundProtocol = TInbound

The inbound upgrade for the protocol(s) used by the handler.

type OutboundProtocol = TOutbound

The outbound upgrade for the protocol(s) used by the handler.

type OutboundOpenInfo = ()

The type of additional information passed to an OutboundSubstreamRequest.

type InboundOpenInfo = ()

The type of additional information returned from listen_protocol.

fn listen_protocol( &self ) -> SubstreamProtocol<<OneShotHandler<TInbound, TOutbound, TEvent> as ConnectionHandler>::InboundProtocol, <OneShotHandler<TInbound, TOutbound, TEvent> as ConnectionHandler>::InboundOpenInfo>

The InboundUpgrade to apply on inbound substreams to negotiate the desired protocols.

fn on_behaviour_event( &mut self, event: <OneShotHandler<TInbound, TOutbound, TEvent> as ConnectionHandler>::InEvent )

Informs the handler about an event from the NetworkBehaviour.

fn connection_keep_alive(&self) -> KeepAlive

Returns until when the connection should be kept alive.

fn poll( &mut self, _: &mut Context<'_> ) -> Poll<ConnectionHandlerEvent<<OneShotHandler<TInbound, TOutbound, TEvent> as ConnectionHandler>::OutboundProtocol, <OneShotHandler<TInbound, TOutbound, TEvent> as ConnectionHandler>::OutboundOpenInfo, <OneShotHandler<TInbound, TOutbound, TEvent> as ConnectionHandler>::OutEvent, <OneShotHandler<TInbound, TOutbound, TEvent> as ConnectionHandler>::Error>>

Should behave like Stream::poll().

fn on_connection_event( &mut self, event: ConnectionEvent<'_, <OneShotHandler<TInbound, TOutbound, TEvent> as ConnectionHandler>::InboundProtocol, <OneShotHandler<TInbound, TOutbound, TEvent> as ConnectionHandler>::OutboundProtocol, <OneShotHandler<TInbound, TOutbound, TEvent> as ConnectionHandler>::InboundOpenInfo, <OneShotHandler<TInbound, TOutbound, TEvent> as ConnectionHandler>::OutboundOpenInfo> )

fn inject_fully_negotiated_inbound( &mut self, protocol: <Self::InboundProtocol as InboundUpgradeSend>::Output, info: Self::InboundOpenInfo )

👎Deprecated since 0.41.0: Handle ConnectionEvent::FullyNegotiatedInbound on ConnectionHandler::on_connection_event instead. The default implemention of this inject_* method delegates to it.

Injects the output of a successful upgrade on a new inbound substream.

fn inject_fully_negotiated_outbound( &mut self, protocol: <Self::OutboundProtocol as OutboundUpgradeSend>::Output, info: Self::OutboundOpenInfo )

👎Deprecated since 0.41.0: Handle ConnectionEvent::FullyNegotiatedOutbound on ConnectionHandler::on_connection_event instead. The default implemention of this inject_* method delegates to it.

Injects the output of a successful upgrade on a new outbound substream.

fn inject_event(&mut self, event: Self::InEvent)

👎Deprecated since 0.41.0: Implement ConnectionHandler::on_behaviour_event instead. The default implementation of inject_event delegates to it.

Injects an event coming from the outside in the handler.

fn inject_address_change(&mut self, new_address: &Multiaddr)

👎Deprecated since 0.41.0: Handle ConnectionEvent::AddressChange on ConnectionHandler::on_connection_event instead. The default implemention of this inject_* method delegates to it.

Notifies the handler of a change in the address of the remote.

fn inject_dial_upgrade_error( &mut self, info: Self::OutboundOpenInfo, error: ConnectionHandlerUpgrErr<<Self::OutboundProtocol as OutboundUpgradeSend>::Error> )

👎Deprecated since 0.41.0: Handle ConnectionEvent::DialUpgradeError on ConnectionHandler::on_connection_event instead. The default implemention of this inject_* method delegates to it.

Indicates to the handler that upgrading an outbound substream to the given protocol has failed.

fn inject_listen_upgrade_error( &mut self, info: Self::InboundOpenInfo, error: ConnectionHandlerUpgrErr<<Self::InboundProtocol as InboundUpgradeSend>::Error> )

👎Deprecated since 0.41.0: Handle ConnectionEvent::ListenUpgradeError on ConnectionHandler::on_connection_event instead. The default implemention of this inject_* method delegates to it.

Indicates to the handler that upgrading an inbound substream to the given protocol has failed.

fn map_in_event<TNewIn, TMap>(self, map: TMap) -> MapInEvent<Self, TNewIn, TMap>where Self: Sized, TMap: Fn(&TNewIn) -> Option<&Self::InEvent>,

Adds a closure that turns the input event into something else.

fn map_out_event<TMap, TNewOut>(self, map: TMap) -> MapOutEvent<Self, TMap>where Self: Sized, TMap: FnMut(Self::OutEvent) -> TNewOut,

Adds a closure that turns the output event into something else.

fn select<TProto2>( self, other: TProto2 ) -> ConnectionHandlerSelect<Self, TProto2>where Self: Sized,

Creates a new ConnectionHandler that selects either this handler or other by delegating methods calls appropriately.

impl<TInbound, TOutbound, TEvent> Default for OneShotHandler<TInbound, TOutbound, TEvent>where TOutbound: OutboundUpgradeSend, TInbound: InboundUpgradeSend + Default,

fn default() -> OneShotHandler<TInbound, TOutbound, TEvent>

Returns the “default value” for a type.