Struct libp2p_ping::protocol::Ping [−][src]
pub struct Ping;
The Ping protocol upgrade.
The ping protocol sends 32 bytes of random data in configurable intervals over a single outbound substream, expecting to receive the same bytes as a response. At the same time, incoming pings on inbound substreams are answered by sending back the received bytes.
At most a single inbound and outbound substream is kept open at any time. In case of a ping timeout or another error on a substream, the substream is dropped. If a configurable number of consecutive outbound pings fail, the connection is closed.
Successful pings report the round-trip time.
Note: The round-trip time of a ping may be subject to delays induced by the underlying transport, e.g. in the case of TCP there is Nagle’s algorithm, delayed acks and similar configuration options which can affect latencies especially on otherwise low-volume connections.
Trait Implementations
impl InboundUpgrade<Negotiated<SubstreamRef<Arc<StreamMuxerBox>>>> for Ping[src]
impl InboundUpgrade<Negotiated<SubstreamRef<Arc<StreamMuxerBox>>>> for Ping[src]type Output = NegotiatedSubstream
Output after the upgrade has been successfully negotiated and the handshake performed.
type Error = Void
Possible error during the handshake.
type Future = Ready<Result<Self::Output, Self::Error>>
Future that performs the handshake with the remote.
fn upgrade_inbound(
self,
stream: NegotiatedSubstream,
_: Self::Info
) -> Self::Future[src]
self,
stream: NegotiatedSubstream,
_: Self::Info
) -> Self::Future
impl OutboundUpgrade<Negotiated<SubstreamRef<Arc<StreamMuxerBox>>>> for Ping[src]
impl OutboundUpgrade<Negotiated<SubstreamRef<Arc<StreamMuxerBox>>>> for Ping[src]type Output = NegotiatedSubstream
Output after the upgrade has been successfully negotiated and the handshake performed.
type Error = Void
Possible error during the handshake.
type Future = Ready<Result<Self::Output, Self::Error>>
Future that performs the handshake with the remote.
fn upgrade_outbound(
self,
stream: NegotiatedSubstream,
_: Self::Info
) -> Self::Future[src]
self,
stream: NegotiatedSubstream,
_: Self::Info
) -> Self::Future
impl UpgradeInfo for Ping[src]
impl UpgradeInfo for Ping[src]type Info = &'static [u8]
Opaque type representing a negotiable protocol.
type InfoIter = Once<Self::Info>
Iterator returned by protocol_info.
fn protocol_info(&self) -> Self::InfoIter[src]
impl Copy for Ping[src]
Auto Trait Implementations
impl RefUnwindSafe for Ping
impl Send for Ping
impl Sync for Ping
impl Unpin for Ping
impl UnwindSafe for Ping
Blanket Implementations
impl<C, U> InboundUpgradeExt<C> for U where
U: InboundUpgrade<C>, [src]
impl<C, U> InboundUpgradeExt<C> for U where
U: InboundUpgrade<C>, [src]pub fn map_inbound<F, T>(self, f: F) -> MapInboundUpgrade<Self, F> where
F: FnOnce(Self::Output) -> T, [src]
F: FnOnce(Self::Output) -> T,
pub fn map_inbound_err<F, T>(self, f: F) -> MapInboundUpgradeErr<Self, F> where
F: FnOnce(Self::Error) -> T, [src]
F: FnOnce(Self::Error) -> T,
impl<C, U> OutboundUpgradeExt<C> for U where
U: OutboundUpgrade<C>, [src]
impl<C, U> OutboundUpgradeExt<C> for U where
U: OutboundUpgrade<C>, [src]pub fn map_outbound<F, T>(self, f: F) -> MapOutboundUpgrade<Self, F> where
F: FnOnce(Self::Output) -> T, [src]
F: FnOnce(Self::Output) -> T,
pub fn map_outbound_err<F, T>(self, f: F) -> MapOutboundUpgradeErr<Self, F> where
F: FnOnce(Self::Error) -> T, [src]
F: FnOnce(Self::Error) -> T,