Struct libp2p::ping::Behaviour

pub struct Behaviour { /* private fields */ }

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 Behaviour

pub fn new(config: Config) -> Behaviour

Creates a new Ping network behaviour with the given configuration.

Trait Implementations

impl Default for Behaviour

fn default() -> Behaviour

Returns the “default value” for a type.

impl NetworkBehaviour for Behaviour

type ConnectionHandler = Handler

Handler for all the protocols the network behaviour supports.

type OutEvent = Event

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

fn handle_established_inbound_connection( &mut self, _: ConnectionId, _: PeerId, _: &Multiaddr, _: &Multiaddr ) -> Result<<<Behaviour as NetworkBehaviour>::ConnectionHandler as IntoConnectionHandler>::Handler, ConnectionDenied>

Callback that is invoked for every established inbound connection.

fn handle_established_outbound_connection( &mut self, _: ConnectionId, _: PeerId, _: &Multiaddr, _: Endpoint ) -> Result<<<Behaviour as NetworkBehaviour>::ConnectionHandler as IntoConnectionHandler>::Handler, ConnectionDenied>

Callback that is invoked for every established outbound connection.

fn on_connection_handler_event( &mut self, peer: PeerId, _: ConnectionId, result: <<<Behaviour as NetworkBehaviour>::ConnectionHandler as IntoConnectionHandler>::Handler as ConnectionHandler>::OutEvent )

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

fn poll( &mut self, _: &mut Context<'_>, _: &mut impl PollParameters ) -> Poll<ToSwarm<<Behaviour as NetworkBehaviour>::OutEvent, <<<Behaviour as NetworkBehaviour>::ConnectionHandler as IntoConnectionHandler>::Handler as ConnectionHandler>::InEvent>>

Polls for things that swarm should do.

fn on_swarm_event( &mut self, event: FromSwarm<'_, <Behaviour as NetworkBehaviour>::ConnectionHandler> )

Informs the behaviour about an event from the Swarm.

fn new_handler(&mut self) -> Self::ConnectionHandler

👎Deprecated since 0.42.0: Use one or more of NetworkBehaviour::{handle_pending_inbound_connection,handle_established_inbound_connection,handle_pending_outbound_connection,handle_established_outbound_connection} instead.

Creates a new ConnectionHandler for a connection with a peer.

fn handle_pending_inbound_connection( &mut self, _connection_id: ConnectionId, _local_addr: &Multiaddr, _remote_addr: &Multiaddr ) -> Result<(), ConnectionDenied>

Callback that is invoked for every new inbound connection.

fn handle_pending_outbound_connection( &mut self, _connection_id: ConnectionId, maybe_peer: Option<PeerId>, _addresses: &[Multiaddr], _effective_role: Endpoint ) -> Result<Vec<Multiaddr, Global>, ConnectionDenied>

Callback that is invoked for every outbound connection attempt.

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

👎Deprecated: Use NetworkBehaviour::handle_pending_outbound_connection instead.

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