io.lettuce.core.failover.health

Class HealthCheckImpl

java.lang.Object

io.lettuce.core.failover.health.HealthCheckImpl

All Implemented Interfaces:

HealthCheck

@Experimental
public class HealthCheckImpl
extends Object
implements HealthCheck

Implementation of the HealthCheck interface.

This class is responsible for periodically checking the health of a Redis endpoint and updating the health status accordingly.

Since:

7.4

Author:

Ali Takavci, Ivo Gaydazhiev

Method Summary

Modifier and Type	Method and Description
void	addListener(HealthStatusListener listener) Add a listener to be notified when the health status changes.
RedisURI	getEndpoint() Get the endpoint being monitored.
long	getMaxWaitFor() Get the maximum wait duration (in milliseconds) to wait for health check HealthStatus reach stable state.
HealthStatus	getStatus() Get the current health status of the endpoint.
void	removeListener(HealthStatusListener listener) Remove a previously registered listener.
void	start() Start the health check.
void	stop() Stop the health check.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getEndpoint

public RedisURI getEndpoint()

Description copied from interface: HealthCheck

Get the endpoint being monitored.

Specified by:

getEndpoint in interface HealthCheck

Returns:

the Redis URI of the endpoint

getStatus

public HealthStatus getStatus()

Description copied from interface: HealthCheck

Get the current health status of the endpoint.

Specified by:

getStatus in interface HealthCheck

Returns:

the current health status (HEALTHY, UNHEALTHY, or UNKNOWN)

start

public void start()

Description copied from interface: HealthCheck

Start the health check. This will begin periodic health check execution.

Specified by:

start in interface HealthCheck

stop

public void stop()

Description copied from interface: HealthCheck

Stop the health check. This will stop the periodic health check execution and clean up resources.

Specified by:

stop in interface HealthCheck

getMaxWaitFor

public long getMaxWaitFor()

Description copied from interface: HealthCheck

Get the maximum wait duration (in milliseconds) to wait for health check HealthStatus reach stable state.

Transition to stable state means either HEALTHY or UNHEALTHY. UNKNOWN is not considered stable. This is calculated based on the health check strategy's timeout, retry delay and retry count.

Specified by:

getMaxWaitFor in interface HealthCheck

Returns:

the maximum wait duration in milliseconds

addListener

public void addListener(HealthStatusListener listener)

Description copied from interface: HealthCheck

Add a listener to be notified when the health status changes.

The listener will be invoked whenever the health status transitions from one state to another (e.g., HEALTHY to UNHEALTHY, UNKNOWN to HEALTHY, etc.).

Specified by:

addListener in interface HealthCheck

Parameters:

listener - the listener to add, must not be null

removeListener

public void removeListener(HealthStatusListener listener)

Description copied from interface: HealthCheck

Remove a previously registered listener.

Specified by:

removeListener in interface HealthCheck

Parameters:

listener - the listener to remove, must not be null