All Known Implementing Classes:

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

Author:

Nikita Koksharov

See Also:

RedissonReactiveClient, RedissonRxClient

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method	Description
`RBatch`	`createBatch()`	Creates batch object which could be executed later with collected group of commands in pipeline mode.
`RBatch`	`createBatch(BatchOptions options)`	Creates batch object which could be executed later with collected group of commands in pipeline mode.
`RTransaction`	`createTransaction(TransactionOptions options)`	Creates transaction with READ_COMMITTED isolation level.
`RAtomicDouble`	`name)`	Returns atomicDouble instance by name.
`RAtomicLong`	`name)`	Returns atomicLong instance by name.
`RBinaryStream`	`name)`	Returns binary stream holder instance by `name`
`RBitSet`	`name)`	Returns bitSet instance by name.
`<V> RBlockingDeque<V>`	`name)`	Returns unbounded blocking deque instance by name.
`<V> RBlockingDeque<V>`	`name, Codec codec)`	Returns unbounded blocking deque instance by name using provided codec for deque objects.
`<V> RBlockingQueue<V>`	`name)`	Returns unbounded blocking queue instance by name.
`<V> RBlockingQueue<V>`	`name, Codec codec)`	Returns unbounded blocking queue instance by name using provided codec for queue objects.
`<V> RBloomFilter<V>`	`name)`	Returns bloom filter instance by name.
`<V> RBloomFilter<V>`	`name, Codec codec)`	Returns bloom filter instance by name using provided codec for objects.
`<V> RBoundedBlockingQueue<V>`	`name)`	Returns bounded blocking queue instance by name.
`<V> RBoundedBlockingQueue<V>`	`name, Codec codec)`	Returns bounded blocking queue instance by name using provided codec for queue objects.
`<V> RBucket<V>`	`name)`	Returns object holder instance by name.
`<V> RBucket<V>`	`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()`	Deprecated.
`Config`	`getConfig()`	Allows to get configuration provided during Redisson instance creation.
`RCountDownLatch`	`name)`	Returns countDownLatch instance by name.
`<V> RDelayedQueue<V>`	`getDelayedQueue(RQueue<V> destinationQueue)`	Returns unbounded delayed queue instance by name.
`<V> RDeque<V>`	`name)`	Returns unbounded deque instance by name.
`<V> RDeque<V>`	`name, Codec codec)`	Returns unbounded deque instance by name using provided codec for deque objects.
`RDoubleAdder`	`name)`	Returns DoubleAdder instances by name.
`RScheduledExecutorService`	`name)`	Returns ScheduledExecutorService by name
`RScheduledExecutorService`	`name, ExecutorOptions options)`	Returns ScheduledExecutorService by name
`RScheduledExecutorService`	`name, Codec codec)`	Returns ScheduledExecutorService by name using provided codec for task, response and request serialization
`RScheduledExecutorService`	`name, Codec codec, ExecutorOptions options)`	Returns ScheduledExecutorService by name using provided codec for task, response and request serialization
`RLock`	`name)`	Returns Lock instance by name.
`<V> RGeo<V>`	`name)`	Returns geospatial items holder instance by `name`.
`<V> RGeo<V>`	`name, Codec codec)`	Returns geospatial items holder instance by `name` using provided codec for geospatial members.
`<V> RHyperLogLog<V>`	`name)`	Returns HyperLogLog instance by name.
`<V> RHyperLogLog<V>`	`name, Codec codec)`	Returns HyperLogLog instance by name using provided codec for hll objects.
	`getId()`	Returns id of this Redisson instance
`RIdGenerator`	`name)`	Returns id generator by name.
`RKeys`	`getKeys()`	Returns interface with methods for Redis keys.
`RLexSortedSet`	`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>`	`name)`	Returns list instance by name.
`<V> RList<V>`	`name, Codec codec)`	Returns list instance by name using provided codec for list objects.
`<K,V> RListMultimap<K,V>`	`name)`	Returns List based Multimap instance by name.
`<K,V> RListMultimap<K,V>`	`name, Codec codec)`	Returns List based Multimap instance by name using provided codec for both map keys and values.
`<K,V> RListMultimapCache<K,V>`	`name)`	Returns List based Multimap instance by name.
`<K,V> RListMultimapCache<K,V>`	`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>`	`name, LocalCachedMapOptions<K,V> options)`	Returns local cached map instance by name.
`<K,V> RLocalCachedMap<K,V>`	`name, Codec codec, LocalCachedMapOptions<K,V> options)`	Returns local cached map instance by name using provided codec.
`RLock`	`name)`	Returns Lock instance by name.
`RLongAdder`	`name)`	Returns LongAdder instances by name.
`<K,V> RMap<K,V>`	`name)`	Returns map instance by name.
`<K,V> RMap<K,V>`	`name, MapOptions<K,V> options)`	Returns map instance by name.
`<K,V> RMap<K,V>`	`name, Codec codec)`	Returns map instance by name using provided codec for both map keys and values.
`<K,V> RMap<K,V>`	`name, Codec codec, MapOptions<K,V> options)`	Returns map instance by name using provided codec for both map keys and values.
`<K,V> RMapCache<K,V>`	`name)`	Returns map-based cache instance by name.
`<K,V> RMapCache<K,V>`	`name, MapOptions<K,V> options)`	Returns map-based cache instance by name.
`<K,V> RMapCache<K,V>`	`name, Codec codec)`	Returns map-based cache instance by `name` using provided `codec` for both cache keys and values.
`<K,V> RMapCache<K,V>`	`name, Codec codec, MapOptions<K,V> options)`	Returns map-based cache instance by `name` using provided `codec` for both cache keys and values.
`RLock`	`getMultiLock(RLock... locks)`	Returns MultiLock instance associated with specified `locks`
`NodesGroup<Node>`	`getNodesGroup()`	Deprecated.
`RPatternTopic`	`pattern)`	Returns topic instance satisfies by pattern name.
`RPatternTopic`	`pattern, Codec codec)`	Returns topic instance satisfies by pattern name using provided codec for messages.
`RPermitExpirableSemaphore`	`name)`	Returns semaphore instance by name.
`<V> RPriorityBlockingDeque<V>`	`name)`	Returns unbounded priority blocking deque instance by name.
`<V> RPriorityBlockingDeque<V>`	`name, Codec codec)`	Returns unbounded priority blocking deque instance by name using provided codec for queue objects.
`<V> RPriorityBlockingQueue<V>`	`name)`	Returns unbounded priority blocking queue instance by name.
`<V> RPriorityBlockingQueue<V>`	`name, Codec codec)`	Returns unbounded priority blocking queue instance by name using provided codec for queue objects.
`<V> RPriorityDeque<V>`	`name)`	Returns priority unbounded deque instance by name.
`<V> RPriorityDeque<V>`	`name, Codec codec)`	Returns priority unbounded deque instance by name using provided codec for queue objects.
`<V> RPriorityQueue<V>`	`name)`	Returns priority unbounded queue instance by name.
`<V> RPriorityQueue<V>`	`name, Codec codec)`	Returns priority unbounded queue instance by name using provided codec for queue objects.
`<V> RQueue<V>`	`name)`	Returns unbounded queue instance by name.
`<V> RQueue<V>`	`name, Codec codec)`	Returns unbounded queue instance by name using provided codec for queue objects.
`RRateLimiter`	`name)`	Returns rate limiter instance by `name`
`RReadWriteLock`	`name)`	Returns ReadWriteLock instance by name.
`<T extends BaseRedisNodes> T`	`getRedisNodes(RedisNodes<T> nodes)`	Returns API to manage Redis nodes
`RLock`	`getRedLock(RLock... locks)`	Deprecated.
`RReliableTopic`	`name)`	Returns reliable topic instance by name.
`RReliableTopic`	`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`	`name)`	Returns object for remote operations prefixed with the specified name
`RRemoteService`	`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> RRingBuffer<V>`	`name)`	Returns RingBuffer based queue.
`<V> RRingBuffer<V>`	`name, Codec codec)`	Returns RingBuffer based queue.
`<V> RScoredSortedSet<V>`	`name)`	Returns Redis Sorted Set instance by name.
`<V> RScoredSortedSet<V>`	`name, Codec codec)`	Returns Redis Sorted Set instance by name using provided codec for sorted set objects.
`RScript`	`getScript()`	Returns script operations object
`RScript`	`getScript(Codec codec)`	Returns script operations object using provided codec.
`RSemaphore`	`name)`	Returns semaphore instance by name
`<V> RSet<V>`	`name)`	Returns set instance by name.
`<V> RSet<V>`	`name, Codec codec)`	Returns set instance by name using provided codec for set objects.
`<V> RSetCache<V>`	`name)`	Returns set-based cache instance by `name`.
`<V> RSetCache<V>`	`name, Codec codec)`	Returns set-based cache instance by `name`.
`<K,V> RSetMultimap<K,V>`	`name)`	Returns Set based Multimap instance by name.
`<K,V> RSetMultimap<K,V>`	`name, Codec codec)`	Returns Set based Multimap instance by name using provided codec for both map keys and values.
`<K,V> RSetMultimapCache<K,V>`	`name)`	Returns Set based Multimap instance by name.
`<K,V> RSetMultimapCache<K,V>`	`name, Codec codec)`	Returns Set based Multimap instance by name using provided codec for both map keys and values.
`<V> RSortedSet<V>`	`name)`	Returns sorted set instance by name.
`<V> RSortedSet<V>`	`name, Codec codec)`	Returns sorted set instance by name using provided codec for sorted set objects.
`RLock`	`name)`	Returns Spin lock instance by name.
`RLock`	`name, LockOptions.BackOff backOff)`	Returns Spin lock instance by name with specified back off options.
`<K,V> RStream<K,V>`	`name)`	Returns stream instance by `name`
`<K,V> RStream<K,V>`	`name, Codec codec)`	Returns stream instance by `name` using provided `codec` for entries.
`<V> RTimeSeries<V>`	`name)`	Returns time-series instance by `name`
`<V> RTimeSeries<V>`	`name, Codec codec)`	Returns time-series instance by `name` using provided `codec` for values.
`RTopic`	`name)`	Returns topic instance by name.
`RTopic`	`name, Codec codec)`	Returns topic instance by name using provided codec for messages.
`<V> RTransferQueue<V>`	`name)`	Returns transfer queue instance by name.
`<V> RTransferQueue<V>`	`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.
`RedissonReactiveClient`	`reactive()`	Returns Reactive Redisson instance
`RedissonRxClient`	`rxJava()`	Returns RxJava Redisson instance
`void`	`shutdown()`	Shutdown Redisson instance but NOT Redis server This equates to invoke shutdown(0, 2, TimeUnit.SECONDS);
`void`	`shutdown(long quietPeriod, long timeout, unit)`	Shuts down Redisson instance but 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
  - getTimeSeries
```
<V>  name)
```
    Returns time-series instance by name
    
    Type Parameters:
    
    V - type of value
    
    Parameters:
    
    name - - name of instance
    
    Returns:
    
    RTimeSeries object
  - getTimeSeries
```
<V>  name,
                                 Codec codec)
```
    Returns time-series instance by name using provided codec for values.
    
    Type Parameters:
    
    V - type of value
    
    Parameters:
    
    name - - name of instance
    
    codec - - codec for values
    
    Returns:
    
    RTimeSeries object
  - getStream
```
<K,V>  name)
```
    Returns stream instance by name
    Requires Redis 5.0.0 and higher.
    
    Type Parameters:
    
    K - type of key
    
    V - type of value
    
    Parameters:
    
    name - of stream
    
    Returns:
    
    RStream object
  - getStream
```
<K,V>  name,
                                         Codec codec)
```
    Returns stream instance by name using provided codec for entries.
    Requires Redis 5.0.0 and higher.
    
    Type Parameters:
    
    K - type of key
    
    V - type of value
    
    Parameters:
    
    name - - name of stream
    
    codec - - codec for entry
    
    Returns:
    
    RStream object
  - getRateLimiter
```
 name)
```
    Returns rate limiter instance by name
    
    Parameters:
    
    name - of rate limiter
    
    Returns:
    
    RateLimiter object
  - getBinaryStream
```
 name)
```
    Returns binary stream holder instance by name
    
    Parameters:
    
    name - of binary stream
    
    Returns:
    
    BinaryStream object
  - getGeo
```
<V>  name)
```
    Returns geospatial items holder instance by name.
    
    Type Parameters:
    
    V - type of value
    
    Parameters:
    
    name - - name of object
    
    Returns:
    
    Geo object
  - getGeo
```
<V>  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>  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>  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>  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>  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>  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>  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>  name)
```
    Returns object holder instance by name.
    
    Type Parameters:
    
    V - type of value
    
    Parameters:
    
    name - - name of object
    
    Returns:
    
    Bucket object
  - getBucket
```
<V>  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>  name)
```
    Returns HyperLogLog instance by name.
    
    Type Parameters:
    
    V - type of value
    
    Parameters:
    
    name - - name of object
    
    Returns:
    
    HyperLogLog object
  - getHyperLogLog
```
<V>  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>  name)
```
    Returns list instance by name.
    
    Type Parameters:
    
    V - type of value
    
    Parameters:
    
    name - - name of object
    
    Returns:
    
    List object
  - getList
```
<V>  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>  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>  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>  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>  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>  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>  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>  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>  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>  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>  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>  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>  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>  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>  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
```
 name)
```
    Returns semaphore instance by name
    
    Parameters:
    
    name - - name of object
    
    Returns:
    
    Semaphore object
  - getPermitExpirableSemaphore
```
 name)
```
    Returns semaphore instance by name. Supports lease time parameter for each acquired permit.
    
    Parameters:
    
    name - - name of object
    
    Returns:
    
    PermitExpirableSemaphore object
  - getLock
```
 name)
```
    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.
    
    Parameters:
    
    name - - name of object
    
    Returns:
    
    Lock object
  - getSpinLock
```
 name)
```
    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
    
    Parameters:
    
    name - - name of object
    
    Returns:
    
    Lock object
  - getSpinLock
```
 name,
                  LockOptions.BackOff backOff)
```
    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
    
    Parameters:
    
    name - - name of object
    
    Returns:
    
    Lock object
  - getMultiLock
```
RLock getMultiLock(RLock... locks)
```
    Returns MultiLock instance associated with specified locks
    
    Parameters:
    
    locks - - collection of locks
    
    Returns:
    
    MultiLock object
  - getRedLock
```
RLock getRedLock(RLock... locks)
```
    Deprecated.
  - getFairLock
```
 name)
```
    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.
    
    Parameters:
    
    name - - name of object
    
    Returns:
    
    Lock object
  - getReadWriteLock
```
 name)
```
    Returns ReadWriteLock instance by name.
    To increase reliability during failover, all operations wait for propagation to all Redis slaves.
    
    Parameters:
    
    name - - name of object
    
    Returns:
    
    Lock object
  - getSet
```
<V>  name)
```
    Returns set instance by name.
    
    Type Parameters:
    
    V - type of value
    
    Parameters:
    
    name - - name of object
    
    Returns:
    
    Set object
  - getSet
```
<V>  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>  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>  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>  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>  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
```
 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
```
 name)
```
    Returns topic instance by name.
    Messages are delivered to all listeners attached to the same Redis setup.
    
    Parameters:
    
    name - - name of object
    
    Returns:
    
    Topic object
  - getTopic
```
 name,
                Codec codec)
```
    Returns topic instance by name using provided codec for messages.
    Messages are delivered to all listeners attached to the same Redis setup.
    
    Parameters:
    
    name - - name of object
    
    codec - - codec for message
    
    Returns:
    
    Topic object
  - getReliableTopic
```
 name)
```
    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.
    
    Parameters:
    
    name - - name of object
    
    Returns:
    
    ReliableTopic object
  - getReliableTopic
```
 name,
                                Codec codec)
```
    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.
    
    Parameters:
    
    name - - name of object
    
    codec - - codec for message
    
    Returns:
    
    ReliableTopic object
  - getPatternTopic
```
 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:
    
    PatterTopic object
  - getPatternTopic
```
 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
    
    codec - - codec for message
    
    Returns:
    
    PatterTopic object
  - getQueue
```
<V>  name)
```
    Returns unbounded queue instance by name.
    
    Type Parameters:
    
    V - type of value
    
    Parameters:
    
    name - of object
    
    Returns:
    
    queue object
  - getTransferQueue
```
<V>  name)
```
    Returns transfer queue instance by name.
    
    Type Parameters:
    
    V - type of values
    
    Parameters:
    
    name - - name of object
    
    Returns:
    
    TransferQueue object
  - getTransferQueue
```
<V>  name,
                                       Codec codec)
```
    Returns transfer queue instance by name using provided codec for queue objects.
    
    Type Parameters:
    
    V - type of values
    
    Parameters:
    
    name - - name of object
    
    codec - - code for values
    
    Returns:
    
    TransferQueue 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>  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
  - getRingBuffer
```
<V>  name)
```
    Returns RingBuffer based queue.
    
    Type Parameters:
    
    V - value type
    
    Parameters:
    
    name - - name of object
    
    Returns:
    
    RingBuffer object
  - getRingBuffer
```
<V>  name,
                                 Codec codec)
```
    Returns RingBuffer based queue.
    
    Type Parameters:
    
    V - value type
    
    Parameters:
    
    name - - name of object
    
    codec - - codec for values
    
    Returns:
    
    RingBuffer object
  - getPriorityQueue
```
<V>  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>  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
  - getPriorityBlockingQueue
```
<V>  name)
```
    Returns unbounded priority blocking queue instance by name. It uses comparator to sort objects.
    
    Type Parameters:
    
    V - type of value
    
    Parameters:
    
    name - of object
    
    Returns:
    
    Queue object
  - getPriorityBlockingQueue
```
<V>  name,
                                                       Codec codec)
```
    Returns unbounded priority blocking 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
  - getPriorityBlockingDeque
```
<V>  name)
```
    Returns unbounded priority blocking deque instance by name. It uses comparator to sort objects.
    
    Type Parameters:
    
    V - type of value
    
    Parameters:
    
    name - of object
    
    Returns:
    
    Queue object
  - getPriorityBlockingDeque
```
<V>  name,
                                                       Codec codec)
```
    Returns unbounded priority blocking 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
  - getPriorityDeque
```
<V>  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>  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>  name)
```
    Returns unbounded blocking queue instance by name.
    
    Type Parameters:
    
    V - type of value
    
    Parameters:
    
    name - - name of object
    
    Returns:
    
    BlockingQueue object
  - getBlockingQueue
```
<V>  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>  name)
```
    Returns bounded blocking queue instance by name.
    
    Type Parameters:
    
    V - type of value
    
    Parameters:
    
    name - of queue
    
    Returns:
    
    BoundedBlockingQueue object
  - getBoundedBlockingQueue
```
<V>  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>  name)
```
    Returns unbounded deque instance by name.
    
    Type Parameters:
    
    V - type of value
    
    Parameters:
    
    name - - name of object
    
    Returns:
    
    Deque object
  - getDeque
```
<V>  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>  name)
```
    Returns unbounded blocking deque instance by name.
    
    Type Parameters:
    
    V - type of value
    
    Parameters:
    
    name - - name of object
    
    Returns:
    
    BlockingDeque object
  - getBlockingDeque
```
<V>  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
```
 name)
```
    Returns atomicLong instance by name.
    
    Parameters:
    
    name - - name of object
    
    Returns:
    
    AtomicLong object
  - getAtomicDouble
```
 name)
```
    Returns atomicDouble instance by name.
    
    Parameters:
    
    name - - name of object
    
    Returns:
    
    AtomicDouble object
  - getLongAdder
```
 name)
```
    Returns LongAdder instances by name.
    
    Parameters:
    
    name - - name of object
    
    Returns:
    
    LongAdder object
  - getDoubleAdder
```
 name)
```
    Returns DoubleAdder instances by name.
    
    Parameters:
    
    name - - name of object
    
    Returns:
    
    LongAdder object
  - getCountDownLatch
```
 name)
```
    Returns countDownLatch instance by name.
    
    Parameters:
    
    name - - name of object
    
    Returns:
    
    CountDownLatch object
  - getBitSet
```
 name)
```
    Returns bitSet instance by name.
    
    Parameters:
    
    name - - name of object
    
    Returns:
    
    BitSet object
  - getBloomFilter
```
<V>  name)
```
    Returns bloom filter instance by name.
    
    Type Parameters:
    
    V - type of value
    
    Parameters:
    
    name - - name of object
    
    Returns:
    
    BloomFilter object
  - getBloomFilter
```
<V>  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
  - getIdGenerator
```
 name)
```
    Returns id generator by name.
    
    Parameters:
    
    name - - name of object
    
    Returns:
    
    IdGenerator object
  - getScript
```
RScript getScript()
```
    Returns script operations object
    
    Returns:
    
    Script object
  - getScript
```
RScript getScript(Codec codec)
```
    Returns script operations object using provided codec.
    
    Parameters:
    
    codec - - codec for params and result
    
    Returns:
    
    Script object
  - getExecutorService
```
 name)
```
    Returns ScheduledExecutorService by name
    
    Parameters:
    
    name - - name of object
    
    Returns:
    
    ScheduledExecutorService object
  - getExecutorService
```
 name,
                                             ExecutorOptions options)
```
    Returns ScheduledExecutorService by name
    
    Parameters:
    
    name - - name of object
    
    options - - options for executor
    
    Returns:
    
    ScheduledExecutorService object
  - getExecutorService
```
 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
  - getExecutorService
```
 name,
                                             Codec codec,
                                             ExecutorOptions options)
```
    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
    
    options - - options for executor
    
    Returns:
    
    ScheduledExecutorService object
  - 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
```
 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
```
 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
  - createTransaction
```
RTransaction createTransaction(TransactionOptions options)
```
    Creates transaction with READ_COMMITTED isolation level.
    
    Parameters:
    
    options - - transaction configuration
    
    Returns:
    
    Transaction object
  - createBatch
```
RBatch createBatch(BatchOptions options)
```
    Creates batch object which could be executed later with collected group of commands in pipeline mode.
    See
    
    Parameters:
    
    options - - batch configuration
    
    Returns:
    
    Batch object
  - createBatch
```
RBatch createBatch()
```
    Creates batch object which could be executed later with collected group of commands in pipeline mode.
    See
    
    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
  - rxJava
```
RedissonRxClient rxJava()
```
    Returns RxJava Redisson instance
    
    Returns:
    
    redisson instance
  - reactive
```
RedissonReactiveClient reactive()
```
    Returns Reactive Redisson instance
    
    Returns:
    
    redisson instance
  - shutdown
```
void shutdown()
```
    Shutdown Redisson instance but NOT Redis server This equates to invoke shutdown(0, 2, TimeUnit.SECONDS);
  - shutdown
```
void shutdown(long quietPeriod,
              long timeout,
               unit)
```
    Shuts down Redisson instance but 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
  - getRedisNodes
```
<T extends BaseRedisNodes> T getRedisNodes(RedisNodes<T> nodes)
```
    Returns API to manage Redis nodes
    
    Type Parameters:
    
    T - type of Redis nodes API
    
    Parameters:
    
    nodes - Redis nodes API class
    
    Returns:
    
    Redis nodes API object
    
    See Also:
    
    RedisNodes.CLUSTER, RedisNodes.MASTER_SLAVE, RedisNodes.SENTINEL_MASTER_SLAVE, RedisNodes.SINGLE
  - getNodesGroup
```
NodesGroup<Node> getNodesGroup()
```
    Deprecated.
  - getClusterNodesGroup
```
ClusterNodesGroup getClusterNodesGroup()
```
    Deprecated.
  - isShutdown
```
boolean isShutdown()
```
    Returns true if this Redisson instance has been shut down.
    
    Returns:
    
    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.
  - getId
```
 getId()
```
    Returns id of this Redisson instance
    
    Returns:
    
    id

Interface RedissonClient

Method Summary

Method Detail

getTimeSeries

getTimeSeries

getStream

getStream

getRateLimiter

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

getSpinLock

getSpinLock

getMultiLock

getRedLock

getFairLock

getReadWriteLock

getSet

getSet

getSortedSet

getSortedSet

getScoredSortedSet

getScoredSortedSet

getLexSortedSet

getTopic

getTopic

getReliableTopic

getReliableTopic

getPatternTopic

getPatternTopic

getQueue

getTransferQueue

getTransferQueue

getDelayedQueue

getQueue

getRingBuffer

getRingBuffer

getPriorityQueue

getPriorityQueue

getPriorityBlockingQueue

getPriorityBlockingQueue

getPriorityBlockingDeque

getPriorityBlockingDeque

getPriorityDeque

getPriorityDeque

getBlockingQueue

getBlockingQueue

getBoundedBlockingQueue

getBoundedBlockingQueue