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 |
protected static LockPubSub |
PUBSUB |
Modifier | Constructor and Description |
---|---|
protected |
RedissonLock(CommandExecutor commandExecutor,
String name,
UUID id) |
Modifier and Type | Method and Description |
---|---|
protected boolean |
await(io.netty.util.concurrent.Future<?> future,
long timeout,
TimeUnit timeoutUnit) |
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) |
protected RedissonLockEntry |
getEntry(long threadId) |
protected String |
getEntryName() |
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.
|
io.netty.util.concurrent.Future<Void> |
lockAsync() |
io.netty.util.concurrent.Future<Void> |
lockAsync(long leaseTime,
TimeUnit unit) |
io.netty.util.concurrent.Future<Void> |
lockAsync(long leaseTime,
TimeUnit unit,
long currentThreadId) |
void |
lockInterruptibly() |
void |
lockInterruptibly(long leaseTime,
TimeUnit unit)
Acquires the lock.
|
void |
migrate(String host,
int port,
int database)
Transfer an object from source Redis instance to destination Redis instance
|
io.netty.util.concurrent.Future<Void> |
migrateAsync(String host,
int port,
int database)
Transfer an object from source Redis instance to 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 |
protected io.netty.util.concurrent.Future<RedissonLockEntry> |
subscribe(long threadId) |
boolean |
tryLock() |
boolean |
tryLock(long waitTime,
long leaseTime,
TimeUnit unit)
Returns
true as soon as the lock is acquired. |
boolean |
tryLock(long waitTime,
TimeUnit unit) |
io.netty.util.concurrent.Future<Boolean> |
tryLockAsync() |
io.netty.util.concurrent.Future<Boolean> |
tryLockAsync(long threadId) |
io.netty.util.concurrent.Future<Boolean> |
tryLockAsync(long waitTime,
long leaseTime,
TimeUnit unit) |
io.netty.util.concurrent.Future<Boolean> |
tryLockAsync(long waitTime,
long leaseTime,
TimeUnit unit,
long currentThreadId) |
io.netty.util.concurrent.Future<Boolean> |
tryLockAsync(long waitTime,
TimeUnit unit) |
void |
unlock() |
io.netty.util.concurrent.Future<Void> |
unlockAsync() |
io.netty.util.concurrent.Future<Void> |
unlockAsync(long threadId) |
protected void |
unsubscribe(io.netty.util.concurrent.Future<RedissonLockEntry> future,
long threadId) |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
clearExpire, expire, expireAt, expireAt, remainTimeToLive
delete, getName, isExists, migrate, move, rename, renamenx
clearExpireAsync, expireAsync, expireAtAsync, expireAtAsync, remainTimeToLiveAsync
isExistsAsync, migrateAsync, moveAsync, renameAsync, renamenxAsync
public static final long LOCK_EXPIRATION_INTERVAL_SECONDS
protected long internalLockLeaseTime
protected static final LockPubSub PUBSUB
protected RedissonLock(CommandExecutor commandExecutor, String name, UUID id)
protected String getEntryName()
public void lock(long leaseTime, TimeUnit unit)
RLock
If 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 RLock
leaseTime
- 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 Lock
InterruptedException
public void lockInterruptibly(long leaseTime, TimeUnit unit) throws InterruptedException
RLock
If 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 RLock
leaseTime
- 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
RLock
true
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 RLock
waitTime
- the maximum time to aquire the lockInterruptedException
protected RedissonLockEntry getEntry(long threadId)
protected io.netty.util.concurrent.Future<RedissonLockEntry> subscribe(long threadId)
protected void unsubscribe(io.netty.util.concurrent.Future<RedissonLockEntry> future, long threadId)
public boolean tryLock(long waitTime, TimeUnit unit) throws InterruptedException
tryLock
in interface Lock
InterruptedException
public Condition newCondition()
newCondition
in interface Lock
public void forceUnlock()
RLock
forceUnlock
in interface RLock
public boolean isLocked()
RLock
public boolean isHeldByCurrentThread()
RLock
isHeldByCurrentThread
in interface RLock
true
if held by current thread
otherwise false
public int getHoldCount()
RLock
getHoldCount
in interface RLock
0
if this lock is not held by current threadpublic io.netty.util.concurrent.Future<Boolean> deleteAsync()
RObjectAsync
deleteAsync
in interface RObjectAsync
true
if object was deleted false
if notpublic io.netty.util.concurrent.Future<Void> unlockAsync()
unlockAsync
in interface RLock
public io.netty.util.concurrent.Future<Void> unlockAsync(long threadId)
public io.netty.util.concurrent.Future<Void> lockAsync()
public io.netty.util.concurrent.Future<Void> lockAsync(long leaseTime, TimeUnit unit, long currentThreadId)
public io.netty.util.concurrent.Future<Boolean> tryLockAsync()
tryLockAsync
in interface RLock
public io.netty.util.concurrent.Future<Boolean> tryLockAsync(long threadId)
public io.netty.util.concurrent.Future<Boolean> tryLockAsync(long waitTime, TimeUnit unit)
tryLockAsync
in interface RLock
public io.netty.util.concurrent.Future<Boolean> tryLockAsync(long waitTime, long leaseTime, TimeUnit unit)
tryLockAsync
in interface RLock
public io.netty.util.concurrent.Future<Boolean> tryLockAsync(long waitTime, long leaseTime, TimeUnit unit, long currentThreadId)
public boolean expire(long timeToLive, TimeUnit timeUnit)
RExpirable
expire
in interface RExpirable
timeToLive
- - 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)
RExpirableAsync
expireAsync
in interface RExpirableAsync
timeToLive
- - timeout before object will be deletedtimeUnit
- - timeout time unittrue
if the timeout was set and false
if notpublic boolean expireAt(long timestamp)
RExpirable
expireAt
in interface RExpirable
timestamp
- - 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)
RExpirableAsync
expireAtAsync
in interface RExpirableAsync
timestamp
- - expire date in seconds (Unix timestamp)true
if the timeout was set and false
if notpublic boolean expireAt(Date timestamp)
RExpirable
expireAt
in interface RExpirable
timestamp
- - expire datetrue
if the timeout was set and false
if notpublic io.netty.util.concurrent.Future<Boolean> expireAtAsync(Date timestamp)
RExpirableAsync
expireAtAsync
in interface RExpirableAsync
timestamp
- - expire datetrue
if the timeout was set and false
if notpublic boolean clearExpire()
RExpirable
clearExpire
in interface RExpirable
true
if timeout was removed
false
if object does not exist or does not have an associated timeoutpublic io.netty.util.concurrent.Future<Boolean> clearExpireAsync()
RExpirableAsync
clearExpireAsync
in interface RExpirableAsync
true
if the timeout was cleared and false
if notpublic long remainTimeToLive()
RExpirable
remainTimeToLive
in interface RExpirable
public io.netty.util.concurrent.Future<Long> remainTimeToLiveAsync()
RExpirableAsync
remainTimeToLiveAsync
in interface RExpirableAsync
-1
if object does not exist or time in secondsprotected boolean await(io.netty.util.concurrent.Future<?> future, long timeout, TimeUnit timeoutUnit) throws InterruptedException
InterruptedException
protected <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)
RObject
newName
public io.netty.util.concurrent.Future<Void> renameAsync(String newName)
RObjectAsync
newName
in async moderenameAsync
in interface RObjectAsync
public void migrate(String host, int port, int database)
RObject
public io.netty.util.concurrent.Future<Void> migrateAsync(String host, int port, int database)
RObjectAsync
migrateAsync
in interface RObjectAsync
host
- - destination hostport
- - destination portdatabase
- - destination databasepublic boolean move(int database)
RObject
public io.netty.util.concurrent.Future<Boolean> moveAsync(int database)
RObjectAsync
moveAsync
in interface RObjectAsync
true
if key was moved false
if notpublic boolean renamenx(String newName)
RObject
newName
only if new key is not existspublic io.netty.util.concurrent.Future<Boolean> renamenxAsync(String newName)
RObjectAsync
newName
in async mode only if new key is not existsrenamenxAsync
in interface RObjectAsync
public boolean delete()
RObject
public boolean isExists()
RObject
public io.netty.util.concurrent.Future<Boolean> isExistsAsync()
RObjectAsync
isExistsAsync
in interface RObjectAsync
true
if object exists and false
otherwiseCopyright © 2014–2016. All rights reserved.