org.redisson.transaction

Class RedissonTransactionalBucket<V>

java.lang.Object

org.redisson.RedissonObject

org.redisson.RedissonBucket<V>

org.redisson.transaction.RedissonTransactionalBucket<V>

Type Parameters:

V - value type

All Implemented Interfaces:

RBucket<V>, RBucketAsync<V>, RExpirable, RExpirableAsync, RObject, RObjectAsync

public class RedissonTransactionalBucket<V>
extends RedissonBucket<V>

Author:

Nikita Koksharov

Field Summary

Fields inherited from class org.redisson.RedissonObject

codec, commandExecutor, name

Constructor Summary

Constructors

Constructor and Description
RedissonTransactionalBucket(Codec codec, CommandAsyncExecutor commandExecutor, long timeout, String name, List<TransactionalOperation> operations, AtomicBoolean executed, String transactionId)
RedissonTransactionalBucket(CommandAsyncExecutor commandExecutor, long timeout, String name, List<TransactionalOperation> operations, AtomicBoolean executed, String transactionId)

Method Summary

Modifier and Type	Method and Description
protected void	checkState()
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.
protected RFuture<Boolean>	clearExpireAsync(String... keys)
RFuture<Boolean>	compareAndSetAsync(V expect, V update) Atomically sets the value to the given updated value only if serialized state of the current value equals to serialized state of the expected value.
RFuture<Boolean>	deleteAsync() Delete object in async mode
protected <R> void	executeLocked(RPromise<R> promise, Runnable runnable)
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.
protected RFuture<Boolean>	expireAsync(long timeToLive, TimeUnit timeUnit, String... keys)
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.
protected RFuture<Boolean>	expireAtAsync(long timestamp, String... keys)
RFuture<V>	getAndDeleteAsync() Retrieves element in the holder and removes it.
RFuture<V>	getAndSetAsync(V value) Retrieves current element in the holder and replaces it with newValue.
RFuture<V>	getAndSetAsync(V value, long timeToLive, TimeUnit timeUnit) Retrieves current element in the holder and replaces it with newValue with defined timeToLive interval.
RFuture<V>	getAsync() Retrieves element stored in the holder.
RFuture<Boolean>	isExistsAsync() Check object existence in async mode.
RFuture<Void>	migrateAsync(String host, int port, int database, long timeout) Transfer object from source Redis instance to destination Redis instance in async mode
RFuture<Boolean>	moveAsync(int database) Move object to another database in async mode
long	remainTimeToLive() Remaining time to live of Redisson object that has a timeout
RFuture<Long>	remainTimeToLiveAsync() Remaining time to live of Redisson object that has a timeout
RFuture<Void>	setAsync(V newValue) Stores element into the holder.
RFuture<Void>	setAsync(V value, long timeToLive, TimeUnit timeUnit) Stores element into the holder with defined timeToLive interval.
RFuture<Long>	sizeAsync() Returns size of object in bytes
RFuture<Boolean>	touchAsync() Update the last access time of an object in async mode.
RFuture<Boolean>	trySetAsync(V newValue) Tries to set element atomically into empty holder.
RFuture<Boolean>	trySetAsync(V value, long timeToLive, TimeUnit timeUnit) Tries to set element atomically into empty holder with defined timeToLive interval.
RFuture<Boolean>	unlinkAsync() Delete the objects.

Methods inherited from class org.redisson.RedissonBucket

addListener, addListenerAsync, compareAndSet, get, getAndDelete, getAndSet, getAndSet, removeListener, removeListenerAsync, set, set, setIfExists, setIfExists, setIfExistsAsync, setIfExistsAsync, size, trySet, trySet

Methods inherited from class org.redisson.RedissonObject

addListener, addListenerAsync, copy, copyAsync, delete, deleteAsync, dump, dumpAsync, encode, encode, encode, encode, encodeMapKey, encodeMapKeys, encodeMapValue, encodeMapValues, get, getCodec, getIdleTime, getIdleTimeAsync, getLockByMapKey, getLockByValue, getName, getName, isExists, migrate, move, prefixName, removeListenersAsync, rename, renameAsync, renamenx, renamenxAsync, restore, restore, restoreAndReplace, restoreAndReplace, restoreAndReplaceAsync, restoreAndReplaceAsync, restoreAsync, restoreAsync, sizeInMemory, sizeInMemoryAsync, sizeInMemoryAsync, sizeInMemoryAsync, suffixName, toSeconds, toStream, touch, unlink

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

clearExpire, expire, expireAt, expireAt, remainTimeToLive

Methods inherited from interface org.redisson.api.RObject

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

Methods inherited from interface org.redisson.api.RExpirableAsync

remainTimeToLiveAsync

Methods inherited from interface org.redisson.api.RObjectAsync

copyAsync, dumpAsync, getIdleTimeAsync, renameAsync, renamenxAsync, restoreAndReplaceAsync, restoreAndReplaceAsync, restoreAsync, restoreAsync, sizeInMemoryAsync

Constructor Detail

RedissonTransactionalBucket

public RedissonTransactionalBucket(CommandAsyncExecutor commandExecutor,
                                   long timeout,
                                   String name,
                                   List<TransactionalOperation> operations,
                                   AtomicBoolean executed,
                                   String transactionId)

RedissonTransactionalBucket

public RedissonTransactionalBucket(Codec codec,
                                   CommandAsyncExecutor commandExecutor,
                                   long timeout,
                                   String name,
                                   List<TransactionalOperation> operations,
                                   AtomicBoolean executed,
                                   String transactionId)

Method Detail

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

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

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 milliseconds (Unix timestamp)

Returns:

true if the timeout was set and false if not

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

moveAsync

public RFuture<Boolean> moveAsync(int database)

Description copied from interface: RObjectAsync

Move object to another database in async mode

Specified by:

moveAsync in interface RObjectAsync

Overrides:

moveAsync in class RedissonObject

Parameters:

database - - number of Redis database

Returns:

true if key was moved false if not

migrateAsync

public RFuture<Void> migrateAsync(String host,
                                  int port,
                                  int database,
                                  long timeout)

Description copied from interface: RObjectAsync

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

Specified by:

migrateAsync in interface RObjectAsync

Overrides:

migrateAsync in class RedissonObject

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

sizeAsync

public RFuture<Long> sizeAsync()

Description copied from interface: RBucketAsync

Returns size of object in bytes

Specified by:

sizeAsync in interface RBucketAsync<V>

Overrides:

sizeAsync in class RedissonBucket<V>

Returns:

object size

isExistsAsync

public RFuture<Boolean> isExistsAsync()

Description copied from interface: RObjectAsync

Check object existence in async mode.

Specified by:

isExistsAsync in interface RObjectAsync

Overrides:

isExistsAsync in class RedissonObject

Returns:

true if object exists and false otherwise

touchAsync

public RFuture<Boolean> touchAsync()

Description copied from interface: RObjectAsync

Update the last access time of an object in async mode.

Specified by:

touchAsync in interface RObjectAsync

Overrides:

touchAsync in class RedissonObject

Returns:

true if object was touched else false

unlinkAsync

public RFuture<Boolean> unlinkAsync()

Description copied from interface: RObjectAsync

Delete the objects. Actual removal will happen later asynchronously.

Requires Redis 4.0+

Specified by:

unlinkAsync in interface RObjectAsync

Overrides:

unlinkAsync in class RedissonObject

Returns:

true if it was exist and deleted else false

deleteAsync

public RFuture<Boolean> deleteAsync()

Description copied from interface: RObjectAsync

Delete object in async mode

Specified by:

deleteAsync in interface RObjectAsync

Overrides:

deleteAsync in class RedissonObject

Returns:

true if object was deleted false if not

getAsync

public RFuture<V> getAsync()

Description copied from interface: RBucketAsync

Retrieves element stored in the holder.

Specified by:

getAsync in interface RBucketAsync<V>

Overrides:

getAsync in class RedissonBucket<V>

Returns:

element

compareAndSetAsync

public RFuture<Boolean> compareAndSetAsync(V expect,
                                           V update)

Description copied from interface: RBucketAsync

Atomically sets the value to the given updated value only if serialized state of the current value equals to serialized state of the expected value.

Specified by:

compareAndSetAsync in interface RBucketAsync<V>

Overrides:

compareAndSetAsync in class RedissonBucket<V>

Parameters:

expect - the expected value

update - the new value

Returns:

true if successful; or false if the actual value was not equal to the expected value.

getAndSetAsync

public RFuture<V> getAndSetAsync(V value,
                                 long timeToLive,
                                 TimeUnit timeUnit)

Description copied from interface: RBucketAsync

Retrieves current element in the holder and replaces it with newValue with defined timeToLive interval.

Specified by:

getAndSetAsync in interface RBucketAsync<V>

Overrides:

getAndSetAsync in class RedissonBucket<V>

Parameters:

value - - value to set

timeToLive - - time to live interval

timeUnit - - unit of time to live interval

Returns:

previous value

getAndSetAsync

public RFuture<V> getAndSetAsync(V value)

Description copied from interface: RBucketAsync

Retrieves current element in the holder and replaces it with newValue.

Specified by:

getAndSetAsync in interface RBucketAsync<V>

Overrides:

getAndSetAsync in class RedissonBucket<V>

Parameters:

value - - value to set

Returns:

previous value

getAndDeleteAsync

public RFuture<V> getAndDeleteAsync()

Description copied from interface: RBucketAsync

Retrieves element in the holder and removes it.

Specified by:

getAndDeleteAsync in interface RBucketAsync<V>

Overrides:

getAndDeleteAsync in class RedissonBucket<V>

Returns:

element

setAsync

public RFuture<Void> setAsync(V newValue)

Description copied from interface: RBucketAsync

Stores element into the holder.

Specified by:

setAsync in interface RBucketAsync<V>

Overrides:

setAsync in class RedissonBucket<V>

Parameters:

newValue - - value to set

Returns:

void

setAsync

public RFuture<Void> setAsync(V value,
                              long timeToLive,
                              TimeUnit timeUnit)

Description copied from interface: RBucketAsync

Stores element into the holder with defined timeToLive interval.

Specified by:

setAsync in interface RBucketAsync<V>

Overrides:

setAsync in class RedissonBucket<V>

Parameters:

value - - value to set

timeToLive - - time to live interval

timeUnit - - unit of time to live interval

Returns:

void

trySetAsync

public RFuture<Boolean> trySetAsync(V newValue)

Description copied from interface: RBucketAsync

Tries to set element atomically into empty holder.

Specified by:

trySetAsync in interface RBucketAsync<V>

Overrides:

trySetAsync in class RedissonBucket<V>

Parameters:

newValue - - value to set

Returns:

true if successful, or false if element was already set

trySetAsync

public RFuture<Boolean> trySetAsync(V value,
                                    long timeToLive,
                                    TimeUnit timeUnit)

Description copied from interface: RBucketAsync

Tries to set element atomically into empty holder with defined timeToLive interval.

Specified by:

trySetAsync in interface RBucketAsync<V>

Overrides:

trySetAsync in class RedissonBucket<V>

Parameters:

value - - value to set

timeToLive - - time to live interval

timeUnit - - unit of time to live interval

Returns:

true if successful, or false if element was already set

executeLocked

protected <R> void executeLocked(RPromise<R> promise,
                                 Runnable runnable)

checkState

protected void checkState()

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

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

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

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

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

Remaining time to live of Redisson object that has a timeout

Specified by:

remainTimeToLiveAsync in interface RExpirableAsync

Returns:

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

expireAsync

protected RFuture<Boolean> expireAsync(long timeToLive,
                                       TimeUnit timeUnit,
                                       String... keys)

expireAtAsync

protected RFuture<Boolean> expireAtAsync(long timestamp,
                                         String... keys)

clearExpireAsync

protected RFuture<Boolean> clearExpireAsync(String... keys)