Package org.redisson.reactive

Class RedissonLockReactive

java.lang.Object

org.redisson.reactive.RedissonLockReactive

All Implemented Interfaces:

RExpirableReactive, RLockReactive, RObjectReactive

public class RedissonLockReactive
extends Object
implements RLockReactive

Author:

Nikita Koksharov

Constructor Summary

Constructors

Constructor	Description
RedissonLockReactive(CommandReactiveExecutor connectionManager, String name)
RedissonLockReactive(CommandReactiveExecutor connectionManager, String name, RLockAsync instance)

Method Summary

Modifier and Type	Method	Description
org.reactivestreams.Publisher<Boolean>	clearExpire()	Clear an expire timeout or expire date for object in mode.
org.reactivestreams.Publisher<Void>	copy(String host, int port, int database, long timeout)	Copy object from source Redis instance to destination Redis instance
org.reactivestreams.Publisher<Boolean>	delete()	Delete object in mode
org.reactivestreams.Publisher<byte[]>	dump()	Returns dump of object
protected io.netty.buffer.ByteBuf	encode(Object value)
protected void	encode(Collection<Object> params, Collection<?> values)
protected io.netty.buffer.ByteBuf	encodeMapKey(Object value)
protected io.netty.buffer.ByteBuf	encodeMapValue(Object value)
org.reactivestreams.Publisher<Boolean>	expire(long timeToLive, TimeUnit timeUnit)	Set a timeout for object in mode.
org.reactivestreams.Publisher<Boolean>	expireAt(long timestamp)	Set an expire date for object in mode.
org.reactivestreams.Publisher<Boolean>	expireAt(Date timestamp)	Set an expire date for object in mode.
org.reactivestreams.Publisher<Boolean>	forceUnlock()
Codec	getCodec()
String	getName()
org.reactivestreams.Publisher<Boolean>	isExists()	Check object existence
org.reactivestreams.Publisher<Void>	lock()
org.reactivestreams.Publisher<Void>	lock(long threadId)
org.reactivestreams.Publisher<Void>	lock(long leaseTime, TimeUnit unit)
org.reactivestreams.Publisher<Void>	lock(long leaseTime, TimeUnit unit, long threadId)
org.reactivestreams.Publisher<Void>	migrate(String host, int port, int database, long timeout)	Transfer a object from a source Redis instance to a destination Redis instance in mode
org.reactivestreams.Publisher<Boolean>	move(int database)	Move object to another database in mode
protected <V> reactor.rx.Stream<V>	newSucceeded(V result)
<R> org.reactivestreams.Publisher<R>	reactive(reactor.fn.Supplier<RFuture<R>> supplier)
org.reactivestreams.Publisher<Long>	remainTimeToLive()	Get remaining time to live of object in milliseconds.
org.reactivestreams.Publisher<Void>	rename(String newName)	Rename current object key to newName in mode
org.reactivestreams.Publisher<Boolean>	renamenx(String newName)	Rename current object key to newName in mode only if new key is not exists
org.reactivestreams.Publisher<Void>	restore(byte[] state)	Restores object using its state returned by RObjectReactive.dump() method.
org.reactivestreams.Publisher<Void>	restore(byte[] state, long timeToLive, TimeUnit timeUnit)	Restores object using its state returned by RObjectReactive.dump() method and set time to live for it.
org.reactivestreams.Publisher<Void>	restoreAndReplace(byte[] state)	Restores and replaces object if it already exists.
org.reactivestreams.Publisher<Void>	restoreAndReplace(byte[] state, long timeToLive, TimeUnit timeUnit)	Restores and replaces object if it already exists and set time to live for it.
org.reactivestreams.Publisher<Boolean>	touch()	Update the last access time of an object.
org.reactivestreams.Publisher<Boolean>	tryLock()
org.reactivestreams.Publisher<Boolean>	tryLock(long threadId)
org.reactivestreams.Publisher<Boolean>	tryLock(long waitTime, long leaseTime, TimeUnit unit)
org.reactivestreams.Publisher<Boolean>	tryLock(long waitTime, long leaseTime, TimeUnit unit, long threadId)
org.reactivestreams.Publisher<Boolean>	tryLock(long waitTime, TimeUnit unit)
org.reactivestreams.Publisher<Boolean>	unlink()	Delete the objects.
org.reactivestreams.Publisher<Void>	unlock()
org.reactivestreams.Publisher<Void>	unlock(long threadId)

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.RExpirableReactive

clearExpire, expire, expireAt, expireAt, remainTimeToLive

Methods inherited from interface org.redisson.api.RObjectReactive

copy, delete, dump, getCodec, getName, isExists, migrate, move, rename, renamenx, restore, restore, restoreAndReplace, restoreAndReplace, touch, unlink

Constructor Detail

RedissonLockReactive

public RedissonLockReactive(CommandReactiveExecutor connectionManager,
                            String name)

RedissonLockReactive

public RedissonLockReactive(CommandReactiveExecutor connectionManager,
                            String name,
                            RLockAsync instance)

Method Detail

forceUnlock

public org.reactivestreams.Publisher<Boolean> forceUnlock()

Specified by:

forceUnlock in interface RLockReactive

unlock

public org.reactivestreams.Publisher<Void> unlock()

Specified by:

unlock in interface RLockReactive

unlock

public org.reactivestreams.Publisher<Void> unlock(long threadId)

Specified by:

unlock in interface RLockReactive

tryLock

public org.reactivestreams.Publisher<Boolean> tryLock()

Specified by:

tryLock in interface RLockReactive

lock

public org.reactivestreams.Publisher<Void> lock()

Specified by:

lock in interface RLockReactive

lock

public org.reactivestreams.Publisher<Void> lock(long threadId)

Specified by:

lock in interface RLockReactive

lock

public org.reactivestreams.Publisher<Void> lock(long leaseTime,
                                                TimeUnit unit)

Specified by:

lock in interface RLockReactive

lock

public org.reactivestreams.Publisher<Void> lock(long leaseTime,
                                                TimeUnit unit,
                                                long threadId)

Specified by:

lock in interface RLockReactive

tryLock

public org.reactivestreams.Publisher<Boolean> tryLock(long threadId)

Specified by:

tryLock in interface RLockReactive

tryLock

public org.reactivestreams.Publisher<Boolean> tryLock(long waitTime,
                                                      TimeUnit unit)

Specified by:

tryLock in interface RLockReactive

tryLock

public org.reactivestreams.Publisher<Boolean> tryLock(long waitTime,
                                                      long leaseTime,
                                                      TimeUnit unit)

Specified by:

tryLock in interface RLockReactive

tryLock

public org.reactivestreams.Publisher<Boolean> tryLock(long waitTime,
                                                      long leaseTime,
                                                      TimeUnit unit,
                                                      long threadId)

Specified by:

tryLock in interface RLockReactive

expire

public org.reactivestreams.Publisher<Boolean> expire(long timeToLive,
                                                     TimeUnit timeUnit)

Description copied from interface: RExpirableReactive

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

Specified by:

expire in interface RExpirableReactive

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 org.reactivestreams.Publisher<Boolean> expireAt(long timestamp)

Description copied from interface: RExpirableReactive

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

Specified by:

expireAt in interface RExpirableReactive

Parameters:

timestamp - - expire date in milliseconds (Unix timestamp)

Returns:

true if the timeout was set and false if not

expireAt

public org.reactivestreams.Publisher<Boolean> expireAt(Date timestamp)

Description copied from interface: RExpirableReactive

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

Specified by:

expireAt in interface RExpirableReactive

Parameters:

timestamp - - expire date

Returns:

true if the timeout was set and false if not

clearExpire

public org.reactivestreams.Publisher<Boolean> clearExpire()

Description copied from interface: RExpirableReactive

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

Specified by:

clearExpire in interface RExpirableReactive

Returns:

true if the timeout was cleared and false if not

remainTimeToLive

public org.reactivestreams.Publisher<Long> remainTimeToLive()

Description copied from interface: RExpirableReactive

Get remaining time to live of object in milliseconds.

Specified by:

remainTimeToLive in interface RExpirableReactive

Returns:

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

reactive

public <R> org.reactivestreams.Publisher<R> reactive(reactor.fn.Supplier<RFuture<R>> supplier)

newSucceeded

protected <V> reactor.rx.Stream<V> newSucceeded(V result)

getName

public String getName()

Specified by:

getName in interface RObjectReactive

getCodec

public Codec getCodec()

Specified by:

getCodec in interface RObjectReactive

encode

protected void encode(Collection<Object> params,
                      Collection<?> values)

encode

protected io.netty.buffer.ByteBuf encode(Object value)

encodeMapKey

protected io.netty.buffer.ByteBuf encodeMapKey(Object value)

encodeMapValue

protected io.netty.buffer.ByteBuf encodeMapValue(Object value)

restore

public org.reactivestreams.Publisher<Void> restore(byte[] state)

Description copied from interface: RObjectReactive

Restores object using its state returned by RObjectReactive.dump() method.

Specified by:

restore in interface RObjectReactive

Parameters:

state - - state of object

Returns:

void

restore

public org.reactivestreams.Publisher<Void> restore(byte[] state,
                                                   long timeToLive,
                                                   TimeUnit timeUnit)

Description copied from interface: RObjectReactive

Restores object using its state returned by RObjectReactive.dump() method and set time to live for it.

Specified by:

restore in interface RObjectReactive

Parameters:

state - - state of object

timeToLive - - time to live of the object

timeUnit - - time unit

Returns:

void

restoreAndReplace

public org.reactivestreams.Publisher<Void> restoreAndReplace(byte[] state)

Description copied from interface: RObjectReactive

Restores and replaces object if it already exists.

Specified by:

restoreAndReplace in interface RObjectReactive

Parameters:

state - - state of the object

Returns:

void

restoreAndReplace

public org.reactivestreams.Publisher<Void> restoreAndReplace(byte[] state,
                                                             long timeToLive,
                                                             TimeUnit timeUnit)

Description copied from interface: RObjectReactive

Restores and replaces object if it already exists and set time to live for it.

Specified by:

restoreAndReplace in interface RObjectReactive

Parameters:

state - - state of the object

timeToLive - - time to live of the object

timeUnit - - time unit

Returns:

void

dump

public org.reactivestreams.Publisher<byte[]> dump()

Description copied from interface: RObjectReactive

Returns dump of object

Specified by:

dump in interface RObjectReactive

Returns:

dump

touch

public org.reactivestreams.Publisher<Boolean> touch()

Description copied from interface: RObjectReactive

Update the last access time of an object.

Specified by:

touch in interface RObjectReactive

Returns:

true if object was touched else false

unlink

public org.reactivestreams.Publisher<Boolean> unlink()

Description copied from interface: RObjectReactive

Delete the objects. Actual removal will happen later asynchronously.

Requires Redis 4.0+

Specified by:

unlink in interface RObjectReactive

Returns:

true if it was exist and deleted else false

copy

public org.reactivestreams.Publisher<Void> copy(String host,
                                                int port,
                                                int database,
                                                long timeout)

Description copied from interface: RObjectReactive

Copy object from source Redis instance to destination Redis instance

Specified by:

copy in interface RObjectReactive

Parameters:

host - - destination host

port - - destination port

database - - destination database

timeout - - maximum idle time in any moment of the communication with the destination instance in milliseconds

Returns:

void

rename

public org.reactivestreams.Publisher<Void> rename(String newName)

Description copied from interface: RObjectReactive

Rename current object key to newName in mode

Specified by:

rename in interface RObjectReactive

Parameters:

newName - - new name of object

Returns:

void

migrate

public org.reactivestreams.Publisher<Void> migrate(String host,
                                                   int port,
                                                   int database,
                                                   long timeout)

Description copied from interface: RObjectReactive

Transfer a object from a source Redis instance to a destination Redis instance in mode

Specified by:

migrate in interface RObjectReactive

Parameters:

host - - destination host

port - - destination port

database - - destination database

timeout - - maximum idle time in any moment of the communication with the destination instance in milliseconds

Returns:

void

move

public org.reactivestreams.Publisher<Boolean> move(int database)

Description copied from interface: RObjectReactive

Move object to another database in mode

Specified by:

move in interface RObjectReactive

Parameters:

database - - number of Redis database

Returns:

true if key was moved false if not

renamenx

public org.reactivestreams.Publisher<Boolean> renamenx(String newName)

Description copied from interface: RObjectReactive

Rename current object key to newName in mode only if new key is not exists

Specified by:

renamenx in interface RObjectReactive

Parameters:

newName - - new name of object

Returns:

true if object has been renamed successfully and false otherwise

delete

public org.reactivestreams.Publisher<Boolean> delete()

Description copied from interface: RObjectReactive

Delete object in mode

Specified by:

delete in interface RObjectReactive

Returns:

true if object was deleted false if not

isExists

public org.reactivestreams.Publisher<Boolean> isExists()

Description copied from interface: RObjectReactive

Check object existence

Specified by:

isExists in interface RObjectReactive

Returns:

true if object exists and false otherwise