Module lettuce.core

Package io.lettuce.core

Class TimeoutOptions

java.lang.Object

io.lettuce.core.TimeoutOptions

All Implemented Interfaces:

Serializable

public class TimeoutOptions
extends Object
implements Serializable

Options for command timeouts. This options configure how and whether commands time out once they were dispatched. Command timeout begins:

• When the command is sent successfully to the transport
• Queued while the connection was inactive

The timeout is canceled upon command completion/cancellation. Timeouts are not tied to a specific API and expire commands regardless of the synchronization method provided by the API that was used to enqueue the command.

Since:

5.1

Author:

Mark Paluch

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TimeoutOptions.Builder	Builder for TimeoutOptions.
static class	TimeoutOptions.TimeoutSource	Source for the actual timeout to expire a particular RedisCommand.

Field Summary

Fields

Modifier and Type	Field	Description
static boolean	DEFAULT_TIMEOUT_COMMANDS

Method Summary

Modifier and Type	Method	Description
static TimeoutOptions.Builder	builder()	Returns a new TimeoutOptions.Builder to construct TimeoutOptions.
static TimeoutOptions	create()	Create a new instance of TimeoutOptions with default settings.
static TimeoutOptions	enabled()	Create a new instance of TimeoutOptions with enabled timeout applying default connection timeouts.
static TimeoutOptions	enabled(Duration timeout)	Create a new instance of TimeoutOptions with enabled timeout applying a fixed timeout.
TimeoutOptions.TimeoutSource	getSource()
boolean	isApplyConnectionTimeout()
boolean	isTimeoutCommands()

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_TIMEOUT_COMMANDS

public static final boolean DEFAULT_TIMEOUT_COMMANDS

See Also:

Constant Field Values

Method Details

builder

public static TimeoutOptions.Builder builder()

Returns a new TimeoutOptions.Builder to construct TimeoutOptions.

Returns:

a new TimeoutOptions.Builder to construct TimeoutOptions.

create

public static TimeoutOptions create()

Create a new instance of TimeoutOptions with default settings.

Returns:

a new instance of TimeoutOptions with default settings.

enabled

public static TimeoutOptions enabled()

Create a new instance of TimeoutOptions with enabled timeout applying default connection timeouts.

Returns:

a new instance of TimeoutOptions with enabled timeout applying default connection timeouts.

enabled

public static TimeoutOptions enabled(Duration timeout)

Create a new instance of TimeoutOptions with enabled timeout applying a fixed timeout.

Returns:

a new instance of TimeoutOptions with enabled timeout applying a fixed timeout.

isTimeoutCommands

public boolean isTimeoutCommands()

Returns:

true if commands should time out.

isApplyConnectionTimeout

public boolean isApplyConnectionTimeout()

Returns:

true to apply connection timeouts declared on connection level.

getSource

public TimeoutOptions.TimeoutSource getSource()

Returns:

the timeout source to determine the timeout for a RedisCommand. Can be null if isTimeoutCommands() is false.