RedissonClient (Redisson 3.5.7 API)

All Known Implementing Classes:

Redisson
```
public interface RedissonClient
```
Main Redisson interface for access to all redisson objects with sync/async interface.

Author:

Nikita Koksharov

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`RBatch`	`createBatch()` Return batch object which executes group of command in pipeline.
`RAtomicDouble`	`getAtomicDouble(String name)` Returns atomicDouble instance by name.
`RAtomicLong`	`getAtomicLong(String name)` Returns atomicLong instance by name.
`RBinaryStream`	`getBinaryStream(String name)` Returns binary stream holder instance by `name`
`RBitSet`	`getBitSet(String name)` Returns bitSet instance by name.
`<V> RBlockingDeque<V>`	`getBlockingDeque(String name)` Returns unbounded blocking deque instance by name.
`<V> RBlockingDeque<V>`	`getBlockingDeque(String name, Codec codec)` Returns unbounded blocking deque instance by name using provided codec for deque objects.
`<V> RBlockingQueue<V>`	`getBlockingQueue(String name)` Returns unbounded blocking queue instance by name.
`<V> RBlockingQueue<V>`	`getBlockingQueue(String name, Codec codec)` Returns unbounded blocking queue instance by name using provided codec for queue objects.
`<V> RBloomFilter<V>`	`getBloomFilter(String name)` Returns bloom filter instance by name.
`<V> RBloomFilter<V>`	`getBloomFilter(String name, Codec codec)` Returns bloom filter instance by name using provided codec for objects.
`<V> RBoundedBlockingQueue<V>`	`getBoundedBlockingQueue(String name)` Returns bounded blocking queue instance by name.
`<V> RBoundedBlockingQueue<V>`	`getBoundedBlockingQueue(String name, Codec codec)` Returns bounded blocking queue instance by name using provided codec for queue objects.
`<V> RBucket<V>`	`getBucket(String name)` Returns object holder instance by name.
`<V> RBucket<V>`	`getBucket(String name, Codec codec)` Returns object holder instance by name using provided codec for object.
`RBuckets`	`getBuckets()` Returns interface for mass operations with Bucket objects.
`RBuckets`	`getBuckets(Codec codec)` Returns interface for mass operations with Bucket objects using provided codec for object.
`ClusterNodesGroup`	`getClusterNodesGroup()` Get Redis cluster nodes group for server operations
`ReferenceCodecProvider`	`getCodecProvider()` Returns the CodecProvider instance
`Config`	`getConfig()` Allows to get configuration provided during Redisson instance creation.
`RCountDownLatch`	`getCountDownLatch(String name)` Returns countDownLatch instance by name.
`<V> RDelayedQueue<V>`	`getDelayedQueue(RQueue<V> destinationQueue)` Returns unbounded delayed queue instance by name.
`<V> RDeque<V>`	`getDeque(String name)` Returns unbounded deque instance by name.
`<V> RDeque<V>`	`getDeque(String name, Codec codec)` Returns unbounded deque instance by name using provided codec for deque objects.
`RScheduledExecutorService`	`getExecutorService(Codec codec, String name)` Deprecated. - use `getExecutorService(String, Codec)` instead.
`RScheduledExecutorService`	`getExecutorService(String name)` Returns ScheduledExecutorService by name
`RScheduledExecutorService`	`getExecutorService(String name, Codec codec)` Returns ScheduledExecutorService by name using provided codec for task, response and request serialization
`RLock`	`getFairLock(String name)` Returns lock instance by name.
`<V> RGeo<V>`	`getGeo(String name)` Returns geospatial items holder instance by `name`.
`<V> RGeo<V>`	`getGeo(String name, Codec codec)` Returns geospatial items holder instance by `name` using provided codec for geospatial members.
`<V> RHyperLogLog<V>`	`getHyperLogLog(String name)` Returns HyperLogLog instance by name.
`<V> RHyperLogLog<V>`	`getHyperLogLog(String name, Codec codec)` Returns HyperLogLog instance by name using provided codec for hll objects.
`RKeys`	`getKeys()` Returns interface with methods for Redis keys.
`RLexSortedSet`	`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> RList<V>`	`getList(String name)` Returns list instance by name.
`<V> RList<V>`	`getList(String name, Codec codec)` Returns list instance by name using provided codec for list objects.
`<K,V> RListMultimap<K,V>`	`getListMultimap(String name)` Returns List based Multimap instance by name.
`<K,V> RListMultimap<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> RListMultimapCache<K,V>`	`getListMultimapCache(String name)` Returns List based Multimap instance by name.
`<K,V> RListMultimapCache<K,V>`	`getListMultimapCache(String name, Codec codec)` Returns List based Multimap instance by name using provided codec for both map keys and values.
`RLiveObjectService`	`getLiveObjectService()` Returns RedissonAttachedLiveObjectService which can be used to retrieve live REntity(s)
`<K,V> RLocalCachedMap<K,V>`	`getLocalCachedMap(String name, Codec codec, LocalCachedMapOptions<K,V> options)` Returns local cached map instance by name using provided codec.
`<K,V> RLocalCachedMap<K,V>`	`getLocalCachedMap(String name, LocalCachedMapOptions<K,V> options)` Returns local cached map instance by name.
`RLock`	`getLock(String name)` Returns lock instance by name.
`<K,V> RMap<K,V>`	`getMap(String name)` Returns map instance by name.
`<K,V> RMap<K,V>`	`getMap(String name, Codec codec)` Returns map instance by name using provided codec for both map keys and values.
`<K,V> RMap<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> RMap<K,V>`	`getMap(String name, MapOptions<K,V> options)` Returns map instance by name.
`<K,V> RMapCache<K,V>`	`getMapCache(String name)` Returns map-based cache instance by name.
`<K,V> RMapCache<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> RMapCache<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> RMapCache<K,V>`	`getMapCache(String name, MapOptions<K,V> options)` Returns map-based cache instance by name.
`NodesGroup<Node>`	`getNodesGroup()` Get Redis nodes group for server operations
`<M> RPatternTopic<M>`	`getPatternTopic(String pattern)` Returns topic instance satisfies by pattern name.
`<M> RPatternTopic<M>`	`getPatternTopic(String pattern, Codec codec)` Returns topic instance satisfies by pattern name using provided codec for messages.
`RPermitExpirableSemaphore`	`getPermitExpirableSemaphore(String name)` Returns semaphore instance by name.
`<V> RPriorityDeque<V>`	`getPriorityDeque(String name)` Returns priority unbounded deque instance by name.
`<V> RPriorityDeque<V>`	`getPriorityDeque(String name, Codec codec)` Returns priority unbounded deque instance by name using provided codec for queue objects.
`<V> RPriorityQueue<V>`	`getPriorityQueue(String name)` Returns priority unbounded queue instance by name.
`<V> RPriorityQueue<V>`	`getPriorityQueue(String name, Codec codec)` Returns priority unbounded queue instance by name using provided codec for queue objects.
`<V> RQueue<V>`	`getQueue(String name)` Returns unbounded queue instance by name.
`<V> RQueue<V>`	`getQueue(String name, Codec codec)` Returns unbounded queue instance by name using provided codec for queue objects.
`RReadWriteLock`	`getReadWriteLock(String name)` Returns readWriteLock instance by name.
`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> RScoredSortedSet<V>`	`getScoredSortedSet(String name)` Returns Redis Sorted Set instance by name.
`<V> RScoredSortedSet<V>`	`getScoredSortedSet(String name, Codec codec)` Returns Redis Sorted Set instance by name using provided codec for sorted set objects.
`RScript`	`getScript()` Returns script operations object
`RSemaphore`	`getSemaphore(String name)` Returns semaphore instance by name
`<V> RSet<V>`	`getSet(String name)` Returns set instance by name.
`<V> RSet<V>`	`getSet(String name, Codec codec)` Returns set instance by name using provided codec for set objects.
`<V> RSetCache<V>`	`getSetCache(String name)` Returns set-based cache instance by `name`.
`<V> RSetCache<V>`	`getSetCache(String name, Codec codec)` Returns set-based cache instance by `name`.
`<K,V> RSetMultimap<K,V>`	`getSetMultimap(String name)` Returns Set based Multimap instance by name.
`<K,V> RSetMultimap<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> RSetMultimapCache<K,V>`	`getSetMultimapCache(String name)` Returns Set based Multimap instance by name.
`<K,V> RSetMultimapCache<K,V>`	`getSetMultimapCache(String name, Codec codec)` Returns Set based Multimap instance by name using provided codec for both map keys and values.
`<V> RSortedSet<V>`	`getSortedSet(String name)` Returns sorted set instance by name.
`<V> RSortedSet<V>`	`getSortedSet(String name, Codec codec)` Returns sorted set instance by name using provided codec for sorted set objects.
`<M> RTopic<M>`	`getTopic(String name)` Returns topic instance by name.
`<M> RTopic<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()` Shutdown Redisson instance but NOT Redis server This equates to invoke shutdown(2, 15, TimeUnit.SECONDS);
`void`	`shutdown(long quietPeriod, long timeout, TimeUnit unit)` Shuts down Redisson instance NOT Redis server Shutdown ensures that no tasks are submitted for 'the quiet period' (usually a couple seconds) before it shuts itself down.

- Method Detail
  - getBinaryStream
```
RBinaryStream getBinaryStream(String name)
```
    Returns binary stream holder instance by name
    
    Parameters:
    
    name - of binary stream
    
    Returns:
    
    BinaryStream object
  - getGeo
```
<V> RGeo<V> getGeo(String name)
```
    Returns geospatial items holder instance by name.
    
    Type Parameters:
    
    V - type of value
    
    Parameters:
    
    name - - name of object
    
    Returns:
    
    Geo object
  - getGeo
```
<V> RGeo<V> getGeo(String name,
                   Codec codec)
```
    Returns geospatial items holder instance by name using provided codec for geospatial members.
    
    Type Parameters:
    
    V - type of value
    
    Parameters:
    
    name - - name of object
    
    codec - - codec for value
    
    Returns:
    
    Geo object
  - getSetCache
```
<V> RSetCache<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).
    
    Type Parameters:
    
    V - type of value
    
    Parameters:
    
    name - - name of object
    
    Returns:
    
    SetCache object
  - getSetCache
```
<V> RSetCache<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).
    
    Type Parameters:
    
    V - type of value
    
    Parameters:
    
    name - - name of object
    
    codec - - codec for values
    
    Returns:
    
    SetCache object
  - getMapCache
```
<K,V> RMapCache<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 MaxIdleTime and TTL settings.
    If eviction is not required then it's better to use regular map getMap(String, Codec).
    
    Type Parameters:
    
    K - type of key
    
    V - type of value
    
    Parameters:
    
    name - - object name
    
    codec - - codec for keys and values
    
    Returns:
    
    MapCache object
  - getMapCache
```
<K,V> RMapCache<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. 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).
    
    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
```
<K,V> RMapCache<K,V> getMapCache(String name)
```
    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 getMap(String).
    
    Type Parameters:
    
    K - type of key
    
    V - type of value
    
    Parameters:
    
    name - - name of object
    
    Returns:
    
    MapCache object
  - getMapCache
```
<K,V> RMapCache<K,V> getMapCache(String name,
                                 MapOptions<K,V> options)
```
    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 getMap(String).
    
    Type Parameters:
    
    K - type of key
    
    V - type of value
    
    Parameters:
    
    name - - name of object
    
    options - - map options
    
    Returns:
    
    MapCache object
  - getBucket
```
<V> RBucket<V> getBucket(String name)
```
    Returns object holder instance by name.
    
    Type Parameters:
    
    V - type of value
    
    Parameters:
    
    name - - name of object
    
    Returns:
    
    Bucket object
  - getBucket
```
<V> RBucket<V> getBucket(String name,
                         Codec codec)
```
    Returns object holder instance by name using provided codec for object.
    
    Type Parameters:
    
    V - type of value
    
    Parameters:
    
    name - - name of object
    
    codec - - codec for values
    
    Returns:
    
    Bucket object
  - getBuckets
```
RBuckets getBuckets()
```
    Returns interface for mass operations with Bucket objects.
    
    Returns:
    
    Buckets
  - getBuckets
```
RBuckets getBuckets(Codec codec)
```
    Returns interface for mass operations with Bucket objects using provided codec for object.
    
    Parameters:
    
    codec - - codec for bucket objects
    
    Returns:
    
    Buckets
  - getHyperLogLog
```
<V> RHyperLogLog<V> getHyperLogLog(String name)
```
    Returns HyperLogLog instance by name.
    
    Type Parameters:
    
    V - type of value
    
    Parameters:
    
    name - - name of object
    
    Returns:
    
    HyperLogLog object
  - getHyperLogLog
```
<V> RHyperLogLog<V> getHyperLogLog(String name,
                                   Codec codec)
```
    Returns HyperLogLog instance by name using provided codec for hll objects.
    
    Type Parameters:
    
    V - type of value
    
    Parameters:
    
    name - - name of object
    
    codec - - codec for values
    
    Returns:
    
    HyperLogLog object
  - getList
```
<V> RList<V> getList(String name)
```
    Returns list instance by name.
    
    Type Parameters:
    
    V - type of value
    
    Parameters:
    
    name - - name of object
    
    Returns:
    
    List object
  - getList
```
<V> RList<V> getList(String name,
                     Codec codec)
```
    Returns list instance by name using provided codec for list objects.
    
    Type Parameters:
    
    V - type of value
    
    Parameters:
    
    name - - name of object
    
    codec - - codec for values
    
    Returns:
    
    List object
  - getListMultimap
```
<K,V> RListMultimap<K,V> getListMultimap(String name)
```
    Returns List based Multimap instance by name.
    
    Type Parameters:
    
    K - type of key
    
    V - type of value
    
    Parameters:
    
    name - - name of object
    
    Returns:
    
    ListMultimap object
  - getListMultimap
```
<K,V> RListMultimap<K,V> getListMultimap(String name,
                                         Codec codec)
```
    Returns List based Multimap instance by name using provided codec for both map keys and values.
    
    Type Parameters:
    
    K - type of key
    
    V - type of value
    
    Parameters:
    
    name - - name of object
    
    codec - - codec for keys and values
    
    Returns:
    
    ListMultimap object
  - getListMultimapCache
```
<K,V> RListMultimapCache<K,V> getListMultimapCache(String name)
```
    Returns List based Multimap instance by name. Supports key-entry eviction with a given TTL value.
    If eviction is not required then it's better to use regular map getSetMultimap(String).
    
    Type Parameters:
    
    K - type of key
    
    V - type of value
    
    Parameters:
    
    name - - name of object
    
    Returns:
    
    ListMultimapCache object
  - getListMultimapCache
```
<K,V> RListMultimapCache<K,V> getListMultimapCache(String name,
                                                   Codec codec)
```
    Returns List based Multimap instance by name using provided codec for both map keys and values. Supports key-entry eviction with a given TTL value.
    If eviction is not required then it's better to use regular map getSetMultimap(String, Codec).
    
    Type Parameters:
    
    K - type of key
    
    V - type of value
    
    Parameters:
    
    name - - name of object
    
    codec - - codec for keys and values
    
    Returns:
    
    ListMultimapCache object
  - getLocalCachedMap
```
<K,V> RLocalCachedMap<K,V> getLocalCachedMap(String name,
                                             LocalCachedMapOptions<K,V> options)
```
    Returns local cached map instance by name. Configured by parameters of options-object.
    
    Type Parameters:
    
    K - type of key
    
    V - type of value
    
    Parameters:
    
    name - - name of object
    
    options - - local map options
    
    Returns:
    
    LocalCachedMap object
  - getLocalCachedMap
```
<K,V> RLocalCachedMap<K,V> getLocalCachedMap(String name,
                                             Codec codec,
                                             LocalCachedMapOptions<K,V> options)
```
    Returns local cached map instance by name using provided codec. Configured by parameters of options-object.
    
    Type Parameters:
    
    K - type of key
    
    V - type of value
    
    Parameters:
    
    name - - name of object
    
    codec - - codec for keys and values
    
    options - - local map options
    
    Returns:
    
    LocalCachedMap object
  - getMap
```
<K,V> RMap<K,V> getMap(String name)
```
    Returns map instance by name.
    
    Type Parameters:
    
    K - type of key
    
    V - type of value
    
    Parameters:
    
    name - - name of object
    
    Returns:
    
    Map object
  - getMap
```
<K,V> RMap<K,V> getMap(String name,
                       MapOptions<K,V> options)
```
    Returns map instance by name.
    
    Type Parameters:
    
    K - type of key
    
    V - type of value
    
    Parameters:
    
    name - - name of object
    
    options - - map options
    
    Returns:
    
    Map object
  - getMap
```
<K,V> RMap<K,V> getMap(String name,
                       Codec codec)
```
    Returns map instance by name using provided codec for both map keys and values.
    
    Type Parameters:
    
    K - type of key
    
    V - type of value
    
    Parameters:
    
    name - - name of object
    
    codec - - codec for keys and values
    
    Returns:
    
    Map object
  - getMap
```
<K,V> RMap<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.
    
    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
  - getSetMultimap
```
<K,V> RSetMultimap<K,V> getSetMultimap(String name)
```
    Returns Set based Multimap instance by name.
    
    Type Parameters:
    
    K - type of key
    
    V - type of value
    
    Parameters:
    
    name - - name of object
    
    Returns:
    
    SetMultimap object
  - getSetMultimap
```
<K,V> RSetMultimap<K,V> getSetMultimap(String name,
                                       Codec codec)
```
    Returns Set based Multimap instance by name using provided codec for both map keys and values.
    
    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
```
<K,V> RSetMultimapCache<K,V> getSetMultimapCache(String name)
```
    Returns Set based Multimap instance by name. Supports key-entry eviction with a given TTL value.
    If eviction is not required then it's better to use regular map getSetMultimap(String).
    
    Type Parameters:
    
    K - type of key
    
    V - type of value
    
    Parameters:
    
    name - - name of object
    
    Returns:
    
    SetMultimapCache object
  - getSetMultimapCache
```
<K,V> RSetMultimapCache<K,V> getSetMultimapCache(String name,
                                                 Codec codec)
```
    Returns Set based Multimap instance by name using provided codec for both map keys and values. Supports key-entry eviction with a given TTL value.
    If eviction is not required then it's better to use regular map getSetMultimap(String, Codec).
    
    Type Parameters:
    
    K - type of key
    
    V - type of value
    
    Parameters:
    
    name - - name of object
    
    codec - - codec for keys and values
    
    Returns:
    
    SetMultimapCache object
  - getSemaphore
```
RSemaphore getSemaphore(String name)
```
    Returns semaphore instance by name
    
    Parameters:
    
    name - - name of object
    
    Returns:
    
    Semaphore object
  - getPermitExpirableSemaphore
```
RPermitExpirableSemaphore getPermitExpirableSemaphore(String name)
```
    Returns semaphore instance by name. Supports lease time parameter for each acquired permit.
    
    Parameters:
    
    name - - name of object
    
    Returns:
    
    PermitExpirableSemaphore object
  - getLock
```
RLock getLock(String name)
```
    Returns lock instance by name.
    Implements a non-fair locking so doesn't guarantees an acquire order by threads.
    
    Parameters:
    
    name - - name of object
    
    Returns:
    
    Lock object
  - getFairLock
```
RLock getFairLock(String name)
```
    Returns lock instance by name.
    Implements a fair locking so it guarantees an acquire order by threads.
    
    Parameters:
    
    name - - name of object
    
    Returns:
    
    Lock object
  - getReadWriteLock
```
RReadWriteLock getReadWriteLock(String name)
```
    Returns readWriteLock instance by name.
    
    Parameters:
    
    name - - name of object
    
    Returns:
    
    Lock object
  - getSet
```
<V> RSet<V> getSet(String name)
```
    Returns set instance by name.
    
    Type Parameters:
    
    V - type of value
    
    Parameters:
    
    name - - name of object
    
    Returns:
    
    Set object
  - getSet
```
<V> RSet<V> getSet(String name,
                   Codec codec)
```
    Returns set instance by name using provided codec for set objects.
    
    Type Parameters:
    
    V - type of value
    
    Parameters:
    
    name - - name of object
    
    codec - - codec for values
    
    Returns:
    
    Set object
  - getSortedSet
```
<V> RSortedSet<V> getSortedSet(String name)
```
    Returns sorted set instance by name. This sorted set uses comparator to sort objects.
    
    Type Parameters:
    
    V - type of value
    
    Parameters:
    
    name - - name of object
    
    Returns:
    
    SortedSet object
  - getSortedSet
```
<V> RSortedSet<V> getSortedSet(String name,
                               Codec codec)
```
    Returns sorted set instance by name using provided codec for sorted set objects. This sorted set sorts objects using comparator.
    
    Type Parameters:
    
    V - type of value
    
    Parameters:
    
    name - - name of object
    
    codec - - codec for values
    
    Returns:
    
    SortedSet object
  - getScoredSortedSet
```
<V> RScoredSortedSet<V> getScoredSortedSet(String name)
```
    Returns Redis Sorted Set instance by name. This sorted set sorts objects by object score.
    
    Type Parameters:
    
    V - type of value
    
    Parameters:
    
    name - - name of object
    
    Returns:
    
    ScoredSortedSet object
  - getScoredSortedSet
```
<V> RScoredSortedSet<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.
    
    Type Parameters:
    
    V - type of value
    
    Parameters:
    
    name - - name of object
    
    codec - - codec for values
    
    Returns:
    
    ScoredSortedSet object
  - getLexSortedSet
```
RLexSortedSet 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 - - name of object
    
    Returns:
    
    LexSortedSet object
  - getTopic
```
<M> RTopic<M> getTopic(String name)
```
    Returns topic instance by name.
    
    Type Parameters:
    
    M - type of message
    
    Parameters:
    
    name - - name of object
    
    Returns:
    
    Topic object
  - getTopic
```
<M> RTopic<M> getTopic(String name,
                       Codec codec)
```
    Returns topic instance by name using provided codec for messages.
    
    Type Parameters:
    
    M - type of message
    
    Parameters:
    
    name - - name of object
    
    codec - - codec for message
    
    Returns:
    
    Topic object
  - getPatternTopic
```
<M> RPatternTopic<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
    
    Type Parameters:
    
    M - type of message
    
    Parameters:
    
    pattern - of the topic
    
    Returns:
    
    PatterTopic object
  - getPatternTopic
```
<M> RPatternTopic<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
    
    Type Parameters:
    
    M - type of message
    
    Parameters:
    
    pattern - of the topic
    
    codec - - codec for message
    
    Returns:
    
    PatterTopic object
  - getQueue
```
<V> RQueue<V> getQueue(String name)
```
    Returns unbounded queue instance by name.
    
    Type Parameters:
    
    V - type of value
    
    Parameters:
    
    name - of object
    
    Returns:
    
    queue object
  - getDelayedQueue
```
<V> RDelayedQueue<V> getDelayedQueue(RQueue<V> destinationQueue)
```
    Returns unbounded delayed queue instance by name.
    Could be attached to destination queue only. All elements are inserted with transfer delay to destination queue.
    
    Type Parameters:
    
    V - type of value
    
    Parameters:
    
    destinationQueue - - destination queue
    
    Returns:
    
    Delayed queue object
  - getQueue
```
<V> RQueue<V> getQueue(String name,
                       Codec codec)
```
    Returns unbounded queue instance by name using provided codec for queue objects.
    
    Type Parameters:
    
    V - type of value
    
    Parameters:
    
    name - - name of object
    
    codec - - codec for message
    
    Returns:
    
    Queue object
  - getPriorityQueue
```
<V> RPriorityQueue<V> getPriorityQueue(String name)
```
    Returns priority unbounded queue instance by name. It uses comparator to sort objects.
    
    Type Parameters:
    
    V - type of value
    
    Parameters:
    
    name - of object
    
    Returns:
    
    Queue object
  - getPriorityQueue
```
<V> RPriorityQueue<V> getPriorityQueue(String name,
                                       Codec codec)
```
    Returns priority unbounded queue instance by name using provided codec for queue objects. It uses comparator to sort objects.
    
    Type Parameters:
    
    V - type of value
    
    Parameters:
    
    name - - name of object
    
    codec - - codec for message
    
    Returns:
    
    Queue object
  - getPriorityDeque
```
<V> RPriorityDeque<V> getPriorityDeque(String name)
```
    Returns priority unbounded deque instance by name. It uses comparator to sort objects.
    
    Type Parameters:
    
    V - type of value
    
    Parameters:
    
    name - of object
    
    Returns:
    
    Queue object
  - getPriorityDeque
```
<V> RPriorityDeque<V> getPriorityDeque(String name,
                                       Codec codec)
```
    Returns priority unbounded deque instance by name using provided codec for queue objects. It uses comparator to sort objects.
    
    Type Parameters:
    
    V - type of value
    
    Parameters:
    
    name - - name of object
    
    codec - - codec for message
    
    Returns:
    
    Queue object
  - getBlockingQueue
```
<V> RBlockingQueue<V> getBlockingQueue(String name)
```
    Returns unbounded blocking queue instance by name.
    
    Type Parameters:
    
    V - type of value
    
    Parameters:
    
    name - - name of object
    
    Returns:
    
    BlockingQueue object
  - getBlockingQueue
```
<V> RBlockingQueue<V> getBlockingQueue(String name,
                                       Codec codec)
```
    Returns unbounded blocking queue instance by name using provided codec for queue objects.
    
    Type Parameters:
    
    V - type of value
    
    Parameters:
    
    name - - name of queue
    
    codec - - queue objects codec
    
    Returns:
    
    BlockingQueue object
  - getBoundedBlockingQueue
```
<V> RBoundedBlockingQueue<V> getBoundedBlockingQueue(String name)
```
    Returns bounded blocking queue instance by name.
    
    Type Parameters:
    
    V - type of value
    
    Parameters:
    
    name - of queue
    
    Returns:
    
    BoundedBlockingQueue object
  - getBoundedBlockingQueue
```
<V> RBoundedBlockingQueue<V> getBoundedBlockingQueue(String name,
                                                     Codec codec)
```
    Returns bounded blocking queue instance by name using provided codec for queue objects.
    
    Type Parameters:
    
    V - type of value
    
    Parameters:
    
    name - - name of queue
    
    codec - - codec for values
    
    Returns:
    
    BoundedBlockingQueue object
  - getDeque
```
<V> RDeque<V> getDeque(String name)
```
    Returns unbounded deque instance by name.
    
    Type Parameters:
    
    V - type of value
    
    Parameters:
    
    name - - name of object
    
    Returns:
    
    Deque object
  - getDeque
```
<V> RDeque<V> getDeque(String name,
                       Codec codec)
```
    Returns unbounded deque instance by name using provided codec for deque objects.
    
    Type Parameters:
    
    V - type of value
    
    Parameters:
    
    name - - name of object
    
    codec - - codec for values
    
    Returns:
    
    Deque object
  - getBlockingDeque
```
<V> RBlockingDeque<V> getBlockingDeque(String name)
```
    Returns unbounded blocking deque instance by name.
    
    Type Parameters:
    
    V - type of value
    
    Parameters:
    
    name - - name of object
    
    Returns:
    
    BlockingDeque object
  - getBlockingDeque
```
<V> RBlockingDeque<V> getBlockingDeque(String name,
                                       Codec codec)
```
    Returns unbounded blocking deque instance by name using provided codec for deque objects.
    
    Type Parameters:
    
    V - type of value
    
    Parameters:
    
    name - - name of object
    
    codec - - deque objects codec
    
    Returns:
    
    BlockingDeque object
  - getAtomicLong
```
RAtomicLong getAtomicLong(String name)
```
    Returns atomicLong instance by name.
    
    Parameters:
    
    name - - name of object
    
    Returns:
    
    AtomicLong object
  - getAtomicDouble
```
RAtomicDouble getAtomicDouble(String name)
```
    Returns atomicDouble instance by name.
    
    Parameters:
    
    name - - name of object
    
    Returns:
    
    AtomicDouble object
  - getCountDownLatch
```
RCountDownLatch getCountDownLatch(String name)
```
    Returns countDownLatch instance by name.
    
    Parameters:
    
    name - - name of object
    
    Returns:
    
    CountDownLatch object
  - getBitSet
```
RBitSet getBitSet(String name)
```
    Returns bitSet instance by name.
    
    Parameters:
    
    name - - name of object
    
    Returns:
    
    BitSet object
  - getBloomFilter
```
<V> RBloomFilter<V> getBloomFilter(String name)
```
    Returns bloom filter instance by name.
    
    Type Parameters:
    
    V - type of value
    
    Parameters:
    
    name - - name of object
    
    Returns:
    
    BloomFilter object
  - getBloomFilter
```
<V> RBloomFilter<V> getBloomFilter(String name,
                                   Codec codec)
```
    Returns bloom filter instance by name using provided codec for objects.
    
    Type Parameters:
    
    V - type of value
    
    Parameters:
    
    name - - name of object
    
    codec - - codec for values
    
    Returns:
    
    BloomFilter object
  - getScript
```
RScript getScript()
```
    Returns script operations object
    
    Returns:
    
    Script object
  - getExecutorService
```
RScheduledExecutorService getExecutorService(String name)
```
    Returns ScheduledExecutorService by name
    
    Parameters:
    
    name - - name of object
    
    Returns:
    
    ScheduledExecutorService object
  - getExecutorService
```
@Deprecated
RScheduledExecutorService getExecutorService(Codec codec,
                                                          String name)
```
    Deprecated. - use getExecutorService(String, Codec) instead.
    
    Returns ScheduledExecutorService by name using provided codec for task, response and request serialization Please use getExecutorService(String name, Codec codec) method instead.
    
    Parameters:
    
    name - - name of object
    
    codec - - codec for task, response and request
    
    Returns:
    
    ScheduledExecutorService object
  - getExecutorService
```
RScheduledExecutorService getExecutorService(String name,
                                             Codec codec)
```
    Returns ScheduledExecutorService by name using provided codec for task, response and request serialization
    
    Parameters:
    
    name - - name of object
    
    codec - - codec for task, response and request
    
    Returns:
    
    ScheduledExecutorService object
    
    Since:
    
    2.8.2
  - getRemoteService
```
RRemoteService getRemoteService()
```
    Returns object for remote operations prefixed with the default name (redisson_remote_service)
    
    Returns:
    
    RemoteService object
  - getRemoteService
```
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.
    
    Parameters:
    
    codec - - codec for response and request
    
    Returns:
    
    RemoteService object
  - getRemoteService
```
RRemoteService getRemoteService(String name)
```
    Returns object for remote operations prefixed with the specified name
    
    Parameters:
    
    name - - the name used as the Redis key prefix for the services
    
    Returns:
    
    RemoteService object
  - getRemoteService
```
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.
    
    Parameters:
    
    name - - the name used as the Redis key prefix for the services
    
    codec - - codec for response and request
    
    Returns:
    
    RemoteService object
  - createBatch
```
RBatch createBatch()
```
    Return batch object which executes group of command in pipeline. See http://redis.io/topics/pipelining
    
    Returns:
    
    Batch object
  - getKeys
```
RKeys getKeys()
```
    Returns interface with methods for Redis keys. Each of Redis/Redisson object associated with own key
    
    Returns:
    
    Keys object
  - getLiveObjectService
```
RLiveObjectService getLiveObjectService()
```
    Returns RedissonAttachedLiveObjectService which can be used to retrieve live REntity(s)
    
    Returns:
    
    LiveObjectService object
  - shutdown
```
void shutdown()
```
    Shutdown Redisson instance but NOT Redis server This equates to invoke shutdown(2, 15, TimeUnit.SECONDS);
  - shutdown
```
void shutdown(long quietPeriod,
              long timeout,
              TimeUnit unit)
```
    Shuts down Redisson instance NOT Redis server Shutdown ensures that no tasks are submitted for 'the quiet period' (usually a couple seconds) before it shuts itself down. If a task is submitted during the quiet period, it is guaranteed to be accepted and the quiet period will start over.
    
    Parameters:
    
    quietPeriod - the quiet period as described in the documentation
    
    timeout - the maximum amount of time to wait until the executor is shutdown() regardless if a task was submitted during the quiet period
    
    unit - the unit of quietPeriod and timeout
  - getConfig
```
Config getConfig()
```
    Allows to get configuration provided during Redisson instance creation. Further changes on this object not affect Redisson instance.
    
    Returns:
    
    Config object
  - getCodecProvider
```
ReferenceCodecProvider getCodecProvider()
```
    Returns the CodecProvider instance
    
    Returns:
    
    CodecProvider object
  - getNodesGroup
```
NodesGroup<Node> getNodesGroup()
```
    Get Redis nodes group for server operations
    
    Returns:
    
    NodesGroup object
  - getClusterNodesGroup
```
ClusterNodesGroup getClusterNodesGroup()
```
    Get Redis cluster nodes group for server operations
    
    Returns:
    
    ClusterNodesGroup object
  - isShutdown
```
boolean isShutdown()
```
    Returns true if this Redisson instance has been shut down.
    
    Returns:
    
    code true} if this Redisson instance has been shut down overwise false
  - isShuttingDown
```
boolean isShuttingDown()
```
    Returns true if this Redisson instance was started to be shutdown or was shutdown isShutdown() already.
    
    Returns:
    
    true if this Redisson instance was started to be shutdown or was shutdown isShutdown() already.

Interface RedissonClient

Method Summary

Method Detail

getBinaryStream

getGeo

getGeo

getSetCache

getSetCache

getMapCache

getMapCache

getMapCache

getMapCache

getBucket

getBucket

getBuckets

getBuckets

getHyperLogLog

getHyperLogLog

getList

getList

getListMultimap

getListMultimap

getListMultimapCache

getListMultimapCache

getLocalCachedMap

getLocalCachedMap

getMap

getMap

getMap

getMap

getSetMultimap

getSetMultimap

getSetMultimapCache

getSetMultimapCache

getSemaphore

getPermitExpirableSemaphore

getLock

getFairLock

getReadWriteLock

getSet

getSet

getSortedSet

getSortedSet

getScoredSortedSet

getScoredSortedSet

getLexSortedSet

getTopic

getTopic

getPatternTopic

getPatternTopic

getQueue

getDelayedQueue

getQueue

getPriorityQueue

getPriorityQueue

getPriorityDeque

getPriorityDeque

getBlockingQueue

getBlockingQueue

getBoundedBlockingQueue

getBoundedBlockingQueue

getDeque

getDeque

getBlockingDeque

getBlockingDeque

getAtomicLong

getAtomicDouble

getCountDownLatch

getBitSet

getBloomFilter

getBloomFilter

getScript

getExecutorService

getExecutorService

getExecutorService

getRemoteService

getRemoteService

getRemoteService

getRemoteService

createBatch