io.lettuce.core.failover.health

Interface HealthCheck

@Experimental
public interface HealthCheck

Interface for health check operations on a Redis endpoint.

A health check periodically monitors the health status of a Redis endpoint and notifies registered listeners when the status changes.

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.

Method Detail

getEndpoint

RedisURI getEndpoint()

Get the endpoint being monitored.

Returns:

the Redis URI of the endpoint

getStatus

HealthStatus getStatus()

Get the current health status of the endpoint.

Returns:

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

stop

void stop()

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

start

void start()

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

getMaxWaitFor

long getMaxWaitFor()

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.

Returns:

the maximum wait duration in milliseconds

addListener

void addListener(HealthStatusListener listener)

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.).

Parameters:

listener - the listener to add, must not be null

removeListener

void removeListener(HealthStatusListener listener)

Remove a previously registered listener.

Parameters:

listener - the listener to remove, must not be null