ClientOptions (lettuce 4.3.3.Final API)

java.lang.Object
- com.lambdaworks.redis.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

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.

Field Summary

Fields
Modifier and Type	Field and Description
`static boolean`	`DEFAULT_AUTO_RECONNECT`
`static boolean`	`DEFAULT_CANCEL_CMD_RECONNECT_FAIL`
`static ClientOptions.DisconnectedBehavior`	`DEFAULT_DISCONNECTED_BEHAVIOR`
`static boolean`	`DEFAULT_PING_BEFORE_ACTIVATE_CONNECTION`
`static int`	`DEFAULT_REQUEST_QUEUE_SIZE`
`static SocketOptions`	`DEFAULT_SOCKET_OPTIONS`
`static SslOptions`	`DEFAULT_SSL_OPTIONS`
`static boolean`	`DEFAULT_SUSPEND_RECONNECT_PROTO_FAIL`

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
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.
`ClientOptions.DisconnectedBehavior`	`getDisconnectedBehavior()` Behavior for command invocation when connections are in a disconnected state.
`int`	`getRequestQueueSize()` Request queue size for a connection.
`SocketOptions`	`getSocketOptions()` Returns the `SocketOptions`.
`SslOptions`	`getSslOptions()` Returns the `SslOptions`.
`boolean`	`isAutoReconnect()` Controls auto-reconnect behavior on connections.
`boolean`	`isCancelCommandsOnReconnectFailure()` If this flag is true any queued commands will be canceled when a reconnect fails within the activation sequence.
`boolean`	`isPingBeforeActivateConnection()` Enables initial PING barrier before any connection is usable.
`boolean`	`isSuspendReconnectOnProtocolFailure()` If this flag is true the reconnect will be suspended on protocol errors.

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

- Field Detail
  - DEFAULT_PING_BEFORE_ACTIVATE_CONNECTION
```
public static final boolean DEFAULT_PING_BEFORE_ACTIVATE_CONNECTION
```
    See Also:
    
    Constant Field Values
  - DEFAULT_AUTO_RECONNECT
```
public static final boolean DEFAULT_AUTO_RECONNECT
```
    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_SUSPEND_RECONNECT_PROTO_FAIL
```
public static final boolean DEFAULT_SUSPEND_RECONNECT_PROTO_FAIL
```
    See Also:
    
    Constant Field Values
  - DEFAULT_REQUEST_QUEUE_SIZE
```
public static final int DEFAULT_REQUEST_QUEUE_SIZE
```
    See Also:
    
    Constant Field Values
  - DEFAULT_DISCONNECTED_BEHAVIOR
```
public static final ClientOptions.DisconnectedBehavior DEFAULT_DISCONNECTED_BEHAVIOR
```
  - DEFAULT_SOCKET_OPTIONS
```
public static final SocketOptions DEFAULT_SOCKET_OPTIONS
```
  - DEFAULT_SSL_OPTIONS
```
public static final SslOptions DEFAULT_SSL_OPTIONS
```
- 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
  - isPingBeforeActivateConnection
```
public boolean isPingBeforeActivateConnection()
```
    Enables initial PING barrier before any connection is usable. If true (default is false ), every connection and reconnect will issue a PING command and awaits its response before the connection is activated and enabled for use. If the check fails, the connect/reconnect is treated as failure.
    
    Returns:
    
    true if PING barrier is enabled.
  - 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.
  - isCancelCommandsOnReconnectFailure
```
public boolean isCancelCommandsOnReconnectFailure()
```
    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.
  - 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.
  - 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.
  - 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
  - getSocketOptions
```
public SocketOptions getSocketOptions()
```
    Returns the SocketOptions.
    
    Returns:
    
    the SocketOptions.
  - getSslOptions
```
public SslOptions getSslOptions()
```
    Returns the SslOptions.
    
    Returns:
    
    the SslOptions.

Class ClientOptions

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_PING_BEFORE_ACTIVATE_CONNECTION

DEFAULT_AUTO_RECONNECT

DEFAULT_CANCEL_CMD_RECONNECT_FAIL

DEFAULT_SUSPEND_RECONNECT_PROTO_FAIL

DEFAULT_REQUEST_QUEUE_SIZE

DEFAULT_DISCONNECTED_BEHAVIOR

DEFAULT_SOCKET_OPTIONS

DEFAULT_SSL_OPTIONS

Constructor Detail

ClientOptions

ClientOptions

Method Detail

copyOf

builder

create

isPingBeforeActivateConnection

isAutoReconnect

isCancelCommandsOnReconnectFailure

isSuspendReconnectOnProtocolFailure

getRequestQueueSize

getDisconnectedBehavior

getSocketOptions

getSslOptions