org.redisson.api

Interface RedissonReactiveClient

All Known Implementing Classes:

RedissonReactive

public interface RedissonReactiveClient

Main Redisson interface for access to all redisson objects with reactive interface.

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 isShutdown() already.
void	shutdown() Shuts down Redisson instance NOT Redis server

Method Detail

getSetCache

<V> RSetCacheReactive<V> getSetCache(String name)

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 getSet(String, Codec).

Parameters:

name -

codec -

Returns:

getSetCache

<V> RSetCacheReactive<V> getSetCache(String name,
                                   Codec codec)

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 getSet(String, Codec).

Parameters:

name -

codec -

Returns:

getMapCache

<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. Supports entry eviction with a given TTL value.

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

Parameters:

name -

codec -

Returns:

getMapCache

<K,V> RMapCacheReactive<K,V> getMapCache(String name)

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 getMap(String).

Parameters:

name -

Returns:

getBucket

<V> RBucketReactive<V> getBucket(String name)

Returns object holder instance by name

Parameters:

name - of object

Returns:

getBucket

<V> RBucketReactive<V> getBucket(String name,
                               Codec codec)

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

Parameters:

name - of object

object - codec

Returns:

findBuckets

<V> List<RBucketReactive<V>> findBuckets(String pattern)

Returns a list of object holder instances by a key pattern

getHyperLogLog

<V> RHyperLogLogReactive<V> getHyperLogLog(String name)

Returns HyperLogLog instance by name.

Parameters:

name - of object

Returns:

getHyperLogLog

<V> RHyperLogLogReactive<V> getHyperLogLog(String name,
                                         Codec codec)

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

Parameters:

name - of object

object - codec

Returns:

getList

<V> RListReactive<V> getList(String name)

Returns list instance by name.

Parameters:

name - of object

Returns:

getList

<V> RListReactive<V> getList(String name,
                           Codec codec)

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

Parameters:

name - of object

list - object codec

Returns:

getMap

<K,V> RMapReactive<K,V> getMap(String name)

Returns map instance by name.

Parameters:

name - of map

Returns:

getMap

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

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

Parameters:

name - of map

map - key and value codec

Returns:

getSet

<V> RSetReactive<V> getSet(String name)

Returns set instance by name.

Parameters:

name - of set

Returns:

getSet

<V> RSetReactive<V> getSet(String name,
                         Codec codec)

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

Parameters:

name - of set

set - object codec

Returns:

getScoredSortedSet

<V> RScoredSortedSetReactive<V> getScoredSortedSet(String name)

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

Parameters:

name - of scored sorted set

Returns:

getScoredSortedSet

<V> RScoredSortedSetReactive<V> getScoredSortedSet(String name,
                                                 Codec codec)

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

Parameters:

name - of scored sorted set

scored - sorted set object codec

Returns:

getLexSortedSet

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

Parameters:

name -

Returns:

getTopic

<M> RTopicReactive<M> getTopic(String name)

Returns topic instance by name.

Parameters:

name - of topic

Returns:

getTopic

<M> RTopicReactive<M> getTopic(String name,
                             Codec codec)

Returns topic instance by name using provided codec for messages.

Parameters:

name - of topic

message - codec

Returns:

getPatternTopic

<M> RPatternTopicReactive<M> getPatternTopic(String pattern)

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

Parameters:

pattern - of the topic

Returns:

getPatternTopic

<M> RPatternTopicReactive<M> getPatternTopic(String pattern,
                                           Codec codec)

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

Parameters:

pattern - of the topic

message - codec

Returns:

getQueue

<V> RQueueReactive<V> getQueue(String name)

Returns queue instance by name.

Parameters:

name - of queue

Returns:

getQueue

<V> RQueueReactive<V> getQueue(String name,
                             Codec codec)

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

Parameters:

name - of queue

queue - objects codec

Returns:

getBlockingQueue

<V> RBlockingQueueReactive<V> getBlockingQueue(String name)

Returns blocking queue instance by name.

Parameters:

name - of queue

Returns:

getBlockingQueue

<V> RBlockingQueueReactive<V> getBlockingQueue(String name,
                                             Codec codec)

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

Parameters:

name - of queue

queue - objects codec

Returns:

getDeque

<V> RDequeReactive<V> getDeque(String name)

Returns deque instance by name.

Parameters:

name - of deque

Returns:

getDeque

<V> RDequeReactive<V> getDeque(String name,
                             Codec codec)

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

Parameters:

name - of deque

deque - objects codec

Returns:

getAtomicLong

RAtomicLongReactive getAtomicLong(String name)

Returns "atomic long" instance by name.

Parameters:

name - of the "atomic long"

Returns:

getBitSet

RBitSetReactive getBitSet(String name)

Returns bitSet instance by name.

Parameters:

name - of bitSet

Returns:

getScript

RScriptReactive getScript()

Returns script operations object

Returns:

createBatch

RBatchReactive createBatch()

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

Returns:

getKeys

RKeysReactive getKeys()

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

Returns:

shutdown

void shutdown()

Shuts down Redisson instance NOT Redis server

getConfig

Config getConfig()

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

Returns:

Config object

getNodesGroup

NodesGroup<Node> getNodesGroup()

Get Redis nodes group for server operations

Returns:

getClusterNodesGroup

NodesGroup<ClusterNode> getClusterNodesGroup()

Get Redis cluster nodes group for server operations

Returns:

isShutdown

boolean isShutdown()

Returns true if this Redisson instance has been shut down.

Returns:

isShuttingDown

boolean isShuttingDown()

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

Returns: