Module network::protocols::health_checker

Protocol used to ensure peer liveness

The HealthChecker is responsible for ensuring liveness of all peers of a node. It does so by periodically selecting a random connected peer and sending a Ping probe. A healthy peer is expected to respond with a corresponding Pong message.

If a certain number of successive liveness probes for a peer fail, the HealthChecker initiates a disconnect from the peer. It relies on ConnectivityManager or the remote peer to re-establish the connection.

Future Work

We can make a few other improvements to the health checker. These are:

• Make the policy for interpreting ping failures pluggable
• Use successful inbound pings as a sign of remote note being healthy
• Ping a peer only in periods of no application-level communication with the peer

Modules

• builder

Structs

• HealthChecker
  The actor performing health checks by running the Ping protocol
• HealthCheckerNetworkSender
  The interface from HealthChecker to Networking layer.
• Ping
• Pong

Enums

• HealthCheckerMsg

Functions

• network_endpoint_config
  Configuration for the network endpoints to support HealthChecker.

Type Definitions

• HealthCheckerNetworkEvents
  The interface from Network to HealthChecker layer.