Struct HealthChecker 

pub struct HealthChecker {
    ping_timeout: Duration,
}

Connection health checker

This structure provides periodic health checking for connections, monitoring response times and overall connection health.

Health Check Process

Connection
    |
    | 1. Send ping
    v
Measure response time
    |
    | 2. Compare to timeout
    v
Health decision (healthy/unhealthy)

Health Criteria

A connection is considered healthy if:

• Response time < ping_timeout (default 5 seconds)

Example Usage

let checker = HealthChecker::new();
let mut handle = ConnectionHandle::new();

let is_healthy = checker.check_connection_health(&mut handle).await;

Fields

ping_timeout: Duration

Maximum allowed response time for a connection to be considered healthy

Implementations

impl HealthChecker

pub fn new() -> Self

Create a new health checker with default settings

Default ping timeout is 5 seconds.

pub fn with_timeout(ping_timeout: Duration) -> Self

Create a new health checker with custom timeout

Parameters

• ping_timeout: Maximum allowed response time

pub async fn check_connection_health( &self, handle: &mut ConnectionHandle, ) -> bool

Check connection health by sending a ping

This method simulates a health check by measuring response time. In a production environment, this would send an actual ping message through the connection.

Parameters

• handle: Mutable reference to the connection handle to update based on health

Returns

• true: Connection is healthy
• false: Connection is unhealthy

Example

let is_healthy = checker.check_connection_health(&mut handle).await;

pub fn ping_timeout(&self) -> Duration

Get the ping timeout

pub fn set_ping_timeout(&mut self, timeout: Duration)

Set a new ping timeout

Trait Implementations

impl Default for HealthChecker

fn default() -> Self

Returns the “default value” for a type.