Struct libp2p::core::protocols_handler::ProtocolsHandlerSelect

pub struct ProtocolsHandlerSelect<TProto1, TProto2> { /* fields omitted */ }

Implementation of ProtocolsHandler that combines two protocols into one.

Trait Implementations

impl<TSubstream, TProto1, TProto2> ProtocolsHandler for ProtocolsHandlerSelect<TProto1, TProto2> where
    TProto1: ProtocolsHandler<Substream = TSubstream>,
    TProto2: ProtocolsHandler<Substream = TSubstream>,
    TSubstream: AsyncRead + AsyncWrite,
    <TProto1 as ProtocolsHandler>::InboundProtocol: InboundUpgrade<TSubstream>,
    <TProto2 as ProtocolsHandler>::InboundProtocol: InboundUpgrade<TSubstream>,
    <TProto1 as ProtocolsHandler>::OutboundProtocol: OutboundUpgrade<TSubstream>,
    <TProto2 as ProtocolsHandler>::OutboundProtocol: OutboundUpgrade<TSubstream>, 

type InEvent = EitherOutput<<TProto1 as ProtocolsHandler>::InEvent, <TProto2 as ProtocolsHandler>::InEvent>

Custom event that can be received from the outside.

type OutEvent = EitherOutput<<TProto1 as ProtocolsHandler>::OutEvent, <TProto2 as ProtocolsHandler>::OutEvent>

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

type Error = EitherError<<TProto1 as ProtocolsHandler>::Error, <TProto2 as ProtocolsHandler>::Error>

Error that can happen when polling.

type Substream = TSubstream

The type of the substream that contains the raw data.

type InboundProtocol = SelectUpgrade<<Fuse<TProto1> as ProtocolsHandler>::InboundProtocol, <Fuse<TProto2> as ProtocolsHandler>::InboundProtocol>

The upgrade for the protocol or protocols handled by this handler.

type OutboundProtocol = EitherUpgrade<<TProto1 as ProtocolsHandler>::OutboundProtocol, <TProto2 as ProtocolsHandler>::OutboundProtocol>

The upgrade for the protocol or protocols handled by this handler.

type OutboundOpenInfo = EitherOutput<<TProto1 as ProtocolsHandler>::OutboundOpenInfo, <TProto2 as ProtocolsHandler>::OutboundOpenInfo>

Information about a substream. Can be sent to the handler through a NodeHandlerEndpoint, and will be passed back in inject_substream or inject_outbound_closed.

fn listen_protocol(
    &self
) -> <ProtocolsHandlerSelect<TProto1, TProto2> as ProtocolsHandler>::InboundProtocol

Produces a ConnectionUpgrade for the protocol or protocols to accept when listening.

fn inject_fully_negotiated_outbound(
    &mut self,
    protocol: <<ProtocolsHandlerSelect<TProto1, TProto2> as ProtocolsHandler>::OutboundProtocol as OutboundUpgrade<TSubstream>>::Output,
    endpoint: <ProtocolsHandlerSelect<TProto1, TProto2> as ProtocolsHandler>::OutboundOpenInfo
)

fn inject_fully_negotiated_inbound(
    &mut self,
    protocol: <<ProtocolsHandlerSelect<TProto1, TProto2> as ProtocolsHandler>::InboundProtocol as InboundUpgrade<TSubstream>>::Output
)

Injects a fully-negotiated substream in the handler.

fn inject_event(
    &mut self,
    event: <ProtocolsHandlerSelect<TProto1, TProto2> as ProtocolsHandler>::InEvent
)

Injects an event coming from the outside in the handler.

fn inject_inbound_closed(&mut self)

Indicates to the handler that the inbound part of the muxer has been closed, and that therefore no more inbound substreams will be produced.

fn inject_dial_upgrade_error(
    &mut self,
    info: <ProtocolsHandlerSelect<TProto1, TProto2> as ProtocolsHandler>::OutboundOpenInfo,
    error: ProtocolsHandlerUpgrErr<<<ProtocolsHandlerSelect<TProto1, TProto2> as ProtocolsHandler>::OutboundProtocol as OutboundUpgrade<<ProtocolsHandlerSelect<TProto1, TProto2> as ProtocolsHandler>::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 shutdown(&mut self)

Indicates to the node that it should shut down. After that, it is expected that poll() returns Ready(ProtocolsHandlerEvent::Shutdown) as soon as possible.

fn poll(
    &mut self
) -> Result<Async<ProtocolsHandlerEvent<<ProtocolsHandlerSelect<TProto1, TProto2> as ProtocolsHandler>::OutboundProtocol, <ProtocolsHandlerSelect<TProto1, TProto2> as ProtocolsHandler>::OutboundOpenInfo, <ProtocolsHandlerSelect<TProto1, TProto2> as ProtocolsHandler>::OutEvent>>, <ProtocolsHandlerSelect<TProto1, TProto2> as ProtocolsHandler>::Error>

Should behave like Stream::poll(). Should close if no more event can be produced and the node should be closed.

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 fuse(self) -> Fuse<Self>

Wraps around self. When poll() returns Shutdown, any further call to any method will be ignored.

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

Builds an implementation of ProtocolsHandler that handles both this protocol and the other one together.

fn into_node_handler_builder(self) -> NodeHandlerWrapperBuilder<Self>

Creates a builder that will allow 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.

impl<TProto1, TProto2> Clone for ProtocolsHandlerSelect<TProto1, TProto2> where
    TProto1: Clone,
    TProto2: Clone, 

fn clone(&self) -> ProtocolsHandlerSelect<TProto1, TProto2>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<TProto1, TProto2> Debug for ProtocolsHandlerSelect<TProto1, TProto2> where
    TProto1: Debug,
    TProto2: Debug, 

fn fmt(&self, f: &mut Formatter) -> Result<(), Error>

Formats the value using the given formatter.