Struct libp2p::swarm::protocols_handler::DummyProtocolsHandler

pub struct DummyProtocolsHandler {
    pub keep_alive: KeepAlive,
}

Implementation of ProtocolsHandler that doesn’t handle anything.

Fields

keep_alive: KeepAlive

Trait Implementations

impl Clone for DummyProtocolsHandler

pub fn clone(&self) -> DummyProtocolsHandler

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DummyProtocolsHandler

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

Formats the value using the given formatter.

impl Default for DummyProtocolsHandler

pub fn default() -> DummyProtocolsHandler

Returns the “default value” for a type.

impl ProtocolsHandler for DummyProtocolsHandler

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

type InboundOpenInfo = ()

The type of additional information returned from listen_protocol.

pub fn listen_protocol(
    &self
) -> SubstreamProtocol<<DummyProtocolsHandler as ProtocolsHandler>::InboundProtocol, <DummyProtocolsHandler as ProtocolsHandler>::InboundOpenInfo>

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

pub fn inject_fully_negotiated_inbound(
    &mut self,
    <<DummyProtocolsHandler as ProtocolsHandler>::InboundProtocol as InboundUpgrade<Negotiated<SubstreamRef<Arc<StreamMuxerBox>>>>>::Output,
    <DummyProtocolsHandler as ProtocolsHandler>::InboundOpenInfo
)

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

pub fn inject_fully_negotiated_outbound(
    &mut self,
    <<DummyProtocolsHandler as ProtocolsHandler>::OutboundProtocol as OutboundUpgrade<Negotiated<SubstreamRef<Arc<StreamMuxerBox>>>>>::Output,
    <DummyProtocolsHandler as ProtocolsHandler>::OutboundOpenInfo
)

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

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

Injects an event coming from the outside in the handler.

pub fn inject_address_change(&mut self, &Multiaddr)

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

pub fn inject_dial_upgrade_error(
    &mut self,
    <DummyProtocolsHandler as ProtocolsHandler>::OutboundOpenInfo,
    ProtocolsHandlerUpgrErr<<<DummyProtocolsHandler as ProtocolsHandler>::OutboundProtocol as OutboundUpgrade<Negotiated<SubstreamRef<Arc<StreamMuxerBox>>>>>::Error>
)

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

pub fn inject_listen_upgrade_error(
    &mut self,
    <DummyProtocolsHandler as ProtocolsHandler>::InboundOpenInfo,
    ProtocolsHandlerUpgrErr<<<DummyProtocolsHandler as ProtocolsHandler>::InboundProtocol as InboundUpgrade<Negotiated<SubstreamRef<Arc<StreamMuxerBox>>>>>::Error>
)

Indicates to the handler that upgrading an inbound 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<<DummyProtocolsHandler as ProtocolsHandler>::OutboundProtocol, <DummyProtocolsHandler as ProtocolsHandler>::OutboundOpenInfo, <DummyProtocolsHandler as ProtocolsHandler>::OutEvent, <DummyProtocolsHandler 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.