Struct libp2p::swarm::OneShotHandler

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

A ProtocolsHandler 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> Default for OneShotHandler<TInbound, TOutbound, TEvent> where
    TInbound: InboundUpgradeSend + Default,
    TOutbound: OutboundUpgradeSend, 

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

Returns the “default value” for a type.

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

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 = ProtocolsHandlerUpgrErr<<<OneShotHandler<TInbound, TOutbound, TEvent> as ProtocolsHandler>::OutboundProtocol as OutboundUpgradeSend>::Error>

The type of errors returned by ProtocolsHandler::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.

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

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

pub fn inject_fully_negotiated_inbound(
    &mut self,
    out: <<OneShotHandler<TInbound, TOutbound, TEvent> as ProtocolsHandler>::InboundProtocol as InboundUpgradeSend>::Output,
    <OneShotHandler<TInbound, TOutbound, TEvent> as ProtocolsHandler>::InboundOpenInfo
)

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

pub fn inject_fully_negotiated_outbound(
    &mut self,
    out: <<OneShotHandler<TInbound, TOutbound, TEvent> as ProtocolsHandler>::OutboundProtocol as OutboundUpgradeSend>::Output,
    <OneShotHandler<TInbound, TOutbound, TEvent> as ProtocolsHandler>::OutboundOpenInfo
)

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

pub fn inject_event(
    &mut self,
    event: <OneShotHandler<TInbound, TOutbound, TEvent> as ProtocolsHandler>::InEvent
)

Injects an event coming from the outside in the handler.

pub fn inject_dial_upgrade_error(
    &mut self,
    _info: <OneShotHandler<TInbound, TOutbound, TEvent> as ProtocolsHandler>::OutboundOpenInfo,
    error: ProtocolsHandlerUpgrErr<<<OneShotHandler<TInbound, TOutbound, TEvent> as ProtocolsHandler>::OutboundProtocol as OutboundUpgradeSend>::Error>
)

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

pub fn connection_keep_alive(&self) -> KeepAlive

Returns until when the connection should be kept alive.

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

Should behave like Stream::poll().

pub fn inject_address_change(&mut self, _new_address: &Multiaddr)

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

pub fn inject_listen_upgrade_error(
    &mut self,
    Self::InboundOpenInfo,
    ProtocolsHandlerUpgrErr<<Self::InboundProtocol as InboundUpgradeSend>::Error>
)

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

pub 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.

pub 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.

pub 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.

pub fn into_node_handler_builder(self) -> NodeHandlerWrapperBuilder<Self>

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