Struct libp2p::ping::Ping

pub struct Ping { /* fields omitted */ }

Ping is a NetworkBehaviour that responds to inbound pings and periodically sends outbound pings on every established connection.

See the crate root documentation for more information.

Implementations

impl Ping

pub fn new(config: PingConfig) -> Ping

Creates a new Ping network behaviour with the given configuration.

Trait Implementations

impl Default for Ping

pub fn default() -> Ping

Returns the “default value” for a type.

impl NetworkBehaviour for Ping

type ProtocolsHandler = PingHandler

Handler for all the protocols the network behaviour supports.

type OutEvent = PingEvent

Event generated by the NetworkBehaviour and that the swarm will report back.

pub fn new_handler(&mut self) -> <Ping as NetworkBehaviour>::ProtocolsHandler

Creates a new ProtocolsHandler for a connection with a peer.

pub fn addresses_of_peer(&mut self, _peer_id: &PeerId) -> Vec<Multiaddr, Global>

Addresses that this behaviour is aware of for this specific peer, and that may allow reaching the peer.

pub fn inject_connected(&mut self, &PeerId)

Indicate to the behaviour that we connected to the node with the given peer id.

pub fn inject_disconnected(&mut self, &PeerId)

Indicates to the behaviour that we disconnected from the node with the given peer id.

pub fn inject_event(
    &mut self,
    peer: PeerId,
    ConnectionId,
    result: Result<PingSuccess, PingFailure>
)

Informs the behaviour about an event generated by the handler dedicated to the peer identified by peer_id. for the behaviour.

pub fn poll(
    &mut self,
    &mut Context<'_>,
    &mut impl PollParameters
) -> Poll<NetworkBehaviourAction<Void, PingEvent>>

Polls for things that swarm should do.

fn inject_connection_established(
    &mut self,
    &PeerId,
    &ConnectionId,
    &ConnectedPoint
)

Informs the behaviour about a newly established connection to a peer.

fn inject_connection_closed(&mut self, &PeerId, &ConnectionId, &ConnectedPoint)

Informs the behaviour about a closed connection to a peer.

fn inject_address_change(
    &mut self,
    &PeerId,
    &ConnectionId,
    _old: &ConnectedPoint,
    _new: &ConnectedPoint
)

Informs the behaviour that the ConnectedPoint of an existing connection has changed.

fn inject_addr_reach_failure(
    &mut self,
    _peer_id: Option<&PeerId>,
    _addr: &Multiaddr,
    _error: &dyn Error
)

Indicates to the behaviour that we tried to reach an address, but failed.

fn inject_dial_failure(&mut self, _peer_id: &PeerId)

Indicates to the behaviour that we tried to dial all the addresses known for a node, but failed.

fn inject_new_listener(&mut self, _id: ListenerId)

Indicates to the behaviour that a new listener was created.

fn inject_new_listen_addr(&mut self, _id: ListenerId, _addr: &Multiaddr)

Indicates to the behaviour that we have started listening on a new multiaddr.

fn inject_expired_listen_addr(&mut self, _id: ListenerId, _addr: &Multiaddr)

Indicates to the behaviour that a multiaddr we were listening on has expired, which means that we are no longer listening in it.

fn inject_listener_error(
    &mut self,
    _id: ListenerId,
    _err: &(dyn Error + 'static)
)

A listener experienced an error.

fn inject_listener_closed(
    &mut self,
    _id: ListenerId,
    _reason: Result<(), &Error>
)

A listener closed.

fn inject_new_external_addr(&mut self, _addr: &Multiaddr)

Indicates to the behaviour that we have discovered a new external address for us.

fn inject_expired_external_addr(&mut self, _addr: &Multiaddr)

Indicates to the behaviour that an external address was removed.