Ping

libp2p_ping::protocol

Struct Ping 

Source 
pub struct Ping;
Expand description

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§

Source§

impl Clone for Ping

Source§

fn clone(&self) -> Ping

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for Ping

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for Ping

Source§

fn default() -> Ping

Returns the “default value” for a type. Read more
Source§

impl InboundUpgrade<Negotiated<SubstreamRef<Arc<StreamMuxerBox>>>> for Ping

Source§

type Output = Negotiated<SubstreamRef<Arc<StreamMuxerBox>>>

Output after the upgrade has been successfully negotiated and the handshake performed.
Source§

type Error = Void

Possible error during the handshake.
Source§

type Future = Ready<Result<<Ping as InboundUpgrade<Negotiated<SubstreamRef<Arc<StreamMuxerBox>>>>>::Output, <Ping as InboundUpgrade<Negotiated<SubstreamRef<Arc<StreamMuxerBox>>>>>::Error>>

Future that performs the handshake with the remote.
Source§

fn upgrade_inbound( self, stream: NegotiatedSubstream, _: Self::Info, ) -> Self::Future

After we have determined that the remote supports one of the protocols we support, this method is called to start the handshake. Read more
Source§

impl OutboundUpgrade<Negotiated<SubstreamRef<Arc<StreamMuxerBox>>>> for Ping

Source§

type Output = Negotiated<SubstreamRef<Arc<StreamMuxerBox>>>

Output after the upgrade has been successfully negotiated and the handshake performed.
Source§

type Error = Void

Possible error during the handshake.
Source§

type Future = Ready<Result<<Ping as OutboundUpgrade<Negotiated<SubstreamRef<Arc<StreamMuxerBox>>>>>::Output, <Ping as OutboundUpgrade<Negotiated<SubstreamRef<Arc<StreamMuxerBox>>>>>::Error>>

Future that performs the handshake with the remote.
Source§

fn upgrade_outbound( self, stream: NegotiatedSubstream, _: Self::Info, ) -> Self::Future

After we have determined that the remote supports one of the protocols we support, this method is called to start the handshake. Read more
Source§

impl UpgradeInfo for Ping

Source§

type Info = &'static [u8]

Opaque type representing a negotiable protocol.
Source§

type InfoIter = Once<<Ping as UpgradeInfo>::Info>

Iterator returned by protocol_info.
Source§

fn protocol_info(&self) -> Self::InfoIter

Returns the list of protocols that are supported. Used during the negotiation process.
Source§

impl Copy for Ping

Auto Trait Implementations§

§

impl Freeze for Ping

§

impl RefUnwindSafe for Ping

§

impl Send for Ping

§

impl Sync for Ping

§

impl Unpin for Ping

§

impl UnwindSafe for Ping

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<C, U> InboundUpgradeExt<C> for U
where U: InboundUpgrade<C>,

Source§

fn map_inbound<F, T>(self, f: F) -> MapInboundUpgrade<Self, F>
where Self: Sized, F: FnOnce(Self::Output) -> T,

Returns a new object that wraps around Self and applies a closure to the Output.
Source§

fn map_inbound_err<F, T>(self, f: F) -> MapInboundUpgradeErr<Self, F>
where Self: Sized, F: FnOnce(Self::Error) -> T,

Returns a new object that wraps around Self and applies a closure to the Error.
Source§

impl<T, TInfo> InboundUpgradeSend for T
where T: InboundUpgrade<Negotiated<SubstreamRef<Arc<StreamMuxerBox>>>, Info = TInfo> + UpgradeInfoSend<Info = TInfo>, TInfo: ProtocolName + Clone + Send + 'static, <T as InboundUpgrade<Negotiated<SubstreamRef<Arc<StreamMuxerBox>>>>>::Output: Send + 'static, <T as InboundUpgrade<Negotiated<SubstreamRef<Arc<StreamMuxerBox>>>>>::Error: Send + 'static, <T as InboundUpgrade<Negotiated<SubstreamRef<Arc<StreamMuxerBox>>>>>::Future: Send + 'static,

Source§

type Output = <T as InboundUpgrade<Negotiated<SubstreamRef<Arc<StreamMuxerBox>>>>>::Output

Equivalent to InboundUpgrade::Output.
Source§

type Error = <T as InboundUpgrade<Negotiated<SubstreamRef<Arc<StreamMuxerBox>>>>>::Error

Equivalent to InboundUpgrade::Error.
Source§

type Future = <T as InboundUpgrade<Negotiated<SubstreamRef<Arc<StreamMuxerBox>>>>>::Future

Equivalent to InboundUpgrade::Future.
Source§

fn upgrade_inbound( self, socket: Negotiated<SubstreamRef<Arc<StreamMuxerBox>>>, info: TInfo, ) -> <T as InboundUpgradeSend>::Future

Equivalent to InboundUpgrade::upgrade_inbound.
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<C, U> OutboundUpgradeExt<C> for U
where U: OutboundUpgrade<C>,

Source§

fn map_outbound<F, T>(self, f: F) -> MapOutboundUpgrade<Self, F>
where Self: Sized, F: FnOnce(Self::Output) -> T,

Returns a new object that wraps around Self and applies a closure to the Output.
Source§

fn map_outbound_err<F, T>(self, f: F) -> MapOutboundUpgradeErr<Self, F>
where Self: Sized, F: FnOnce(Self::Error) -> T,

Returns a new object that wraps around Self and applies a closure to the Error.
Source§

impl<T, TInfo> OutboundUpgradeSend for T
where T: OutboundUpgrade<Negotiated<SubstreamRef<Arc<StreamMuxerBox>>>, Info = TInfo> + UpgradeInfoSend<Info = TInfo>, TInfo: ProtocolName + Clone + Send + 'static, <T as OutboundUpgrade<Negotiated<SubstreamRef<Arc<StreamMuxerBox>>>>>::Output: Send + 'static, <T as OutboundUpgrade<Negotiated<SubstreamRef<Arc<StreamMuxerBox>>>>>::Error: Send + 'static, <T as OutboundUpgrade<Negotiated<SubstreamRef<Arc<StreamMuxerBox>>>>>::Future: Send + 'static,

Source§

type Output = <T as OutboundUpgrade<Negotiated<SubstreamRef<Arc<StreamMuxerBox>>>>>::Output

Equivalent to OutboundUpgrade::Output.
Source§

type Error = <T as OutboundUpgrade<Negotiated<SubstreamRef<Arc<StreamMuxerBox>>>>>::Error

Equivalent to OutboundUpgrade::Error.
Source§

type Future = <T as OutboundUpgrade<Negotiated<SubstreamRef<Arc<StreamMuxerBox>>>>>::Future

Equivalent to OutboundUpgrade::Future.
Source§

fn upgrade_outbound( self, socket: Negotiated<SubstreamRef<Arc<StreamMuxerBox>>>, info: TInfo, ) -> <T as OutboundUpgradeSend>::Future

Equivalent to OutboundUpgrade::upgrade_outbound.
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> UpgradeInfoSend for T
where T: UpgradeInfo + Send + 'static, <T as UpgradeInfo>::Info: Send + 'static, <<T as UpgradeInfo>::InfoIter as IntoIterator>::IntoIter: Send + 'static,

Source§

type Info = <T as UpgradeInfo>::Info

Equivalent to UpgradeInfo::Info.
Source§

type InfoIter = <<T as UpgradeInfo>::InfoIter as IntoIterator>::IntoIter

Equivalent to UpgradeInfo::InfoIter.
Source§

fn protocol_info(&self) -> <T as UpgradeInfoSend>::InfoIter

Equivalent to UpgradeInfo::protocol_info.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> ErasedDestructor for T
where T: 'static,