com.lambdaworks.redis

Class ClientOptions

java.lang.Object

com.lambdaworks.redis.ClientOptions

All Implemented Interfaces:

Serializable

public class ClientOptions
extends Object
implements Serializable

Client Options to control the behavior of RedisClient and RedisClusterClient.

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.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ClientOptions()

Method Summary

Modifier and Type	Method and Description
static ClientOptions	copyOf(ClientOptions options) Create a copy of options
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

Constructor Detail

ClientOptions

protected ClientOptions()

Method Detail

copyOf

public static ClientOptions copyOf(ClientOptions options)

Create a copy of options

Parameters:

options -

Returns:

A new instance of ClientOptions containing the values of options

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.