io.lettuce.core

Class TimeoutOptions.Builder

java.lang.Object

io.lettuce.core.TimeoutOptions.Builder

Enclosing class:

TimeoutOptions

public static class TimeoutOptions.Builder
extends Object

Builder for TimeoutOptions.

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
TimeoutOptions	build() Create a new instance of TimeoutOptions.
TimeoutOptions.Builder	connectionTimeout() Configure a TimeoutOptions.TimeoutSource that applies timeouts configured on the connection/client instance.
TimeoutOptions.Builder	fixedTimeout(Duration duration) Set a fixed timeout for all commands.
TimeoutOptions.Builder	relaxedTimeoutsDuringMaintenance(Duration duration) Enable timeout relaxing during maintenance events.
TimeoutOptions.Builder	timeoutCommands() Enable command timeouts.
TimeoutOptions.Builder	timeoutCommands(boolean enabled) Configure whether commands should timeout.
TimeoutOptions.Builder	timeoutSource(TimeoutOptions.TimeoutSource source) Set a TimeoutOptions.TimeoutSource to obtain the timeout value per RedisCommand.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

timeoutCommands

public TimeoutOptions.Builder timeoutCommands()

Enable command timeouts. Disabled by default, see TimeoutOptions.DEFAULT_TIMEOUT_COMMANDS.

Returns:

this

timeoutCommands

public TimeoutOptions.Builder timeoutCommands(boolean enabled)

Configure whether commands should timeout. Disabled by default, see TimeoutOptions.DEFAULT_TIMEOUT_COMMANDS.

Parameters:

enabled - true to enable timeout; false to disable timeouts.

Returns:

this

relaxedTimeoutsDuringMaintenance

public TimeoutOptions.Builder relaxedTimeoutsDuringMaintenance(Duration duration)

Enable timeout relaxing during maintenance events.

If the Redis server supports sending maintenance events, and the client is set up to use that by the ClientOptions.getMaintNotificationsConfig() option, the client would listen to notifications that the current endpoint is about to go down (as part of some maintenance activity, for example). In such cases, the driver could extend the existing timeout settings for newly issued commands, or such that are in flight, to make sure they do not time out during this process. These commands could be either a part of the offline buffer or waiting for a reply.

Parameters:

duration - Duration to relax timeouts proactively, must not be null.

Returns:

this

Since:

7.0

See Also:

ClientOptions.getMaintNotificationsConfig()

fixedTimeout

public TimeoutOptions.Builder fixedTimeout(Duration duration)

Set a fixed timeout for all commands.

Parameters:

duration - the timeout Duration, must not be null.

Returns:

this

connectionTimeout

public TimeoutOptions.Builder connectionTimeout()

Configure a TimeoutOptions.TimeoutSource that applies timeouts configured on the connection/client instance.

Returns:

this

timeoutSource

public TimeoutOptions.Builder timeoutSource(TimeoutOptions.TimeoutSource source)

Set a TimeoutOptions.TimeoutSource to obtain the timeout value per RedisCommand.

Parameters:

source - the timeout source.

Returns:

this

build

public TimeoutOptions build()

Create a new instance of TimeoutOptions.

Returns:

new instance of TimeoutOptions