Struct libp2p_swarm::handler::multi::MultiHandler

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

A ConnectionHandler for multiple ConnectionHandlers of the same type.

Implementations

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

pub fn try_from_iter<I>(iter: I) -> Result<Self, 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.

Trait Implementations

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

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> ConnectionHandler for MultiHandler<K, H>where
    K: Clone + Debug + Hash + Eq + Send + 'static,
    H: ConnectionHandler,
    H::InboundProtocol: InboundUpgradeSend,
    H::OutboundProtocol: OutboundUpgradeSend,

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

Custom event that can be received from the outside.

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

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

type Error = <H as ConnectionHandler>::Error

The type of errors returned by ConnectionHandler::poll.

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

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

type OutboundProtocol = <H as ConnectionHandler>::OutboundProtocol

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

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

The type of additional information returned from listen_protocol.

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

The type of additional information passed to an OutboundSubstreamRequest.

fn listen_protocol(
    &self
) -> SubstreamProtocol<Self::InboundProtocol, Self::InboundOpenInfo>

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

fn inject_fully_negotiated_outbound(
    &mut self,
    protocol: <Self::OutboundProtocol as OutboundUpgradeSend>::Output,
    (key, arg): Self::OutboundOpenInfo
)

👎Deprecated since 0.41.0: Handle ConnectionEvent::FullyNegotiatedOutbound on ConnectionHandler::on_connection_event instead. The default implemention of this inject_* method delegates to it.

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

fn inject_fully_negotiated_inbound(
    &mut self,
    (key, arg): <Self::InboundProtocol as InboundUpgradeSend>::Output,
    info: Self::InboundOpenInfo
)

👎Deprecated since 0.41.0: Handle ConnectionEvent::FullyNegotiatedInbound on ConnectionHandler::on_connection_event instead. The default implemention of this inject_* method delegates to it.

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

fn on_behaviour_event(&mut self, (key, event): Self::InEvent)

Informs the handler about an event from the NetworkBehaviour.

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

👎Deprecated since 0.41.0: Handle ConnectionEvent::AddressChange on ConnectionHandler::on_connection_event instead. The default implemention of this inject_* method delegates to it.

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

fn inject_dial_upgrade_error(
    &mut self,
    (key, arg): Self::OutboundOpenInfo,
    error: ConnectionHandlerUpgrErr<<Self::OutboundProtocol as OutboundUpgradeSend>::Error>
)

👎Deprecated since 0.41.0: Handle ConnectionEvent::DialUpgradeError on ConnectionHandler::on_connection_event instead. The default implemention of this inject_* method delegates to it.

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

fn inject_listen_upgrade_error(
    &mut self,
    info: Self::InboundOpenInfo,
    error: ConnectionHandlerUpgrErr<<Self::InboundProtocol as InboundUpgradeSend>::Error>
)

👎Deprecated since 0.41.0: Handle ConnectionEvent::ListenUpgradeError on ConnectionHandler::on_connection_event instead. The default implemention of this inject_* method delegates to it.

Indicates to the handler that upgrading an inbound 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,
    cx: &mut Context<'_>
) -> Poll<ConnectionHandlerEvent<Self::OutboundProtocol, Self::OutboundOpenInfo, Self::OutEvent, Self::Error>>

Should behave like Stream::poll().

fn inject_event(&mut self, event: Self::InEvent)

👎Deprecated since 0.41.0: Implement ConnectionHandler::on_behaviour_event instead. The default implementation of inject_event delegates to it.

Injects an event coming from the outside in the handler.

fn map_in_event<TNewIn, TMap>(self, map: TMap) -> MapInEvent<Self, TNewIn, TMap>where
    Self: Sized,
    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
    Self: Sized,
    TMap: FnMut(Self::OutEvent) -> TNewOut,

Adds a closure that turns the output event into something else.

fn select<TProto2>(
    self,
    other: TProto2
) -> ConnectionHandlerSelect<Self, TProto2>where
    Self: Sized,

Creates a new ConnectionHandler that selects either this handler or other by delegating methods calls appropriately.

fn on_connection_event(
    &mut self,
    _event: ConnectionEvent<'_, Self::InboundProtocol, Self::OutboundProtocol, Self::InboundOpenInfo, Self::OutboundOpenInfo>
)

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

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

Formats the value using the given formatter.

impl<K, H> IntoIterator for MultiHandler<K, H>

Split MultiHandler into parts.

type Item = <<MultiHandler<K, H> as IntoIterator>::IntoIter as Iterator>::Item

The type of the elements being iterated over.

type IntoIter = IntoIter<K, H>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.