ClientOptions (Lettuce 6.6.0.RELEASE API)

java.lang.Object
- io.lettuce.core.ClientOptions

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

ClusterClientOptions
```
public class ClientOptions
extends Object
implements Serializable
```
Client Options to control the behavior of RedisClient.

Author:

Mark Paluch, Gavin Cook, Jim Brunner

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`ClientOptions.Builder` Builder for `ClientOptions`.
`static class`	`ClientOptions.DisconnectedBehavior` Behavior of connections in disconnected state.
`static class`	`ClientOptions.ReauthenticateBehavior` Defines the re-authentication behavior of the Redis client.

Field Summary

Fields
Modifier and Type	Field and Description
`static boolean`	`DEFAULT_AUTO_RECONNECT`
`static int`	`DEFAULT_BUFFER_USAGE_RATIO`
`static boolean`	`DEFAULT_CANCEL_CMD_RECONNECT_FAIL`
`static ClientOptions.DisconnectedBehavior`	`DEFAULT_DISCONNECTED_BEHAVIOR`
`static Supplier<JsonParser>`	`DEFAULT_JSON_PARSER`
`static boolean`	`DEFAULT_PING_BEFORE_ACTIVATE_CONNECTION`
`static ProtocolVersion`	`DEFAULT_PROTOCOL_VERSION`
`static boolean`	`DEFAULT_PUBLISH_ON_SCHEDULER`
`static ReadOnlyCommands.ReadOnlyPredicate`	`DEFAULT_READ_ONLY_COMMANDS`
`static ClientOptions.ReauthenticateBehavior`	`DEFAULT_REAUTHENTICATE_BEHAVIOUR`
`static Predicate<RedisCommand<?,?,?>>`	`DEFAULT_REPLAY_FILTER`
`static int`	`DEFAULT_REQUEST_QUEUE_SIZE`
`static Charset`	`DEFAULT_SCRIPT_CHARSET`
`static SocketOptions`	`DEFAULT_SOCKET_OPTIONS`
`static SslOptions`	`DEFAULT_SSL_OPTIONS`
`static boolean`	`DEFAULT_SUSPEND_RECONNECT_PROTO_FAIL`
`static TimeoutOptions`	`DEFAULT_TIMEOUT_OPTIONS`
`static boolean`	`DEFAULT_USE_HASH_INDEX_QUEUE`

Constructor Summary

Constructors
Modifier Constructor and Description

protected ClientOptions(ClientOptions.Builder builder)

protected ClientOptions(ClientOptions original)

Constructors
Modifier	Constructor and Description
`protected`	`ClientOptions(ClientOptions.Builder builder)`
`protected`	`ClientOptions(ClientOptions original)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static ClientOptions.Builder`	`builder()` Returns a new `ClientOptions.Builder` to construct `ClientOptions`.
`static ClientOptions`	`copyOf(ClientOptions options)` Create a copy of options
`static ClientOptions`	`create()` Create a new instance of `ClientOptions` with default settings.
`int`	`getBufferUsageRatio()` Deprecated. since 6.0 in favor of `DecodeBufferPolicy`.
`ProtocolVersion`	`getConfiguredProtocolVersion()` Returns the configured `ProtocolVersion`.
`DecodeBufferPolicy`	`getDecodeBufferPolicy()` Returns the `DecodeBufferPolicy` used to reclaim memory.
`ClientOptions.DisconnectedBehavior`	`getDisconnectedBehavior()` Behavior for command invocation when connections are in a disconnected state.
`Supplier<JsonParser>`	`getJsonParser()` Returns the currently set up `JsonParser`.
`ProtocolVersion`	`getProtocolVersion()` Returns the `ProtocolVersion` to use.
`ReadOnlyCommands.ReadOnlyPredicate`	`getReadOnlyCommands()` Predicate to identify commands as read-only.
`ClientOptions.ReauthenticateBehavior`	`getReauthenticateBehaviour()` Behavior for re-authentication when the `RedisCredentialsProvider` emits new credentials.
`Predicate<RedisCommand<?,?,?>>`	`getReplayFilter()` Controls which `RedisCommand` will be replayed after a re-connect.
`int`	`getRequestQueueSize()` Request queue size for a connection.
`Charset`	`getScriptCharset()` Returns the Lua script `Charset`.
`SocketOptions`	`getSocketOptions()` Returns the `SocketOptions`.
`SslOptions`	`getSslOptions()` Returns the `SslOptions`.
`TimeoutOptions`	`getTimeoutOptions()` Returns the `TimeoutOptions`.
`boolean`	`isAutoReconnect()` Controls auto-reconnect behavior on connections.
`boolean`	`isCancelCommandsOnReconnectFailure()` Deprecated. since 6.2, to be removed with 7.0. See `ClientOptions.Builder.cancelCommandsOnReconnectFailure(boolean)`.
`boolean`	`isPingBeforeActivateConnection()` Perform a lightweight PING connection handshake when establishing a Redis connection.
`boolean`	`isPublishOnScheduler()` Use a dedicated `Scheduler` to emit reactive data signals.
`boolean`	`isSuspendReconnectOnProtocolFailure()` If this flag is `true`, the reconnect will be suspended on protocol errors.
`boolean`	`isUseHashIndexedQueue()` Whether we should use hash indexed queue, which provides O(1) remove(Object)
`ClientOptions.Builder`	`mutate()` Returns a builder to create new `ClientOptions` whose settings are replicated from the current `ClientOptions`.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT_AUTO_RECONNECT
```
public static final boolean DEFAULT_AUTO_RECONNECT
```
    See Also:
    
    Constant Field Values
  - DEFAULT_REPLAY_FILTER
```
public static final Predicate<RedisCommand<?,?,?>> DEFAULT_REPLAY_FILTER
```
  - DEFAULT_BUFFER_USAGE_RATIO
```
public static final int DEFAULT_BUFFER_USAGE_RATIO
```
    See Also:
    
    Constant Field Values
  - DEFAULT_CANCEL_CMD_RECONNECT_FAIL
```
public static final boolean DEFAULT_CANCEL_CMD_RECONNECT_FAIL
```
    See Also:
    
    Constant Field Values
  - DEFAULT_DISCONNECTED_BEHAVIOR
```
public static final ClientOptions.DisconnectedBehavior DEFAULT_DISCONNECTED_BEHAVIOR
```
  - DEFAULT_REAUTHENTICATE_BEHAVIOUR
```
public static final ClientOptions.ReauthenticateBehavior DEFAULT_REAUTHENTICATE_BEHAVIOUR
```
  - DEFAULT_PUBLISH_ON_SCHEDULER
```
public static final boolean DEFAULT_PUBLISH_ON_SCHEDULER
```
    See Also:
    
    Constant Field Values
  - DEFAULT_PING_BEFORE_ACTIVATE_CONNECTION
```
public static final boolean DEFAULT_PING_BEFORE_ACTIVATE_CONNECTION
```
    See Also:
    
    Constant Field Values
  - DEFAULT_PROTOCOL_VERSION
```
public static final ProtocolVersion DEFAULT_PROTOCOL_VERSION
```
  - DEFAULT_READ_ONLY_COMMANDS
```
public static final ReadOnlyCommands.ReadOnlyPredicate DEFAULT_READ_ONLY_COMMANDS
```
  - DEFAULT_REQUEST_QUEUE_SIZE
```
public static final int DEFAULT_REQUEST_QUEUE_SIZE
```
    See Also:
    
    Constant Field Values
  - DEFAULT_SCRIPT_CHARSET
```
public static final Charset DEFAULT_SCRIPT_CHARSET
```
  - DEFAULT_SOCKET_OPTIONS
```
public static final SocketOptions DEFAULT_SOCKET_OPTIONS
```
  - DEFAULT_JSON_PARSER
```
public static final Supplier<JsonParser> DEFAULT_JSON_PARSER
```
  - DEFAULT_SSL_OPTIONS
```
public static final SslOptions DEFAULT_SSL_OPTIONS
```
  - DEFAULT_SUSPEND_RECONNECT_PROTO_FAIL
```
public static final boolean DEFAULT_SUSPEND_RECONNECT_PROTO_FAIL
```
    See Also:
    
    Constant Field Values
  - DEFAULT_TIMEOUT_OPTIONS
```
public static final TimeoutOptions DEFAULT_TIMEOUT_OPTIONS
```
  - DEFAULT_USE_HASH_INDEX_QUEUE
```
public static final boolean DEFAULT_USE_HASH_INDEX_QUEUE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ClientOptions
```
protected ClientOptions(ClientOptions.Builder builder)
```
  - ClientOptions
```
protected ClientOptions(ClientOptions original)
```
- Method Detail
  - copyOf
```
public static ClientOptions copyOf(ClientOptions options)
```
    Create a copy of options
    
    Parameters:
    
    options - the original
    
    Returns:
    
    A new instance of ClientOptions containing the values of options
  - builder
```
public static ClientOptions.Builder builder()
```
    Returns a new ClientOptions.Builder to construct ClientOptions.
    
    Returns:
    
    a new ClientOptions.Builder to construct ClientOptions.
  - create
```
public static ClientOptions create()
```
    Create a new instance of ClientOptions with default settings.
    
    Returns:
    
    a new instance of ClientOptions with default settings
  - mutate
```
public ClientOptions.Builder mutate()
```
    Returns a builder to create new ClientOptions whose settings are replicated from the current ClientOptions.
    
    Returns:
    
    a ClientOptions.Builder to create new ClientOptions whose settings are replicated from the current ClientOptions.
    
    Since:
    
    5.1
  - isAutoReconnect
```
public boolean isAutoReconnect()
```
    Controls auto-reconnect behavior on connections. If auto-reconnect is true (default), it is enabled. As soon as a connection gets closed/reset without the intention to close it, the client will try to reconnect and re-issue any queued commands. This flag has also the effect that disconnected connections will refuse commands and cancel these with an exception.
    
    Returns:
    
    true if auto-reconnect is enabled.
  - getReplayFilter
```
public Predicate<RedisCommand<?,?,?>> getReplayFilter()
```
    Controls which RedisCommand will be replayed after a re-connect. The Predicate returns true if command should be filtered out and not replayed. Defaults to DEFAULT_REPLAY_FILTER.
    
    Returns:
    
    the currently set Predicate used to filter out commands to replay
  - isCancelCommandsOnReconnectFailure
```
@Deprecated
public boolean isCancelCommandsOnReconnectFailure()
```
    Deprecated. since 6.2, to be removed with 7.0. See ClientOptions.Builder.cancelCommandsOnReconnectFailure(boolean).
    
    If this flag is true any queued commands will be canceled when a reconnect fails within the activation sequence. Default is false.
    
    Returns:
    
    true if commands should be cancelled on reconnect failures.
  - getDecodeBufferPolicy
```
public DecodeBufferPolicy getDecodeBufferPolicy()
```
    Returns the DecodeBufferPolicy used to reclaim memory.
    
    Returns:
    
    the DecodeBufferPolicy.
    
    Since:
    
    6.0
  - getBufferUsageRatio
```
@Deprecated
public int getBufferUsageRatio()
```
    Deprecated. since 6.0 in favor of DecodeBufferPolicy.
    
    Buffer usage ratio for CommandHandler. This ratio controls how often bytes are discarded during decoding. In particular, when buffer usage reaches bufferUsageRatio / bufferUsageRatio + 1. E.g. setting bufferUsageRatio to 3, will discard read bytes once the buffer usage reaches 75 percent.
    
    Returns:
    
    zero.
    
    Since:
    
    5.2
  - getDisconnectedBehavior
```
public ClientOptions.DisconnectedBehavior getDisconnectedBehavior()
```
    Behavior for command invocation when connections are in a disconnected state. Defaults to true. See DEFAULT_DISCONNECTED_BEHAVIOR.
    
    Returns:
    
    the behavior for command invocation when connections are in a disconnected state
  - getReauthenticateBehaviour
```
public ClientOptions.ReauthenticateBehavior getReauthenticateBehaviour()
```
    Behavior for re-authentication when the RedisCredentialsProvider emits new credentials. Defaults to ClientOptions.ReauthenticateBehavior.DEFAULT.
    
    Returns:
    
    the currently set ClientOptions.ReauthenticateBehavior.
  - getReadOnlyCommands
```
public ReadOnlyCommands.ReadOnlyPredicate getReadOnlyCommands()
```
    Predicate to identify commands as read-only. Defaults to DEFAULT_READ_ONLY_COMMANDS.
    
    Returns:
    
    the predicate to identify read-only commands.
  - getRequestQueueSize
```
public int getRequestQueueSize()
```
    Request queue size for a connection. This value applies per connection. The command invocation will throw a RedisException if the queue size is exceeded and a new command is requested. Defaults to Integer.MAX_VALUE.
    
    Returns:
    
    the request queue size.
  - isPingBeforeActivateConnection
```
public boolean isPingBeforeActivateConnection()
```
    Perform a lightweight PING connection handshake when establishing a Redis connection. If true (default is true), every connection and reconnect will issue a PING command and await its response before the connection is activated and enabled for use. If the check fails, the connect/reconnect is treated as a failure. This option has no effect unless forced to use the RESP 2 protocol version. RESP 3/protocol discovery performs a HELLO handshake.
    The PING handshake validates whether the other end of the connected socket is a service that behaves like a Redis server.
    
    Returns:
    
    true if PING handshake is enabled.
  - getProtocolVersion
```
public ProtocolVersion getProtocolVersion()
```
    Returns the ProtocolVersion to use.
    
    Returns:
    
    the ProtocolVersion to use.
  - getConfiguredProtocolVersion
```
public ProtocolVersion getConfiguredProtocolVersion()
```
    Returns the configured ProtocolVersion. May return null if unconfigured.
    
    Returns:
    
    the ProtocolVersion to use. May be null.
    
    Since:
    
    6.0
  - isPublishOnScheduler
```
public boolean isPublishOnScheduler()
```
    Use a dedicated Scheduler to emit reactive data signals. Enabling this option can be useful for reactive sequences that require a significant amount of processing with a single/a few Redis connections.
    A single Redis connection operates on a single thread. Operations that require a significant amount of processing can lead to a single-threaded-like behavior for all consumers of the Redis connection. When enabled, data signals will be emitted using a different thread served by ClientResources.eventExecutorGroup(). Defaults to false , see DEFAULT_PUBLISH_ON_SCHEDULER.
    
    Returns:
    
    true to use a dedicated Scheduler
    
    Since:
    
    5.2
  - isSuspendReconnectOnProtocolFailure
```
public boolean isSuspendReconnectOnProtocolFailure()
```
    If this flag is true, the reconnect will be suspended on protocol errors. Protocol errors are errors while SSL negotiation or when PING before connect fails.
    
    Returns:
    
    true if reconnect will be suspended on protocol errors.
  - getScriptCharset
```
public Charset getScriptCharset()
```
    Returns the Lua script Charset.
    
    Returns:
    
    the script Charset.
    
    Since:
    
    6.0
  - getJsonParser
```
public Supplier<JsonParser> getJsonParser()
```
    Returns the currently set up JsonParser.
    
    Returns:
    
    the implementation of the JsonParser to use.
    
    Since:
    
    6.5
  - getSocketOptions
```
public SocketOptions getSocketOptions()
```
    Returns the SocketOptions.
    
    Returns:
    
    the SocketOptions.
  - getSslOptions
```
public SslOptions getSslOptions()
```
    Returns the SslOptions.
    
    Returns:
    
    the SslOptions.
  - getTimeoutOptions
```
public TimeoutOptions getTimeoutOptions()
```
    Returns the TimeoutOptions.
    
    Returns:
    
    the TimeoutOptions.
    
    Since:
    
    5.1
  - isUseHashIndexedQueue
```
public boolean isUseHashIndexedQueue()
```
    Whether we should use hash indexed queue, which provides O(1) remove(Object)
    
    Returns:
    
    if hash indexed queue should be used

Class ClientOptions

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_AUTO_RECONNECT

DEFAULT_REPLAY_FILTER

DEFAULT_BUFFER_USAGE_RATIO

DEFAULT_CANCEL_CMD_RECONNECT_FAIL

DEFAULT_DISCONNECTED_BEHAVIOR

DEFAULT_REAUTHENTICATE_BEHAVIOUR

DEFAULT_PUBLISH_ON_SCHEDULER

DEFAULT_PING_BEFORE_ACTIVATE_CONNECTION

DEFAULT_PROTOCOL_VERSION

DEFAULT_READ_ONLY_COMMANDS

DEFAULT_REQUEST_QUEUE_SIZE

DEFAULT_SCRIPT_CHARSET

DEFAULT_SOCKET_OPTIONS

DEFAULT_JSON_PARSER

DEFAULT_SSL_OPTIONS

DEFAULT_SUSPEND_RECONNECT_PROTO_FAIL

DEFAULT_TIMEOUT_OPTIONS

DEFAULT_USE_HASH_INDEX_QUEUE

Constructor Detail

ClientOptions

ClientOptions

Method Detail

copyOf

builder

create

mutate

isAutoReconnect

getReplayFilter

isCancelCommandsOnReconnectFailure

getDecodeBufferPolicy

getBufferUsageRatio

getDisconnectedBehavior

getReauthenticateBehaviour

getReadOnlyCommands

getRequestQueueSize

isPingBeforeActivateConnection

getProtocolVersion

getConfiguredProtocolVersion

isPublishOnScheduler

isSuspendReconnectOnProtocolFailure

getScriptCharset

getJsonParser

getSocketOptions

getSslOptions

getTimeoutOptions

isUseHashIndexedQueue