Struct libp2p::ping::handler::PingHandler

pub struct PingHandler { /* fields omitted */ }

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

impl PingHandler

pub fn new(config: PingConfig) -> PingHandler

Builds a new PingHandler with the given configuration.

Trait Implementations

impl ProtocolsHandler for PingHandler

type InEvent = Void

Custom event that can be received from the outside.

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

The type of errors returned by ProtocolsHandler::poll.

type InboundProtocol = Ping

The inbound upgrade for the protocol(s) used by the handler.

type OutboundProtocol = Ping

The outbound upgrade for the protocol(s) used by the handler.

type OutboundOpenInfo = ()

The type of additional information passed to an OutboundSubstreamRequest.

type InboundOpenInfo = ()

The type of additional information returned from listen_protocol.

pub fn listen_protocol(&self) -> SubstreamProtocol<Ping, ()>

The InboundUpgrade to apply on inbound substreams to negotiate the desired protocols.

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>>>,
    ()
)

Injects the output of a successful upgrade on a new outbound substream.

pub fn inject_event(&mut self, Void)

Injects an event coming from the outside in the handler.

pub fn inject_dial_upgrade_error(
    &mut self,
    _info: (),
    error: ProtocolsHandlerUpgrErr<Void>
)

Indicates to the handler that upgrading an outbound substream to the given protocol has failed.

pub fn connection_keep_alive(&self) -> KeepAlive

Returns until when the connection should be kept alive.

pub fn poll(
    &mut self,
    cx: &mut Context<'_>
) -> Poll<ProtocolsHandlerEvent<Ping, (), Result<PingSuccess, PingFailure>, <PingHandler as ProtocolsHandler>::Error>>

Should behave like Stream::poll().

pub fn inject_address_change(&mut self, _new_address: &Multiaddr)

Notifies the handler of a change in the address of the remote.

pub 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.

pub 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.

pub 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.

pub fn select<TProto2>(
    self,
    other: TProto2
) -> ProtocolsHandlerSelect<Self, TProto2>

Creates a new ProtocolsHandler that selects either this handler or other by delegating methods calls appropriately.

pub fn into_node_handler_builder(self) -> NodeHandlerWrapperBuilder<Self>

Creates a builder that allows creating a NodeHandler that handles this protocol exclusively.