public interface RedissonRxClient
RedissonReactiveClient
,
RedissonClient
Modifier and Type | Method and 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
|
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
|
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.
|
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,
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> RMapRx<K,V> |
getMap(String name,
MapOptions<K,V> options)
Returns map instance by name.
|
<K,V> RMapCacheRx<K,V> |
getMapCache(String name)
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. |
<K,V> RMapCacheRx<K,V> |
getMapCache(String name,
MapOptions<K,V> options)
Returns map-based cache instance by name.
|
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)
Deprecated.
|
RRemoteService |
getRemoteService()
Returns object for remote operations prefixed with the default name (redisson_remote_service)
|
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.
|
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.
|
<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> RStreamRx<K,V> |
getStream(String name)
Returns stream instance by
name
Requires Redis 5.0.0 and higher. |
<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 isShutdown() already. |
void |
shutdown()
Shuts down Redisson instance NOT Redis server
|
<V> RTimeSeriesRx<V> getTimeSeries(String name)
name
V
- type of valuename
- - name of instance<V> RTimeSeriesRx<V> getTimeSeries(String name, Codec codec)
name
using provided codec
for values.V
- type of valuename
- - name of instancecodec
- - codec for values<K,V> RStreamRx<K,V> getStream(String name)
name
Requires Redis 5.0.0 and higher.
K
- type of keyV
- type of valuename
- of stream<K,V> RStreamRx<K,V> getStream(String name, Codec codec)
name
using provided codec
for entries.
Requires Redis 5.0.0 and higher.
K
- type of keyV
- type of valuename
- - name of streamcodec
- - codec for entry<V> RGeoRx<V> getGeo(String name)
name
.V
- type of valuename
- - name of object<V> RGeoRx<V> getGeo(String name, Codec codec)
name
using provided codec for geospatial members.V
- type of valuename
- - name of objectcodec
- - codec for valueRRateLimiterRx getRateLimiter(String name)
name
name
- of rate limiterRBinaryStreamRx getBinaryStream(String name)
name
name
- of binary streamRSemaphoreRx getSemaphore(String name)
name
- - name of objectRPermitExpirableSemaphoreRx getPermitExpirableSemaphore(String name)
name
- - name of objectRReadWriteLockRx getReadWriteLock(String name)
To increase reliability during failover, all operations wait for propagation to all Redis slaves.
name
- - name of objectRLockRx getFairLock(String 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.
name
- - name of objectRLockRx getLock(String 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.
name
- - name of objectRLockRx getMultiLock(RLock... locks)
locks
locks
- - collection of locks@Deprecated RLockRx getRedLock(RLock... locks)
RCountDownLatchRx getCountDownLatch(String name)
name
- - name of object<V> RSetCacheRx<V> getSetCache(String name)
name
.
Supports value eviction with a given TTL value.
If eviction is not required then it's better to use regular map getSet(String, Codec)
.
V
- type of valuesname
- - name of object<V> RSetCacheRx<V> getSetCache(String name, Codec codec)
name
.
Supports value eviction with a given TTL value.
If eviction is not required then it's better to use regular map getSet(String, Codec)
.
V
- type of valuesname
- - name of objectcodec
- - codec for values<K,V> RMapCacheRx<K,V> getMapCache(String name, Codec codec)
If eviction is not required then it's better to use regular map getMap(String, Codec)
.
K
- type of keysV
- type of valuesname
- - name of objectcodec
- - codec for values<K,V> RMapCacheRx<K,V> getMapCache(String name, Codec codec, MapOptions<K,V> options)
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 getMap(String, Codec, MapOptions)
.
K
- type of keyV
- type of valuename
- - object namecodec
- - codec for keys and valuesoptions
- - map options<K,V> RMapCacheRx<K,V> getMapCache(String name)
If eviction is not required then it's better to use regular map getMap(String)
.
K
- type of keysV
- type of valuesname
- - name of object<K,V> RMapCacheRx<K,V> getMapCache(String name, MapOptions<K,V> options)
If eviction is not required then it's better to use regular map getMap(String, MapOptions)
.
K
- type of keyV
- type of valuename
- - name of objectoptions
- - map options<V> RBucketRx<V> getBucket(String name)
V
- type of valuename
- - name of object<V> RBucketRx<V> getBucket(String name, Codec codec)
V
- type of valuename
- - name of objectcodec
- - codec for valueRBucketsRx getBuckets()
RBucketsRx getBuckets(Codec codec)
codec
- - codec for bucket objects<V> RHyperLogLogRx<V> getHyperLogLog(String name)
V
- type of valuesname
- - name of object<V> RHyperLogLogRx<V> getHyperLogLog(String name, Codec codec)
V
- type of valuesname
- - name of objectcodec
- - codec of values<V> RListRx<V> getList(String name)
V
- type of valuesname
- - name of object<V> RListRx<V> getList(String name, Codec codec)
V
- type of valuesname
- - name of objectcodec
- - codec for values<K,V> RListMultimapRx<K,V> getListMultimap(String name)
K
- type of keyV
- type of valuename
- - name of object<K,V> RListMultimapRx<K,V> getListMultimap(String name, Codec codec)
K
- type of keyV
- type of valuename
- - name of objectcodec
- - codec for keys and values<K,V> RSetMultimapRx<K,V> getSetMultimap(String name)
K
- type of keyV
- type of valuename
- - name of object<K,V> RSetMultimapRx<K,V> getSetMultimap(String name, Codec codec)
K
- type of keyV
- type of valuename
- - name of objectcodec
- - codec for keys and values<K,V> RMapRx<K,V> getMap(String name)
K
- type of keysV
- type of valuesname
- - name of object<K,V> RMapRx<K,V> getMap(String name, MapOptions<K,V> options)
K
- type of keyV
- type of valuename
- - name of objectoptions
- - map options<K,V> RMapRx<K,V> getMap(String name, Codec codec)
K
- type of keysV
- type of valuesname
- - name of objectcodec
- - codec for keys and values<K,V> RMapRx<K,V> getMap(String name, Codec codec, MapOptions<K,V> options)
K
- type of keyV
- type of valuename
- - name of objectcodec
- - codec for keys and valuesoptions
- - map options<V> RSetRx<V> getSet(String name)
V
- type of valuesname
- - name of object<V> RSetRx<V> getSet(String name, Codec codec)
V
- type of valuesname
- - name of setcodec
- - codec for values<V> RScoredSortedSetRx<V> getScoredSortedSet(String name)
V
- type of valuesname
- of scored sorted set<V> RScoredSortedSetRx<V> getScoredSortedSet(String name, Codec codec)
V
- type of valuesname
- - name of scored sorted setcodec
- - codec for valuesRLexSortedSetRx getLexSortedSet(String name)
name
- - name of objectRTopicRx getTopic(String name)
name
- - name of objectRTopicRx getTopic(String name, Codec codec)
name
- - name of objectcodec
- - codec for messageRPatternTopicRx getPatternTopic(String pattern)
pattern
- of the topicRPatternTopicRx getPatternTopic(String pattern, Codec codec)
pattern
- of the topiccodec
- - codec for message<V> RQueueRx<V> getQueue(String name)
V
- type of valuesname
- - name of object<V> RQueueRx<V> getQueue(String name, Codec codec)
V
- type of valuesname
- - name of objectcodec
- - codec for values<V> RRingBufferRx<V> getRingBuffer(String name)
V
- value typename
- - name of object<V> RRingBufferRx<V> getRingBuffer(String name, Codec codec)
V
- value typename
- - name of objectcodec
- - codec for values<V> RBlockingQueueRx<V> getBlockingQueue(String name)
V
- type of valuesname
- - name of object<V> RBlockingQueueRx<V> getBlockingQueue(String name, Codec codec)
V
- type of valuesname
- - name of objectcodec
- - code for values<V> RBlockingDequeRx<V> getBlockingDeque(String name)
V
- type of valuename
- - name of object<V> RBlockingDequeRx<V> getBlockingDeque(String name, Codec codec)
V
- type of valuename
- - name of objectcodec
- - deque objects codec<V> RTransferQueueRx<V> getTransferQueue(String name)
V
- type of valuesname
- - name of object<V> RTransferQueueRx<V> getTransferQueue(String name, Codec codec)
V
- type of valuesname
- - name of objectcodec
- - code for values<V> RDequeRx<V> getDeque(String name)
V
- type of valuesname
- - name of object<V> RDequeRx<V> getDeque(String name, Codec codec)
V
- type of valuesname
- - name of objectcodec
- - coded for valuesRAtomicLongRx getAtomicLong(String name)
name
- of the "atomic long"RAtomicDoubleRx getAtomicDouble(String name)
name
- of the "atomic double"RRemoteService getRemoteService()
RRemoteService getRemoteService(Codec codec)
codec
- - codec for response and requestRRemoteService getRemoteService(String name)
name
- - the name used as the Redis key prefix for the servicesRRemoteService getRemoteService(String name, Codec codec)
name
- - the name used as the Redis key prefix for the servicescodec
- - codec for response and requestRBitSetRx getBitSet(String name)
name
- - name of objectRScriptRx getScript()
RScriptRx getScript(Codec codec)
codec
- - codec for params and resultRTransactionRx createTransaction(TransactionOptions options)
options
- - transaction configurationRBatchRx createBatch(BatchOptions options)
options
- - batch configurationRBatchRx createBatch()
RKeysRx getKeys()
void shutdown()
Config getConfig()
NodesGroup<Node> getNodesGroup()
NodesGroup<ClusterNode> getClusterNodesGroup()
boolean isShutdown()
true
if this Redisson instance has been shut down.true
if this Redisson instance has been shut down otherwise false
boolean isShuttingDown()
true
if this Redisson instance was started to be shutdown
or was shutdown isShutdown()
already.true
if this Redisson instance was started to be shutdown
or was shutdown isShutdown()
already otherwise false
String getId()
Copyright © 2014–2020 Redisson. All rights reserved.