public class RedissonLock extends Object implements RLock
Lock
Implements reentrant lock.| Modifier and Type | Field and Description |
|---|---|
protected long |
internalLockLeaseTime |
static long |
LOCK_EXPIRATION_INTERVAL_SECONDS |
static Long |
unlockMessage |
| Modifier | Constructor and Description |
|---|---|
protected |
RedissonLock(CommandExecutor commandExecutor,
String name,
UUID id) |
| Modifier and Type | Method and Description |
|---|---|
boolean |
clearExpire()
Clear an expire timeout or expire date for object.
|
io.netty.util.concurrent.Future<Boolean> |
clearExpireAsync()
Clear an expire timeout or expire date for object in async mode.
|
boolean |
delete()
Deletes the object
|
io.netty.util.concurrent.Future<Boolean> |
deleteAsync()
Delete object in async mode
|
boolean |
expire(long timeToLive,
TimeUnit timeUnit)
Set a timeout for object.
|
io.netty.util.concurrent.Future<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.
|
io.netty.util.concurrent.Future<Boolean> |
expireAtAsync(Date timestamp)
Set an expire date for object in async mode.
|
io.netty.util.concurrent.Future<Boolean> |
expireAtAsync(long timestamp)
Set an expire date for object in async mode.
|
void |
forceUnlock()
Unlocks lock independently of state
|
protected <V> V |
get(io.netty.util.concurrent.Future<V> future) |
int |
getHoldCount()
Number of holds on this lock by the current thread
|
String |
getName()
Returns name of object
|
boolean |
isExists()
Check object existence
|
io.netty.util.concurrent.Future<Boolean> |
isExistsAsync()
Check object existence in async mode.
|
boolean |
isHeldByCurrentThread()
Checks if this lock is held by the current thread
|
boolean |
isLocked()
Checks if this lock locked by any thread
|
void |
lock() |
void |
lock(long leaseTime,
TimeUnit unit)
Acquires the lock.
|
void |
lockInterruptibly() |
void |
lockInterruptibly(long leaseTime,
TimeUnit unit)
Acquires the lock.
|
void |
migrate(String host,
int port,
int database)
Transfer a object from a source Redis instance to a destination Redis instance
|
io.netty.util.concurrent.Future<Void> |
migrateAsync(String host,
int port,
int database)
Transfer a object from a source Redis instance to a destination Redis instance
in async mode
|
boolean |
move(int database)
Move object to another database
|
io.netty.util.concurrent.Future<Boolean> |
moveAsync(int database)
Move object to another database in async mode
|
Condition |
newCondition() |
protected <V> io.netty.util.concurrent.Promise<V> |
newPromise() |
protected <V> io.netty.util.concurrent.Future<V> |
newSucceededFuture(V result) |
long |
remainTimeToLive()
Remaining time to live of Redisson object that has a timeout
|
io.netty.util.concurrent.Future<Long> |
remainTimeToLiveAsync()
Get remaining time to live of object in seconds.
|
void |
rename(String newName)
Rename current object key to
newName |
io.netty.util.concurrent.Future<Void> |
renameAsync(String newName)
Rename current object key to
newName
in async mode |
boolean |
renamenx(String newName)
Rename current object key to
newName
only if new key is not exists |
io.netty.util.concurrent.Future<Boolean> |
renamenxAsync(String newName)
Rename current object key to
newName
in async mode only if new key is not exists |
boolean |
tryLock() |
boolean |
tryLock(long waitTime,
long leaseTime,
TimeUnit unit)
Returns
true as soon as the lock is acquired. |
boolean |
tryLock(long time,
TimeUnit unit) |
void |
unlock() |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitclearExpire, expire, expireAt, expireAt, remainTimeToLivedelete, getName, isExists, migrate, move, rename, renamenxclearExpireAsync, expireAsync, expireAtAsync, expireAtAsync, remainTimeToLiveAsyncisExistsAsync, migrateAsync, moveAsync, renameAsync, renamenxAsyncpublic static final long LOCK_EXPIRATION_INTERVAL_SECONDS
protected long internalLockLeaseTime
public static final Long unlockMessage
protected RedissonLock(CommandExecutor commandExecutor, String name, UUID id)
public void lock(long leaseTime,
TimeUnit unit)
RLockIf the lock is not available then the current thread becomes
disabled for thread scheduling purposes and lies dormant until the
lock has been acquired.
If the lock is acquired, it is held until unlock is invoked,
or until leaseTime milliseconds have passed
since the lock was granted - whichever comes first.
lock in interface RLockleaseTime - the maximum time to hold the lock after granting it,
before automatically releasing it if it hasn't already been released by invoking unlock.
If leaseTime is -1, hold the lock until explicitly unlocked.unit - the time unit of the leaseTime argumentpublic void lockInterruptibly()
throws InterruptedException
lockInterruptibly in interface LockInterruptedExceptionpublic void lockInterruptibly(long leaseTime,
TimeUnit unit)
throws InterruptedException
RLockIf the lock is not available then the current thread becomes
disabled for thread scheduling purposes and lies dormant until the
lock has been acquired.
If the lock is acquired, it is held until unlock is invoked,
or until leaseTime have passed
since the lock was granted - whichever comes first.
lockInterruptibly in interface RLockleaseTime - the maximum time to hold the lock after granting it,
before automatically releasing it if it hasn't already been released by invoking unlock.
If leaseTime is -1, hold the lock until explicitly unlocked.unit - the time unit of the leaseTime argumentInterruptedException - - if the thread is interrupted before or during this method.public boolean tryLock(long waitTime,
long leaseTime,
TimeUnit unit)
throws InterruptedException
RLocktrue as soon as the lock is acquired.
If the lock is currently held by another thread in this or any
other process in the distributed system this method keeps trying
to acquire the lock for up to waitTime before
giving up and returning false. If the lock is acquired,
it is held until unlock is invoked, or until leaseTime
have passed since the lock was granted - whichever comes first.tryLock in interface RLockwaitTime - the maximum time to aquire the lockInterruptedExceptionpublic boolean tryLock(long time,
TimeUnit unit)
throws InterruptedException
tryLock in interface LockInterruptedExceptionpublic Condition newCondition()
newCondition in interface Lockpublic void forceUnlock()
RLockforceUnlock in interface RLockpublic boolean isLocked()
RLockpublic boolean isHeldByCurrentThread()
RLockisHeldByCurrentThread in interface RLocktrue if held by current thread
otherwise falsepublic int getHoldCount()
RLockgetHoldCount in interface RLock0 if this lock is not held by current threadpublic io.netty.util.concurrent.Future<Boolean> deleteAsync()
RObjectAsyncdeleteAsync in interface RObjectAsynctrue if object was deleted false if notpublic boolean expire(long timeToLive,
TimeUnit timeUnit)
RExpirableexpire in interface RExpirabletimeToLive - - timeout before object will be deletedtimeUnit - - timeout time unittrue if the timeout was set and false if notpublic io.netty.util.concurrent.Future<Boolean> expireAsync(long timeToLive, TimeUnit timeUnit)
RExpirableAsyncexpireAsync in interface RExpirableAsynctimeToLive - - timeout before object will be deletedtimeUnit - - timeout time unittrue if the timeout was set and false if notpublic boolean expireAt(long timestamp)
RExpirableexpireAt in interface RExpirabletimestamp - - expire date in milliseconds (Unix timestamp)true if the timeout was set and false if notpublic io.netty.util.concurrent.Future<Boolean> expireAtAsync(long timestamp)
RExpirableAsyncexpireAtAsync in interface RExpirableAsynctimestamp - - expire date in seconds (Unix timestamp)true if the timeout was set and false if notpublic boolean expireAt(Date timestamp)
RExpirableexpireAt in interface RExpirabletimestamp - - expire datetrue if the timeout was set and false if notpublic io.netty.util.concurrent.Future<Boolean> expireAtAsync(Date timestamp)
RExpirableAsyncexpireAtAsync in interface RExpirableAsynctimestamp - - expire datetrue if the timeout was set and false if notpublic boolean clearExpire()
RExpirableclearExpire in interface RExpirabletrue if timeout was removed
false if object does not exist or does not have an associated timeoutpublic io.netty.util.concurrent.Future<Boolean> clearExpireAsync()
RExpirableAsyncclearExpireAsync in interface RExpirableAsynctrue if the timeout was cleared and false if notpublic long remainTimeToLive()
RExpirableremainTimeToLive in interface RExpirablepublic io.netty.util.concurrent.Future<Long> remainTimeToLiveAsync()
RExpirableAsyncremainTimeToLiveAsync in interface RExpirableAsync-1 if object does not exist or time in secondsprotected <V> V get(io.netty.util.concurrent.Future<V> future)
protected <V> io.netty.util.concurrent.Promise<V> newPromise()
protected <V> io.netty.util.concurrent.Future<V> newSucceededFuture(V result)
public void rename(String newName)
RObjectnewNamepublic io.netty.util.concurrent.Future<Void> renameAsync(String newName)
RObjectAsyncnewName
in async moderenameAsync in interface RObjectAsyncpublic void migrate(String host, int port, int database)
RObjectpublic io.netty.util.concurrent.Future<Void> migrateAsync(String host, int port, int database)
RObjectAsyncmigrateAsync in interface RObjectAsynchost - - destination hostport - - destination portdatabase - - destination databasepublic boolean move(int database)
RObjectpublic io.netty.util.concurrent.Future<Boolean> moveAsync(int database)
RObjectAsyncmoveAsync in interface RObjectAsynctrue if key was moved false if notpublic boolean renamenx(String newName)
RObjectnewName
only if new key is not existspublic io.netty.util.concurrent.Future<Boolean> renamenxAsync(String newName)
RObjectAsyncnewName
in async mode only if new key is not existsrenamenxAsync in interface RObjectAsyncpublic boolean delete()
RObjectpublic boolean isExists()
RObjectpublic io.netty.util.concurrent.Future<Boolean> isExistsAsync()
RObjectAsyncisExistsAsync in interface RObjectAsynctrue if object exists and false otherwiseCopyright © 2014–2015. All rights reserved.