public static class ClientOptions.Builder extends Object
ClientOptions
.Modifier | Constructor and Description |
---|---|
protected |
Builder() |
Modifier and Type | Method and Description |
---|---|
ClientOptions.Builder |
autoReconnect(boolean autoReconnect)
Enables or disables auto reconnection on connection loss.
|
ClientOptions |
build()
Create a new instance of
ClientOptions . |
ClientOptions.Builder |
cancelCommandsOnReconnectFailure(boolean cancelCommandsOnReconnectFailure)
Allows cancelling queued commands in case a reconnect fails.Defaults to false.
|
ClientOptions.Builder |
disconnectedBehavior(ClientOptions.DisconnectedBehavior disconnectedBehavior)
Sets the behavior for command invocation when connections are in a disconnected state.
|
ClientOptions.Builder |
pingBeforeActivateConnection(boolean pingBeforeActivateConnection)
Sets the PING before activate connection flag.
|
ClientOptions.Builder |
requestQueueSize(int requestQueueSize)
Set the per-connection request queue size.
|
ClientOptions.Builder |
socketOptions(SocketOptions socketOptions)
Sets the low-level
SocketOptions for the connections kept to Redis servers. |
ClientOptions.Builder |
sslOptions(SslOptions sslOptions)
Sets the
SslOptions for SSL connections kept to Redis servers. |
ClientOptions.Builder |
suspendReconnectOnProtocolFailure(boolean suspendReconnectOnProtocolFailure)
Suspends reconnect when reconnects run into protocol failures (SSL verification, PING before connect fails).
|
ClientOptions.Builder |
timeoutOptions(TimeoutOptions timeoutOptions)
Sets the
TimeoutOptions to expire and cancel commands. |
public ClientOptions.Builder pingBeforeActivateConnection(boolean pingBeforeActivateConnection)
ClientOptions.DEFAULT_PING_BEFORE_ACTIVATE_CONNECTION
.pingBeforeActivateConnection
- true/falsethis
public ClientOptions.Builder autoReconnect(boolean autoReconnect)
ClientOptions.DEFAULT_AUTO_RECONNECT
.autoReconnect
- true/falsethis
public ClientOptions.Builder suspendReconnectOnProtocolFailure(boolean suspendReconnectOnProtocolFailure)
ClientOptions.DEFAULT_SUSPEND_RECONNECT_PROTO_FAIL
.suspendReconnectOnProtocolFailure
- true/falsethis
public ClientOptions.Builder cancelCommandsOnReconnectFailure(boolean cancelCommandsOnReconnectFailure)
ClientOptions.DEFAULT_CANCEL_CMD_RECONNECT_FAIL
.cancelCommandsOnReconnectFailure
- true/falsethis
public ClientOptions.Builder requestQueueSize(int requestQueueSize)
RedisException
if the queue
size is exceeded. Setting the requestQueueSize
to a lower value will lead earlier to exceptions during
overload or while the connection is in a disconnected state. A higher value means hitting the boundary will take
longer to occur, but more requests will potentially be queued up and more heap space is used. Defaults to
Integer.MAX_VALUE
. See ClientOptions.DEFAULT_REQUEST_QUEUE_SIZE
.requestQueueSize
- the queue size.this
public ClientOptions.Builder disconnectedBehavior(ClientOptions.DisconnectedBehavior disconnectedBehavior)
ClientOptions.DEFAULT_DISCONNECTED_BEHAVIOR
.disconnectedBehavior
- must not be null.this
public ClientOptions.Builder socketOptions(SocketOptions socketOptions)
SocketOptions
for the connections kept to Redis servers. See
ClientOptions.DEFAULT_SOCKET_OPTIONS
.socketOptions
- must not be null.this
public ClientOptions.Builder sslOptions(SslOptions sslOptions)
SslOptions
for SSL connections kept to Redis servers. See ClientOptions.DEFAULT_SSL_OPTIONS
.sslOptions
- must not be null.this
public ClientOptions.Builder timeoutOptions(TimeoutOptions timeoutOptions)
TimeoutOptions
to expire and cancel commands. See ClientOptions.DEFAULT_TIMEOUT_OPTIONS
.timeoutOptions
- must not be null.this
public ClientOptions build()
ClientOptions
.ClientOptions
Copyright © 2018 lettuce.io. All rights reserved.