Struct libp2p::swarm::toggle::ToggleProtoHandler

pub struct ToggleProtoHandler<TInner> { /* fields omitted */ }

Implementation of ProtocolsHandler that can be in the disabled state.

Trait Implementations

impl<TInner> ProtocolsHandler for ToggleProtoHandler<TInner> where
    TInner: ProtocolsHandler, 

type InEvent = <TInner as ProtocolsHandler>::InEvent

Custom event that can be received from the outside.

type OutEvent = <TInner as ProtocolsHandler>::OutEvent

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

type Error = <TInner as ProtocolsHandler>::Error

The type of errors returned by ProtocolsHandler::poll.

type InboundProtocol = EitherUpgrade<SendWrapper<<TInner as ProtocolsHandler>::InboundProtocol>, SendWrapper<DeniedUpgrade>>

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

type OutboundProtocol = <TInner as ProtocolsHandler>::OutboundProtocol

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

type OutboundOpenInfo = <TInner as ProtocolsHandler>::OutboundOpenInfo

The type of additional information passed to an OutboundSubstreamRequest.

type InboundOpenInfo = Either<<TInner as ProtocolsHandler>::InboundOpenInfo, ()>

The type of additional information returned from listen_protocol.

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

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

pub fn inject_fully_negotiated_inbound(
    &mut self,
    out: <<ToggleProtoHandler<TInner> as ProtocolsHandler>::InboundProtocol as InboundUpgradeSend>::Output,
    info: <ToggleProtoHandler<TInner> as ProtocolsHandler>::InboundOpenInfo
)

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

pub fn inject_fully_negotiated_outbound(
    &mut self,
    out: <<ToggleProtoHandler<TInner> as ProtocolsHandler>::OutboundProtocol as OutboundUpgradeSend>::Output,
    info: <ToggleProtoHandler<TInner> as ProtocolsHandler>::OutboundOpenInfo
)

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

pub fn inject_event(
    &mut self,
    event: <ToggleProtoHandler<TInner> as ProtocolsHandler>::InEvent
)

Injects an event coming from the outside in the handler.

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

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

pub fn inject_dial_upgrade_error(
    &mut self,
    info: <ToggleProtoHandler<TInner> as ProtocolsHandler>::OutboundOpenInfo,
    err: ProtocolsHandlerUpgrErr<<<ToggleProtoHandler<TInner> as ProtocolsHandler>::OutboundProtocol as OutboundUpgradeSend>::Error>
)

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

pub fn inject_listen_upgrade_error(
    &mut self,
    info: <ToggleProtoHandler<TInner> as ProtocolsHandler>::InboundOpenInfo,
    err: ProtocolsHandlerUpgrErr<<<ToggleProtoHandler<TInner> as ProtocolsHandler>::InboundProtocol as InboundUpgradeSend>::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,
    cx: &mut Context<'_>
) -> Poll<ProtocolsHandlerEvent<<ToggleProtoHandler<TInner> as ProtocolsHandler>::OutboundProtocol, <ToggleProtoHandler<TInner> as ProtocolsHandler>::OutboundOpenInfo, <ToggleProtoHandler<TInner> as ProtocolsHandler>::OutEvent, <ToggleProtoHandler<TInner> as ProtocolsHandler>::Error>>

Should behave like Stream::poll().

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.