io.lettuce.core.failover.health

Interface HealthStatusManager

All Known Implementing Classes:

HealthStatusManagerImpl

@Experimental
public interface HealthStatusManager

Manager for health status of Redis endpoints.

The health status manager coordinates health checks for multiple endpoints and provides a unified view of their health statuses. It also allows registering listeners to be notified when the health status of any endpoint changes.

The health status manager is responsible for:

• Creating and managing health checks for each endpoint
• Notifying listeners when the health status of any endpoint changes
• Providing a unified view of the health statuses of all endpoints

Since:

7.4

Author:

Ali Takavci, Ivo Gaydazhiev

Method Summary

Modifier and Type	Method and Description
HealthCheck	add(RedisURI endpoint, HealthCheckStrategy strategy) Create and register a health check for the given endpoint.
void	close() Close the health status manager and stop all health checks.
HealthStatus	getHealthStatus(RedisURI endpoint) Get the health status for the given endpoint.
long	getMaxWaitFor(RedisURI endpoint) Get the maximum wait time for the health check to complete.
void	registerListener(HealthStatusListener listener) Register a global listener to be notified when the health status of any endpoint changes.
void	registerListener(RedisURI endpoint, HealthStatusListener listener) Register a listener to be notified when the health status of the given endpoint changes.
void	remove(RedisURI endpoint) Unregister the health check for the given endpoint.
void	unregisterListener(HealthStatusListener listener) Unregister a previously registered global listener.
void	unregisterListener(RedisURI endpoint, HealthStatusListener listener) Unregister a previously registered listener for the given endpoint.

Method Detail

add

HealthCheck add(RedisURI endpoint,
                HealthCheckStrategy strategy)

Create and register a health check for the given endpoint.

Parameters:

endpoint - the endpoint to check

strategy - the health check strategy

Returns:

the health check

remove

void remove(RedisURI endpoint)

Unregister the health check for the given endpoint.

Parameters:

endpoint - the endpoint to check

getHealthStatus

HealthStatus getHealthStatus(RedisURI endpoint)

Get the health status for the given endpoint.

Parameters:

endpoint - the endpoint to check

Returns:

the health status

registerListener

void registerListener(HealthStatusListener listener)

Register a global listener to be notified when the health status of any endpoint changes.

Parameters:

listener - the listener to add, must not be null

unregisterListener

void unregisterListener(HealthStatusListener listener)

Unregister a previously registered global listener.

Parameters:

listener - the listener to remove, must not be null

registerListener

void registerListener(RedisURI endpoint,
                      HealthStatusListener listener)

Register a listener to be notified when the health status of the given endpoint changes.

Parameters:

endpoint - the endpoint to check

listener - the listener to add, must not be null

unregisterListener

void unregisterListener(RedisURI endpoint,
                        HealthStatusListener listener)

Unregister a previously registered listener for the given endpoint.

Parameters:

endpoint - the endpoint to check

listener - the listener to remove, must not be null

getMaxWaitFor

long getMaxWaitFor(RedisURI endpoint)

Get the maximum wait time for the health check to complete.

Parameters:

endpoint - the endpoint to check

Returns:

the maximum wait time in milliseconds

close

void close()

Close the health status manager and stop all health checks.