Struct libp2p_swarm::protocols_handler::multi::MultiHandler
source · [−]pub struct MultiHandler<K, H> { /* private fields */ }
Expand description
A ProtocolsHandler
for multiple ProtocolsHandler
s of the same type.
Implementations
pub fn try_from_iter<I>(iter: I) -> Result<Self, DuplicateProtonameError> where
I: IntoIterator<Item = (K, H)>,
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, H> ProtocolsHandler for MultiHandler<K, H> where
K: Clone + Debug + Hash + Eq + Send + 'static,
H: ProtocolsHandler,
H::InboundProtocol: InboundUpgradeSend,
H::OutboundProtocol: OutboundUpgradeSend,
impl<K, H> ProtocolsHandler for MultiHandler<K, H> where
K: Clone + Debug + Hash + Eq + Send + 'static,
H: ProtocolsHandler,
H::InboundProtocol: InboundUpgradeSend,
H::OutboundProtocol: OutboundUpgradeSend,
type InEvent = (K, <H as ProtocolsHandler>::InEvent)
type InEvent = (K, <H as ProtocolsHandler>::InEvent)
Custom event that can be received from the outside.
type OutEvent = (K, <H as ProtocolsHandler>::OutEvent)
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
type Error = <H as ProtocolsHandler>::Error
The type of errors returned by ProtocolsHandler::poll
.
type InboundProtocol = Upgrade<K, <H as ProtocolsHandler>::InboundProtocol>
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
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>
type InboundOpenInfo = Info<K, <H as ProtocolsHandler>::InboundOpenInfo>
The type of additional information returned from listen_protocol
.
type OutboundOpenInfo = (K, <H as ProtocolsHandler>::OutboundOpenInfo)
type OutboundOpenInfo = (K, <H as ProtocolsHandler>::OutboundOpenInfo)
The type of additional information passed to an OutboundSubstreamRequest
.
The InboundUpgrade
to apply on inbound
substreams to negotiate the desired protocols. Read more
fn inject_fully_negotiated_outbound(
&mut self,
protocol: <Self::OutboundProtocol as OutboundUpgradeSend>::Output,
(key, arg): Self::OutboundOpenInfo
)
fn inject_fully_negotiated_outbound(
&mut self,
protocol: <Self::OutboundProtocol as OutboundUpgradeSend>::Output,
(key, arg): Self::OutboundOpenInfo
)
Injects the output of a successful upgrade on a new outbound substream. Read more
fn inject_fully_negotiated_inbound(
&mut self,
(key, arg): <Self::InboundProtocol as InboundUpgradeSend>::Output,
info: Self::InboundOpenInfo
)
fn inject_fully_negotiated_inbound(
&mut self,
(key, arg): <Self::InboundProtocol as InboundUpgradeSend>::Output,
info: Self::InboundOpenInfo
)
Injects the output of a successful upgrade on a new inbound substream.
Injects an event coming from the outside in the handler.
Notifies the handler of a change in the address of the remote.
fn inject_dial_upgrade_error(
&mut self,
(key, arg): Self::OutboundOpenInfo,
error: ProtocolsHandlerUpgrErr<<Self::OutboundProtocol as OutboundUpgradeSend>::Error>
)
fn inject_dial_upgrade_error(
&mut self,
(key, arg): Self::OutboundOpenInfo,
error: ProtocolsHandlerUpgrErr<<Self::OutboundProtocol as OutboundUpgradeSend>::Error>
)
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: ProtocolsHandlerUpgrErr<<Self::InboundProtocol as InboundUpgradeSend>::Error>
)
fn inject_listen_upgrade_error(
&mut self,
info: Self::InboundOpenInfo,
error: ProtocolsHandlerUpgrErr<<Self::InboundProtocol as InboundUpgradeSend>::Error>
)
Indicates to the handler that upgrading an inbound substream to the given protocol has failed.
Returns until when the connection should be kept alive. Read more
fn poll(
&mut self,
cx: &mut Context<'_>
) -> Poll<ProtocolsHandlerEvent<Self::OutboundProtocol, Self::OutboundOpenInfo, Self::OutEvent, Self::Error>>
fn poll(
&mut self,
cx: &mut Context<'_>
) -> Poll<ProtocolsHandlerEvent<Self::OutboundProtocol, Self::OutboundOpenInfo, Self::OutEvent, Self::Error>>
Should behave like Stream::poll()
.
fn map_in_event<TNewIn, TMap>(self, map: TMap) -> MapInEvent<Self, TNewIn, TMap> where
Self: Sized,
TMap: Fn(&TNewIn) -> Option<&Self::InEvent>,
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,
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
) -> ProtocolsHandlerSelect<Self, TProto2> where
Self: Sized,
fn select<TProto2>(
self,
other: TProto2
) -> ProtocolsHandlerSelect<Self, TProto2> where
Self: Sized,
Creates a new ProtocolsHandler
that selects either this handler or
other
by delegating methods calls appropriately. Read more
Creates a builder that allows creating a NodeHandler
that handles this protocol
exclusively. Read more
Auto Trait Implementations
impl<K, H> RefUnwindSafe for MultiHandler<K, H> where
H: RefUnwindSafe,
K: RefUnwindSafe,
impl<K, H> Send for MultiHandler<K, H> where
H: Send,
K: Send,
impl<K, H> Sync for MultiHandler<K, H> where
H: Sync,
K: Sync,
impl<K, H> Unpin for MultiHandler<K, H> where
H: Unpin,
K: Unpin,
impl<K, H> UnwindSafe for MultiHandler<K, H> where
H: UnwindSafe,
K: UnwindSafe,
Blanket Implementations
Mutably borrows from an owned value. Read more
type Handler = Self
type Handler = Self
The protocols handler.
Builds the protocols handler. Read more
Return the handler’s inbound protocol.
fn select<TProto2>(
self,
other: TProto2
) -> IntoProtocolsHandlerSelect<Self, TProto2> where
Self: Sized,
fn select<TProto2>(
self,
other: TProto2
) -> IntoProtocolsHandlerSelect<Self, TProto2> where
Self: Sized,
Builds an implementation of IntoProtocolsHandler
that handles both this protocol and the
other one together. Read more
Creates a builder that will allow creating a NodeHandler
that handles this protocol
exclusively. Read more