org.redisson

Class RedissonReadLock

java.lang.Object

org.redisson.RedissonObject

org.redisson.RedissonLock

org.redisson.RedissonReadLock

All Implemented Interfaces:

Lock, RExpirable, RExpirableAsync, RLock, RObject, RObjectAsync

public class RedissonReadLock
extends RedissonLock
implements RLock

Lock will be removed automatically if client disconnects.

Author:

Nikita Koksharov

Field Summary

Fields inherited from class org.redisson.RedissonLock

internalLockLeaseTime, LOCK_EXPIRATION_INTERVAL_SECONDS, PUBSUB

Fields inherited from class org.redisson.RedissonObject

codec

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RedissonReadLock(CommandExecutor commandExecutor, String name, UUID id)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	clearExpire() Clear an expire timeout or expire date for object.
RFuture<Boolean>	clearExpireAsync() Clear an expire timeout or expire date for object in async mode.
boolean	expire(long timeToLive, TimeUnit timeUnit) Set a timeout for object.
RFuture<Boolean>	expireAsync(long timeToLive, TimeUnit timeUnit) Set a timeout for object in async mode.
boolean	expireAt(Date timestamp) Set an expire date for object.
boolean	expireAt(long timestamp) Set an expire date for object.
RFuture<Boolean>	expireAtAsync(Date timestamp) Set an expire date for object in async mode.
RFuture<Boolean>	expireAtAsync(long timestamp) Set an expire date for object in async mode.
RFuture<Boolean>	forceUnlockAsync()
int	getHoldCount() Number of holds on this lock by the current thread
boolean	isHeldByCurrentThread() Checks if this lock is held by the current thread
boolean	isLocked() Checks if this lock locked by any thread
Condition	newCondition()
long	remainTimeToLive() Remaining time to live of Redisson object that has a timeout
RFuture<Long>	remainTimeToLiveAsync() Get remaining time to live of object in seconds.
void	unlock()

Methods inherited from class org.redisson.RedissonLock

deleteAsync, forceUnlock, getEntry, getEntryName, isExistsAsync, lock, lock, lockAsync, lockAsync, lockAsync, lockInterruptibly, lockInterruptibly, subscribe, tryLock, tryLock, tryLock, tryLockAsync, tryLockAsync, tryLockAsync, tryLockAsync, tryLockAsync, unlockAsync, unlockAsync, unlockInnerAsync, unsubscribe

Methods inherited from class org.redisson.RedissonObject

await, delete, encode, encodeMapKey, encodeMapValue, get, getCodec, getName, isExists, migrate, migrateAsync, move, moveAsync, newPromise, newSucceededFuture, prefixName, rename, renameAsync, renamenx, renamenxAsync

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.redisson.api.RLock

forceUnlock, lock, lockAsync, lockAsync, lockInterruptibly, tryLock, tryLockAsync, tryLockAsync, tryLockAsync, unlockAsync

Methods inherited from interface java.util.concurrent.locks.Lock

lock, lockInterruptibly, tryLock, tryLock

Methods inherited from interface org.redisson.api.RExpirable

clearExpire, expire, expireAt, expireAt, remainTimeToLive

Methods inherited from interface org.redisson.api.RObject

delete, getCodec, getName, isExists, migrate, move, rename, renamenx

Methods inherited from interface org.redisson.api.RExpirableAsync

clearExpireAsync, expireAsync, expireAtAsync, expireAtAsync, remainTimeToLiveAsync

Methods inherited from interface org.redisson.api.RObjectAsync

deleteAsync, isExistsAsync, migrateAsync, moveAsync, renameAsync, renamenxAsync

Constructor Detail

RedissonReadLock

protected RedissonReadLock(CommandExecutor commandExecutor,
                String name,
                UUID id)

Method Detail

unlock

public void unlock()

Specified by:

unlock in interface Lock

Overrides:

unlock in class RedissonLock

newCondition

public Condition newCondition()

Specified by:

newCondition in interface Lock

Overrides:

newCondition in class RedissonLock

forceUnlockAsync

public RFuture<Boolean> forceUnlockAsync()

Specified by:

forceUnlockAsync in interface RLock

Overrides:

forceUnlockAsync in class RedissonLock

isLocked

public boolean isLocked()

Description copied from interface: RLock

Checks if this lock locked by any thread

Specified by:

isLocked in interface RLock

Overrides:

isLocked in class RedissonLock

Returns:

true if locked otherwise false

isHeldByCurrentThread

public boolean isHeldByCurrentThread()

Description copied from interface: RLock

Checks if this lock is held by the current thread

Specified by:

isHeldByCurrentThread in interface RLock

Overrides:

isHeldByCurrentThread in class RedissonLock

Returns:

true if held by current thread otherwise false

getHoldCount

public int getHoldCount()

Description copied from interface: RLock

Number of holds on this lock by the current thread

Specified by:

getHoldCount in interface RLock

Overrides:

getHoldCount in class RedissonLock

Returns:

holds or 0 if this lock is not held by current thread

expire

public boolean expire(long timeToLive,
             TimeUnit timeUnit)

Description copied from interface: RExpirable

Set a timeout for object. After the timeout has expired, the key will automatically be deleted.

Specified by:

expire in interface RExpirable

Parameters:

timeToLive - - timeout before object will be deleted

timeUnit - - timeout time unit

Returns:

true if the timeout was set and false if not

expireAsync

public RFuture<Boolean> expireAsync(long timeToLive,
                           TimeUnit timeUnit)

Description copied from interface: RExpirableAsync

Set a timeout for object in async mode. After the timeout has expired, the key will automatically be deleted.

Specified by:

expireAsync in interface RExpirableAsync

Parameters:

timeToLive - - timeout before object will be deleted

timeUnit - - timeout time unit

Returns:

true if the timeout was set and false if not

expireAt

public boolean expireAt(long timestamp)

Description copied from interface: RExpirable

Set an expire date for object. When expire date comes the key will automatically be deleted.

Specified by:

expireAt in interface RExpirable

Parameters:

timestamp - - expire date in milliseconds (Unix timestamp)

Returns:

true if the timeout was set and false if not

expireAtAsync

public RFuture<Boolean> expireAtAsync(long timestamp)

Description copied from interface: RExpirableAsync

Set an expire date for object in async mode. When expire date comes the key will automatically be deleted.

Specified by:

expireAtAsync in interface RExpirableAsync

Parameters:

timestamp - - expire date in seconds (Unix timestamp)

Returns:

true if the timeout was set and false if not

expireAt

public boolean expireAt(Date timestamp)

Description copied from interface: RExpirable

Set an expire date for object. When expire date comes the key will automatically be deleted.

Specified by:

expireAt in interface RExpirable

Parameters:

timestamp - - expire date

Returns:

true if the timeout was set and false if not

expireAtAsync

public RFuture<Boolean> expireAtAsync(Date timestamp)

Description copied from interface: RExpirableAsync

Set an expire date for object in async mode. When expire date comes the key will automatically be deleted.

Specified by:

expireAtAsync in interface RExpirableAsync

Parameters:

timestamp - - expire date

Returns:

true if the timeout was set and false if not

clearExpire

public boolean clearExpire()

Description copied from interface: RExpirable

Clear an expire timeout or expire date for object.

Specified by:

clearExpire in interface RExpirable

Returns:

true if timeout was removed false if object does not exist or does not have an associated timeout

clearExpireAsync

public RFuture<Boolean> clearExpireAsync()

Description copied from interface: RExpirableAsync

Clear an expire timeout or expire date for object in async mode. Object will not be deleted.

Specified by:

clearExpireAsync in interface RExpirableAsync

Returns:

true if the timeout was cleared and false if not

remainTimeToLive

public long remainTimeToLive()

Description copied from interface: RExpirable

Remaining time to live of Redisson object that has a timeout

Specified by:

remainTimeToLive in interface RExpirable

Returns:

time in milliseconds -2 if the key does not exist. -1 if the key exists but has no associated expire.

remainTimeToLiveAsync

public RFuture<Long> remainTimeToLiveAsync()

Description copied from interface: RExpirableAsync

Get remaining time to live of object in seconds.

Specified by:

remainTimeToLiveAsync in interface RExpirableAsync

Returns:

-1 if object does not exist or time in seconds