Struct libp2p::swarm::protocols_handler::DummyProtocolsHandler

pub struct DummyProtocolsHandler<TSubstream> { /* fields omitted */ }

Implementation of ProtocolsHandler that doesn't handle anything.

Trait Implementations

impl<TSubstream> ProtocolsHandler for DummyProtocolsHandler<TSubstream> where
    TSubstream: AsyncRead + AsyncWrite, 

type InEvent = Void

Custom event that can be received from the outside.

type OutEvent = Void

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

type Error = Void

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

type Substream = TSubstream

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

type InboundProtocol = DeniedUpgrade

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

type OutboundProtocol = DeniedUpgrade

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

type OutboundOpenInfo = Void

The type of additional information passed to an OutboundSubstreamRequest.

fn listen_protocol(
    &self
) -> SubstreamProtocol<<DummyProtocolsHandler<TSubstream> as ProtocolsHandler>::InboundProtocol>

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

fn inject_fully_negotiated_inbound(
    &mut self,
    <<DummyProtocolsHandler<TSubstream> as ProtocolsHandler>::InboundProtocol as InboundUpgrade<TSubstream>>::Output
)

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

fn inject_fully_negotiated_outbound(
    &mut self,
    <<DummyProtocolsHandler<TSubstream> as ProtocolsHandler>::OutboundProtocol as OutboundUpgrade<TSubstream>>::Output,
    <DummyProtocolsHandler<TSubstream> as ProtocolsHandler>::OutboundOpenInfo
)

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

fn inject_event(
    &mut self,
    <DummyProtocolsHandler<TSubstream> as ProtocolsHandler>::InEvent
)

Injects an event coming from the outside in the handler.

fn inject_dial_upgrade_error(
    &mut self,
    <DummyProtocolsHandler<TSubstream> as ProtocolsHandler>::OutboundOpenInfo,
    ProtocolsHandlerUpgrErr<<<DummyProtocolsHandler<TSubstream> as ProtocolsHandler>::OutboundProtocol as OutboundUpgrade<<DummyProtocolsHandler<TSubstream> 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 poll(
    &mut self
) -> Result<Async<ProtocolsHandlerEvent<<DummyProtocolsHandler<TSubstream> as ProtocolsHandler>::OutboundProtocol, <DummyProtocolsHandler<TSubstream> as ProtocolsHandler>::OutboundOpenInfo, <DummyProtocolsHandler<TSubstream> as ProtocolsHandler>::OutEvent>>, Void>

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.

impl<TSubstream> Default for DummyProtocolsHandler<TSubstream>

fn default() -> DummyProtocolsHandler<TSubstream>

Returns the "default value" for a type.