RedissonReactive (Redisson 2.2.13 API)

java.lang.Object
- org.redisson.RedissonReactive

All Implemented Interfaces:

RedissonReactiveClient
```
public class RedissonReactive
extends Object
implements RedissonReactiveClient
```
Main infrastructure class allows to get access to all Redisson objects on top of Redis server.

Author:

Nikita Koksharov

Method Summary

Methods
Modifier and Type	Method and Description
`RBatchReactive`	`createBatch()` Return batch object which executes group of command in pipeline.
`<V> List<RBucketReactive<V>>`	`findBuckets(String pattern)` Returns a list of object holder instances by a key pattern
`RAtomicLongReactive`	`getAtomicLong(String name)` Returns "atomic long" instance by name.
`RBitSetReactive`	`getBitSet(String name)` Returns bitSet instance by name.
`<V> RBlockingQueueReactive<V>`	`getBlockingQueue(String name)` Returns blocking queue instance by name.
`<V> RBlockingQueueReactive<V>`	`getBlockingQueue(String name, Codec codec)` Returns blocking queue instance by name using provided codec for queue objects.
`<V> RBucketReactive<V>`	`getBucket(String name)` Returns object holder instance by name
`<V> RBucketReactive<V>`	`getBucket(String name, Codec codec)` Returns object holder instance by name 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.
`<V> RDequeReactive<V>`	`getDeque(String name)` Returns deque instance by name.
`<V> RDequeReactive<V>`	`getDeque(String name, Codec codec)` Returns deque instance by name using provided codec for deque objects.
`<V> RHyperLogLogReactive<V>`	`getHyperLogLog(String name)` Returns HyperLogLog instance by name.
`<V> RHyperLogLogReactive<V>`	`getHyperLogLog(String name, Codec codec)` Returns HyperLogLog instance by name using provided codec for hll objects.
`RKeysReactive`	`getKeys()` Returns keys operations.
`RLexSortedSetReactive`	`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> RListReactive<V>`	`getList(String name)` Returns list instance by name.
`<V> RListReactive<V>`	`getList(String name, Codec codec)` Returns list instance by name using provided codec for list objects.
`<K,V> RMapReactive<K,V>`	`getMap(String name)` Returns map instance by name.
`<K,V> RMapReactive<K,V>`	`getMap(String name, Codec codec)` Returns map instance by name using provided codec for both map keys and values.
`<K,V> RMapCacheReactive<K,V>`	`getMapCache(String name)` Returns map-based cache instance by name.
`<K,V> RMapCacheReactive<K,V>`	`getMapCache(String name, Codec codec)` Returns map-based cache instance by name using provided codec for both cache keys and values.
`NodesGroup<Node>`	`getNodesGroup()` Get Redis nodes group for server operations
`<M> RPatternTopicReactive<M>`	`getPatternTopic(String pattern)` Returns topic instance satisfies by pattern name.
`<M> RPatternTopicReactive<M>`	`getPatternTopic(String pattern, Codec codec)` Returns topic instance satisfies by pattern name using provided codec for messages.
`<V> RQueueReactive<V>`	`getQueue(String name)` Returns queue instance by name.
`<V> RQueueReactive<V>`	`getQueue(String name, Codec codec)` Returns queue instance by name using provided codec for queue objects.
`<V> RScoredSortedSetReactive<V>`	`getScoredSortedSet(String name)` Returns Redis Sorted Set instance by name.
`<V> RScoredSortedSetReactive<V>`	`getScoredSortedSet(String name, Codec codec)` Returns Redis Sorted Set instance by name using provided codec for sorted set objects.
`RScriptReactive`	`getScript()` Returns script operations object
`<V> RSetReactive<V>`	`getSet(String name)` Returns set instance by name.
`<V> RSetReactive<V>`	`getSet(String name, Codec codec)` Returns set instance by name using provided codec for set objects.
`<V> RSetCacheReactive<V>`	`getSetCache(String name)` Returns set-based cache instance by `name`.
`<V> RSetCacheReactive<V>`	`getSetCache(String name, Codec codec)` Returns set-based cache instance by `name`.
`<M> RTopicReactive<M>`	`getTopic(String name)` Returns topic instance by name.
`<M> RTopicReactive<M>`	`getTopic(String name, Codec codec)` Returns topic instance by name using provided codec for messages.
`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 `RedissonReactiveClient.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

- Method Detail
  - getMapCache
```
public <K,V> RMapCacheReactive<K,V> getMapCache(String name,
                                       Codec codec)
```
    Description copied from interface: RedissonReactiveClient
    
    Returns map-based cache instance by name using provided codec for both cache keys and values. Supports entry eviction with a given TTL value.
    If eviction is not required then it's better to use regular map RedissonReactiveClient.getMap(String, Codec).
    
    Specified by:
    
    getMapCache in interface RedissonReactiveClient
    
    Returns:
  - getMapCache
```
public <K,V> RMapCacheReactive<K,V> getMapCache(String name)
```
    Description copied from interface: RedissonReactiveClient
    
    Returns map-based cache instance by name. Supports entry eviction with a given TTL value.
    If eviction is not required then it's better to use regular map RedissonReactiveClient.getMap(String).
    
    Specified by:
    
    getMapCache in interface RedissonReactiveClient
    
    Returns:
  - getBucket
```
public <V> RBucketReactive<V> getBucket(String name)
```
    Description copied from interface: RedissonReactiveClient
    
    Returns object holder instance by name
    
    Specified by:
    
    getBucket in interface RedissonReactiveClient
    
    Parameters:
    name - of object
    
    Returns:
  - getBucket
```
public <V> RBucketReactive<V> getBucket(String name,
                               Codec codec)
```
    Description copied from interface: RedissonReactiveClient
    
    Returns object holder instance by name using provided codec for object.
    
    Specified by:
    
    getBucket in interface RedissonReactiveClient
    
    Parameters:
    name - of object
    
    Returns:
  - findBuckets
```
public <V> List<RBucketReactive<V>> findBuckets(String pattern)
```
    Description copied from interface: RedissonReactiveClient
    
    Returns a list of object holder instances by a key pattern
    
    Specified by:
    
    findBuckets in interface RedissonReactiveClient
  - getHyperLogLog
```
public <V> RHyperLogLogReactive<V> getHyperLogLog(String name)
```
    Description copied from interface: RedissonReactiveClient
    
    Returns HyperLogLog instance by name.
    
    Specified by:
    
    getHyperLogLog in interface RedissonReactiveClient
    
    Parameters:
    name - of object
    
    Returns:
  - getHyperLogLog
```
public <V> RHyperLogLogReactive<V> getHyperLogLog(String name,
                                         Codec codec)
```
    Description copied from interface: RedissonReactiveClient
    
    Returns HyperLogLog instance by name using provided codec for hll objects.
    
    Specified by:
    
    getHyperLogLog in interface RedissonReactiveClient
    
    Parameters:
    name - of object
    
    Returns:
  - getList
```
public <V> RListReactive<V> getList(String name)
```
    Description copied from interface: RedissonReactiveClient
    
    Returns list instance by name.
    
    Specified by:
    
    getList in interface RedissonReactiveClient
    
    Parameters:
    name - of object
    
    Returns:
  - getList
```
public <V> RListReactive<V> getList(String name,
                           Codec codec)
```
    Description copied from interface: RedissonReactiveClient
    
    Returns list instance by name using provided codec for list objects.
    
    Specified by:
    
    getList in interface RedissonReactiveClient
    
    Parameters:
    name - of object
    
    Returns:
  - getMap
```
public <K,V> RMapReactive<K,V> getMap(String name)
```
    Description copied from interface: RedissonReactiveClient
    
    Returns map instance by name.
    
    Specified by:
    
    getMap in interface RedissonReactiveClient
    
    Parameters:
    name - of map
    
    Returns:
  - getMap
```
public <K,V> RMapReactive<K,V> getMap(String name,
                             Codec codec)
```
    Description copied from interface: RedissonReactiveClient
    
    Returns map instance by name using provided codec for both map keys and values.
    
    Specified by:
    
    getMap in interface RedissonReactiveClient
    
    Parameters:
    name - of map
    
    Returns:
  - getSet
```
public <V> RSetReactive<V> getSet(String name)
```
    Description copied from interface: RedissonReactiveClient
    
    Returns set instance by name.
    
    Specified by:
    
    getSet in interface RedissonReactiveClient
    
    Parameters:
    name - of set
    
    Returns:
  - getSet
```
public <V> RSetReactive<V> getSet(String name,
                         Codec codec)
```
    Description copied from interface: RedissonReactiveClient
    
    Returns set instance by name using provided codec for set objects.
    
    Specified by:
    
    getSet in interface RedissonReactiveClient
    
    Parameters:
    name - of set
    
    Returns:
  - getScoredSortedSet
```
public <V> RScoredSortedSetReactive<V> getScoredSortedSet(String name)
```
    Description copied from interface: RedissonReactiveClient
    
    Returns Redis Sorted Set instance by name. This sorted set sorts objects by object score.
    
    Specified by:
    
    getScoredSortedSet in interface RedissonReactiveClient
    
    Parameters:
    name - of scored sorted set
    
    Returns:
  - getScoredSortedSet
```
public <V> RScoredSortedSetReactive<V> getScoredSortedSet(String name,
                                                 Codec codec)
```
    Description copied from interface: RedissonReactiveClient
    
    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 RedissonReactiveClient
    
    Parameters:
    name - of scored sorted set
    
    Returns:
  - getLexSortedSet
```
public RLexSortedSetReactive getLexSortedSet(String name)
```
    Description copied from interface: RedissonReactiveClient
    
    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 RedissonReactiveClient
    
    Returns:
  - getTopic
```
public <M> RTopicReactive<M> getTopic(String name)
```
    Description copied from interface: RedissonReactiveClient
    
    Returns topic instance by name.
    
    Specified by:
    
    getTopic in interface RedissonReactiveClient
    
    Parameters:
    name - of topic
    
    Returns:
  - getTopic
```
public <M> RTopicReactive<M> getTopic(String name,
                             Codec codec)
```
    Description copied from interface: RedissonReactiveClient
    
    Returns topic instance by name using provided codec for messages.
    
    Specified by:
    
    getTopic in interface RedissonReactiveClient
    
    Parameters:
    name - of topic
    
    Returns:
  - getPatternTopic
```
public <M> RPatternTopicReactive<M> getPatternTopic(String pattern)
```
    Description copied from interface: RedissonReactiveClient
    
    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 RedissonReactiveClient
    
    Parameters:
    pattern - of the topic
    
    Returns:
  - getPatternTopic
```
public <M> RPatternTopicReactive<M> getPatternTopic(String pattern,
                                           Codec codec)
```
    Description copied from interface: RedissonReactiveClient
    
    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 RedissonReactiveClient
    
    Parameters:
    pattern - of the topic
    
    Returns:
  - getQueue
```
public <V> RQueueReactive<V> getQueue(String name)
```
    Description copied from interface: RedissonReactiveClient
    
    Returns queue instance by name.
    
    Specified by:
    
    getQueue in interface RedissonReactiveClient
    
    Parameters:
    name - of queue
    
    Returns:
  - getQueue
```
public <V> RQueueReactive<V> getQueue(String name,
                             Codec codec)
```
    Description copied from interface: RedissonReactiveClient
    
    Returns queue instance by name using provided codec for queue objects.
    
    Specified by:
    
    getQueue in interface RedissonReactiveClient
    
    Parameters:
    name - of queue
    
    Returns:
  - getBlockingQueue
```
public <V> RBlockingQueueReactive<V> getBlockingQueue(String name)
```
    Description copied from interface: RedissonReactiveClient
    
    Returns blocking queue instance by name.
    
    Specified by:
    
    getBlockingQueue in interface RedissonReactiveClient
    
    Parameters:
    name - of queue
    
    Returns:
  - getBlockingQueue
```
public <V> RBlockingQueueReactive<V> getBlockingQueue(String name,
                                             Codec codec)
```
    Description copied from interface: RedissonReactiveClient
    
    Returns blocking queue instance by name using provided codec for queue objects.
    
    Specified by:
    
    getBlockingQueue in interface RedissonReactiveClient
    
    Parameters:
    name - of queue
    
    Returns:
  - getDeque
```
public <V> RDequeReactive<V> getDeque(String name)
```
    Description copied from interface: RedissonReactiveClient
    
    Returns deque instance by name.
    
    Specified by:
    
    getDeque in interface RedissonReactiveClient
    
    Parameters:
    name - of deque
    
    Returns:
  - getDeque
```
public <V> RDequeReactive<V> getDeque(String name,
                             Codec codec)
```
    Description copied from interface: RedissonReactiveClient
    
    Returns deque instance by name using provided codec for deque objects.
    
    Specified by:
    
    getDeque in interface RedissonReactiveClient
    
    Parameters:
    name - of deque
    
    Returns:
  - getSetCache
```
public <V> RSetCacheReactive<V> getSetCache(String name)
```
    Description copied from interface: RedissonReactiveClient
    
    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 RedissonReactiveClient.getSet(String, Codec).
    
    Specified by:
    
    getSetCache in interface RedissonReactiveClient
    
    Returns:
  - getSetCache
```
public <V> RSetCacheReactive<V> getSetCache(String name,
                                   Codec codec)
```
    Description copied from interface: RedissonReactiveClient
    
    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 RedissonReactiveClient.getSet(String, Codec).
    
    Specified by:
    
    getSetCache in interface RedissonReactiveClient
    
    Returns:
  - getAtomicLong
```
public RAtomicLongReactive getAtomicLong(String name)
```
    Description copied from interface: RedissonReactiveClient
    
    Returns "atomic long" instance by name.
    
    Specified by:
    
    getAtomicLong in interface RedissonReactiveClient
    
    Parameters:
    name - of the "atomic long"
    
    Returns:
  - getBitSet
```
public RBitSetReactive getBitSet(String name)
```
    Description copied from interface: RedissonReactiveClient
    
    Returns bitSet instance by name.
    
    Specified by:
    
    getBitSet in interface RedissonReactiveClient
    
    Parameters:
    name - of bitSet
    
    Returns:
  - getScript
```
public RScriptReactive getScript()
```
    Description copied from interface: RedissonReactiveClient
    
    Returns script operations object
    
    Specified by:
    
    getScript in interface RedissonReactiveClient
    
    Returns:
  - createBatch
```
public RBatchReactive createBatch()
```
    Description copied from interface: RedissonReactiveClient
    
    Return batch object which executes group of command in pipeline. See http://redis.io/topics/pipelining
    
    Specified by:
    
    createBatch in interface RedissonReactiveClient
    
    Returns:
  - getKeys
```
public RKeysReactive getKeys()
```
    Description copied from interface: RedissonReactiveClient
    
    Returns keys operations. Each of Redis/Redisson object associated with own key
    
    Specified by:
    
    getKeys in interface RedissonReactiveClient
    
    Returns:
  - getConfig
```
public Config getConfig()
```
    Description copied from interface: RedissonReactiveClient
    
    Allows to get configuration provided during Redisson instance creation. Further changes on this object not affect Redisson instance.
    
    Specified by:
    
    getConfig in interface RedissonReactiveClient
    
    Returns:
    Config object
  - getNodesGroup
```
public NodesGroup<Node> getNodesGroup()
```
    Description copied from interface: RedissonReactiveClient
    
    Get Redis nodes group for server operations
    
    Specified by:
    
    getNodesGroup in interface RedissonReactiveClient
    
    Returns:
  - getClusterNodesGroup
```
public NodesGroup<ClusterNode> getClusterNodesGroup()
```
    Description copied from interface: RedissonReactiveClient
    
    Get Redis cluster nodes group for server operations
    
    Specified by:
    
    getClusterNodesGroup in interface RedissonReactiveClient
    
    Returns:
  - shutdown
```
public void shutdown()
```
    Description copied from interface: RedissonReactiveClient
    
    Shuts down Redisson instance NOT Redis server
    
    Specified by:
    
    shutdown in interface RedissonReactiveClient
  - isShutdown
```
public boolean isShutdown()
```
    Description copied from interface: RedissonReactiveClient
    
    Returns true if this Redisson instance has been shut down.
    
    Specified by:
    
    isShutdown in interface RedissonReactiveClient
    
    Returns:
  - isShuttingDown
```
public boolean isShuttingDown()
```
    Description copied from interface: RedissonReactiveClient
    
    Returns true if this Redisson instance was started to be shutdown or was shutdown RedissonReactiveClient.isShutdown() already.
    
    Specified by:
    
    isShuttingDown in interface RedissonReactiveClient
    
    Returns:

Class RedissonReactive

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getMapCache

getMapCache

getBucket

getBucket

findBuckets

getHyperLogLog

getHyperLogLog

getList

getList

getMap

getMap

getSet

getSet

getScoredSortedSet

getScoredSortedSet

getLexSortedSet

getTopic

getTopic

getPatternTopic

getPatternTopic

getQueue

getQueue

getBlockingQueue

getBlockingQueue

getDeque

getDeque

getSetCache

getSetCache

getAtomicLong

getBitSet

getScript

createBatch

getKeys

getConfig

getNodesGroup

getClusterNodesGroup

shutdown

isShutdown

isShuttingDown