com.lambdaworks.redis.cluster

Class ClusterClientOptions

java.lang.Object

com.lambdaworks.redis.ClientOptions

com.lambdaworks.redis.cluster.ClusterClientOptions

All Implemented Interfaces:

Serializable

public class ClusterClientOptions
extends ClientOptions

Client Options to control the behavior of RedisClusterClient.

Author:

Mark Paluch

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ClusterClientOptions.Builder Builder for ClusterClientOptions.

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_CLOSE_STALE_CONNECTIONS
static boolean	DEFAULT_REFRESH_CLUSTER_VIEW
static long	DEFAULT_REFRESH_PERIOD
static TimeUnit	DEFAULT_REFRESH_PERIOD_UNIT
static boolean	DEFAULT_VALIDATE_CLUSTER_MEMBERSHIP

Fields inherited from class com.lambdaworks.redis.ClientOptions

DEFAULT_AUTO_RECONNECT, DEFAULT_CANCEL_CMD_RECONNECT_FAIL, DEFAULT_PING_BEFORE_ACTIVATE_CONNECTION, DEFAULT_REQUEST_QUEUE_SIZE, DEFAULT_SUSPEND_RECONNECT_PROTO_FAIL

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ClusterClientOptions(ClusterClientOptions.Builder builder)
protected	ClusterClientOptions(ClusterClientOptions original)

Method Summary

Modifier and Type	Method and Description
static ClusterClientOptions	copyOf(ClusterClientOptions options) Create a copy of options.
static ClusterClientOptions	create() Create a new ClusterClientOptions using default settings.
long	getRefreshPeriod() Period between the regular cluster topology updates.
TimeUnit	getRefreshPeriodUnit() Unit for the getRefreshPeriod().
boolean	isCloseStaleConnections() Flag, whether to close stale connections when refreshing the cluster topology.
boolean	isRefreshClusterView() Flag, whether regular cluster topology updates are updated.
boolean	isValidateClusterNodeMembership() Validate the cluster node membership before allowing connections to a cluster node.

Methods inherited from class com.lambdaworks.redis.ClientOptions

copyOf, getRequestQueueSize, isAutoReconnect, isCancelCommandsOnReconnectFailure, isPingBeforeActivateConnection, isSuspendReconnectOnProtocolFailure

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_REFRESH_CLUSTER_VIEW

public static final boolean DEFAULT_REFRESH_CLUSTER_VIEW

See Also:

Constant Field Values

DEFAULT_REFRESH_PERIOD

public static final long DEFAULT_REFRESH_PERIOD

See Also:

Constant Field Values

DEFAULT_REFRESH_PERIOD_UNIT

public static final TimeUnit DEFAULT_REFRESH_PERIOD_UNIT

DEFAULT_CLOSE_STALE_CONNECTIONS

public static final boolean DEFAULT_CLOSE_STALE_CONNECTIONS

See Also:

Constant Field Values

DEFAULT_VALIDATE_CLUSTER_MEMBERSHIP

public static final boolean DEFAULT_VALIDATE_CLUSTER_MEMBERSHIP

See Also:

Constant Field Values

Constructor Detail

ClusterClientOptions

protected ClusterClientOptions(ClusterClientOptions.Builder builder)

ClusterClientOptions

protected ClusterClientOptions(ClusterClientOptions original)

Method Detail

copyOf

public static ClusterClientOptions copyOf(ClusterClientOptions options)

Create a copy of options.

Parameters:

options - the original

Returns:

A new instance of ClusterClientOptions containing the values of options

isRefreshClusterView

public boolean isRefreshClusterView()

Flag, whether regular cluster topology updates are updated. The client starts updating the cluster topology in the intervals of getRefreshPeriod() /getRefreshPeriodUnit(). Defaults to false.

Returns:

true it the cluster topology view is updated periodically

getRefreshPeriod

public long getRefreshPeriod()

Period between the regular cluster topology updates. Defaults to 60.

Returns:

the period between the regular cluster topology updates

getRefreshPeriodUnit

public TimeUnit getRefreshPeriodUnit()

Unit for the getRefreshPeriod(). Defaults to TimeUnit.SECONDS.

Returns:

unit for the getRefreshPeriod()

isCloseStaleConnections

public boolean isCloseStaleConnections()

Flag, whether to close stale connections when refreshing the cluster topology. Defaults to true. Comes only into effect if isRefreshClusterView() is true.

Returns:

true if stale connections are cleaned up after cluster topology updates

isValidateClusterNodeMembership

public boolean isValidateClusterNodeMembership()

Validate the cluster node membership before allowing connections to a cluster node. Defaults to true.

Returns:

true if validation is enabled.

create

public static ClusterClientOptions create()

Create a new ClusterClientOptions using default settings.

Returns:

a new instance of default cluster client client options.