com.lambdaworks.redis

Class ClientOptions.Builder

java.lang.Object

com.lambdaworks.redis.ClientOptions.Builder

Direct Known Subclasses:

ClusterClientOptions.Builder

Enclosing class:

ClientOptions

public static class ClientOptions.Builder
extends Object

Builder for ClientOptions.

Constructor Summary

Constructors

Constructor and Description
Builder() Deprecated. Use ClientOptions.builder()

Method Summary

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	suspendReconnectOnProtocolFailure(boolean suspendReconnectOnProtocolFailure) Suspends reconnect when reconnects run into protocol failures (SSL verification, PING before connect fails).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

@Deprecated
public Builder()

Deprecated. Use ClientOptions.builder()

Method Detail

pingBeforeActivateConnection

public ClientOptions.Builder pingBeforeActivateConnection(boolean pingBeforeActivateConnection)

Sets the PING before activate connection flag. Defaults to false. See ClientOptions.DEFAULT_PING_BEFORE_ACTIVATE_CONNECTION.

Parameters:

pingBeforeActivateConnection - true/false

Returns:

this

autoReconnect

public ClientOptions.Builder autoReconnect(boolean autoReconnect)

Enables or disables auto reconnection on connection loss. Defaults to true. See ClientOptions.DEFAULT_AUTO_RECONNECT.

Parameters:

autoReconnect - true/false

Returns:

this

suspendReconnectOnProtocolFailure

public ClientOptions.Builder suspendReconnectOnProtocolFailure(boolean suspendReconnectOnProtocolFailure)

Suspends reconnect when reconnects run into protocol failures (SSL verification, PING before connect fails). Defaults to false. See ClientOptions.DEFAULT_SUSPEND_RECONNECT_PROTO_FAIL.

Parameters:

suspendReconnectOnProtocolFailure - true/false

Returns:

this

cancelCommandsOnReconnectFailure

public ClientOptions.Builder cancelCommandsOnReconnectFailure(boolean cancelCommandsOnReconnectFailure)

Allows cancelling queued commands in case a reconnect fails.Defaults to false. See ClientOptions.DEFAULT_CANCEL_CMD_RECONNECT_FAIL.

Parameters:

cancelCommandsOnReconnectFailure - true/false

Returns:

this

requestQueueSize

public ClientOptions.Builder requestQueueSize(int requestQueueSize)

Set the per-connection request queue size. The command invocation will lead to a 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.

Parameters:

requestQueueSize - the queue size.

Returns:

this

disconnectedBehavior

public ClientOptions.Builder disconnectedBehavior(ClientOptions.DisconnectedBehavior disconnectedBehavior)

Sets the behavior for command invocation when connections are in a disconnected state. Defaults to true. See ClientOptions.DEFAULT_DISCONNECTED_BEHAVIOR.

Parameters:

disconnectedBehavior - true/false

Returns:

this

build

public ClientOptions build()

Create a new instance of ClientOptions.

Returns:

new instance of ClientOptions