[−][src]Struct libp2p::core::protocols_handler::OneShotHandler
Implementation of ProtocolsHandler
that opens a new substream for each individual message.
This struct is meant to be a helper for other implementations to use.
Methods
impl<TSubstream, TInProto, TOutProto, TOutEvent> OneShotHandler<TSubstream, TInProto, TOutProto, TOutEvent> where
TOutProto: OutboundUpgrade<TSubstream>,
[src]
TOutProto: OutboundUpgrade<TSubstream>,
pub fn new(
listen_protocol: SubstreamProtocol<TInProto>,
inactive_timeout: Duration
) -> OneShotHandler<TSubstream, TInProto, TOutProto, TOutEvent>
[src]
listen_protocol: SubstreamProtocol<TInProto>,
inactive_timeout: Duration
) -> OneShotHandler<TSubstream, TInProto, TOutProto, TOutEvent>
Creates a OneShotHandler
.
pub fn pending_requests(&self) -> u32
[src]
Returns the number of pending requests.
pub fn listen_protocol_ref(&self) -> &SubstreamProtocol<TInProto>
[src]
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.
pub fn listen_protocol_mut(&mut self) -> &mut SubstreamProtocol<TInProto>
[src]
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.
pub fn send_request(&mut self, upgrade: TOutProto)
[src]
Opens an outbound substream with upgrade
.
Trait Implementations
impl<TSubstream, TInProto, TOutProto, TOutEvent> Default for OneShotHandler<TSubstream, TInProto, TOutProto, TOutEvent> where
TInProto: InboundUpgrade<TSubstream> + Default,
TOutProto: OutboundUpgrade<TSubstream>,
[src]
TInProto: InboundUpgrade<TSubstream> + Default,
TOutProto: OutboundUpgrade<TSubstream>,
fn default() -> OneShotHandler<TSubstream, TInProto, TOutProto, TOutEvent>
[src]
impl<TSubstream, TInProto, TOutProto, TOutEvent> ProtocolsHandler for OneShotHandler<TSubstream, TInProto, TOutProto, TOutEvent> where
TInProto: InboundUpgrade<TSubstream>,
TOutProto: OutboundUpgrade<TSubstream>,
TSubstream: AsyncRead + AsyncWrite,
<TInProto as InboundUpgrade<TSubstream>>::Output: Into<TOutEvent>,
<TOutProto as OutboundUpgrade<TSubstream>>::Output: Into<TOutEvent>,
<TOutProto as OutboundUpgrade<TSubstream>>::Error: Error,
<TOutProto as OutboundUpgrade<TSubstream>>::Error: 'static,
SubstreamProtocol<TInProto>: Clone,
[src]
TInProto: InboundUpgrade<TSubstream>,
TOutProto: OutboundUpgrade<TSubstream>,
TSubstream: AsyncRead + AsyncWrite,
<TInProto as InboundUpgrade<TSubstream>>::Output: Into<TOutEvent>,
<TOutProto as OutboundUpgrade<TSubstream>>::Output: Into<TOutEvent>,
<TOutProto as OutboundUpgrade<TSubstream>>::Error: Error,
<TOutProto as OutboundUpgrade<TSubstream>>::Error: 'static,
SubstreamProtocol<TInProto>: Clone,
type InEvent = TOutProto
Custom event that can be received from the outside.
type OutEvent = TOutEvent
Custom event that can be produced by the handler and that will be returned to the outside.
type Error = ProtocolsHandlerUpgrErr<<<OneShotHandler<TSubstream, TInProto, TOutProto, TOutEvent> as ProtocolsHandler>::OutboundProtocol as OutboundUpgrade<<OneShotHandler<TSubstream, TInProto, TOutProto, TOutEvent> as ProtocolsHandler>::Substream>>::Error>
The type of errors returned by [ProtocolsHandler::poll
].
type Substream = TSubstream
The type of substreams on which the protocol(s) are negotiated.
type InboundProtocol = TInProto
The inbound upgrade for the protocol(s) used by the handler.
type OutboundProtocol = TOutProto
The outbound upgrade for the protocol(s) used by the handler.
type OutboundOpenInfo = ()
The type of additional information passed to an OutboundSubstreamRequest
.
fn listen_protocol(
&self
) -> SubstreamProtocol<<OneShotHandler<TSubstream, TInProto, TOutProto, TOutEvent> as ProtocolsHandler>::InboundProtocol>
[src]
&self
) -> SubstreamProtocol<<OneShotHandler<TSubstream, TInProto, TOutProto, TOutEvent> as ProtocolsHandler>::InboundProtocol>
fn inject_fully_negotiated_inbound(
&mut self,
out: <<OneShotHandler<TSubstream, TInProto, TOutProto, TOutEvent> as ProtocolsHandler>::InboundProtocol as InboundUpgrade<<OneShotHandler<TSubstream, TInProto, TOutProto, TOutEvent> as ProtocolsHandler>::Substream>>::Output
)
[src]
&mut self,
out: <<OneShotHandler<TSubstream, TInProto, TOutProto, TOutEvent> as ProtocolsHandler>::InboundProtocol as InboundUpgrade<<OneShotHandler<TSubstream, TInProto, TOutProto, TOutEvent> as ProtocolsHandler>::Substream>>::Output
)
fn inject_fully_negotiated_outbound(
&mut self,
out: <<OneShotHandler<TSubstream, TInProto, TOutProto, TOutEvent> as ProtocolsHandler>::OutboundProtocol as OutboundUpgrade<<OneShotHandler<TSubstream, TInProto, TOutProto, TOutEvent> as ProtocolsHandler>::Substream>>::Output,
<OneShotHandler<TSubstream, TInProto, TOutProto, TOutEvent> as ProtocolsHandler>::OutboundOpenInfo
)
[src]
&mut self,
out: <<OneShotHandler<TSubstream, TInProto, TOutProto, TOutEvent> as ProtocolsHandler>::OutboundProtocol as OutboundUpgrade<<OneShotHandler<TSubstream, TInProto, TOutProto, TOutEvent> as ProtocolsHandler>::Substream>>::Output,
<OneShotHandler<TSubstream, TInProto, TOutProto, TOutEvent> as ProtocolsHandler>::OutboundOpenInfo
)
fn inject_event(
&mut self,
event: <OneShotHandler<TSubstream, TInProto, TOutProto, TOutEvent> as ProtocolsHandler>::InEvent
)
[src]
&mut self,
event: <OneShotHandler<TSubstream, TInProto, TOutProto, TOutEvent> as ProtocolsHandler>::InEvent
)
fn inject_dial_upgrade_error(
&mut self,
<OneShotHandler<TSubstream, TInProto, TOutProto, TOutEvent> as ProtocolsHandler>::OutboundOpenInfo,
error: ProtocolsHandlerUpgrErr<<<OneShotHandler<TSubstream, TInProto, TOutProto, TOutEvent> as ProtocolsHandler>::OutboundProtocol as OutboundUpgrade<<OneShotHandler<TSubstream, TInProto, TOutProto, TOutEvent> as ProtocolsHandler>::Substream>>::Error>
)
[src]
&mut self,
<OneShotHandler<TSubstream, TInProto, TOutProto, TOutEvent> as ProtocolsHandler>::OutboundOpenInfo,
error: ProtocolsHandlerUpgrErr<<<OneShotHandler<TSubstream, TInProto, TOutProto, TOutEvent> as ProtocolsHandler>::OutboundProtocol as OutboundUpgrade<<OneShotHandler<TSubstream, TInProto, TOutProto, TOutEvent> as ProtocolsHandler>::Substream>>::Error>
)
fn connection_keep_alive(&self) -> KeepAlive
[src]
fn poll(
&mut self
) -> Result<Async<ProtocolsHandlerEvent<<OneShotHandler<TSubstream, TInProto, TOutProto, TOutEvent> as ProtocolsHandler>::OutboundProtocol, <OneShotHandler<TSubstream, TInProto, TOutProto, TOutEvent> as ProtocolsHandler>::OutboundOpenInfo, <OneShotHandler<TSubstream, TInProto, TOutProto, TOutEvent> as ProtocolsHandler>::OutEvent>>, <OneShotHandler<TSubstream, TInProto, TOutProto, TOutEvent> as ProtocolsHandler>::Error>
[src]
&mut self
) -> Result<Async<ProtocolsHandlerEvent<<OneShotHandler<TSubstream, TInProto, TOutProto, TOutEvent> as ProtocolsHandler>::OutboundProtocol, <OneShotHandler<TSubstream, TInProto, TOutProto, TOutEvent> as ProtocolsHandler>::OutboundOpenInfo, <OneShotHandler<TSubstream, TInProto, TOutProto, TOutEvent> as ProtocolsHandler>::OutEvent>>, <OneShotHandler<TSubstream, TInProto, TOutProto, TOutEvent> as ProtocolsHandler>::Error>
fn map_in_event<TNewIn, TMap>(self, map: TMap) -> MapInEvent<Self, TNewIn, TMap> where
TMap: Fn(&TNewIn) -> Option<&Self::InEvent>,
[src]
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,
[src]
TMap: FnMut(Self::OutEvent) -> TNewOut,
Adds a closure that turns the output event into something else.
fn select<TProto2>(
self,
other: TProto2
) -> ProtocolsHandlerSelect<Self, TProto2>
[src]
self,
other: TProto2
) -> ProtocolsHandlerSelect<Self, TProto2>
Creates a new ProtocolsHandler
that selects either this handler or other
by delegating methods calls appropriately. Read more
fn into_node_handler_builder(self) -> NodeHandlerWrapperBuilder<Self>
[src]
Creates a builder that allows creating a NodeHandler
that handles this protocol exclusively. Read more
fn into_node_handler(self) -> NodeHandlerWrapper<Self>
[src]
Use into_node_handler_builder instead
Builds an implementation of NodeHandler
that handles this protocol exclusively. Read more
Auto Trait Implementations
impl<TSubstream, TInProto, TOutProto, TOutEvent> Send for OneShotHandler<TSubstream, TInProto, TOutProto, TOutEvent> where
TInProto: Send,
TOutEvent: Send,
TOutProto: Send,
TSubstream: Send,
<TOutProto as OutboundUpgrade<TSubstream>>::Error: Send,
TInProto: Send,
TOutEvent: Send,
TOutProto: Send,
TSubstream: Send,
<TOutProto as OutboundUpgrade<TSubstream>>::Error: Send,
impl<TSubstream, TInProto, TOutProto, TOutEvent> Sync for OneShotHandler<TSubstream, TInProto, TOutProto, TOutEvent> where
TInProto: Sync,
TOutEvent: Sync,
TOutProto: Sync,
TSubstream: Sync,
<TOutProto as OutboundUpgrade<TSubstream>>::Error: Sync,
TInProto: Sync,
TOutEvent: Sync,
TOutProto: Sync,
TSubstream: Sync,
<TOutProto as OutboundUpgrade<TSubstream>>::Error: Sync,
Blanket Implementations
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> From<T> for T
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Same<T> for T
type Output = T
Should always be Self
impl<T> Clear for T where
T: InitializableFromZeroed + ?Sized,
T: InitializableFromZeroed + ?Sized,
fn clear(&mut self)
impl<T> InitializableFromZeroed for T where
T: Default,
T: Default,
unsafe fn initialize(place: *mut T)
impl<T> IntoProtocolsHandler for T where
T: ProtocolsHandler,
[src]
T: ProtocolsHandler,
type Handler = T
The protocols handler.
fn into_handler(self, &PeerId, &ConnectedPoint) -> T
[src]
fn inbound_protocol(
&self
) -> <<T as IntoProtocolsHandler>::Handler as ProtocolsHandler>::InboundProtocol
[src]
&self
) -> <<T as IntoProtocolsHandler>::Handler as ProtocolsHandler>::InboundProtocol
fn select<TProto2>(
self,
other: TProto2
) -> IntoProtocolsHandlerSelect<Self, TProto2>
[src]
self,
other: TProto2
) -> IntoProtocolsHandlerSelect<Self, TProto2>
Builds an implementation of IntoProtocolsHandler
that handles both this protocol and the other one together. Read more
fn into_node_handler_builder(self) -> NodeHandlerWrapperBuilder<Self>
[src]
Creates a builder that will allow creating a NodeHandler
that handles this protocol exclusively. Read more