Struct libp2p::swarm::protocols_handler::multi::MultiHandler

pub struct MultiHandler<K, H> { /* private fields */ }

A ProtocolsHandler for multiple ProtocolsHandlers of the same type.

Implementations

impl<K, H> MultiHandler<K, H> where
    K: Hash + Eq,
    H: ProtocolsHandler, 

pub fn try_from_iter<I>(
    iter: I
) -> Result<MultiHandler<K, H>, DuplicateProtonameError> where
    I: IntoIterator<Item = (K, H)>, 

Create and populate a MultiHandler from the given handler iterator.

It is an error for any two protocols handlers to share the same protocol name.

Note: All handlers should use the same upgrade::Version for the inbound and outbound SubstreamProtocols.

Trait Implementations

impl<K, H> Clone for MultiHandler<K, H> where
    K: Clone,
    H: Clone, 

pub fn clone(&self) -> MultiHandler<K, H>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<K, H> Debug for MultiHandler<K, H> where
    K: Debug + Eq + Hash,
    H: Debug, 

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

Formats the value using the given formatter.

impl<K, H> ProtocolsHandler for MultiHandler<K, H> where
    K: 'static + Clone + Hash + Eq + Send,
    H: ProtocolsHandler,
    <H as ProtocolsHandler>::InboundProtocol: InboundUpgradeSend,
    <H as ProtocolsHandler>::OutboundProtocol: OutboundUpgradeSend, 

type InEvent = (K, <H as ProtocolsHandler>::InEvent)

Custom event that can be received from the outside.

type OutEvent = (K, <H as ProtocolsHandler>::OutEvent)

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

type Error = <H as ProtocolsHandler>::Error

The type of errors returned by ProtocolsHandler::poll.

type InboundProtocol = Upgrade<K, <H as ProtocolsHandler>::InboundProtocol>

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

type OutboundProtocol = <H as ProtocolsHandler>::OutboundProtocol

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

type InboundOpenInfo = Info<K, <H as ProtocolsHandler>::InboundOpenInfo>

The type of additional information returned from listen_protocol.

type OutboundOpenInfo = (K, <H as ProtocolsHandler>::OutboundOpenInfo)

The type of additional information passed to an OutboundSubstreamRequest.

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

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

pub fn inject_fully_negotiated_outbound(
    &mut self,
    protocol: <<MultiHandler<K, H> as ProtocolsHandler>::OutboundProtocol as OutboundUpgradeSend>::Output,
    <MultiHandler<K, H> as ProtocolsHandler>::OutboundOpenInfo
)

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

pub fn inject_fully_negotiated_inbound(
    &mut self,
    <<MultiHandler<K, H> as ProtocolsHandler>::InboundProtocol as InboundUpgradeSend>::Output,
    info: <MultiHandler<K, H> as ProtocolsHandler>::InboundOpenInfo
)

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

pub fn inject_event(
    &mut self,
    <MultiHandler<K, H> 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,
    <MultiHandler<K, H> as ProtocolsHandler>::OutboundOpenInfo,
    error: ProtocolsHandlerUpgrErr<<<MultiHandler<K, H> 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: <MultiHandler<K, H> as ProtocolsHandler>::InboundOpenInfo,
    error: ProtocolsHandlerUpgrErr<<<MultiHandler<K, H> 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<<MultiHandler<K, H> as ProtocolsHandler>::OutboundProtocol, <MultiHandler<K, H> as ProtocolsHandler>::OutboundOpenInfo, <MultiHandler<K, H> as ProtocolsHandler>::OutEvent, <MultiHandler<K, H> 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.