Struct libp2p::swarm::OneShotHandler

pub struct OneShotHandler<TInProto, TOutProto, TOutEvent> where
    TOutProto: OutboundUpgradeSend,  { /* fields omitted */ }

Implementation of ProtocolsHandler that opens a new substream for each individual message.

This struct is meant to be a helper for other implementations to use.

Methods

impl<TInProto, TOutProto, TOutEvent> OneShotHandler<TInProto, TOutProto, TOutEvent> where
    TOutProto: OutboundUpgradeSend, 

pub fn new(
    listen_protocol: SubstreamProtocol<TInProto>,
    inactive_timeout: Duration
) -> OneShotHandler<TInProto, TOutProto, TOutEvent>

Creates a OneShotHandler.

pub fn pending_requests(&self) -> u32

Returns the number of pending requests.

pub fn listen_protocol_ref(&self) -> &SubstreamProtocol<TInProto>

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<TInProto>

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: TOutProto)

Opens an outbound substream with upgrade.

Trait Implementations

impl<TInProto, TOutProto, TOutEvent> Default for OneShotHandler<TInProto, TOutProto, TOutEvent> where
    TInProto: InboundUpgradeSend + Default,
    TOutProto: OutboundUpgradeSend, 

fn default() -> OneShotHandler<TInProto, TOutProto, TOutEvent>

Returns the "default value" for a type.

impl<TInProto, TOutProto, TOutEvent> ProtocolsHandler for OneShotHandler<TInProto, TOutProto, TOutEvent> where
    TInProto: InboundUpgradeSend + Send + 'static,
    TOutEvent: Send + 'static,
    TOutProto: OutboundUpgradeSend,
    <TInProto as InboundUpgradeSend>::Output: Into<TOutEvent>,
    <TOutProto as OutboundUpgradeSend>::Output: Into<TOutEvent>,
    <TOutProto as OutboundUpgradeSend>::Error: Error,
    <TOutProto as OutboundUpgradeSend>::Error: Send,
    <TOutProto as OutboundUpgradeSend>::Error: 'static,
    SubstreamProtocol<TInProto>: Clone, 

type InEvent = TOutProto

Custom event that can be received from the outside.

type OutEvent = TOutEvent

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

type Error = ProtocolsHandlerUpgrErr<<<OneShotHandler<TInProto, TOutProto, TOutEvent> as ProtocolsHandler>::OutboundProtocol as OutboundUpgradeSend>::Error>

The type of errors returned by [ProtocolsHandler::poll].

type InboundProtocol = TInProto

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

type OutboundProtocol = TOutProto

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

type OutboundOpenInfo = ()

The type of additional information passed to an OutboundSubstreamRequest.

fn listen_protocol(
    &self
) -> SubstreamProtocol<<OneShotHandler<TInProto, TOutProto, TOutEvent> as ProtocolsHandler>::InboundProtocol>

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

fn inject_fully_negotiated_inbound(
    &mut self,
    out: <<OneShotHandler<TInProto, TOutProto, TOutEvent> as ProtocolsHandler>::InboundProtocol as InboundUpgradeSend>::Output
)

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

fn inject_fully_negotiated_outbound(
    &mut self,
    out: <<OneShotHandler<TInProto, TOutProto, TOutEvent> as ProtocolsHandler>::OutboundProtocol as OutboundUpgradeSend>::Output,
    <OneShotHandler<TInProto, TOutProto, TOutEvent> as ProtocolsHandler>::OutboundOpenInfo
)

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

fn inject_event(
    &mut self,
    event: <OneShotHandler<TInProto, TOutProto, TOutEvent> as ProtocolsHandler>::InEvent
)

Injects an event coming from the outside in the handler.

fn inject_dial_upgrade_error(
    &mut self,
    <OneShotHandler<TInProto, TOutProto, TOutEvent> as ProtocolsHandler>::OutboundOpenInfo,
    error: ProtocolsHandlerUpgrErr<<<OneShotHandler<TInProto, TOutProto, TOutEvent> as ProtocolsHandler>::OutboundProtocol as OutboundUpgradeSend>::Error>
)

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

fn connection_keep_alive(&self) -> KeepAlive

Returns until when the connection should be kept alive.

fn poll(
    &mut self,
    &mut Context
) -> Poll<ProtocolsHandlerEvent<<OneShotHandler<TInProto, TOutProto, TOutEvent> as ProtocolsHandler>::OutboundProtocol, <OneShotHandler<TInProto, TOutProto, TOutEvent> as ProtocolsHandler>::OutboundOpenInfo, <OneShotHandler<TInProto, TOutProto, TOutEvent> as ProtocolsHandler>::OutEvent, <OneShotHandler<TInProto, TOutProto, TOutEvent> as ProtocolsHandler>::Error>>

Should behave like Stream::poll().

fn map_in_event<TNewIn, TMap>(self, map: TMap) -> MapInEvent<Self, TNewIn, TMap> where
    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
    TMap: FnMut(Self::OutEvent) -> TNewOut, 

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

fn select<TProto2>(
    self,
    other: TProto2
) -> ProtocolsHandlerSelect<Self, TProto2>

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

fn into_node_handler_builder(self) -> NodeHandlerWrapperBuilder<Self>

Creates a builder that allows creating a NodeHandler that handles this protocol exclusively.

fn into_node_handler(self) -> NodeHandlerWrapper<Self>

Deprecated:

Use into_node_handler_builder instead

Builds an implementation of NodeHandler that handles this protocol exclusively.