pub struct MultiHandler<K, H> { /* private fields */ }
Expand description
A ConnectionHandler
for multiple ConnectionHandler
s of the same type.
Implementations§
source§impl<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<MultiHandler<K, H>, DuplicateProtonameError>where
I: IntoIterator<Item = (K, H)>,
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.
Trait Implementations§
source§impl<K, H> Clone for MultiHandler<K, H>where
K: Clone,
H: Clone,
impl<K, H> Clone for MultiHandler<K, H>where K: Clone, H: Clone,
source§fn clone(&self) -> MultiHandler<K, H>
fn clone(&self) -> MultiHandler<K, H>
Returns a copy of the value. Read more
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source
. Read moresource§impl<K, H> ConnectionHandler for MultiHandler<K, H>where
K: Clone + Debug + Hash + Eq + Send + 'static,
H: ConnectionHandler,
<H as ConnectionHandler>::InboundProtocol: InboundUpgradeSend,
<H as ConnectionHandler>::OutboundProtocol: OutboundUpgradeSend,
impl<K, H> ConnectionHandler for MultiHandler<K, H>where K: Clone + Debug + Hash + Eq + Send + 'static, H: ConnectionHandler, <H as ConnectionHandler>::InboundProtocol: InboundUpgradeSend, <H as ConnectionHandler>::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
.source§fn listen_protocol(
&self
) -> SubstreamProtocol<<MultiHandler<K, H> as ConnectionHandler>::InboundProtocol, <MultiHandler<K, H> as ConnectionHandler>::InboundOpenInfo>
fn listen_protocol( &self ) -> SubstreamProtocol<<MultiHandler<K, H> as ConnectionHandler>::InboundProtocol, <MultiHandler<K, H> as ConnectionHandler>::InboundOpenInfo>
The
InboundUpgrade
to apply on inbound
substreams to negotiate the desired protocols. Read moresource§fn inject_fully_negotiated_outbound(
&mut self,
protocol: <<MultiHandler<K, H> as ConnectionHandler>::OutboundProtocol as OutboundUpgradeSend>::Output,
_: <MultiHandler<K, H> as ConnectionHandler>::OutboundOpenInfo
)
fn inject_fully_negotiated_outbound( &mut self, protocol: <<MultiHandler<K, H> as ConnectionHandler>::OutboundProtocol as OutboundUpgradeSend>::Output, _: <MultiHandler<K, H> as ConnectionHandler>::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. Read more
source§fn inject_fully_negotiated_inbound(
&mut self,
_: <<MultiHandler<K, H> as ConnectionHandler>::InboundProtocol as InboundUpgradeSend>::Output,
info: <MultiHandler<K, H> as ConnectionHandler>::InboundOpenInfo
)
fn inject_fully_negotiated_inbound( &mut self, _: <<MultiHandler<K, H> as ConnectionHandler>::InboundProtocol as InboundUpgradeSend>::Output, info: <MultiHandler<K, H> as ConnectionHandler>::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. Read more
source§fn on_behaviour_event(
&mut self,
_: <MultiHandler<K, H> as ConnectionHandler>::InEvent
)
fn on_behaviour_event( &mut self, _: <MultiHandler<K, H> as ConnectionHandler>::InEvent )
Informs the handler about an event from the
NetworkBehaviour
.source§fn inject_address_change(&mut self, addr: &Multiaddr)
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.
source§fn inject_dial_upgrade_error(
&mut self,
_: <MultiHandler<K, H> as ConnectionHandler>::OutboundOpenInfo,
error: ConnectionHandlerUpgrErr<<<MultiHandler<K, H> as ConnectionHandler>::OutboundProtocol as OutboundUpgradeSend>::Error>
)
fn inject_dial_upgrade_error( &mut self, _: <MultiHandler<K, H> as ConnectionHandler>::OutboundOpenInfo, error: ConnectionHandlerUpgrErr<<<MultiHandler<K, H> as ConnectionHandler>::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.
source§fn inject_listen_upgrade_error(
&mut self,
info: <MultiHandler<K, H> as ConnectionHandler>::InboundOpenInfo,
error: ConnectionHandlerUpgrErr<<<MultiHandler<K, H> as ConnectionHandler>::InboundProtocol as InboundUpgradeSend>::Error>
)
fn inject_listen_upgrade_error( &mut self, info: <MultiHandler<K, H> as ConnectionHandler>::InboundOpenInfo, error: ConnectionHandlerUpgrErr<<<MultiHandler<K, H> as ConnectionHandler>::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.
source§fn connection_keep_alive(&self) -> KeepAlive
fn connection_keep_alive(&self) -> KeepAlive
Returns until when the connection should be kept alive. Read more
source§fn poll(
&mut self,
cx: &mut Context<'_>
) -> Poll<ConnectionHandlerEvent<<MultiHandler<K, H> as ConnectionHandler>::OutboundProtocol, <MultiHandler<K, H> as ConnectionHandler>::OutboundOpenInfo, <MultiHandler<K, H> as ConnectionHandler>::OutEvent, <MultiHandler<K, H> as ConnectionHandler>::Error>>
fn poll( &mut self, cx: &mut Context<'_> ) -> Poll<ConnectionHandlerEvent<<MultiHandler<K, H> as ConnectionHandler>::OutboundProtocol, <MultiHandler<K, H> as ConnectionHandler>::OutboundOpenInfo, <MultiHandler<K, H> as ConnectionHandler>::OutEvent, <MultiHandler<K, H> as ConnectionHandler>::Error>>
Should behave like
Stream::poll()
.source§fn inject_event(&mut self, event: Self::InEvent)
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.
source§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.
source§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.
source§fn 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 morefn on_connection_event( &mut self, _event: ConnectionEvent<'_, Self::InboundProtocol, Self::OutboundProtocol, Self::InboundOpenInfo, Self::OutboundOpenInfo> )
source§impl<K, H> IntoIterator for MultiHandler<K, H>
impl<K, H> IntoIterator for MultiHandler<K, H>
Split MultiHandler
into parts.
§type Item = <<MultiHandler<K, H> as IntoIterator>::IntoIter as Iterator>::Item
type Item = <<MultiHandler<K, H> as IntoIterator>::IntoIter as Iterator>::Item
The type of the elements being iterated over.
source§fn into_iter(self) -> <MultiHandler<K, H> as IntoIterator>::IntoIter
fn into_iter(self) -> <MultiHandler<K, H> as IntoIterator>::IntoIter
Creates an iterator from a value. 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§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
source§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
source§impl<T> IntoConnectionHandler for Twhere
T: ConnectionHandler,
impl<T> IntoConnectionHandler for Twhere T: ConnectionHandler,
source§fn into_handler(self, _: &PeerId, _: &ConnectedPoint) -> T
fn into_handler(self, _: &PeerId, _: &ConnectedPoint) -> T
Builds the protocols handler. Read more
source§fn 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.
source§fn 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.