public class ClientOptions extends Object implements Serializable
RedisClient
.Modifier and Type | Class and Description |
---|---|
static class |
ClientOptions.Builder
Builder for
ClientOptions . |
static class |
ClientOptions.DisconnectedBehavior
Behavior of connections in disconnected state.
|
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 |
Modifier | Constructor and Description |
---|---|
protected |
ClientOptions(ClientOptions.Builder builder) |
protected |
ClientOptions(ClientOptions original) |
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.
|
public static final boolean DEFAULT_PING_BEFORE_ACTIVATE_CONNECTION
public static final boolean DEFAULT_AUTO_RECONNECT
public static final boolean DEFAULT_CANCEL_CMD_RECONNECT_FAIL
public static final boolean DEFAULT_SUSPEND_RECONNECT_PROTO_FAIL
public static final int DEFAULT_REQUEST_QUEUE_SIZE
public static final ClientOptions.DisconnectedBehavior DEFAULT_DISCONNECTED_BEHAVIOR
public static final SocketOptions DEFAULT_SOCKET_OPTIONS
public static final SslOptions DEFAULT_SSL_OPTIONS
protected ClientOptions(ClientOptions.Builder builder)
protected ClientOptions(ClientOptions original)
public static ClientOptions copyOf(ClientOptions options)
options
- the originalClientOptions
containing the values of optionspublic static ClientOptions.Builder builder()
ClientOptions.Builder
to construct ClientOptions
.ClientOptions.Builder
to construct ClientOptions
.public static ClientOptions create()
ClientOptions
with default settings.ClientOptions
with default settingspublic boolean isPingBeforeActivateConnection()
public boolean isAutoReconnect()
public boolean isCancelCommandsOnReconnectFailure()
public boolean isSuspendReconnectOnProtocolFailure()
public int getRequestQueueSize()
RedisException
if the queue size is exceeded and a new command is requested. Defaults to
Integer.MAX_VALUE
.public ClientOptions.DisconnectedBehavior getDisconnectedBehavior()
true
. See DEFAULT_DISCONNECTED_BEHAVIOR
.public SocketOptions getSocketOptions()
SocketOptions
.SocketOptions
.public SslOptions getSslOptions()
SslOptions
.SslOptions
.Copyright © 2017 lettuce.io. All rights reserved.