Struct libp2p_swarm::handler::ConnectionHandlerSelect
source · [−]pub struct ConnectionHandlerSelect<TProto1, TProto2> { /* private fields */ }
Expand description
Implementation of ConnectionHandler
that combines two protocols into one.
Implementations
sourceimpl<TProto1, TProto2> ConnectionHandlerSelect<TProto1, TProto2>
impl<TProto1, TProto2> ConnectionHandlerSelect<TProto1, TProto2>
pub fn into_inner(self) -> (TProto1, TProto2)
Trait Implementations
sourceimpl<TProto1: Clone, TProto2: Clone> Clone for ConnectionHandlerSelect<TProto1, TProto2>
impl<TProto1: Clone, TProto2: Clone> Clone for ConnectionHandlerSelect<TProto1, TProto2>
sourcefn clone(&self) -> ConnectionHandlerSelect<TProto1, TProto2>
fn clone(&self) -> ConnectionHandlerSelect<TProto1, TProto2>
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<TProto1, TProto2> ConnectionHandler for ConnectionHandlerSelect<TProto1, TProto2> where
TProto1: ConnectionHandler,
TProto2: ConnectionHandler,
impl<TProto1, TProto2> ConnectionHandler for ConnectionHandlerSelect<TProto1, TProto2> where
TProto1: ConnectionHandler,
TProto2: ConnectionHandler,
type InEvent = EitherOutput<<TProto1 as ConnectionHandler>::InEvent, <TProto2 as ConnectionHandler>::InEvent>
type InEvent = EitherOutput<<TProto1 as ConnectionHandler>::InEvent, <TProto2 as ConnectionHandler>::InEvent>
Custom event that can be received from the outside.
type OutEvent = EitherOutput<<TProto1 as ConnectionHandler>::OutEvent, <TProto2 as ConnectionHandler>::OutEvent>
type OutEvent = EitherOutput<<TProto1 as ConnectionHandler>::OutEvent, <TProto2 as ConnectionHandler>::OutEvent>
Custom event that can be produced by the handler and that will be returned to the outside.
type Error = EitherError<<TProto1 as ConnectionHandler>::Error, <TProto2 as ConnectionHandler>::Error>
type Error = EitherError<<TProto1 as ConnectionHandler>::Error, <TProto2 as ConnectionHandler>::Error>
The type of errors returned by ConnectionHandler::poll
.
type InboundProtocol = SelectUpgrade<SendWrapper<<TProto1 as ConnectionHandler>::InboundProtocol>, SendWrapper<<TProto2 as ConnectionHandler>::InboundProtocol>>
type InboundProtocol = SelectUpgrade<SendWrapper<<TProto1 as ConnectionHandler>::InboundProtocol>, SendWrapper<<TProto2 as ConnectionHandler>::InboundProtocol>>
The inbound upgrade for the protocol(s) used by the handler.
type OutboundProtocol = EitherUpgrade<SendWrapper<<TProto1 as ConnectionHandler>::OutboundProtocol>, SendWrapper<<TProto2 as ConnectionHandler>::OutboundProtocol>>
type OutboundProtocol = EitherUpgrade<SendWrapper<<TProto1 as ConnectionHandler>::OutboundProtocol>, SendWrapper<<TProto2 as ConnectionHandler>::OutboundProtocol>>
The outbound upgrade for the protocol(s) used by the handler.
type OutboundOpenInfo = EitherOutput<<TProto1 as ConnectionHandler>::OutboundOpenInfo, <TProto2 as ConnectionHandler>::OutboundOpenInfo>
type OutboundOpenInfo = EitherOutput<<TProto1 as ConnectionHandler>::OutboundOpenInfo, <TProto2 as ConnectionHandler>::OutboundOpenInfo>
The type of additional information passed to an OutboundSubstreamRequest
.
type InboundOpenInfo = (<TProto1 as ConnectionHandler>::InboundOpenInfo, <TProto2 as ConnectionHandler>::InboundOpenInfo)
type InboundOpenInfo = (<TProto1 as ConnectionHandler>::InboundOpenInfo, <TProto2 as ConnectionHandler>::InboundOpenInfo)
The type of additional information returned from listen_protocol
.
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,
endpoint: Self::OutboundOpenInfo
)
fn inject_fully_negotiated_outbound(
&mut self,
protocol: <Self::OutboundProtocol as OutboundUpgradeSend>::Output,
endpoint: Self::OutboundOpenInfo
)
Injects the output of a successful upgrade on a new outbound substream. Read more
sourcefn inject_fully_negotiated_inbound(
&mut self,
protocol: <Self::InboundProtocol as InboundUpgradeSend>::Output,
(i1, i2): Self::InboundOpenInfo
)
fn inject_fully_negotiated_inbound(
&mut self,
protocol: <Self::InboundProtocol as InboundUpgradeSend>::Output,
(i1, i2): Self::InboundOpenInfo
)
Injects the output of a successful upgrade on a new inbound substream.
sourcefn inject_event(&mut self, event: Self::InEvent)
fn inject_event(&mut self, event: Self::InEvent)
Injects an event coming from the outside in the handler.
sourcefn inject_address_change(&mut self, new_address: &Multiaddr)
fn inject_address_change(&mut self, new_address: &Multiaddr)
Notifies the handler of a change in the address of the remote.
sourcefn inject_dial_upgrade_error(
&mut self,
info: Self::OutboundOpenInfo,
error: ConnectionHandlerUpgrErr<<Self::OutboundProtocol as OutboundUpgradeSend>::Error>
)
fn inject_dial_upgrade_error(
&mut self,
info: 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,
(i1, i2): Self::InboundOpenInfo,
error: ConnectionHandlerUpgrErr<<Self::InboundProtocol as InboundUpgradeSend>::Error>
)
fn inject_listen_upgrade_error(
&mut self,
(i1, i2): 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
Auto Trait Implementations
impl<TProto1, TProto2> RefUnwindSafe for ConnectionHandlerSelect<TProto1, TProto2> where
TProto1: RefUnwindSafe,
TProto2: RefUnwindSafe,
impl<TProto1, TProto2> Send for ConnectionHandlerSelect<TProto1, TProto2> where
TProto1: Send,
TProto2: Send,
impl<TProto1, TProto2> Sync for ConnectionHandlerSelect<TProto1, TProto2> where
TProto1: Sync,
TProto2: Sync,
impl<TProto1, TProto2> Unpin for ConnectionHandlerSelect<TProto1, TProto2> where
TProto1: Unpin,
TProto2: Unpin,
impl<TProto1, TProto2> UnwindSafe for ConnectionHandlerSelect<TProto1, TProto2> where
TProto1: UnwindSafe,
TProto2: 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