org.redisson.config

Class ReplicatedServersConfig

java.lang.Object

org.redisson.config.BaseMasterSlaveServersConfig<ReplicatedServersConfig>

org.redisson.config.ReplicatedServersConfig

Direct Known Subclasses:

ElasticacheServersConfig

public class ReplicatedServersConfig
extends BaseMasterSlaveServersConfig<ReplicatedServersConfig>

Configuration for an Azure Redis Cache or AWS ElastiCache servers. A replication group is composed of a single master endpoint and multiple read slaves.

Author:

Steve Ungerer, Nikita Koksharov

Constructor Summary

Constructors

Constructor and Description
ReplicatedServersConfig()

Method Summary

Modifier and Type	Method and Description
ReplicatedServersConfig	addNodeAddress(String... addresses) Add Redis cluster node address.
String	getClientName()
int	getConnectTimeout()
int	getDatabase()
int	getFailedAttempts()
int	getIdleConnectionTimeout()
List<URL>	getNodeAddresses()
String	getPassword()
int	getPingTimeout()
int	getReconnectionTimeout()
int	getRetryAttempts()
int	getRetryInterval()
int	getScanInterval()
int	getSubscriptionsPerConnection()
int	getTimeout()
T	setClientName(String clientName) Setup connection name during connection init via CLIENT SETNAME command
T	setConnectTimeout(int connectTimeout) Timeout during connecting to any Redis server.
ReplicatedServersConfig	setDatabase(int database) Database index used for Redis connection Default is 0
T	setFailedAttempts(int slaveFailedAttempts) Redis server will be excluded from the internal list of available nodes when sequential unsuccessful execution attempts of any Redis command on this server reaches failedAttempts.
T	setIdleConnectionTimeout(int idleConnectionTimeout) If pooled connection not used for a timeout time and current connections amount bigger than minimum idle connections pool size, then it will closed and removed from pool.
T	setPassword(String password) Password for Redis authentication.
T	setPingTimeout(int pingTimeout) Ping timeout used in Node.ping and Node.pingAll operation
T	setReconnectionTimeout(int slaveRetryTimeout) Reconnection attempt timeout to Redis server when it has been excluded from internal list of available servers.
T	setRetryAttempts(int retryAttempts) Error will be thrown if Redis command can't be sended to Redis server after retryAttempts.
T	setRetryInterval(int retryInterval) Time interval after which another one attempt to send Redis command will be executed.
ReplicatedServersConfig	setScanInterval(int scanInterval) Elasticache node scan interval in milliseconds
T	setSubscriptionsPerConnection(int subscriptionsPerConnection) Subscriptions per Redis connection limit Default is 5
T	setTimeout(int timeout) Redis server response timeout.

Methods inherited from class org.redisson.config.BaseMasterSlaveServersConfig

getLoadBalancer, getMasterConnectionMinimumIdleSize, getMasterConnectionPoolSize, getReadMode, getSlaveConnectionMinimumIdleSize, getSlaveConnectionPoolSize, getSlaveSubscriptionConnectionMinimumIdleSize, getSlaveSubscriptionConnectionPoolSize, getSubscriptionConnectionMinimumIdleSize, getSubscriptionConnectionPoolSize, getSubscriptionMode, setLoadBalancer, setMasterConnectionMinimumIdleSize, setMasterConnectionPoolSize, setReadMode, setSlaveConnectionMinimumIdleSize, setSlaveConnectionPoolSize, setSlaveSubscriptionConnectionMinimumIdleSize, setSlaveSubscriptionConnectionPoolSize, setSubscriptionConnectionMinimumIdleSize, setSubscriptionConnectionPoolSize, setSubscriptionMode

Methods inherited from class java.lang.Object

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

Constructor Detail

ReplicatedServersConfig

public ReplicatedServersConfig()

Method Detail

addNodeAddress

public ReplicatedServersConfig addNodeAddress(String... addresses)

Add Redis cluster node address. Use follow format -- host:port

Parameters:

addresses - in host:port format

Returns:

config

getNodeAddresses

public List<URL> getNodeAddresses()

getScanInterval

public int getScanInterval()

setScanInterval

public ReplicatedServersConfig setScanInterval(int scanInterval)

Elasticache node scan interval in milliseconds

Parameters:

scanInterval - in milliseconds

Returns:

config

setDatabase

public ReplicatedServersConfig setDatabase(int database)

Database index used for Redis connection Default is 0

Parameters:

database - number

Returns:

config

getDatabase

public int getDatabase()

setSubscriptionsPerConnection

public T setSubscriptionsPerConnection(int subscriptionsPerConnection)

Subscriptions per Redis connection limit Default is 5

Parameters:

subscriptionsPerConnection - amount

Returns:

config

getSubscriptionsPerConnection

public int getSubscriptionsPerConnection()

setPassword

public T setPassword(String password)

Password for Redis authentication. Should be null if not needed Default is null

Parameters:

password - for connection

Returns:

config

getPassword

public String getPassword()

setRetryAttempts

public T setRetryAttempts(int retryAttempts)

Error will be thrown if Redis command can't be sended to Redis server after retryAttempts. But if it sent succesfully then timeout will be started.

Default is 3 attempts

Parameters:

retryAttempts - - retry attempts

Returns:

config

See Also:

timeout

getRetryAttempts

public int getRetryAttempts()

setRetryInterval

public T setRetryInterval(int retryInterval)

Time interval after which another one attempt to send Redis command will be executed.

Default is 1500 milliseconds

Parameters:

retryInterval - - time in milliseconds

Returns:

config

See Also:

retryAttempts

getRetryInterval

public int getRetryInterval()

setTimeout

public T setTimeout(int timeout)

Redis server response timeout.

Default is 3000 milliseconds

Parameters:

timeout - in milliseconds

Returns:

config

getTimeout

public int getTimeout()

setClientName

public T setClientName(String clientName)

Setup connection name during connection init via CLIENT SETNAME command

Parameters:

clientName - - name of client

Returns:

config

getClientName

public String getClientName()

setPingTimeout

public T setPingTimeout(int pingTimeout)

Ping timeout used in Node.ping and Node.pingAll operation

Parameters:

pingTimeout - - timeout in milliseconds

Returns:

config

getPingTimeout

public int getPingTimeout()

setConnectTimeout

public T setConnectTimeout(int connectTimeout)

Timeout during connecting to any Redis server.

Default is 10000 milliseconds.

Parameters:

connectTimeout - - timeout in milliseconds

Returns:

config

getConnectTimeout

public int getConnectTimeout()

setIdleConnectionTimeout

public T setIdleConnectionTimeout(int idleConnectionTimeout)

If pooled connection not used for a timeout time and current connections amount bigger than minimum idle connections pool size, then it will closed and removed from pool.

Parameters:

idleConnectionTimeout - - timeout in milliseconds

Returns:

config

getIdleConnectionTimeout

public int getIdleConnectionTimeout()

setReconnectionTimeout

public T setReconnectionTimeout(int slaveRetryTimeout)

Reconnection attempt timeout to Redis server when it has been excluded from internal list of available servers.

On every such timeout event Redisson tries to connect to disconnected Redis server.

Default is 3000

Parameters:

slaveRetryTimeout - - retry timeout in milliseconds

Returns:

config

See Also:

failedAttempts

getReconnectionTimeout

public int getReconnectionTimeout()

setFailedAttempts

public T setFailedAttempts(int slaveFailedAttempts)

Redis server will be excluded from the internal list of available nodes when sequential unsuccessful execution attempts of any Redis command on this server reaches failedAttempts.

Default is 3

Parameters:

slaveFailedAttempts - - attempts

Returns:

config

getFailedAttempts

public int getFailedAttempts()