Struct libp2p_swarm::keep_alive::Behaviour

pub struct Behaviour;

👎Deprecated: Configure an appropriate idle connection timeout via SwarmBuilder::idle_connection_timeout instead. To keep connections alive ‘forever’, use Duration::from_secs(u64::MAX).

Implementation of NetworkBehaviour that doesn’t do anything other than keep all connections alive.

This is primarily useful for test code. In can however occasionally be useful for production code too. The caveat is that open connections consume system resources and should thus be shutdown when they are not in use. Connections can also fail at any time so really, your application should be designed to establish them when necessary, making the use of this behaviour likely redundant.

Trait Implementations

impl Default for Behaviour

fn default() -> Behaviour

Returns the “default value” for a type.

impl NetworkBehaviour for Behaviour

type ConnectionHandler = ConnectionHandler

Handler for all the protocols the network behaviour supports.

type ToSwarm = Void

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

fn handle_established_inbound_connection( &mut self, _: ConnectionId, _: PeerId, _: &Multiaddr, _: &Multiaddr, ) -> Result<THandler<Self>, ConnectionDenied>

Callback that is invoked for every established inbound connection.

fn handle_established_outbound_connection( &mut self, _: ConnectionId, _: PeerId, _: &Multiaddr, _: Endpoint, ) -> Result<THandler<Self>, ConnectionDenied>

Callback that is invoked for every established outbound connection.

fn on_connection_handler_event( &mut self, _: PeerId, _: ConnectionId, event: THandlerOutEvent<Self>, )

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<Self::ToSwarm, THandlerInEvent<Self>>>

Polls for things that swarm should do.

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

Informs the behaviour about an event from the Swarm.

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>, ConnectionDenied>

Callback that is invoked for every outbound connection attempt.