Struct susyp2p_core::protocols_handler::OneShotHandler

pub struct OneShotHandler<TSubstream, TInProto, TOutProto, TOutEvent> where
    TOutProto: OutboundUpgrade<TSubstream>,  { /* 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<TSubstream, TInProto, TOutProto, TOutEvent> OneShotHandler<TSubstream, TInProto, TOutProto, TOutEvent> where
    TOutProto: OutboundUpgrade<TSubstream>, 

pub fn new(
    listen_protocol: SubstreamProtocol<TInProto>,
    inactive_timeout: Duration
) -> Self

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<TSubstream, TInProto, TOutProto, TOutEvent> ProtocolsHandler for OneShotHandler<TSubstream, TInProto, TOutProto, TOutEvent> where
    TSubstream: AsyncRead + AsyncWrite,
    TInProto: InboundUpgrade<TSubstream>,
    TOutProto: OutboundUpgrade<TSubstream>,
    TInProto::Output: Into<TOutEvent>,
    TOutProto::Output: Into<TOutEvent>,
    TOutProto::Error: 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<<Self::OutboundProtocol as OutboundUpgrade<Self::Substream>>::Error>

The type of errors returned by ProtocolsHandler::poll.

type Substream = TSubstream

The type of substreams on which the protocol(s) are negotiated.

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<Self::InboundProtocol>

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

fn inject_fully_negotiated_inbound(
    &mut self,
    out: <Self::InboundProtocol as InboundUpgrade<Self::Substream>>::Output
)

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

fn inject_fully_negotiated_outbound(
    &mut self,
    out: <Self::OutboundProtocol as OutboundUpgrade<Self::Substream>>::Output,
    _: Self::OutboundOpenInfo
)

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

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

Injects an event coming from the outside in the handler.

fn inject_dial_upgrade_error(
    &mut self,
    _: Self::OutboundOpenInfo,
    error: ProtocolsHandlerUpgrErr<<Self::OutboundProtocol as OutboundUpgrade<Self::Substream>>::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
) -> Poll<ProtocolsHandlerEvent<Self::OutboundProtocol, Self::OutboundOpenInfo, Self::OutEvent>, Self::Error>

Should behave like Stream::poll().

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
) -> ProtocolsHandlerSelect<Self, TProto2> where
    Self: Sized, 

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

fn into_node_handler_builder(self) -> NodeHandlerWrapperBuilder<Self> where
    Self: Sized, 

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

fn into_node_handler(self) -> NodeHandlerWrapper<Self> where
    Self: Sized, 

Deprecated:

Use into_node_handler_builder instead

Builds an implementation of NodeHandler that handles this protocol exclusively.

impl<TSubstream, TInProto, TOutProto, TOutEvent> Default for OneShotHandler<TSubstream, TInProto, TOutProto, TOutEvent> where
    TOutProto: OutboundUpgrade<TSubstream>,
    TInProto: InboundUpgrade<TSubstream> + Default, 

fn default() -> Self

Returns the "default value" for a type.