Package org.redisson

Class RedissonRx

java.lang.Object

org.redisson.RedissonRx

All Implemented Interfaces:

RedissonRxClient

public class RedissonRx
extends Object
implements RedissonRxClient

Main infrastructure class allows to get access to all Redisson objects on top of Redis server.

Author:

Nikita Koksharov

Field Summary

Fields

Modifier and Type	Field	Description
protected CommandRxExecutor	commandExecutor
protected ConnectionManager	connectionManager
protected EvictionScheduler	evictionScheduler
protected ConcurrentMap<String,ResponseEntry>	responses
protected WriteBehindService	writeBehindService

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	RedissonRx(Config config)
protected	RedissonRx(ConnectionManager connectionManager, EvictionScheduler evictionScheduler, WriteBehindService writeBehindService, ConcurrentMap<String,ResponseEntry> responses)

Method Summary

Modifier and Type	Method	Description
RBatchRx	createBatch()	Return batch object which executes group of command in pipeline.
RBatchRx	createBatch(BatchOptions options)	Return batch object which executes group of command in pipeline.
RTransactionRx	createTransaction(TransactionOptions options)	Creates transaction with READ_COMMITTED isolation level.
RAtomicDoubleRx	getAtomicDouble(String name)	Returns "atomic double" instance by name.
RAtomicLongRx	getAtomicLong(String name)	Returns "atomic long" instance by name.
RBinaryStreamRx	getBinaryStream(String name)	Returns binary stream holder instance by name
RBitSetRx	getBitSet(String name)	Returns bitSet instance by name.
<V> RBlockingDequeRx<V>	getBlockingDeque(String name)	Returns unbounded blocking deque instance by name.
<V> RBlockingDequeRx<V>	getBlockingDeque(String name, Codec codec)	Returns unbounded blocking deque instance by name using provided codec for deque objects.
<V> RBlockingQueueRx<V>	getBlockingQueue(String name)	Returns blocking queue instance by name.
<V> RBlockingQueueRx<V>	getBlockingQueue(String name, Codec codec)	Returns blocking queue instance by name using provided codec for queue objects.
<V> RBucketRx<V>	getBucket(String name)	Returns object holder instance by name
<V> RBucketRx<V>	getBucket(String name, Codec codec)	Returns object holder instance by name using provided codec for object.
RBucketsRx	getBuckets()	Returns interface for mass operations with Bucket objects.
RBucketsRx	getBuckets(Codec codec)	Returns interface for mass operations with Bucket objects using provided codec for object.
NodesGroup<ClusterNode>	getClusterNodesGroup()	Get Redis cluster nodes group for server operations
CommandRxExecutor	getCommandExecutor()
Config	getConfig()	Allows to get configuration provided during Redisson instance creation.
RCountDownLatchRx	getCountDownLatch(String name)	Returns CountDownLatch instance by name.
<V> RDequeRx<V>	getDeque(String name)	Returns deque instance by name.
<V> RDequeRx<V>	getDeque(String name, Codec codec)	Returns deque instance by name using provided codec for deque objects.
RLockRx	getFairLock(String name)	Returns Lock instance by name.
<V> RGeoRx<V>	getGeo(String name)	Returns geospatial items holder instance by name.
<V> RGeoRx<V>	getGeo(String name, Codec codec)	Returns geospatial items holder instance by name using provided codec for geospatial members.
<V> RHyperLogLogRx<V>	getHyperLogLog(String name)	Returns HyperLogLog instance by name.
<V> RHyperLogLogRx<V>	getHyperLogLog(String name, Codec codec)	Returns HyperLogLog instance by name using provided codec for hll objects.
String	getId()	Returns id of this Redisson instance
RIdGeneratorRx	getIdGenerator(String name)	Returns id generator by name.
RKeysRx	getKeys()	Returns keys operations.
RLexSortedSetRx	getLexSortedSet(String name)	Returns String based Redis Sorted Set instance by name All elements are inserted with the same score during addition, in order to force lexicographical ordering
<V> RListRx<V>	getList(String name)	Returns list instance by name.
<V> RListRx<V>	getList(String name, Codec codec)	Returns list instance by name using provided codec for list objects.
<K,V> RListMultimapRx<K,V>	getListMultimap(String name)	Returns List based Multimap instance by name.
<K,V> RListMultimapRx<K,V>	getListMultimap(String name, Codec codec)	Returns List based Multimap instance by name using provided codec for both map keys and values.
<K,V> RListMultimapCacheRx<K,V>	getListMultimapCache(String name)	Returns List based Multimap cache instance by name.
<K,V> RListMultimapCacheRx<K,V>	getListMultimapCache(String name, Codec codec)	Returns List based Multimap cache instance by name using provided codec for both map keys and values.
RLockRx	getLock(String name)	Returns Lock instance by name.
<K,V> RMapRx<K,V>	getMap(String name)	Returns map instance by name.
<K,V> RMapRx<K,V>	getMap(String name, MapOptions<K,V> options)	Returns map instance by name.
<K,V> RMapRx<K,V>	getMap(String name, Codec codec)	Returns map instance by name using provided codec for both map keys and values.
<K,V> RMapRx<K,V>	getMap(String name, Codec codec, MapOptions<K,V> options)	Returns map instance by name using provided codec for both map keys and values.
<K,V> RMapCacheRx<K,V>	getMapCache(String name)	Returns map-based cache instance by name.
<K,V> RMapCacheRx<K,V>	getMapCache(String name, MapOptions<K,V> options)	Returns map-based cache instance by name.
<K,V> RMapCacheRx<K,V>	getMapCache(String name, Codec codec)	Returns map-based cache instance by name using provided codec for both cache keys and values.
<K,V> RMapCacheRx<K,V>	getMapCache(String name, Codec codec, MapOptions<K,V> options)	Returns map-based cache instance by name using provided codec for both cache keys and values.
RLockRx	getMultiLock(RLock... locks)	Returns MultiLock instance associated with specified locks
NodesGroup<Node>	getNodesGroup()	Get Redis nodes group for server operations
RPatternTopicRx	getPatternTopic(String pattern)	Returns topic instance satisfies by pattern name.
RPatternTopicRx	getPatternTopic(String pattern, Codec codec)	Returns topic instance satisfies by pattern name using provided codec for messages.
RPermitExpirableSemaphoreRx	getPermitExpirableSemaphore(String name)	Returns semaphore instance by name.
<V> RQueueRx<V>	getQueue(String name)	Returns queue instance by name.
<V> RQueueRx<V>	getQueue(String name, Codec codec)	Returns queue instance by name using provided codec for queue objects.
RRateLimiterRx	getRateLimiter(String name)	Returns rate limiter instance by name
RReadWriteLockRx	getReadWriteLock(String name)	Returns ReadWriteLock instance by name.
RLockRx	getRedLock(RLock... locks)
RReliableTopicRx	getReliableTopic(String name)	Returns reliable topic instance by name.
RReliableTopicRx	getReliableTopic(String name, Codec codec)	Returns reliable topic instance by name using provided codec for messages.
RRemoteService	getRemoteService()	Returns object for remote operations prefixed with the default name (redisson_remote_service)
RRemoteService	getRemoteService(String name)	Returns object for remote operations prefixed with the specified name
RRemoteService	getRemoteService(String name, Codec codec)	Returns object for remote operations prefixed with the specified name and uses provided codec for method arguments and result.
RRemoteService	getRemoteService(Codec codec)	Returns object for remote operations prefixed with the default name (redisson_remote_service) and uses provided codec for method arguments and result.
<V> RRingBufferRx<V>	getRingBuffer(String name)	Returns RingBuffer based queue.
<V> RRingBufferRx<V>	getRingBuffer(String name, Codec codec)	Returns RingBuffer based queue.
<V> RScoredSortedSetRx<V>	getScoredSortedSet(String name)	Returns Redis Sorted Set instance by name.
<V> RScoredSortedSetRx<V>	getScoredSortedSet(String name, Codec codec)	Returns Redis Sorted Set instance by name using provided codec for sorted set objects.
RScriptRx	getScript()	Returns script operations object
RScriptRx	getScript(Codec codec)	Returns script operations object using provided codec.
RSemaphoreRx	getSemaphore(String name)	Returns semaphore instance by name
<V> RSetRx<V>	getSet(String name)	Returns set instance by name.
<V> RSetRx<V>	getSet(String name, Codec codec)	Returns set instance by name using provided codec for set objects.
<V> RSetCacheRx<V>	getSetCache(String name)	Returns set-based cache instance by name.
<V> RSetCacheRx<V>	getSetCache(String name, Codec codec)	Returns set-based cache instance by name.
<K,V> RSetMultimapRx<K,V>	getSetMultimap(String name)	Returns Set based Multimap instance by name.
<K,V> RSetMultimapRx<K,V>	getSetMultimap(String name, Codec codec)	Returns Set based Multimap instance by name using provided codec for both map keys and values.
<K,V> RSetMultimapCacheRx<K,V>	getSetMultimapCache(String name)	Returns Set based Multimap cache instance by name.
<K,V> RSetMultimapCacheRx<K,V>	getSetMultimapCache(String name, Codec codec)	Returns Set based Multimap cache instance by name using provided codec for both map keys and values.
RLockRx	getSpinLock(String name)	Returns Spin lock instance by name.
RLockRx	getSpinLock(String name, LockOptions.BackOff backOff)	Returns Spin lock instance by name with specified back off options.
<K,V> RStreamRx<K,V>	getStream(String name)	Returns stream instance by name
<K,V> RStreamRx<K,V>	getStream(String name, Codec codec)	Returns stream instance by name using provided codec for entries.
<V> RTimeSeriesRx<V>	getTimeSeries(String name)	Returns time-series instance by name
<V> RTimeSeriesRx<V>	getTimeSeries(String name, Codec codec)	Returns time-series instance by name using provided codec for values.
RTopicRx	getTopic(String name)	Returns topic instance by name.
RTopicRx	getTopic(String name, Codec codec)	Returns topic instance by name using provided codec for messages.
<V> RTransferQueueRx<V>	getTransferQueue(String name)	Returns transfer queue instance by name.
<V> RTransferQueueRx<V>	getTransferQueue(String name, Codec codec)	Returns transfer queue instance by name using provided codec for queue objects.
boolean	isShutdown()	Returns true if this Redisson instance has been shut down.
boolean	isShuttingDown()	Returns true if this Redisson instance was started to be shutdown or was shutdown RedissonRxClient.isShutdown() already.
void	shutdown()	Shuts down Redisson instance NOT Redis server

Methods inherited from class java.lang.Object

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

Field Detail

writeBehindService

protected final WriteBehindService writeBehindService

evictionScheduler

protected final EvictionScheduler evictionScheduler

commandExecutor

protected final CommandRxExecutor commandExecutor

connectionManager

protected final ConnectionManager connectionManager

responses

protected final ConcurrentMap<String,ResponseEntry> responses

Constructor Detail

RedissonRx

protected RedissonRx(Config config)

RedissonRx

protected RedissonRx(ConnectionManager connectionManager,
                     EvictionScheduler evictionScheduler,
                     WriteBehindService writeBehindService,
                     ConcurrentMap<String,ResponseEntry> responses)

Method Detail

getCommandExecutor

public CommandRxExecutor getCommandExecutor()

getStream

public <K,V> RStreamRx<K,V> getStream(String name)

Description copied from interface: RedissonRxClient

Returns stream instance by name

Requires Redis 5.0.0 and higher.

Specified by:

getStream in interface RedissonRxClient

Type Parameters:

K - type of key

V - type of value

Parameters:

name - of stream

Returns:

RStream object

getStream

public <K,V> RStreamRx<K,V> getStream(String name,
                                                  Codec codec)

Description copied from interface: RedissonRxClient

Returns stream instance by name using provided codec for entries.

Requires Redis 5.0.0 and higher.

Specified by:

getStream in interface RedissonRxClient

Type Parameters:

K - type of key

V - type of value

Parameters:

name - - name of stream

codec - - codec for entry

Returns:

RStream object

getGeo

public <V> RGeoRx<V> getGeo(String name)

Description copied from interface: RedissonRxClient

Returns geospatial items holder instance by name.

Specified by:

getGeo in interface RedissonRxClient

Type Parameters:

V - type of value

Parameters:

name - - name of object

Returns:

Geo object

getGeo

public <V> RGeoRx<V> getGeo(String name,
                            Codec codec)

Description copied from interface: RedissonRxClient

Returns geospatial items holder instance by name using provided codec for geospatial members.

Specified by:

getGeo in interface RedissonRxClient

Type Parameters:

V - type of value

Parameters:

name - - name of object

codec - - codec for value

Returns:

Geo object

getFairLock

public RLockRx getFairLock(String name)

Description copied from interface: RedissonRxClient

Returns Lock instance by name.

Implements a fair locking so it guarantees an acquire order by threads.

To increase reliability during failover, all operations wait for propagation to all Redis slaves.

Specified by:

getFairLock in interface RedissonRxClient

Parameters:

name - - name of object

Returns:

Lock object

getRateLimiter

public RRateLimiterRx getRateLimiter(String name)

Description copied from interface: RedissonRxClient

Returns rate limiter instance by name

Specified by:

getRateLimiter in interface RedissonRxClient

Parameters:

name - of rate limiter

Returns:

RateLimiter object

getBinaryStream

public RBinaryStreamRx getBinaryStream(String name)

Description copied from interface: RedissonRxClient

Returns binary stream holder instance by name

Specified by:

getBinaryStream in interface RedissonRxClient

Parameters:

name - of binary stream

Returns:

BinaryStream object

getSemaphore

public RSemaphoreRx getSemaphore(String name)

Description copied from interface: RedissonRxClient

Returns semaphore instance by name

Specified by:

getSemaphore in interface RedissonRxClient

Parameters:

name - - name of object

Returns:

Semaphore object

getPermitExpirableSemaphore

public RPermitExpirableSemaphoreRx getPermitExpirableSemaphore(String name)

Description copied from interface: RedissonRxClient

Returns semaphore instance by name. Supports lease time parameter for each acquired permit.

Specified by:

getPermitExpirableSemaphore in interface RedissonRxClient

Parameters:

name - - name of object

Returns:

PermitExpirableSemaphore object

getReadWriteLock

public RReadWriteLockRx getReadWriteLock(String name)

Description copied from interface: RedissonRxClient

Returns ReadWriteLock instance by name.

To increase reliability during failover, all operations wait for propagation to all Redis slaves.

Specified by:

getReadWriteLock in interface RedissonRxClient

Parameters:

name - - name of object

Returns:

Lock object

getLock

public RLockRx getLock(String name)

Description copied from interface: RedissonRxClient

Returns Lock instance by name.

Implements a non-fair locking so doesn't guarantees an acquire order by threads.

To increase reliability during failover, all operations wait for propagation to all Redis slaves.

Specified by:

getLock in interface RedissonRxClient

Parameters:

name - - name of object

Returns:

Lock object

getSpinLock

public RLockRx getSpinLock(String name)

Description copied from interface: RedissonRxClient

Returns Spin lock instance by name.

Implements a non-fair locking so doesn't guarantees an acquire order by threads.

Lock doesn't use a pub/sub mechanism

Specified by:

getSpinLock in interface RedissonRxClient

Parameters:

name - - name of object

Returns:

Lock object

getSpinLock

public RLockRx getSpinLock(String name,
                           LockOptions.BackOff backOff)

Description copied from interface: RedissonRxClient

Returns Spin lock instance by name with specified back off options.

Implements a non-fair locking so doesn't guarantees an acquire order by threads.

Lock doesn't use a pub/sub mechanism

Specified by:

getSpinLock in interface RedissonRxClient

Parameters:

name - - name of object

Returns:

Lock object

getMultiLock

public RLockRx getMultiLock(RLock... locks)

Description copied from interface: RedissonRxClient

Returns MultiLock instance associated with specified locks

Specified by:

getMultiLock in interface RedissonRxClient

Parameters:

locks - - collection of locks

Returns:

MultiLock object

getRedLock

public RLockRx getRedLock(RLock... locks)

Specified by:

getRedLock in interface RedissonRxClient

getCountDownLatch

public RCountDownLatchRx getCountDownLatch(String name)

Description copied from interface: RedissonRxClient

Returns CountDownLatch instance by name.

Specified by:

getCountDownLatch in interface RedissonRxClient

Parameters:

name - - name of object

Returns:

CountDownLatch object

getMapCache

public <K,V> RMapCacheRx<K,V> getMapCache(String name,
                                                      Codec codec)

Description copied from interface: RedissonRxClient

Returns map-based cache instance by name using provided codec for both cache keys and values. Supports entry eviction with a given MaxIdleTime and TTL settings.

If eviction is not required then it's better to use regular map RedissonRxClient.getMap(String, Codec).

Specified by:

getMapCache in interface RedissonRxClient

Type Parameters:

K - type of keys

V - type of values

Parameters:

name - - name of object

codec - - codec for values

Returns:

MapCache object

getMapCache

public <K,V> RMapCacheRx<K,V> getMapCache(String name)

Description copied from interface: RedissonRxClient

Returns map-based cache instance by name. Supports entry eviction with a given MaxIdleTime and TTL settings.

If eviction is not required then it's better to use regular map RedissonRxClient.getMap(String).

Specified by:

getMapCache in interface RedissonRxClient

Type Parameters:

K - type of keys

V - type of values

Parameters:

name - - name of object

Returns:

MapCache object

getBucket

public <V> RBucketRx<V> getBucket(String name)

Description copied from interface: RedissonRxClient

Returns object holder instance by name

Specified by:

getBucket in interface RedissonRxClient

Type Parameters:

V - type of value

Parameters:

name - - name of object

Returns:

Bucket object

getBucket

public <V> RBucketRx<V> getBucket(String name,
                                  Codec codec)

Description copied from interface: RedissonRxClient

Returns object holder instance by name using provided codec for object.

Specified by:

getBucket in interface RedissonRxClient

Type Parameters:

V - type of value

Parameters:

name - - name of object

codec - - codec for value

Returns:

Bucket object

getBuckets

public RBucketsRx getBuckets()

Description copied from interface: RedissonRxClient

Returns interface for mass operations with Bucket objects.

Specified by:

getBuckets in interface RedissonRxClient

Returns:

Buckets

getBuckets

public RBucketsRx getBuckets(Codec codec)

Description copied from interface: RedissonRxClient

Returns interface for mass operations with Bucket objects using provided codec for object.

Specified by:

getBuckets in interface RedissonRxClient

Parameters:

codec - - codec for bucket objects

Returns:

Buckets

getHyperLogLog

public <V> RHyperLogLogRx<V> getHyperLogLog(String name)

Description copied from interface: RedissonRxClient

Returns HyperLogLog instance by name.

Specified by:

getHyperLogLog in interface RedissonRxClient

Type Parameters:

V - type of values

Parameters:

name - - name of object

Returns:

HyperLogLog object

getHyperLogLog

public <V> RHyperLogLogRx<V> getHyperLogLog(String name,
                                            Codec codec)

Description copied from interface: RedissonRxClient

Returns HyperLogLog instance by name using provided codec for hll objects.

Specified by:

getHyperLogLog in interface RedissonRxClient

Type Parameters:

V - type of values

Parameters:

name - - name of object

codec - - codec of values

Returns:

HyperLogLog object

getIdGenerator

public RIdGeneratorRx getIdGenerator(String name)

Description copied from interface: RedissonRxClient

Returns id generator by name.

Specified by:

getIdGenerator in interface RedissonRxClient

Parameters:

name - - name of object

Returns:

IdGenerator object

getList

public <V> RListRx<V> getList(String name)

Description copied from interface: RedissonRxClient

Returns list instance by name.

Specified by:

getList in interface RedissonRxClient

Type Parameters:

V - type of values

Parameters:

name - - name of object

Returns:

List object

getList

public <V> RListRx<V> getList(String name,
                              Codec codec)

Description copied from interface: RedissonRxClient

Returns list instance by name using provided codec for list objects.

Specified by:

getList in interface RedissonRxClient

Type Parameters:

V - type of values

Parameters:

name - - name of object

codec - - codec for values

Returns:

List object

getListMultimap

public <K,V> RListMultimapRx<K,V> getListMultimap(String name)

Description copied from interface: RedissonRxClient

Returns List based Multimap instance by name.

Specified by:

getListMultimap in interface RedissonRxClient

Type Parameters:

K - type of key

V - type of value

Parameters:

name - - name of object

Returns:

ListMultimap object

getListMultimap

public <K,V> RListMultimapRx<K,V> getListMultimap(String name,
                                                              Codec codec)

Description copied from interface: RedissonRxClient

Returns List based Multimap instance by name using provided codec for both map keys and values.

Specified by:

getListMultimap in interface RedissonRxClient

Type Parameters:

K - type of key

V - type of value

Parameters:

name - - name of object

codec - - codec for keys and values

Returns:

RListMultimapReactive object

getListMultimapCache

public <K,V> RListMultimapCacheRx<K,V> getListMultimapCache(String name)

Description copied from interface: RedissonRxClient

Returns List based Multimap cache instance by name. Supports key eviction by specifying a time to live. If eviction is not required then it's better to use regular list multimap RedissonRxClient.getListMultimap(String).

Specified by:

getListMultimapCache in interface RedissonRxClient

Type Parameters:

K - type of key

V - type of value

Parameters:

name - - name of object

Returns:

RListMultimapCacheRx object

getListMultimapCache

public <K,V> RListMultimapCacheRx<K,V> getListMultimapCache(String name,
                                                                        Codec codec)

Description copied from interface: RedissonRxClient

Returns List based Multimap cache instance by name using provided codec for both map keys and values. Supports key eviction by specifying a time to live. If eviction is not required then it's better to use regular list multimap RedissonRxClient.getListMultimap(String, Codec).

Specified by:

getListMultimapCache in interface RedissonRxClient

Type Parameters:

K - type of key

V - type of value

Parameters:

name - - name of object

codec - - codec for keys and values

Returns:

RListMultimapCacheRx object

getSetMultimap

public <K,V> RSetMultimapRx<K,V> getSetMultimap(String name)

Description copied from interface: RedissonRxClient

Returns Set based Multimap instance by name.

Specified by:

getSetMultimap in interface RedissonRxClient

Type Parameters:

K - type of key

V - type of value

Parameters:

name - - name of object

Returns:

SetMultimap object

getSetMultimap

public <K,V> RSetMultimapRx<K,V> getSetMultimap(String name,
                                                            Codec codec)

Description copied from interface: RedissonRxClient

Returns Set based Multimap instance by name using provided codec for both map keys and values.

Specified by:

getSetMultimap in interface RedissonRxClient

Type Parameters:

K - type of key

V - type of value

Parameters:

name - - name of object

codec - - codec for keys and values

Returns:

SetMultimap object

getSetMultimapCache

public <K,V> RSetMultimapCacheRx<K,V> getSetMultimapCache(String name)

Description copied from interface: RedissonRxClient

Returns Set based Multimap cache instance by name. Supports key eviction by specifying a time to live. If eviction is not required then it's better to use regular set multimap RedissonRxClient.getSetMultimap(String).

Specified by:

getSetMultimapCache in interface RedissonRxClient

Type Parameters:

K - type of key

V - type of value

Parameters:

name - - name of object

Returns:

RSetMultimapCacheRx object

getSetMultimapCache

public <K,V> RSetMultimapCacheRx<K,V> getSetMultimapCache(String name,
                                                                      Codec codec)

Description copied from interface: RedissonRxClient

Returns Set based Multimap cache instance by name using provided codec for both map keys and values. Supports key eviction by specifying a time to live. If eviction is not required then it's better to use regular set multimap RedissonRxClient.getSetMultimap(String, Codec).

Specified by:

getSetMultimapCache in interface RedissonRxClient

Type Parameters:

K - type of key

V - type of value

Parameters:

name - - name of object

codec - - codec for keys and values

Returns:

RSetMultimapCacheRx object

getMap

public <K,V> RMapRx<K,V> getMap(String name)

Description copied from interface: RedissonRxClient

Returns map instance by name.

Specified by:

getMap in interface RedissonRxClient

Type Parameters:

K - type of keys

V - type of values

Parameters:

name - - name of object

Returns:

Map object

getMap

public <K,V> RMapRx<K,V> getMap(String name,
                                            Codec codec)

Description copied from interface: RedissonRxClient

Returns map instance by name using provided codec for both map keys and values.

Specified by:

getMap in interface RedissonRxClient

Type Parameters:

K - type of keys

V - type of values

Parameters:

name - - name of object

codec - - codec for keys and values

Returns:

Map object

getSet

public <V> RSetRx<V> getSet(String name)

Description copied from interface: RedissonRxClient

Returns set instance by name.

Specified by:

getSet in interface RedissonRxClient

Type Parameters:

V - type of values

Parameters:

name - - name of object

Returns:

Set object

getSet

public <V> RSetRx<V> getSet(String name,
                            Codec codec)

Description copied from interface: RedissonRxClient

Returns set instance by name using provided codec for set objects.

Specified by:

getSet in interface RedissonRxClient

Type Parameters:

V - type of values

Parameters:

name - - name of set

codec - - codec for values

Returns:

Set object

getScoredSortedSet

public <V> RScoredSortedSetRx<V> getScoredSortedSet(String name)

Description copied from interface: RedissonRxClient

Returns Redis Sorted Set instance by name. This sorted set sorts objects by object score.

Specified by:

getScoredSortedSet in interface RedissonRxClient

Type Parameters:

V - type of values

Parameters:

name - of scored sorted set

Returns:

ScoredSortedSet object

getScoredSortedSet

public <V> RScoredSortedSetRx<V> getScoredSortedSet(String name,
                                                    Codec codec)

Description copied from interface: RedissonRxClient

Returns Redis Sorted Set instance by name using provided codec for sorted set objects. This sorted set sorts objects by object score.

Specified by:

getScoredSortedSet in interface RedissonRxClient

Type Parameters:

V - type of values

Parameters:

name - - name of scored sorted set

codec - - codec for values

Returns:

ScoredSortedSet object

getLexSortedSet

public RLexSortedSetRx getLexSortedSet(String name)

Description copied from interface: RedissonRxClient

Returns String based Redis Sorted Set instance by name All elements are inserted with the same score during addition, in order to force lexicographical ordering

Specified by:

getLexSortedSet in interface RedissonRxClient

Parameters:

name - - name of object

Returns:

LexSortedSet object

getTopic

public RTopicRx getTopic(String name)

Description copied from interface: RedissonRxClient

Returns topic instance by name.

Specified by:

getTopic in interface RedissonRxClient

Parameters:

name - - name of object

Returns:

Topic object

getTopic

public RTopicRx getTopic(String name,
                         Codec codec)

Description copied from interface: RedissonRxClient

Returns topic instance by name using provided codec for messages.

Specified by:

getTopic in interface RedissonRxClient

Parameters:

name - - name of object

codec - - codec for message

Returns:

Topic object

getReliableTopic

public RReliableTopicRx getReliableTopic(String name)

Description copied from interface: RedissonRxClient

Returns reliable topic instance by name.

Dedicated Redis connection is allocated per instance (subscriber) of this object. Messages are delivered to all listeners attached to the same Redis setup.

Requires Redis 5.0.0 and higher.

Specified by:

getReliableTopic in interface RedissonRxClient

Parameters:

name - - name of object

Returns:

ReliableTopic object

getReliableTopic

public RReliableTopicRx getReliableTopic(String name,
                                         Codec codec)

Description copied from interface: RedissonRxClient

Returns reliable topic instance by name using provided codec for messages.

Dedicated Redis connection is allocated per instance (subscriber) of this object. Messages are delivered to all listeners attached to the same Redis setup.

Requires Redis 5.0.0 and higher.

Specified by:

getReliableTopic in interface RedissonRxClient

Parameters:

name - - name of object

codec - - codec for message

Returns:

ReliableTopic object

getPatternTopic

public RPatternTopicRx getPatternTopic(String pattern)

Description copied from interface: RedissonRxClient

Returns topic instance satisfies by pattern name. Supported glob-style patterns: h?llo subscribes to hello, hallo and hxllo h*llo subscribes to hllo and heeeello h[ae]llo subscribes to hello and hallo, but not hillo

Specified by:

getPatternTopic in interface RedissonRxClient

Parameters:

pattern - of the topic

Returns:

PatternTopic object

getPatternTopic

public RPatternTopicRx getPatternTopic(String pattern,
                                       Codec codec)

Description copied from interface: RedissonRxClient

Returns topic instance satisfies by pattern name using provided codec for messages. Supported glob-style patterns: h?llo subscribes to hello, hallo and hxllo h*llo subscribes to hllo and heeeello h[ae]llo subscribes to hello and hallo, but not hillo

Specified by:

getPatternTopic in interface RedissonRxClient

Parameters:

pattern - of the topic

codec - - codec for message

Returns:

PatternTopic object

getQueue

public <V> RQueueRx<V> getQueue(String name)

Description copied from interface: RedissonRxClient

Returns queue instance by name.

Specified by:

getQueue in interface RedissonRxClient

Type Parameters:

V - type of values

Parameters:

name - - name of object

Returns:

Queue object

getQueue

public <V> RQueueRx<V> getQueue(String name,
                                Codec codec)

Description copied from interface: RedissonRxClient

Returns queue instance by name using provided codec for queue objects.

Specified by:

getQueue in interface RedissonRxClient

Type Parameters:

V - type of values

Parameters:

name - - name of object

codec - - codec for values

Returns:

Queue object

getRingBuffer

public <V> RRingBufferRx<V> getRingBuffer(String name)

Description copied from interface: RedissonRxClient

Returns RingBuffer based queue.

Specified by:

getRingBuffer in interface RedissonRxClient

Type Parameters:

V - value type

Parameters:

name - - name of object

Returns:

RingBuffer object

getRingBuffer

public <V> RRingBufferRx<V> getRingBuffer(String name,
                                          Codec codec)

Description copied from interface: RedissonRxClient

Returns RingBuffer based queue.

Specified by:

getRingBuffer in interface RedissonRxClient

Type Parameters:

V - value type

Parameters:

name - - name of object

codec - - codec for values

Returns:

RingBuffer object

getBlockingQueue

public <V> RBlockingQueueRx<V> getBlockingQueue(String name)

Description copied from interface: RedissonRxClient

Returns blocking queue instance by name.

Specified by:

getBlockingQueue in interface RedissonRxClient

Type Parameters:

V - type of values

Parameters:

name - - name of object

Returns:

BlockingQueue object

getBlockingQueue

public <V> RBlockingQueueRx<V> getBlockingQueue(String name,
                                                Codec codec)

Description copied from interface: RedissonRxClient

Returns blocking queue instance by name using provided codec for queue objects.

Specified by:

getBlockingQueue in interface RedissonRxClient

Type Parameters:

V - type of values

Parameters:

name - - name of object

codec - - code for values

Returns:

BlockingQueue object

getDeque

public <V> RDequeRx<V> getDeque(String name)

Description copied from interface: RedissonRxClient

Returns deque instance by name.

Specified by:

getDeque in interface RedissonRxClient

Type Parameters:

V - type of values

Parameters:

name - - name of object

Returns:

Deque object

getDeque

public <V> RDequeRx<V> getDeque(String name,
                                Codec codec)

Description copied from interface: RedissonRxClient

Returns deque instance by name using provided codec for deque objects.

Specified by:

getDeque in interface RedissonRxClient

Type Parameters:

V - type of values

Parameters:

name - - name of object

codec - - coded for values

Returns:

Deque object

getTimeSeries

public <V> RTimeSeriesRx<V> getTimeSeries(String name)

Description copied from interface: RedissonRxClient

Returns time-series instance by name

Specified by:

getTimeSeries in interface RedissonRxClient

Type Parameters:

V - type of value

Parameters:

name - - name of instance

Returns:

RTimeSeries object

getTimeSeries

public <V> RTimeSeriesRx<V> getTimeSeries(String name,
                                          Codec codec)

Description copied from interface: RedissonRxClient

Returns time-series instance by name using provided codec for values.

Specified by:

getTimeSeries in interface RedissonRxClient

Type Parameters:

V - type of value

Parameters:

name - - name of instance

codec - - codec for values

Returns:

RTimeSeries object

getSetCache

public <V> RSetCacheRx<V> getSetCache(String name)

Description copied from interface: RedissonRxClient

Returns set-based cache instance by name. Supports value eviction with a given TTL value.

If eviction is not required then it's better to use regular map RedissonRxClient.getSet(String, Codec).

Specified by:

getSetCache in interface RedissonRxClient

Type Parameters:

V - type of values

Parameters:

name - - name of object

Returns:

SetCache object

getSetCache

public <V> RSetCacheRx<V> getSetCache(String name,
                                      Codec codec)

Description copied from interface: RedissonRxClient

Returns set-based cache instance by name. Supports value eviction with a given TTL value.

If eviction is not required then it's better to use regular map RedissonRxClient.getSet(String, Codec).

Specified by:

getSetCache in interface RedissonRxClient

Type Parameters:

V - type of values

Parameters:

name - - name of object

codec - - codec for values

Returns:

SetCache object

getAtomicLong

public RAtomicLongRx getAtomicLong(String name)

Description copied from interface: RedissonRxClient

Returns "atomic long" instance by name.

Specified by:

getAtomicLong in interface RedissonRxClient

Parameters:

name - of the "atomic long"

Returns:

AtomicLong object

getAtomicDouble

public RAtomicDoubleRx getAtomicDouble(String name)

Description copied from interface: RedissonRxClient

Returns "atomic double" instance by name.

Specified by:

getAtomicDouble in interface RedissonRxClient

Parameters:

name - of the "atomic double"

Returns:

AtomicLong object

getRemoteService

public RRemoteService getRemoteService()

Description copied from interface: RedissonRxClient

Returns object for remote operations prefixed with the default name (redisson_remote_service)

Specified by:

getRemoteService in interface RedissonRxClient

Returns:

RemoteService object

getRemoteService

public RRemoteService getRemoteService(String name)

Description copied from interface: RedissonRxClient

Returns object for remote operations prefixed with the specified name

Specified by:

getRemoteService in interface RedissonRxClient

Parameters:

name - - the name used as the Redis key prefix for the services

Returns:

RemoteService object

getRemoteService

public RRemoteService getRemoteService(Codec codec)

Description copied from interface: RedissonRxClient

Returns object for remote operations prefixed with the default name (redisson_remote_service) and uses provided codec for method arguments and result.

Specified by:

getRemoteService in interface RedissonRxClient

Parameters:

codec - - codec for response and request

Returns:

RemoteService object

getRemoteService

public RRemoteService getRemoteService(String name,
                                       Codec codec)

Description copied from interface: RedissonRxClient

Returns object for remote operations prefixed with the specified name and uses provided codec for method arguments and result.

Specified by:

getRemoteService in interface RedissonRxClient

Parameters:

name - - the name used as the Redis key prefix for the services

codec - - codec for response and request

Returns:

RemoteService object

getBitSet

public RBitSetRx getBitSet(String name)

Description copied from interface: RedissonRxClient

Returns bitSet instance by name.

Specified by:

getBitSet in interface RedissonRxClient

Parameters:

name - - name of object

Returns:

BitSet object

getScript

public RScriptRx getScript()

Description copied from interface: RedissonRxClient

Returns script operations object

Specified by:

getScript in interface RedissonRxClient

Returns:

Script object

getScript

public RScriptRx getScript(Codec codec)

Description copied from interface: RedissonRxClient

Returns script operations object using provided codec.

Specified by:

getScript in interface RedissonRxClient

Parameters:

codec - - codec for params and result

Returns:

Script object

createBatch

public RBatchRx createBatch()

Description copied from interface: RedissonRxClient

Return batch object which executes group of command in pipeline. See http://redis.io/topics/pipelining

Specified by:

createBatch in interface RedissonRxClient

Returns:

Batch object

createBatch

public RBatchRx createBatch(BatchOptions options)

Description copied from interface: RedissonRxClient

Return batch object which executes group of command in pipeline. See http://redis.io/topics/pipelining

Specified by:

createBatch in interface RedissonRxClient

Parameters:

options - - batch configuration

Returns:

Batch object

getKeys

public RKeysRx getKeys()

Description copied from interface: RedissonRxClient

Returns keys operations. Each of Redis/Redisson object associated with own key

Specified by:

getKeys in interface RedissonRxClient

Returns:

Keys object

getConfig

public Config getConfig()

Description copied from interface: RedissonRxClient

Allows to get configuration provided during Redisson instance creation. Further changes on this object not affect Redisson instance.

Specified by:

getConfig in interface RedissonRxClient

Returns:

Config object

getNodesGroup

public NodesGroup<Node> getNodesGroup()

Description copied from interface: RedissonRxClient

Get Redis nodes group for server operations

Specified by:

getNodesGroup in interface RedissonRxClient

Returns:

NodesGroup object

getClusterNodesGroup

public NodesGroup<ClusterNode> getClusterNodesGroup()

Description copied from interface: RedissonRxClient

Get Redis cluster nodes group for server operations

Specified by:

getClusterNodesGroup in interface RedissonRxClient

Returns:

NodesGroup object

shutdown

public void shutdown()

Description copied from interface: RedissonRxClient

Shuts down Redisson instance NOT Redis server

Specified by:

shutdown in interface RedissonRxClient

isShutdown

public boolean isShutdown()

Description copied from interface: RedissonRxClient

Returns true if this Redisson instance has been shut down.

Specified by:

isShutdown in interface RedissonRxClient

Returns:

true if this Redisson instance has been shut down otherwise false

isShuttingDown

public boolean isShuttingDown()

Description copied from interface: RedissonRxClient

Returns true if this Redisson instance was started to be shutdown or was shutdown RedissonRxClient.isShutdown() already.

Specified by:

isShuttingDown in interface RedissonRxClient

Returns:

true if this Redisson instance was started to be shutdown or was shutdown RedissonRxClient.isShutdown() already otherwise false

getMapCache

public <K,V> RMapCacheRx<K,V> getMapCache(String name,
                                                      Codec codec,
                                                      MapOptions<K,V> options)

Description copied from interface: RedissonRxClient

Returns map-based cache instance by name using provided codec for both cache keys and values. Supports entry eviction with a given MaxIdleTime and TTL settings.

If eviction is not required then it's better to use regular map RedissonRxClient.getMap(String, Codec, MapOptions).

Specified by:

getMapCache in interface RedissonRxClient

Type Parameters:

K - type of key

V - type of value

Parameters:

name - - object name

codec - - codec for keys and values

options - - map options

Returns:

MapCache object

getMapCache

public <K,V> RMapCacheRx<K,V> getMapCache(String name,
                                                      MapOptions<K,V> options)

Description copied from interface: RedissonRxClient

Returns map-based cache instance by name. Supports entry eviction with a given MaxIdleTime and TTL settings.

If eviction is not required then it's better to use regular map RedissonRxClient.getMap(String, MapOptions).

Specified by:

getMapCache in interface RedissonRxClient

Type Parameters:

K - type of key

V - type of value

Parameters:

name - - name of object

options - - map options

Returns:

MapCache object

getMap

public <K,V> RMapRx<K,V> getMap(String name,
                                            MapOptions<K,V> options)

Description copied from interface: RedissonRxClient

Returns map instance by name.

Specified by:

getMap in interface RedissonRxClient

Type Parameters:

K - type of key

V - type of value

Parameters:

name - - name of object

options - - map options

Returns:

Map object

getMap

public <K,V> RMapRx<K,V> getMap(String name,
                                            Codec codec,
                                            MapOptions<K,V> options)

Description copied from interface: RedissonRxClient

Returns map instance by name using provided codec for both map keys and values.

Specified by:

getMap in interface RedissonRxClient

Type Parameters:

K - type of key

V - type of value

Parameters:

name - - name of object

codec - - codec for keys and values

options - - map options

Returns:

Map object

createTransaction

public RTransactionRx createTransaction(TransactionOptions options)

Description copied from interface: RedissonRxClient

Creates transaction with READ_COMMITTED isolation level.

Specified by:

createTransaction in interface RedissonRxClient

Parameters:

options - - transaction configuration

Returns:

Transaction object

getBlockingDeque

public <V> RBlockingDequeRx<V> getBlockingDeque(String name)

Description copied from interface: RedissonRxClient

Returns unbounded blocking deque instance by name.

Specified by:

getBlockingDeque in interface RedissonRxClient

Type Parameters:

V - type of value

Parameters:

name - - name of object

Returns:

BlockingDeque object

getBlockingDeque

public <V> RBlockingDequeRx<V> getBlockingDeque(String name,
                                                Codec codec)

Description copied from interface: RedissonRxClient

Returns unbounded blocking deque instance by name using provided codec for deque objects.

Specified by:

getBlockingDeque in interface RedissonRxClient

Type Parameters:

V - type of value

Parameters:

name - - name of object

codec - - deque objects codec

Returns:

BlockingDeque object

getTransferQueue

public <V> RTransferQueueRx<V> getTransferQueue(String name)

Description copied from interface: RedissonRxClient

Returns transfer queue instance by name.

Specified by:

getTransferQueue in interface RedissonRxClient

Type Parameters:

V - type of values

Parameters:

name - - name of object

Returns:

TransferQueue object

getTransferQueue

public <V> RTransferQueueRx<V> getTransferQueue(String name,
                                                Codec codec)

Description copied from interface: RedissonRxClient

Returns transfer queue instance by name using provided codec for queue objects.

Specified by:

getTransferQueue in interface RedissonRxClient

Type Parameters:

V - type of values

Parameters:

name - - name of object

codec - - code for values

Returns:

TransferQueue object

getId

public String getId()

Description copied from interface: RedissonRxClient

Returns id of this Redisson instance

Specified by:

getId in interface RedissonRxClient

Returns:

id