public static class ClusterClientOptions.Builder extends ClientOptions.Builder
ClusterClientOptions
.Modifier | Constructor and Description |
---|---|
protected |
Builder() |
Modifier and Type | Method and Description |
---|---|
ClusterClientOptions.Builder |
autoReconnect(boolean autoReconnect)
Enables or disables auto reconnection on connection loss.
|
ClusterClientOptions |
build()
Create a new instance of
ClusterClientOptions |
ClusterClientOptions.Builder |
cancelCommandsOnReconnectFailure(boolean cancelCommandsOnReconnectFailure)
Allows cancelling queued commands in case a reconnect fails.Defaults to false.
|
ClusterClientOptions.Builder |
disconnectedBehavior(ClientOptions.DisconnectedBehavior disconnectedBehavior)
Sets the behavior for command invocation when connections are in a disconnected state.
|
ClusterClientOptions.Builder |
maxRedirects(int maxRedirects)
Number of maximal cluster redirects (-MOVED and -ASK) to follow in case a key was moved from
one node to another node.
|
ClusterClientOptions.Builder |
pingBeforeActivateConnection(boolean pingBeforeActivateConnection)
Sets the PING before activate connection flag.
|
ClusterClientOptions.Builder |
requestQueueSize(int requestQueueSize)
Set the per-connection request queue size.
|
ClusterClientOptions.Builder |
socketOptions(SocketOptions socketOptions)
Sets the low-level
SocketOptions for the connections kept to Redis servers. |
ClusterClientOptions.Builder |
sslOptions(SslOptions sslOptions)
Sets the
SslOptions for SSL connections kept to Redis servers. |
ClusterClientOptions.Builder |
suspendReconnectOnProtocolFailure(boolean suspendReconnectOnProtocolFailure)
Suspends reconnect when reconnects run into protocol failures (SSL verification, PING before connect fails).
|
ClusterClientOptions.Builder |
topologyRefreshOptions(ClusterTopologyRefreshOptions topologyRefreshOptions)
Sets the
ClusterTopologyRefreshOptions for detailed control of topology updates. |
ClusterClientOptions.Builder |
validateClusterNodeMembership(boolean validateClusterNodeMembership)
Validate the cluster node membership before allowing connections to a cluster node.
|
public ClusterClientOptions.Builder validateClusterNodeMembership(boolean validateClusterNodeMembership)
ClusterClientOptions.DEFAULT_VALIDATE_CLUSTER_MEMBERSHIP
.validateClusterNodeMembership
- true if validation is enabled.this
public ClusterClientOptions.Builder maxRedirects(int maxRedirects)
ClusterClientOptions.DEFAULT_MAX_REDIRECTS
.maxRedirects
- the limit of maximal cluster redirectsthis
public ClusterClientOptions.Builder topologyRefreshOptions(ClusterTopologyRefreshOptions topologyRefreshOptions)
ClusterTopologyRefreshOptions
for detailed control of topology updates.topologyRefreshOptions
- the ClusterTopologyRefreshOptions
this
public ClusterClientOptions.Builder pingBeforeActivateConnection(boolean pingBeforeActivateConnection)
ClientOptions.Builder
ClientOptions.DEFAULT_PING_BEFORE_ACTIVATE_CONNECTION
.pingBeforeActivateConnection
in class ClientOptions.Builder
pingBeforeActivateConnection
- true/falsethis
public ClusterClientOptions.Builder autoReconnect(boolean autoReconnect)
ClientOptions.Builder
ClientOptions.DEFAULT_AUTO_RECONNECT
.autoReconnect
in class ClientOptions.Builder
autoReconnect
- true/falsethis
public ClusterClientOptions.Builder suspendReconnectOnProtocolFailure(boolean suspendReconnectOnProtocolFailure)
ClientOptions.Builder
ClientOptions.DEFAULT_SUSPEND_RECONNECT_PROTO_FAIL
.suspendReconnectOnProtocolFailure
in class ClientOptions.Builder
suspendReconnectOnProtocolFailure
- true/falsethis
public ClusterClientOptions.Builder cancelCommandsOnReconnectFailure(boolean cancelCommandsOnReconnectFailure)
ClientOptions.Builder
ClientOptions.DEFAULT_CANCEL_CMD_RECONNECT_FAIL
.cancelCommandsOnReconnectFailure
in class ClientOptions.Builder
cancelCommandsOnReconnectFailure
- true/falsethis
public ClusterClientOptions.Builder requestQueueSize(int requestQueueSize)
ClientOptions.Builder
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
in class ClientOptions.Builder
requestQueueSize
- the queue size.this
public ClusterClientOptions.Builder disconnectedBehavior(ClientOptions.DisconnectedBehavior disconnectedBehavior)
ClientOptions.Builder
ClientOptions.DEFAULT_DISCONNECTED_BEHAVIOR
.disconnectedBehavior
in class ClientOptions.Builder
disconnectedBehavior
- must not be null.this
public ClusterClientOptions.Builder socketOptions(SocketOptions socketOptions)
ClientOptions.Builder
SocketOptions
for the connections kept to Redis servers. See
ClientOptions.DEFAULT_SOCKET_OPTIONS
.socketOptions
in class ClientOptions.Builder
socketOptions
- must not be null.this
public ClusterClientOptions.Builder sslOptions(SslOptions sslOptions)
ClientOptions.Builder
SslOptions
for SSL connections kept to Redis servers. See ClientOptions.DEFAULT_SSL_OPTIONS
.sslOptions
in class ClientOptions.Builder
sslOptions
- must not be null.this
public ClusterClientOptions build()
ClusterClientOptions
build
in class ClientOptions.Builder
ClusterClientOptions
Copyright © 2017 lettuce.io. All rights reserved.