Struct libp2p::ping::handler::PingHandler [−][src]
pub struct PingHandler { /* fields omitted */ }
Expand description
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.
Implementations
Builds a new PingHandler
with the given configuration.
Trait Implementations
type InEvent = Void
type InEvent = Void
Custom event that can be received from the outside.
type OutEvent = Result<PingSuccess, PingFailure>
type OutEvent = Result<PingSuccess, PingFailure>
Custom event that can be produced by the handler and that will be returned to the outside.
type Error = PingFailure
type Error = PingFailure
The type of errors returned by ProtocolsHandler::poll
.
type InboundProtocol = Ping
type InboundProtocol = Ping
The inbound upgrade for the protocol(s) used by the handler.
type OutboundProtocol = Ping
type OutboundProtocol = Ping
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
.
The InboundUpgrade
to apply on inbound
substreams to negotiate the desired protocols. Read more
pub fn inject_fully_negotiated_inbound(
&mut self,
stream: Negotiated<SubstreamRef<Arc<StreamMuxerBox>>>,
()
)
pub fn inject_fully_negotiated_inbound(
&mut self,
stream: Negotiated<SubstreamRef<Arc<StreamMuxerBox>>>,
()
)
Injects the output of a successful upgrade on a new inbound substream.
pub fn inject_fully_negotiated_outbound(
&mut self,
stream: Negotiated<SubstreamRef<Arc<StreamMuxerBox>>>,
()
)
pub fn inject_fully_negotiated_outbound(
&mut self,
stream: Negotiated<SubstreamRef<Arc<StreamMuxerBox>>>,
()
)
Injects the output of a successful upgrade on a new outbound substream. Read more
Injects an event coming from the outside in the handler.
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,
cx: &mut Context<'_>
) -> Poll<ProtocolsHandlerEvent<Ping, (), Result<PingSuccess, PingFailure>, <PingHandler as ProtocolsHandler>::Error>>
pub fn poll(
&mut self,
cx: &mut Context<'_>
) -> Poll<ProtocolsHandlerEvent<Ping, (), Result<PingSuccess, PingFailure>, <PingHandler 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 !RefUnwindSafe for PingHandler
impl Send for PingHandler
impl !Sync for PingHandler
impl Unpin for PingHandler
impl !UnwindSafe for PingHandler
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
pub fn vzip(self) -> V