[−][src]Struct libp2p::ping::handler::PingHandler
Protocol handler that handles pinging the remote at a regular period and answering ping queries.
If the remote doesn't respond, produces an error that closes the connection.
Methods
impl<TSubstream> PingHandler<TSubstream> where
TSubstream: AsyncRead + AsyncWrite,
[src]
TSubstream: AsyncRead + AsyncWrite,
pub fn new() -> PingHandler<TSubstream>
[src]
Builds a new PingHandler
.
Trait Implementations
impl<TSubstream> Default for PingHandler<TSubstream> where
TSubstream: AsyncRead + AsyncWrite,
[src]
TSubstream: AsyncRead + AsyncWrite,
fn default() -> PingHandler<TSubstream>
[src]
impl<TSubstream> ProtocolsHandler for PingHandler<TSubstream> where
TSubstream: AsyncRead + AsyncWrite,
[src]
TSubstream: AsyncRead + AsyncWrite,
type InEvent = Void
Custom event that can be received from the outside.
type OutEvent = PingOutput
Custom event that can be produced by the handler and that will be returned to the outside.
type Error = ProtocolsHandlerUpgrErr<Error>
Error that can happen when polling.
type Substream = TSubstream
The type of the substream that contains the raw data.
type InboundProtocol = Ping
The upgrade for the protocol or protocols handled by this handler.
type OutboundProtocol = Ping
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
) -> <PingHandler<TSubstream> as ProtocolsHandler>::InboundProtocol
[src]
&self
) -> <PingHandler<TSubstream> as ProtocolsHandler>::InboundProtocol
fn inject_fully_negotiated_inbound(&mut self, protocol: ())
[src]
fn inject_fully_negotiated_outbound(
&mut self,
duration: Duration,
info: <PingHandler<TSubstream> as ProtocolsHandler>::OutboundOpenInfo
)
[src]
&mut self,
duration: Duration,
info: <PingHandler<TSubstream> as ProtocolsHandler>::OutboundOpenInfo
)
fn inject_event(&mut self, event: Void)
[src]
fn inject_dial_upgrade_error(
&mut self,
info: <PingHandler<TSubstream> as ProtocolsHandler>::OutboundOpenInfo,
error: ProtocolsHandlerUpgrErr<Error>
)
[src]
&mut self,
info: <PingHandler<TSubstream> as ProtocolsHandler>::OutboundOpenInfo,
error: ProtocolsHandlerUpgrErr<Error>
)
fn connection_keep_alive(&self) -> KeepAlive
[src]
fn poll(
&mut self
) -> Result<Async<ProtocolsHandlerEvent<<PingHandler<TSubstream> as ProtocolsHandler>::OutboundProtocol, <PingHandler<TSubstream> as ProtocolsHandler>::OutboundOpenInfo, <PingHandler<TSubstream> as ProtocolsHandler>::OutEvent>>, <PingHandler<TSubstream> as ProtocolsHandler>::Error>
[src]
&mut self
) -> Result<Async<ProtocolsHandlerEvent<<PingHandler<TSubstream> as ProtocolsHandler>::OutboundProtocol, <PingHandler<TSubstream> as ProtocolsHandler>::OutboundOpenInfo, <PingHandler<TSubstream> as ProtocolsHandler>::OutEvent>>, <PingHandler<TSubstream> 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>
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>
[src]
Creates a builder that will allow 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> Send for PingHandler<TSubstream> where
TSubstream: Send,
TSubstream: Send,
impl<TSubstream> Sync for PingHandler<TSubstream> where
TSubstream: Sync,
TSubstream: Sync,
Blanket Implementations
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,
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) -> T
[src]
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
impl<T> Erased for T
impl<T> Erased for T
impl<T> Typeable for T where
T: Any,
T: Any,