[−][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: TInProto) -> Self
[src]
Creates a OneShotHandler
.
pub fn pending_requests(&self) -> u32
[src]
Returns the number of pending requests.
pub fn listen_protocol_ref(&self) -> &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 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> ProtocolsHandler for OneShotHandler<TSubstream, TInProto, TOutProto, TOutEvent> where
TSubstream: AsyncRead + AsyncWrite,
TInProto: InboundUpgrade<TSubstream> + Clone,
TOutProto: OutboundUpgrade<TSubstream>,
TInProto::Output: Into<TOutEvent>,
TOutProto::Output: Into<TOutEvent>,
TOutProto::Error: Error + 'static,
[src]
TSubstream: AsyncRead + AsyncWrite,
TInProto: InboundUpgrade<TSubstream> + Clone,
TOutProto: OutboundUpgrade<TSubstream>,
TInProto::Output: Into<TOutEvent>,
TOutProto::Output: Into<TOutEvent>,
TOutProto::Error: Error + 'static,
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<<Self::OutboundProtocol as OutboundUpgrade<Self::Substream>>::Error>
Error that can happen when polling.
type Substream = TSubstream
The type of the substream that contains the raw data.
type InboundProtocol = TInProto
The upgrade for the protocol or protocols handled by this handler.
type OutboundProtocol = TOutProto
The upgrade for the protocol or protocols handled by this handler.
type OutboundOpenInfo = ()
Information about a substream. Can be sent to the handler through a NodeHandlerEndpoint
, and will be passed back in inject_substream
or inject_outbound_closed
. Read more
fn listen_protocol(&self) -> Self::InboundProtocol
[src]
fn inject_fully_negotiated_inbound(
&mut self,
out: <Self::InboundProtocol as InboundUpgrade<Self::Substream>>::Output
)
[src]
&mut self,
out: <Self::InboundProtocol as InboundUpgrade<Self::Substream>>::Output
)
fn inject_fully_negotiated_outbound(
&mut self,
out: <Self::OutboundProtocol as OutboundUpgrade<Self::Substream>>::Output,
_: Self::OutboundOpenInfo
)
[src]
&mut self,
out: <Self::OutboundProtocol as OutboundUpgrade<Self::Substream>>::Output,
_: Self::OutboundOpenInfo
)
fn inject_event(&mut self, event: Self::InEvent)
[src]
fn inject_dial_upgrade_error(
&mut self,
_: Self::OutboundOpenInfo,
error: ProtocolsHandlerUpgrErr<<Self::OutboundProtocol as OutboundUpgrade<Self::Substream>>::Error>
)
[src]
&mut self,
_: Self::OutboundOpenInfo,
error: ProtocolsHandlerUpgrErr<<Self::OutboundProtocol as OutboundUpgrade<Self::Substream>>::Error>
)
fn connection_keep_alive(&self) -> KeepAlive
[src]
fn poll(
&mut self
) -> Poll<ProtocolsHandlerEvent<Self::OutboundProtocol, Self::OutboundOpenInfo, Self::OutEvent>, Self::Error>
[src]
&mut self
) -> Poll<ProtocolsHandlerEvent<Self::OutboundProtocol, Self::OutboundOpenInfo, Self::OutEvent>, Self::Error>
fn map_in_event<TNewIn, TMap>(self, map: TMap) -> MapInEvent<Self, TNewIn, TMap> where
Self: Sized,
TMap: Fn(&TNewIn) -> Option<&Self::InEvent>,
[src]
Self: Sized,
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
Self: Sized,
TMap: FnMut(Self::OutEvent) -> TNewOut,
[src]
Self: Sized,
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> where
Self: Sized,
[src]
self,
other: TProto2
) -> ProtocolsHandlerSelect<Self, TProto2> where
Self: Sized,
Builds an implementation of ProtocolsHandler
that handles both this protocol and the other one together. Read more
fn into_node_handler_builder(self) -> NodeHandlerWrapperBuilder<Self> where
Self: Sized,
[src]
Self: Sized,
Creates a builder that will allow creating a NodeHandler
that handles this protocol exclusively. Read more
fn into_node_handler(self) -> NodeHandlerWrapper<Self> where
Self: Sized,
[src]
Self: Sized,
Use into_node_handler_builder instead
Builds an implementation of NodeHandler
that handles this protocol exclusively. Read more
impl<TSubstream, TInProto, TOutProto, TOutEvent> Default for OneShotHandler<TSubstream, TInProto, TOutProto, TOutEvent> where
TOutProto: OutboundUpgrade<TSubstream>,
TInProto: Default,
[src]
TOutProto: OutboundUpgrade<TSubstream>,
TInProto: Default,
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> IntoProtocolsHandler for T where
T: ProtocolsHandler,
[src]
T: ProtocolsHandler,
type Handler = T
The protocols handler.
fn into_handler(Self, &PeerId) -> T
[src]
fn select<TProto2>(
self,
other: TProto2
) -> IntoProtocolsHandlerSelect<Self, TProto2> where
Self: Sized,
[src]
self,
other: TProto2
) -> IntoProtocolsHandlerSelect<Self, TProto2> where
Self: Sized,
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> where
Self: Sized,
[src]
Self: Sized,
Creates a builder that will allow creating a NodeHandler
that handles this protocol exclusively. Read more
impl<T, U> Into for T where
U: From<T>,
[src]
U: From<T>,
impl<T> From for T
[src]
impl<T, U> TryFrom 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> Borrow for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> BorrowMut for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T, U> TryInto 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> Same 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,