Struct libp2p_swarm::handler::multi::MultiHandler
source · [−]pub struct MultiHandler<K, H> { /* private fields */ }
Expand description
A ConnectionHandler
for multiple ConnectionHandler
s of the same type.
Implementations
sourceimpl<K, H> MultiHandler<K, H> where
K: Hash + Eq,
H: ConnectionHandler,
impl<K, H> MultiHandler<K, H> where
K: Hash + Eq,
H: ConnectionHandler,
sourcepub 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
sourceimpl<K: Clone, H: Clone> Clone for MultiHandler<K, H>
impl<K: Clone, H: Clone> Clone for MultiHandler<K, H>
sourcefn clone(&self) -> MultiHandler<K, H>
fn clone(&self) -> MultiHandler<K, H>
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl<K, H> ConnectionHandler for MultiHandler<K, H> where
K: Clone + Debug + Hash + Eq + Send + 'static,
H: ConnectionHandler,
H::InboundProtocol: InboundUpgradeSend,
H::OutboundProtocol: OutboundUpgradeSend,
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)
type InEvent = (K, <H as ConnectionHandler>::InEvent)
Custom event that can be received from the outside.
type OutEvent = (K, <H as ConnectionHandler>::OutEvent)
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
type Error = <H as ConnectionHandler>::Error
The type of errors returned by ConnectionHandler::poll
.
type InboundProtocol = Upgrade<K, <H as ConnectionHandler>::InboundProtocol>
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
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>
type InboundOpenInfo = Info<K, <H as ConnectionHandler>::InboundOpenInfo>
The type of additional information returned from listen_protocol
.
type OutboundOpenInfo = (K, <H as ConnectionHandler>::OutboundOpenInfo)
type OutboundOpenInfo = (K, <H as ConnectionHandler>::OutboundOpenInfo)
The type of additional information passed to an OutboundSubstreamRequest
.
sourcefn listen_protocol(
&self
) -> SubstreamProtocol<Self::InboundProtocol, Self::InboundOpenInfo>
fn listen_protocol(
&self
) -> SubstreamProtocol<Self::InboundProtocol, Self::InboundOpenInfo>
The InboundUpgrade
to apply on inbound
substreams to negotiate the desired protocols. Read more
sourcefn 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
sourcefn 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.
sourcefn inject_event(&mut self, (key, event): Self::InEvent)
fn inject_event(&mut self, (key, event): Self::InEvent)
Injects an event coming from the outside in the handler.
sourcefn inject_address_change(&mut self, addr: &Multiaddr)
fn inject_address_change(&mut self, addr: &Multiaddr)
Notifies the handler of a change in the address of the remote.
sourcefn inject_dial_upgrade_error(
&mut self,
(key, arg): Self::OutboundOpenInfo,
error: ConnectionHandlerUpgrErr<<Self::OutboundProtocol as OutboundUpgradeSend>::Error>
)
fn inject_dial_upgrade_error(
&mut self,
(key, arg): Self::OutboundOpenInfo,
error: ConnectionHandlerUpgrErr<<Self::OutboundProtocol as OutboundUpgradeSend>::Error>
)
Indicates to the handler that upgrading an outbound substream to the given protocol has failed.
sourcefn inject_listen_upgrade_error(
&mut self,
info: Self::InboundOpenInfo,
error: ConnectionHandlerUpgrErr<<Self::InboundProtocol as InboundUpgradeSend>::Error>
)
fn inject_listen_upgrade_error(
&mut self,
info: Self::InboundOpenInfo,
error: ConnectionHandlerUpgrErr<<Self::InboundProtocol as InboundUpgradeSend>::Error>
)
Indicates to the handler that upgrading an inbound substream to the given protocol has failed.
sourcefn connection_keep_alive(&self) -> KeepAlive
fn connection_keep_alive(&self) -> KeepAlive
Returns until when the connection should be kept alive. Read more
sourcefn poll(
&mut self,
cx: &mut Context<'_>
) -> Poll<ConnectionHandlerEvent<Self::OutboundProtocol, Self::OutboundOpenInfo, Self::OutEvent, Self::Error>>
fn poll(
&mut self,
cx: &mut Context<'_>
) -> Poll<ConnectionHandlerEvent<Self::OutboundProtocol, Self::OutboundOpenInfo, Self::OutEvent, Self::Error>>
Should behave like Stream::poll()
.
sourcefn 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.
sourcefn 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.
sourcefn select<TProto2>(
self,
other: TProto2
) -> ConnectionHandlerSelect<Self, TProto2> where
Self: Sized,
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. Read more
sourceimpl<K, H> IntoIterator for MultiHandler<K, H>
impl<K, H> IntoIterator for MultiHandler<K, H>
Split MultiHandler
into parts.
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
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> IntoConnectionHandler for T where
T: ConnectionHandler,
impl<T> IntoConnectionHandler for T where
T: ConnectionHandler,
type Handler = T
type Handler = T
The protocols handler.
sourcefn into_handler(self, &PeerId, &ConnectedPoint) -> T
fn into_handler(self, &PeerId, &ConnectedPoint) -> T
Builds the protocols handler. Read more
sourcefn inbound_protocol(
&self
) -> <<T as IntoConnectionHandler>::Handler as ConnectionHandler>::InboundProtocol
fn inbound_protocol(
&self
) -> <<T as IntoConnectionHandler>::Handler as ConnectionHandler>::InboundProtocol
Return the handler’s inbound protocol.
sourcefn select<TProto2>(
self,
other: TProto2
) -> IntoConnectionHandlerSelect<Self, TProto2> where
Self: Sized,
fn select<TProto2>(
self,
other: TProto2
) -> IntoConnectionHandlerSelect<Self, TProto2> where
Self: Sized,
Builds an implementation of IntoConnectionHandler
that handles both this protocol and the
other one together. Read more