Package com.github.ddth.dlock.impl.redis

Class ClusteredRedisDLock

java.lang.Object

com.github.ddth.dlock.impl.AbstractDLock

com.github.ddth.dlock.impl.redis.BaseRedisDLock

com.github.ddth.dlock.impl.redis.ClusteredRedisDLock

All Implemented Interfaces:

IDLock, AutoCloseable

public class ClusteredRedisDLock
extends BaseRedisDLock

Clustered Redis implementation of ICache.

Since:

0.1.0

Author:

Thanh Ba Nguyen

Field Summary

Fields

Modifier and Type	Field	Description
static String	LOCK_PROP_REDIS_HOSTS_AND_PORTS	To override the setRedisHostsAndPorts(String) setting.

Fields inherited from class com.github.ddth.dlock.impl.redis.BaseRedisDLock

LOCK_PROP_REDIS_PASSWORD, myOwnRedis

Fields inherited from interface com.github.ddth.dlock.IDLock

DEFAULT_LOCK_DURATION_MS

Constructor Summary

Constructors

Constructor	Description
ClusteredRedisDLock(String name)

Method Summary

Modifier and Type	Method	Description
protected com.github.ddth.commons.redis.JedisConnector	buildJedisConnector()
protected redis.clients.jedis.JedisCluster	getJedis()
String	getRedisHostsAndPorts()	Redis' hosts and ports scheme (format host1:port1,host2:port2,host3:port3).
ClusteredRedisDLock	init()	Init method.
LockResult	lock(int waitWeight, String clientId, long lockDurationMs)	Acquire the lock for clientId for a duration of lockDurationMs.
ClusteredRedisDLock	setRedisHostsAndPorts(String redisHostsAndPorts)	Redis' hosts and ports scheme (format host1:port1,host2:port2,host3:port3).
LockResult	unlock(String clientId)	Release the lock.

Methods inherited from class com.github.ddth.dlock.impl.redis.BaseRedisDLock

destroy, getJedisConnector, getRedisPassword, getScriptLock, getScriptUnlock, getZsetName, setJedisConnector, setRedisPassword, setScriptLock, setScriptUnlock, unlockResult, updateLockHolder, updateLockHolder

Methods inherited from class com.github.ddth.dlock.impl.AbstractDLock

close, getClientId, getLockProperties, getLockProperty, getName, getTimestampExpiry, lock, lock, lock, setClientId, setLockProperties, setName, setTimestampExpiry, toString, updateLockHolder

Methods inherited from class java.lang.Object

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

Field Detail

LOCK_PROP_REDIS_HOSTS_AND_PORTS

public static final String LOCK_PROP_REDIS_HOSTS_AND_PORTS

To override the setRedisHostsAndPorts(String) setting.

See Also:

Constant Field Values

Constructor Detail

ClusteredRedisDLock

public ClusteredRedisDLock(String name)

Method Detail

getRedisHostsAndPorts

public String getRedisHostsAndPorts()

Redis' hosts and ports scheme (format host1:port1,host2:port2,host3:port3).

Returns:

setRedisHostsAndPorts

public ClusteredRedisDLock setRedisHostsAndPorts(String redisHostsAndPorts)

Redis' hosts and ports scheme (format host1:port1,host2:port2,host3:port3).

Parameters:

redisHostsAndPorts -

Returns:

buildJedisConnector

protected com.github.ddth.commons.redis.JedisConnector buildJedisConnector()

Specified by:

buildJedisConnector in class BaseRedisDLock

Returns:

Since:

0.1.1.2

init

public ClusteredRedisDLock init()

Init method.

Overrides:

init in class BaseRedisDLock

Returns:

getJedis

protected redis.clients.jedis.JedisCluster getJedis()

Returns:

lock

public LockResult lock(int waitWeight,
                       String clientId,
                       long lockDurationMs)

Acquire the lock for clientId for a duration of lockDurationMs.

Reentrant: lock can be acquired multiple times by the same clientId. Lock's expiry will be extended accordingly.

Parameters:

waitWeight - "fairness": clientId with higher waitWeight value might have higher chance to acquire the lock, negative value means "no fairness"

clientId - within a namespace, only one client is allowed to hold the lock as a given time

Returns:

LockResult.SUCCESSFUL if successful, LockResult.HOLD_BY_ANOTHER_CLIENT if lock is currently hold by another client

unlock

public LockResult unlock(String clientId)

Release the lock.

Parameters:

clientId - within a namespace, only one client is allowed to hold the lock as a given time

Returns:

LockResult.SUCCESSFUL if successful, LockResult.HOLD_BY_ANOTHER_CLIENT if lock is currently hold by another client, LockResult.NOT_FOUND if the lock is not currently hold by any client (not locked before, or already expired)