io.lettuce.core.failover.health

Class PingStrategy

java.lang.Object

io.lettuce.core.failover.health.PingStrategy

All Implemented Interfaces:

HealthCheckStrategy, Closeable, AutoCloseable

@Experimental
public class PingStrategy
extends Object
implements HealthCheckStrategy

Health check strategy that uses PING command to check endpoint health.

Since:

7.4

Author:

Ali Takavci

Nested Class Summary

Nested classes/interfaces inherited from interface io.lettuce.core.failover.health.HealthCheckStrategy

HealthCheckStrategy.Config

Field Summary

Fields

Modifier and Type	Field and Description
static HealthCheckStrategySupplier	DEFAULT

Constructor Summary

Constructors

Constructor and Description
PingStrategy(RawConnectionFactory connectionFactory)
PingStrategy(RawConnectionFactory connectionFactory, HealthCheckStrategy.Config config)

Method Summary

Modifier and Type	Method and Description
void	close() Close any resources used by the health check strategy.
HealthStatus	doHealthCheck(RedisURI endpoint) Perform the health check for the given endpoint.
int	getDelayInBetweenProbes() Get the delay (in milliseconds) between retries for failed health checks.
int	getInterval() Get the interval (in milliseconds) between health checks.
int	getNumProbes() Get the number of probes for health checks to repeat.
ProbingPolicy	getPolicy() Get the policy for health checks.
int	getTimeout() Get the timeout (in milliseconds) for a health check.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT

public static final HealthCheckStrategySupplier DEFAULT

Constructor Detail

PingStrategy

public PingStrategy(RawConnectionFactory connectionFactory)

PingStrategy

public PingStrategy(RawConnectionFactory connectionFactory,
                    HealthCheckStrategy.Config config)

Method Detail

getInterval

public int getInterval()

Description copied from interface: HealthCheckStrategy

Get the interval (in milliseconds) between health checks.

Specified by:

getInterval in interface HealthCheckStrategy

Returns:

the interval in milliseconds

getTimeout

public int getTimeout()

Description copied from interface: HealthCheckStrategy

Get the timeout (in milliseconds) for a health check.

Specified by:

getTimeout in interface HealthCheckStrategy

Returns:

the timeout in milliseconds

getNumProbes

public int getNumProbes()

Description copied from interface: HealthCheckStrategy

Get the number of probes for health checks to repeat.

Specified by:

getNumProbes in interface HealthCheckStrategy

Returns:

the number of probes

getPolicy

public ProbingPolicy getPolicy()

Description copied from interface: HealthCheckStrategy

Get the policy for health checks.

Specified by:

getPolicy in interface HealthCheckStrategy

Returns:

the policy

getDelayInBetweenProbes

public int getDelayInBetweenProbes()

Description copied from interface: HealthCheckStrategy

Get the delay (in milliseconds) between retries for failed health checks.

Specified by:

getDelayInBetweenProbes in interface HealthCheckStrategy

Returns:

the delay in milliseconds

doHealthCheck

public HealthStatus doHealthCheck(RedisURI endpoint)

Description copied from interface: HealthCheckStrategy

Perform the health check for the given endpoint.

Specified by:

doHealthCheck in interface HealthCheckStrategy

Parameters:

endpoint - the endpoint to check

Returns:

the health status

close

public void close()

Description copied from interface: HealthCheckStrategy

Close any resources used by the health check strategy.

Specified by:

close in interface HealthCheckStrategy

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable