Struct libp2p::swarm::ProtocolsHandlerSelect [−][src]
pub struct ProtocolsHandlerSelect<TProto1, TProto2> { /* fields omitted */ }
Expand description
Implementation of ProtocolsHandler
that combines two protocols into one.
Implementations
Trait Implementations
impl<TProto1, TProto2> Clone for ProtocolsHandlerSelect<TProto1, TProto2> where
TProto1: Clone,
TProto2: Clone,
impl<TProto1, TProto2> Clone for ProtocolsHandlerSelect<TProto1, TProto2> where
TProto1: Clone,
TProto2: Clone,
impl<TProto1, TProto2> Debug for ProtocolsHandlerSelect<TProto1, TProto2> where
TProto1: Debug,
TProto2: Debug,
impl<TProto1, TProto2> Debug for ProtocolsHandlerSelect<TProto1, TProto2> where
TProto1: Debug,
TProto2: Debug,
impl<TProto1, TProto2> ProtocolsHandler for ProtocolsHandlerSelect<TProto1, TProto2> where
TProto1: ProtocolsHandler,
TProto2: ProtocolsHandler,
impl<TProto1, TProto2> ProtocolsHandler for ProtocolsHandlerSelect<TProto1, TProto2> where
TProto1: ProtocolsHandler,
TProto2: ProtocolsHandler,
type InEvent = EitherOutput<<TProto1 as ProtocolsHandler>::InEvent, <TProto2 as ProtocolsHandler>::InEvent>
type InEvent = EitherOutput<<TProto1 as ProtocolsHandler>::InEvent, <TProto2 as ProtocolsHandler>::InEvent>
Custom event that can be received from the outside.
type OutEvent = EitherOutput<<TProto1 as ProtocolsHandler>::OutEvent, <TProto2 as ProtocolsHandler>::OutEvent>
type OutEvent = EitherOutput<<TProto1 as ProtocolsHandler>::OutEvent, <TProto2 as ProtocolsHandler>::OutEvent>
Custom event that can be produced by the handler and that will be returned to the outside.
type Error = EitherError<<TProto1 as ProtocolsHandler>::Error, <TProto2 as ProtocolsHandler>::Error>
type Error = EitherError<<TProto1 as ProtocolsHandler>::Error, <TProto2 as ProtocolsHandler>::Error>
The type of errors returned by ProtocolsHandler::poll
.
type InboundProtocol = SelectUpgrade<SendWrapper<<TProto1 as ProtocolsHandler>::InboundProtocol>, SendWrapper<<TProto2 as ProtocolsHandler>::InboundProtocol>>
type InboundProtocol = SelectUpgrade<SendWrapper<<TProto1 as ProtocolsHandler>::InboundProtocol>, SendWrapper<<TProto2 as ProtocolsHandler>::InboundProtocol>>
The inbound upgrade for the protocol(s) used by the handler.
type OutboundProtocol = EitherUpgrade<SendWrapper<<TProto1 as ProtocolsHandler>::OutboundProtocol>, SendWrapper<<TProto2 as ProtocolsHandler>::OutboundProtocol>>
type OutboundProtocol = EitherUpgrade<SendWrapper<<TProto1 as ProtocolsHandler>::OutboundProtocol>, SendWrapper<<TProto2 as ProtocolsHandler>::OutboundProtocol>>
The outbound upgrade for the protocol(s) used by the handler.
type OutboundOpenInfo = EitherOutput<<TProto1 as ProtocolsHandler>::OutboundOpenInfo, <TProto2 as ProtocolsHandler>::OutboundOpenInfo>
type OutboundOpenInfo = EitherOutput<<TProto1 as ProtocolsHandler>::OutboundOpenInfo, <TProto2 as ProtocolsHandler>::OutboundOpenInfo>
The type of additional information passed to an OutboundSubstreamRequest
.
type InboundOpenInfo = (<TProto1 as ProtocolsHandler>::InboundOpenInfo, <TProto2 as ProtocolsHandler>::InboundOpenInfo)
type InboundOpenInfo = (<TProto1 as ProtocolsHandler>::InboundOpenInfo, <TProto2 as ProtocolsHandler>::InboundOpenInfo)
The type of additional information returned from listen_protocol
.
pub fn listen_protocol(
&self
) -> SubstreamProtocol<<ProtocolsHandlerSelect<TProto1, TProto2> as ProtocolsHandler>::InboundProtocol, <ProtocolsHandlerSelect<TProto1, TProto2> as ProtocolsHandler>::InboundOpenInfo>
pub fn listen_protocol(
&self
) -> SubstreamProtocol<<ProtocolsHandlerSelect<TProto1, TProto2> as ProtocolsHandler>::InboundProtocol, <ProtocolsHandlerSelect<TProto1, TProto2> as ProtocolsHandler>::InboundOpenInfo>
The InboundUpgrade
to apply on inbound
substreams to negotiate the desired protocols. Read more
pub fn inject_fully_negotiated_outbound(
&mut self,
protocol: <<ProtocolsHandlerSelect<TProto1, TProto2> as ProtocolsHandler>::OutboundProtocol as OutboundUpgradeSend>::Output,
endpoint: <ProtocolsHandlerSelect<TProto1, TProto2> as ProtocolsHandler>::OutboundOpenInfo
)
pub fn inject_fully_negotiated_outbound(
&mut self,
protocol: <<ProtocolsHandlerSelect<TProto1, TProto2> as ProtocolsHandler>::OutboundProtocol as OutboundUpgradeSend>::Output,
endpoint: <ProtocolsHandlerSelect<TProto1, TProto2> as ProtocolsHandler>::OutboundOpenInfo
)
Injects the output of a successful upgrade on a new outbound substream. Read more
pub fn inject_fully_negotiated_inbound(
&mut self,
protocol: <<ProtocolsHandlerSelect<TProto1, TProto2> as ProtocolsHandler>::InboundProtocol as InboundUpgradeSend>::Output,
<ProtocolsHandlerSelect<TProto1, TProto2> as ProtocolsHandler>::InboundOpenInfo
)
pub fn inject_fully_negotiated_inbound(
&mut self,
protocol: <<ProtocolsHandlerSelect<TProto1, TProto2> as ProtocolsHandler>::InboundProtocol as InboundUpgradeSend>::Output,
<ProtocolsHandlerSelect<TProto1, TProto2> as ProtocolsHandler>::InboundOpenInfo
)
Injects the output of a successful upgrade on a new inbound substream.
pub fn inject_event(
&mut self,
event: <ProtocolsHandlerSelect<TProto1, TProto2> as ProtocolsHandler>::InEvent
)
pub fn inject_event(
&mut self,
event: <ProtocolsHandlerSelect<TProto1, TProto2> as ProtocolsHandler>::InEvent
)
Injects an event coming from the outside in the handler.
Notifies the handler of a change in the address of the remote.
pub fn inject_dial_upgrade_error(
&mut self,
info: <ProtocolsHandlerSelect<TProto1, TProto2> as ProtocolsHandler>::OutboundOpenInfo,
error: ProtocolsHandlerUpgrErr<<<ProtocolsHandlerSelect<TProto1, TProto2> as ProtocolsHandler>::OutboundProtocol as OutboundUpgradeSend>::Error>
)
pub fn inject_dial_upgrade_error(
&mut self,
info: <ProtocolsHandlerSelect<TProto1, TProto2> as ProtocolsHandler>::OutboundOpenInfo,
error: ProtocolsHandlerUpgrErr<<<ProtocolsHandlerSelect<TProto1, TProto2> as ProtocolsHandler>::OutboundProtocol as OutboundUpgradeSend>::Error>
)
Indicates to the handler that upgrading an outbound substream to the given protocol has failed.
pub fn inject_listen_upgrade_error(
&mut self,
<ProtocolsHandlerSelect<TProto1, TProto2> as ProtocolsHandler>::InboundOpenInfo,
error: ProtocolsHandlerUpgrErr<<<ProtocolsHandlerSelect<TProto1, TProto2> as ProtocolsHandler>::InboundProtocol as InboundUpgradeSend>::Error>
)
pub fn inject_listen_upgrade_error(
&mut self,
<ProtocolsHandlerSelect<TProto1, TProto2> as ProtocolsHandler>::InboundOpenInfo,
error: ProtocolsHandlerUpgrErr<<<ProtocolsHandlerSelect<TProto1, TProto2> as ProtocolsHandler>::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
pub fn poll(
&mut self,
cx: &mut Context<'_>
) -> Poll<ProtocolsHandlerEvent<<ProtocolsHandlerSelect<TProto1, TProto2> as ProtocolsHandler>::OutboundProtocol, <ProtocolsHandlerSelect<TProto1, TProto2> as ProtocolsHandler>::OutboundOpenInfo, <ProtocolsHandlerSelect<TProto1, TProto2> as ProtocolsHandler>::OutEvent, <ProtocolsHandlerSelect<TProto1, TProto2> as ProtocolsHandler>::Error>>
pub fn poll(
&mut self,
cx: &mut Context<'_>
) -> Poll<ProtocolsHandlerEvent<<ProtocolsHandlerSelect<TProto1, TProto2> as ProtocolsHandler>::OutboundProtocol, <ProtocolsHandlerSelect<TProto1, TProto2> as ProtocolsHandler>::OutboundOpenInfo, <ProtocolsHandlerSelect<TProto1, TProto2> as ProtocolsHandler>::OutEvent, <ProtocolsHandlerSelect<TProto1, TProto2> as ProtocolsHandler>::Error>>
Should behave like Stream::poll()
.
fn map_in_event<TNewIn, TMap>(self, map: TMap) -> MapInEvent<Self, TNewIn, TMap> where
TMap: Fn(&TNewIn) -> Option<&Self::InEvent>,
fn map_in_event<TNewIn, TMap>(self, map: TMap) -> MapInEvent<Self, TNewIn, TMap> where
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
TMap: FnMut(Self::OutEvent) -> TNewOut,
fn map_out_event<TMap, TNewOut>(self, map: TMap) -> MapOutEvent<Self, TMap> where
TMap: FnMut(Self::OutEvent) -> TNewOut,
Adds a closure that turns the output event into something else.
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<TProto1, TProto2> RefUnwindSafe for ProtocolsHandlerSelect<TProto1, TProto2> where
TProto1: RefUnwindSafe,
TProto2: RefUnwindSafe,
impl<TProto1, TProto2> Send for ProtocolsHandlerSelect<TProto1, TProto2> where
TProto1: Send,
TProto2: Send,
impl<TProto1, TProto2> Sync for ProtocolsHandlerSelect<TProto1, TProto2> where
TProto1: Sync,
TProto2: Sync,
impl<TProto1, TProto2> Unpin for ProtocolsHandlerSelect<TProto1, TProto2> where
TProto1: Unpin,
TProto2: Unpin,
impl<TProto1, TProto2> UnwindSafe for ProtocolsHandlerSelect<TProto1, TProto2> where
TProto1: UnwindSafe,
TProto2: UnwindSafe,
Blanket Implementations
Mutably borrows from an owned value. Read more
type Handler = T
type Handler = T
The protocols handler.
Builds the protocols handler. Read more
pub fn inbound_protocol(
&self
) -> <<T as IntoProtocolsHandler>::Handler as ProtocolsHandler>::InboundProtocol
pub fn inbound_protocol(
&self
) -> <<T as IntoProtocolsHandler>::Handler as ProtocolsHandler>::InboundProtocol
Return the handler’s inbound protocol.
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