Struct libp2p::swarm::protocols_handler::OneShotHandler [−][src]
pub struct OneShotHandler<TInbound, TOutbound, TEvent> where
TOutbound: OutboundUpgradeSend, { /* fields omitted */ }
Expand description
A ProtocolsHandler
that opens a new substream for each request.
Implementations
impl<TInbound, TOutbound, TEvent> OneShotHandler<TInbound, TOutbound, TEvent> where
TOutbound: OutboundUpgradeSend,
impl<TInbound, TOutbound, TEvent> OneShotHandler<TInbound, TOutbound, TEvent> where
TOutbound: OutboundUpgradeSend,
pub fn new(
listen_protocol: SubstreamProtocol<TInbound, ()>,
config: OneShotHandlerConfig
) -> OneShotHandler<TInbound, TOutbound, TEvent>
pub fn new(
listen_protocol: SubstreamProtocol<TInbound, ()>,
config: OneShotHandlerConfig
) -> OneShotHandler<TInbound, TOutbound, TEvent>
Creates a OneShotHandler
.
Returns the number of pending requests.
Returns a reference to the listen protocol configuration.
Note: If you modify the protocol, modifications will only applies to future inbound substreams, not the ones already being negotiated.
Returns a mutable reference to the listen protocol configuration.
Note: If you modify the protocol, modifications will only applies to future inbound substreams, not the ones already being negotiated.
Opens an outbound substream with upgrade
.
Trait Implementations
impl<TInbound, TOutbound, TEvent> Default for OneShotHandler<TInbound, TOutbound, TEvent> where
TOutbound: OutboundUpgradeSend,
TInbound: InboundUpgradeSend + Default,
impl<TInbound, TOutbound, TEvent> Default for OneShotHandler<TInbound, TOutbound, TEvent> where
TOutbound: OutboundUpgradeSend,
TInbound: InboundUpgradeSend + Default,
Returns the “default value” for a type. Read more
impl<TInbound, TOutbound, TEvent> ProtocolsHandler for OneShotHandler<TInbound, TOutbound, TEvent> where
TInbound: 'static + InboundUpgradeSend + Send,
TOutbound: Debug + OutboundUpgradeSend,
TEvent: 'static + Debug + Send,
<TInbound as InboundUpgradeSend>::Output: Into<TEvent>,
<TOutbound as OutboundUpgradeSend>::Output: Into<TEvent>,
<TOutbound as OutboundUpgradeSend>::Error: 'static,
<TOutbound as OutboundUpgradeSend>::Error: Error,
<TOutbound as OutboundUpgradeSend>::Error: Send,
SubstreamProtocol<TInbound, ()>: Clone,
impl<TInbound, TOutbound, TEvent> ProtocolsHandler for OneShotHandler<TInbound, TOutbound, TEvent> where
TInbound: 'static + InboundUpgradeSend + Send,
TOutbound: Debug + OutboundUpgradeSend,
TEvent: 'static + Debug + Send,
<TInbound as InboundUpgradeSend>::Output: Into<TEvent>,
<TOutbound as OutboundUpgradeSend>::Output: Into<TEvent>,
<TOutbound as OutboundUpgradeSend>::Error: 'static,
<TOutbound as OutboundUpgradeSend>::Error: Error,
<TOutbound as OutboundUpgradeSend>::Error: Send,
SubstreamProtocol<TInbound, ()>: Clone,
type InEvent = TOutbound
type InEvent = TOutbound
Custom event that can be received from the outside.
type OutEvent = TEvent
type OutEvent = TEvent
Custom event that can be produced by the handler and that will be returned to the outside.
type Error = ProtocolsHandlerUpgrErr<<<OneShotHandler<TInbound, TOutbound, TEvent> as ProtocolsHandler>::OutboundProtocol as OutboundUpgradeSend>::Error>
type Error = ProtocolsHandlerUpgrErr<<<OneShotHandler<TInbound, TOutbound, TEvent> as ProtocolsHandler>::OutboundProtocol as OutboundUpgradeSend>::Error>
The type of errors returned by ProtocolsHandler::poll
.
type InboundProtocol = TInbound
type InboundProtocol = TInbound
The inbound upgrade for the protocol(s) used by the handler.
type OutboundProtocol = TOutbound
type OutboundProtocol = TOutbound
The outbound upgrade for the protocol(s) used by the handler.
type OutboundOpenInfo = ()
type OutboundOpenInfo = ()
The type of additional information passed to an OutboundSubstreamRequest
.
type InboundOpenInfo = ()
type InboundOpenInfo = ()
The type of additional information returned from listen_protocol
.
pub fn listen_protocol(
&self
) -> SubstreamProtocol<<OneShotHandler<TInbound, TOutbound, TEvent> as ProtocolsHandler>::InboundProtocol, <OneShotHandler<TInbound, TOutbound, TEvent> as ProtocolsHandler>::InboundOpenInfo>
pub fn listen_protocol(
&self
) -> SubstreamProtocol<<OneShotHandler<TInbound, TOutbound, TEvent> as ProtocolsHandler>::InboundProtocol, <OneShotHandler<TInbound, TOutbound, TEvent> as ProtocolsHandler>::InboundOpenInfo>
The InboundUpgrade
to apply on inbound
substreams to negotiate the desired protocols. Read more
pub fn inject_fully_negotiated_inbound(
&mut self,
out: <<OneShotHandler<TInbound, TOutbound, TEvent> as ProtocolsHandler>::InboundProtocol as InboundUpgradeSend>::Output,
<OneShotHandler<TInbound, TOutbound, TEvent> as ProtocolsHandler>::InboundOpenInfo
)
pub fn inject_fully_negotiated_inbound(
&mut self,
out: <<OneShotHandler<TInbound, TOutbound, TEvent> as ProtocolsHandler>::InboundProtocol as InboundUpgradeSend>::Output,
<OneShotHandler<TInbound, TOutbound, TEvent> as ProtocolsHandler>::InboundOpenInfo
)
Injects the output of a successful upgrade on a new inbound substream.
pub fn inject_fully_negotiated_outbound(
&mut self,
out: <<OneShotHandler<TInbound, TOutbound, TEvent> as ProtocolsHandler>::OutboundProtocol as OutboundUpgradeSend>::Output,
<OneShotHandler<TInbound, TOutbound, TEvent> as ProtocolsHandler>::OutboundOpenInfo
)
pub fn inject_fully_negotiated_outbound(
&mut self,
out: <<OneShotHandler<TInbound, TOutbound, TEvent> as ProtocolsHandler>::OutboundProtocol as OutboundUpgradeSend>::Output,
<OneShotHandler<TInbound, TOutbound, TEvent> as ProtocolsHandler>::OutboundOpenInfo
)
Injects the output of a successful upgrade on a new outbound substream. Read more
pub fn inject_event(
&mut self,
event: <OneShotHandler<TInbound, TOutbound, TEvent> as ProtocolsHandler>::InEvent
)
pub fn inject_event(
&mut self,
event: <OneShotHandler<TInbound, TOutbound, TEvent> as ProtocolsHandler>::InEvent
)
Injects an event coming from the outside in the handler.
pub fn inject_dial_upgrade_error(
&mut self,
_info: <OneShotHandler<TInbound, TOutbound, TEvent> as ProtocolsHandler>::OutboundOpenInfo,
error: ProtocolsHandlerUpgrErr<<<OneShotHandler<TInbound, TOutbound, TEvent> as ProtocolsHandler>::OutboundProtocol as OutboundUpgradeSend>::Error>
)
pub fn inject_dial_upgrade_error(
&mut self,
_info: <OneShotHandler<TInbound, TOutbound, TEvent> as ProtocolsHandler>::OutboundOpenInfo,
error: ProtocolsHandlerUpgrErr<<<OneShotHandler<TInbound, TOutbound, TEvent> as ProtocolsHandler>::OutboundProtocol as OutboundUpgradeSend>::Error>
)
Indicates to the handler that upgrading an outbound substream to the given protocol has failed.
Returns until when the connection should be kept alive. Read more
pub fn poll(
&mut self,
&mut Context<'_>
) -> Poll<ProtocolsHandlerEvent<<OneShotHandler<TInbound, TOutbound, TEvent> as ProtocolsHandler>::OutboundProtocol, <OneShotHandler<TInbound, TOutbound, TEvent> as ProtocolsHandler>::OutboundOpenInfo, <OneShotHandler<TInbound, TOutbound, TEvent> as ProtocolsHandler>::OutEvent, <OneShotHandler<TInbound, TOutbound, TEvent> as ProtocolsHandler>::Error>>
pub fn poll(
&mut self,
&mut Context<'_>
) -> Poll<ProtocolsHandlerEvent<<OneShotHandler<TInbound, TOutbound, TEvent> as ProtocolsHandler>::OutboundProtocol, <OneShotHandler<TInbound, TOutbound, TEvent> as ProtocolsHandler>::OutboundOpenInfo, <OneShotHandler<TInbound, TOutbound, TEvent> as ProtocolsHandler>::OutEvent, <OneShotHandler<TInbound, TOutbound, TEvent> as ProtocolsHandler>::Error>>
Should behave like Stream::poll()
.
Notifies the handler of a change in the address of the remote.
fn inject_listen_upgrade_error(
&mut self,
Self::InboundOpenInfo,
ProtocolsHandlerUpgrErr<<Self::InboundProtocol as InboundUpgradeSend>::Error>
)
fn inject_listen_upgrade_error(
&mut self,
Self::InboundOpenInfo,
ProtocolsHandlerUpgrErr<<Self::InboundProtocol as InboundUpgradeSend>::Error>
)
Indicates to the handler that upgrading an inbound substream to the given protocol has failed.
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<TInbound, TOutbound, TEvent> !RefUnwindSafe for OneShotHandler<TInbound, TOutbound, TEvent>
impl<TInbound, TOutbound, TEvent> Send for OneShotHandler<TInbound, TOutbound, TEvent> where
TEvent: Send,
TInbound: Send,
impl<TInbound, TOutbound, TEvent> Sync for OneShotHandler<TInbound, TOutbound, TEvent> where
TEvent: Sync,
TInbound: Sync,
TOutbound: Sync,
<TOutbound as OutboundUpgradeSend>::Error: Sync,
impl<TInbound, TOutbound, TEvent> Unpin for OneShotHandler<TInbound, TOutbound, TEvent> where
TEvent: Unpin,
TInbound: Unpin,
TOutbound: Unpin,
<TOutbound as OutboundUpgradeSend>::Error: Unpin,
impl<TInbound, TOutbound, TEvent> !UnwindSafe for OneShotHandler<TInbound, TOutbound, TEvent>
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