Package 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
See Also:

  • Method Details

    • getTimeSeries

      <V, L> RTimeSeriesReactive<V,L> getTimeSeries(String name)
      Returns time-series instance by name
      Type Parameters:
      V - value type
      L - label type
      Parameters:
      name - name of instance
      Returns:
      RTimeSeries object

    • getTimeSeries

      <V, L> RTimeSeriesReactive<V,L> getTimeSeries(String name, Codec codec)
      Returns time-series instance by name using provided codec for values.
      Type Parameters:
      V - value type
      L - label type
      Parameters:
      name - name of instance
      codec - codec for values
      Returns:
      RTimeSeries object

    • getTimeSeries

      <V, L> RTimeSeriesReactive<V,L> getTimeSeries(PlainOptions options)
      Returns time-series instance with specified options.
      Type Parameters:
      V - value type
      L - label type
      Parameters:
      options - instance options
      Returns:
      RTimeSeries object

    • getStream

      <K, V> RStreamReactive<K,V> getStream(String 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> RStreamReactive<K,V> getStream(String 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

    • getStream

      <K, V> RStreamReactive<K,V> getStream(PlainOptions options)
      Returns time-series instance with specified options.

      Requires Redis 5.0.0 and higher.

      Type Parameters:
      K - type of key
      V - type of value
      Parameters:
      options - instance options
      Returns:
      RStream object

    • getSearch

      RSearchReactive getSearch()
      Returns API for RediSearch module
      Returns:
      RSearch object

    • getSearch

      RSearchReactive getSearch(Codec codec)
      Returns API for RediSearch module using defined codec for attribute values.
      Returns:
      RSearch object

    • getSearch

      RSearchReactive getSearch(OptionalOptions options)
      Returns API for RediSearch module with specified options.
      Parameters:
      options - instance options
      Returns:
      RSearch object

    • getGeo

      <V> RGeoReactive<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> RGeoReactive<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

    • getGeo

      <V> RGeoReactive<V> getGeo(PlainOptions options)
      Returns geospatial items holder instance with specified options.
      Type Parameters:
      V - type of value
      Parameters:
      options - instance options
      Returns:
      Geo object

    • getRateLimiter

      RRateLimiterReactive getRateLimiter(String name)
      Returns rate limiter instance by name
      Parameters:
      name - of rate limiter
      Returns:
      RateLimiter object

    • getRateLimiter

      RRateLimiterReactive getRateLimiter(CommonOptions options)
      Returns rate limiter instance with specified options.
      Parameters:
      options - instance options
      Returns:
      RateLimiter object

    • getBinaryStream

      RBinaryStreamReactive getBinaryStream(String name)
      Returns binary stream holder instance by name
      Parameters:
      name - of binary stream
      Returns:
      BinaryStream object

    • getBinaryStream

      RBinaryStreamReactive getBinaryStream(CommonOptions options)
      Returns binary stream holder instance with specified options.
      Parameters:
      options - instance options
      Returns:
      BinaryStream object

    • getSemaphore

      RSemaphoreReactive getSemaphore(String name)
      Returns semaphore instance by name
      Parameters:
      name - name of object
      Returns:
      Semaphore object

    • getSemaphore

      RSemaphoreReactive getSemaphore(CommonOptions options)
      Returns semaphore instance with specified options.
      Parameters:
      options - instance options
      Returns:
      Semaphore object

    • getPermitExpirableSemaphore

      RPermitExpirableSemaphoreReactive getPermitExpirableSemaphore(String name)
      Returns semaphore instance by name. Supports lease time parameter for each acquired permit.
      Parameters:
      name - name of object
      Returns:
      PermitExpirableSemaphore object

    • getPermitExpirableSemaphore

      RPermitExpirableSemaphoreReactive getPermitExpirableSemaphore(CommonOptions options)
      Returns semaphore instance with specified options. Supports lease time parameter for each acquired permit.
      Parameters:
      options - instance options
      Returns:
      PermitExpirableSemaphore object

    • getReadWriteLock

      RReadWriteLockReactive getReadWriteLock(String 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

    • getReadWriteLock

      RReadWriteLockReactive getReadWriteLock(CommonOptions options)
      Returns ReadWriteLock instance with specified options.

      To increase reliability during failover, all operations wait for propagation to all Redis slaves.

      Parameters:
      options - instance options
      Returns:
      Lock object

    • getFairLock

      RLockReactive getFairLock(String 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

    • getFairLock

      RLockReactive getFairLock(CommonOptions options)
      Returns Lock instance with specified options.

      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:
      options - instance options
      Returns:
      Lock object

    • getLock

      RLockReactive getLock(String 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

    • getLock

      RLockReactive getLock(CommonOptions options)
      Returns Lock instance with specified options.

      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:
      options - instance options
      Returns:
      Lock object

    • getSpinLock

      RLockReactive getSpinLock(String 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

      RLockReactive getSpinLock(String 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

    • getFencedLock

      RFencedLockReactive getFencedLock(String name)
      Returns Fenced Lock by name.

      Implements a non-fair locking so doesn't guarantee an acquire order by threads.

      Parameters:
      name - name of object
      Returns:
      Lock object

    • getFencedLock

      RFencedLockReactive getFencedLock(CommonOptions options)
      Returns Fenced Lock instance with specified options..

      Implements a non-fair locking so doesn't guarantee an acquire order by threads.

      Parameters:
      options - instance options
      Returns:
      Lock object

    • getMultiLock

      RLockReactive getMultiLock(RLockReactive... locks)
      Returns MultiLock instance associated with specified locks
      Parameters:
      locks - collection of locks
      Returns:
      MultiLock object

    • getMultiLock

      RLockReactive getMultiLock(String group, Collection<Object> values)
      Returns RedissonFasterMultiLock instance associated with specified group and values
      Parameters:
      group - the group of values
      values - lock values
      Returns:
      BatchLock object

    • getMultiLock

      @Deprecated RLockReactive getMultiLock(RLock... locks)
      Deprecated.

    • getRedLock

      @Deprecated RLockReactive getRedLock(RLock... locks)
      Deprecated.

    • getCountDownLatch

      RCountDownLatchReactive getCountDownLatch(String name)
      Returns CountDownLatch instance by name.
      Parameters:
      name - name of object
      Returns:
      CountDownLatch object

    • getCountDownLatch

      RCountDownLatchReactive getCountDownLatch(CommonOptions options)
      Returns countDownLatch instance with specified options.
      Parameters:
      options - instance options
      Returns:
      CountDownLatch object

    • 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).

      Type Parameters:
      V - type of values
      Parameters:
      name - name of object
      Returns:
      SetCache object

    • 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).

      Type Parameters:
      V - type of values
      Parameters:
      name - name of object
      codec - codec for values
      Returns:
      SetCache object

    • getSetCache

      <V> RSetCacheReactive<V> getSetCache(PlainOptions options)
      Returns set-based cache instance with specified options. Supports value eviction with a given TTL value.

      If eviction is not required then it's better to use regular map getSet(PlainOptions).

      Type Parameters:
      V - type of value
      Parameters:
      options - instance options
      Returns:
      SetCache object

    • 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 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 keys
      V - type of values
      Parameters:
      name - name of object
      codec - codec for values
      Returns:
      MapCache object

    • getMapCache

      @Deprecated <K, V> RMapCacheReactive<K,V> getMapCache(String name, Codec codec, MapCacheOptions<K,V> options)
      Deprecated.
      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, MapOptions).

      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> RMapCacheReactive<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 keys
      V - type of values
      Parameters:
      name - name of object
      Returns:
      MapCache object

    • getMapCache

      @Deprecated <K, V> RMapCacheReactive<K,V> getMapCache(String name, MapCacheOptions<K,V> options)
      Deprecated.
      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, MapOptions).

      Type Parameters:
      K - type of key
      V - type of value
      Parameters:
      name - name of object
      options - map options
      Returns:
      MapCache object

    • getMapCache

      <K, V> RMapCacheReactive<K,V> getMapCache(MapCacheOptions<K,V> options)
      Returns map-based cache instance with specified options. Supports entry eviction with a given MaxIdleTime and TTL settings.

      If eviction is not required then it's better to use regular map getMap(org.redisson.api.options.MapOptions).

      Type Parameters:
      K - type of key
      V - type of value
      Parameters:
      options - instance options
      Returns:
      MapCache object

    • getMapCacheNative

      <K, V> RMapCacheNativeReactive<K,V> getMapCacheNative(String name)
      Returns map instance by name. Supports entry eviction with a given TTL.

      Requires Redis 7.4.0 and higher.

      Type Parameters:
      K - type of key
      V - type of value
      Parameters:
      name - name of object
      Returns:
      Map object

    • getMapCacheNative

      <K, V> RMapCacheNativeReactive<K,V> getMapCacheNative(String name, Codec codec)
      Returns map instance by name using provided codec for both map keys and values. Supports entry eviction with a given TTL.

      Requires Redis 7.4.0 and higher.

      Type Parameters:
      K - type of key
      V - type of value
      Parameters:
      name - name of object
      codec - codec for keys and values
      Returns:
      Map object

    • getMapCacheNative

      <K, V> RMapCacheNativeReactive<K,V> getMapCacheNative(MapOptions<K,V> options)
      Returns map instance. Supports entry eviction with a given TTL. Configured by the parameters of the options-object.

      Requires Redis 7.4.0 and higher.

      Type Parameters:
      K - type of key
      V - type of value
      Parameters:
      options - instance options
      Returns:
      Map object

    • getBucket

      <V> RBucketReactive<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> RBucketReactive<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 value
      Returns:
      Bucket object

    • getBucket

      <V> RBucketReactive<V> getBucket(PlainOptions options)
      Returns object holder instance with specified options.
      Type Parameters:
      V - type of value
      Parameters:
      options - instance options
      Returns:
      Bucket object

    • getBuckets

      RBucketsReactive getBuckets()
      Returns interface for mass operations with Bucket objects.
      Returns:
      Buckets

    • getBuckets

      RBucketsReactive getBuckets(Codec codec)
      Returns interface for mass operations with Bucket objects using provided codec for object.
      Parameters:
      codec - codec for bucket objects
      Returns:
      Buckets

    • getBuckets

      RBucketsReactive getBuckets(OptionalOptions options)
      Returns API for mass operations over Bucket objects with specified options.
      Parameters:
      options - instance options
      Returns:
      Buckets object

    • findBuckets

      @Deprecated <V> List<RBucketReactive<V>> findBuckets(String pattern)
      Deprecated.
      Use getBuckets() instead.
      Type Parameters:
      V - type of value
      Parameters:
      pattern - pattern for name of buckets
      Returns:
      list of buckets

    • getJsonBucket

      <V> RJsonBucketReactive<V> getJsonBucket(String name, JsonCodec codec)
      Returns JSON data holder instance by name using provided codec.
      Type Parameters:
      V - type of value
      Parameters:
      name - name of object
      codec - codec for values
      Returns:
      JsonBucket object

    • getJsonBucket

      <V> RJsonBucketReactive<V> getJsonBucket(JsonBucketOptions<V> options)
      Returns JSON data holder instance with specified options.
      Type Parameters:
      V - type of value
      Parameters:
      options - instance options
      Returns:
      JsonBucket object

    • getJsonBuckets

      RJsonBucketsReactive getJsonBuckets(JsonCodec codec)
      Returns API for mass operations over JsonBucket objects using provided codec for JSON object with default path.
      Parameters:
      codec - using provided codec for JSON object with default path.
      Returns:
      JsonBuckets

    • getHyperLogLog

      <V> RHyperLogLogReactive<V> getHyperLogLog(String name)
      Returns HyperLogLog instance by name.
      Type Parameters:
      V - type of values
      Parameters:
      name - name of object
      Returns:
      HyperLogLog object

    • getHyperLogLog

      <V> RHyperLogLogReactive<V> getHyperLogLog(String name, Codec codec)
      Returns HyperLogLog instance by name using provided codec for hll objects.
      Type Parameters:
      V - type of values
      Parameters:
      name - name of object
      codec - codec of values
      Returns:
      HyperLogLog object

    • getHyperLogLog

      <V> RHyperLogLogReactive<V> getHyperLogLog(PlainOptions options)
      Returns HyperLogLog instance with specified options.
      Type Parameters:
      V - type of value
      Parameters:
      options - instance options
      Returns:
      HyperLogLog object

    • getIdGenerator

      RIdGeneratorReactive getIdGenerator(String name)
      Returns id generator by name.
      Parameters:
      name - name of object
      Returns:
      IdGenerator object

    • getIdGenerator

      RIdGeneratorReactive getIdGenerator(CommonOptions options)
      Returns id generator instance with specified options.
      Parameters:
      options - instance options
      Returns:
      IdGenerator object

    • getList

      <V> RListReactive<V> getList(String name)
      Returns list instance by name.
      Type Parameters:
      V - type of values
      Parameters:
      name - name of object
      Returns:
      List object

    • getList

      <V> RListReactive<V> getList(String name, Codec codec)
      Returns list instance by name using provided codec for list objects.
      Type Parameters:
      V - type of values
      Parameters:
      name - name of object
      codec - codec for values
      Returns:
      List object

    • getList

      <V> RListReactive<V> getList(PlainOptions options)
      Returns list instance with specified options.
      Type Parameters:
      V - type of value
      Parameters:
      options - instance options
      Returns:
      List object

    • getListMultimap

      <K, V> RListMultimapReactive<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> RListMultimapReactive<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:
      RListMultimapReactive object

    • getListMultimap

      <K, V> RListMultimapReactive<K,V> getListMultimap(PlainOptions options)
      Returns List based Multimap instance with specified options.
      Type Parameters:
      K - type of key
      V - type of value
      Parameters:
      options - instance options
      Returns:
      ListMultimap object

    • getListMultimapCache

      <K, V> RListMultimapCacheReactive<K,V> getListMultimapCache(String name)
      Returns List based Multimap cache instance by name. Supports key eviction by specifying a time to live. If eviction is not required then it's better to use regular list multimap getListMultimap(String).
      Type Parameters:
      K - type of key
      V - type of value
      Parameters:
      name - name of object
      Returns:
      RListMultimapCacheReactive object

    • getListMultimapCache

      <K, V> RListMultimapCacheReactive<K,V> getListMultimapCache(String name, Codec codec)
      Returns List based Multimap cache instance by name using provided codec for both map keys and values. Supports key eviction by specifying a time to live. If eviction is not required then it's better to use regular list multimap getListMultimap(String, Codec).
      Type Parameters:
      K - type of key
      V - type of value
      Parameters:
      name - name of object
      codec - codec for keys and values
      Returns:
      RListMultimapCacheReactive object

    • getListMultimapCache

      <K, V> RListMultimapCacheReactive<K,V> getListMultimapCache(PlainOptions options)
      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:
      options - instance options
      Returns:
      ListMultimapCache object

    • getListMultimapCacheNative

      <K, V> RListMultimapCacheNativeReactive<K,V> getListMultimapCacheNative(String name)
      Returns List based Multimap instance by name. Supports key-entry eviction with a given TTL value. Stores insertion order and allows duplicates for values mapped to key.

      Uses Redis native commands for entry expiration and not a scheduled eviction task.

      Requires Redis 7.4.0 and higher.

      Type Parameters:
      K - type of key
      V - type of value
      Parameters:
      name - name of object
      Returns:
      ListMultimapCache object

    • getListMultimapCacheNative

      <K, V> RListMultimapCacheNativeReactive<K,V> getListMultimapCacheNative(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. Stores insertion order and allows duplicates for values mapped to key.

      Uses Redis native commands for entry expiration and not a scheduled eviction task.

      Requires Redis 7.4.0 and higher.

      Type Parameters:
      K - type of key
      V - type of value
      Parameters:
      name - name of object
      codec - codec for keys and values
      Returns:
      ListMultimapCache object

    • getListMultimapCacheNative

      <K, V> RListMultimapCacheNativeReactive<K,V> getListMultimapCacheNative(PlainOptions options)
      Returns List based Multimap instance by name. Supports key-entry eviction with a given TTL value. Stores insertion order and allows duplicates for values mapped to key.

      Uses Redis native commands for entry expiration and not a scheduled eviction task.

      Requires Redis 7.4.0 and higher.

      Type Parameters:
      K - type of key
      V - type of value
      Parameters:
      options - instance options
      Returns:
      ListMultimapCache object

    • getSetMultimap

      <K, V> RSetMultimapReactive<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> RSetMultimapReactive<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

    • getSetMultimap

      <K, V> RSetMultimapReactive<K,V> getSetMultimap(PlainOptions options)
      Returns Set based Multimap instance with specified options.
      Type Parameters:
      K - type of key
      V - type of value
      Parameters:
      options - instance options
      Returns:
      SetMultimap object

    • getSetMultimapCache

      <K, V> RSetMultimapCacheReactive<K,V> getSetMultimapCache(String name)
      Returns Set based Multimap cache instance by name. Supports key eviction by specifying a time to live. If eviction is not required then it's better to use regular set multimap getSetMultimap(String).
      Type Parameters:
      K - type of key
      V - type of value
      Parameters:
      name - name of object
      Returns:
      RSetMultimapCacheReactive object

    • getSetMultimapCache

      <K, V> RSetMultimapCacheReactive<K,V> getSetMultimapCache(String name, Codec codec)
      Returns Set based Multimap cache instance by name using provided codec for both map keys and values. Supports key eviction by specifying a time to live. If eviction is not required then it's better to use regular set multimap 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:
      RSetMultimapCacheReactive object

    • getSetMultimapCache

      <K, V> RSetMultimapCacheReactive<K,V> getSetMultimapCache(PlainOptions options)
      Returns Set based Multimap instance with specified options. Supports key-entry eviction with a given TTL value.

      If eviction is not required then it's better to use regular map getSetMultimap(PlainOptions).

      Type Parameters:
      K - type of key
      V - type of value
      Parameters:
      options - instance options
      Returns:
      SetMultimapCache object

    • getSetMultimapCacheNative

      <K, V> RSetMultimapCacheNativeReactive<K,V> getSetMultimapCacheNative(String name)
      Returns Set based Multimap instance by name. Supports key-entry eviction with a given TTL value. Doesn't allow duplications for values mapped to key.

      Uses Redis native commands for entry expiration and not a scheduled eviction task.

      Requires Redis 7.4.0 and higher.

      Type Parameters:
      K - type of key
      V - type of value
      Parameters:
      name - name of object
      Returns:
      SetMultimapCache object

    • getSetMultimapCacheNative

      <K, V> RSetMultimapCacheNativeReactive<K,V> getSetMultimapCacheNative(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. Doesn't allow duplications for values mapped to key.

      Uses Redis native commands for entry expiration and not a scheduled eviction task.

      Requires Redis 7.4.0 and higher.

      Type Parameters:
      K - type of key
      V - type of value
      Parameters:
      name - name of object
      codec - codec for keys and values
      Returns:
      SetMultimapCache object

    • getSetMultimapCacheNative

      <K, V> RSetMultimapCacheNativeReactive<K,V> getSetMultimapCacheNative(PlainOptions options)
      Returns Set based Multimap instance with specified options. Supports key-entry eviction with a given TTL value. Doesn't allow duplications for values mapped to key.

      Uses Redis native commands for entry expiration and not a scheduled eviction task.

      Requires Redis 7.4.0 and higher.

      Type Parameters:
      K - type of key
      V - type of value
      Parameters:
      options - instance options
      Returns:
      SetMultimapCache object

    • getMap

      <K, V> RMapReactive<K,V> getMap(String name)
      Returns map instance by name.
      Type Parameters:
      K - type of keys
      V - type of values
      Parameters:
      name - name of object
      Returns:
      Map object

    • getMap

      @Deprecated <K, V> RMapReactive<K,V> getMap(String name, MapOptions<K,V> options)
      Deprecated.
      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> RMapReactive<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 keys
      V - type of values
      Parameters:
      name - name of object
      codec - codec for keys and values
      Returns:
      Map object

    • getMap

      @Deprecated <K, V> RMapReactive<K,V> getMap(String name, Codec codec, MapOptions<K,V> options)
      Deprecated.
      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

    • getMap

      <K, V> RMapReactive<K,V> getMap(MapOptions<K,V> options)
      Returns map instance by name.
      Type Parameters:
      K - type of key
      V - type of value
      Parameters:
      options - instance options
      Returns:
      Map object

    • getLocalCachedMap

      @Deprecated <K, V> RLocalCachedMapReactive<K,V> getLocalCachedMap(String name, LocalCachedMapOptions<K,V> options)
      Deprecated.
      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

      @Deprecated <K, V> RLocalCachedMapReactive<K,V> getLocalCachedMap(String name, Codec codec, LocalCachedMapOptions<K,V> options)
      Deprecated.
      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

    • getLocalCachedMap

      <K, V> RLocalCachedMapReactive<K,V> getLocalCachedMap(LocalCachedMapOptions<K,V> options)
      Returns local cached map instance with specified options.
      Type Parameters:
      K - type of key
      V - type of value
      Parameters:
      options - instance options
      Returns:
      LocalCachedMap object

    • getSet

      <V> RSetReactive<V> getSet(String name)
      Returns set instance by name.
      Type Parameters:
      V - type of values
      Parameters:
      name - name of object
      Returns:
      Set object

    • getSet

      <V> RSetReactive<V> getSet(String name, Codec codec)
      Returns set instance by name using provided codec for set objects.
      Type Parameters:
      V - type of values
      Parameters:
      name - name of set
      codec - codec for values
      Returns:
      Set object

    • getSet

      <V> RSetReactive<V> getSet(PlainOptions options)
      Returns set instance with specified options.
      Type Parameters:
      V - type of value
      Parameters:
      options - instance options
      Returns:
      Set object

    • getScoredSortedSet

      <V> RScoredSortedSetReactive<V> getScoredSortedSet(String name)
      Returns Redis Sorted Set instance by name. This sorted set sorts objects by object score.
      Type Parameters:
      V - type of values
      Parameters:
      name - of scored sorted set
      Returns:
      ScoredSortedSet object

    • 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.
      Type Parameters:
      V - type of values
      Parameters:
      name - name of scored sorted set
      codec - codec for values
      Returns:
      ScoredSortedSet object

    • getScoredSortedSet

      <V> RScoredSortedSetReactive<V> getScoredSortedSet(PlainOptions options)
      Returns Redis Sorted Set instance with specified options. This sorted set sorts objects by object score.
      Type Parameters:
      V - type of value
      Parameters:
      options - instance options
      Returns:
      ScoredSortedSet object

    • 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 - name of object
      Returns:
      LexSortedSet object

    • getLexSortedSet

      RLexSortedSetReactive getLexSortedSet(CommonOptions options)
      Returns String based Redis Sorted Set instance with specified options. All elements are inserted with the same score during addition, in order to force lexicographical ordering
      Parameters:
      options - instance options
      Returns:
      LexSortedSet object

    • getShardedTopic

      RShardedTopicReactive getShardedTopic(String name)
      Returns Sharded Topic instance by name.

      Messages are delivered to message listeners connected to the same Topic.

      Parameters:
      name - name of object
      Returns:
      Topic object

    • getShardedTopic

      RShardedTopicReactive getShardedTopic(String name, Codec codec)
      Returns Sharded Topic instance by name using provided codec for messages.

      Messages are delivered to message listeners connected to the same Topic.

      Parameters:
      name - name of object
      codec - codec for message
      Returns:
      Topic object

    • getShardedTopic

      RShardedTopicReactive getShardedTopic(PlainOptions options)
      Returns Sharded Topic instance with specified options.

      Messages are delivered to message listeners connected to the same Topic.

      Parameters:
      options - instance options
      Returns:
      Topic object

    • getTopic

      RTopicReactive getTopic(String name)
      Returns topic instance by name.
      Parameters:
      name - name of object
      Returns:
      Topic object

    • getTopic

      RTopicReactive getTopic(String name, Codec codec)
      Returns topic instance by name using provided codec for messages.
      Parameters:
      name - name of object
      codec - codec for message
      Returns:
      Topic object

    • getTopic

      RTopicReactive getTopic(PlainOptions options)
      Returns topic instance with specified options.

      Messages are delivered to message listeners connected to the same Topic.

      Parameters:
      options - instance options
      Returns:
      Topic object

    • getReliableTopic

      RReliableTopicReactive getReliableTopic(String 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

      RReliableTopicReactive getReliableTopic(String 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

    • getReliableTopic

      RReliableTopicReactive getReliableTopic(PlainOptions options)
      Returns reliable topic instance with specified options.

      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:
      options - instance options
      Returns:
      ReliableTopic object

    • getPatternTopic

      RPatternTopicReactive 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:
      PatternTopic object

    • getPatternTopic

      RPatternTopicReactive 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
      codec - codec for message
      Returns:
      PatternTopic object

    • getPatternTopic

      RPatternTopicReactive getPatternTopic(PatternTopicOptions options)
      Returns topic instance satisfies pattern name and specified options.. 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:
      options - instance options
      Returns:
      PatterTopic object

    • getQueue

      <V> RQueueReactive<V> getQueue(String name)
      Returns queue instance by name.
      Type Parameters:
      V - type of values
      Parameters:
      name - name of object
      Returns:
      Queue object

    • getQueue

      <V> RQueueReactive<V> getQueue(String name, Codec codec)
      Returns queue instance by name using provided codec for queue objects.
      Type Parameters:
      V - type of values
      Parameters:
      name - name of object
      codec - codec for values
      Returns:
      Queue object

    • getQueue

      <V> RQueueReactive<V> getQueue(PlainOptions options)
      Returns unbounded queue instance with specified options.
      Type Parameters:
      V - type of value
      Parameters:
      options - instance options
      Returns:
      queue object

    • getRingBuffer

      <V> RRingBufferReactive<V> getRingBuffer(String name)
      Returns RingBuffer based queue.
      Type Parameters:
      V - value type
      Parameters:
      name - name of object
      Returns:
      RingBuffer object

    • getRingBuffer

      <V> RRingBufferReactive<V> getRingBuffer(String name, Codec codec)
      Returns RingBuffer based queue.
      Type Parameters:
      V - value type
      Parameters:
      name - name of object
      codec - codec for values
      Returns:
      RingBuffer object

    • getRingBuffer

      <V> RRingBufferReactive<V> getRingBuffer(PlainOptions options)
      Returns RingBuffer based queue instance with specified options.
      Type Parameters:
      V - value type
      Parameters:
      options - instance options
      Returns:
      RingBuffer object

    • getBlockingQueue

      <V> RBlockingQueueReactive<V> getBlockingQueue(String name)
      Returns blocking queue instance by name.
      Type Parameters:
      V - type of values
      Parameters:
      name - name of object
      Returns:
      BlockingQueue object

    • getBlockingQueue

      <V> RBlockingQueueReactive<V> getBlockingQueue(String name, Codec codec)
      Returns blocking 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:
      BlockingQueue object

    • getBlockingQueue

      <V> RBlockingQueueReactive<V> getBlockingQueue(PlainOptions options)
      Returns unbounded blocking queue instance with specified options.
      Type Parameters:
      V - type of value
      Parameters:
      options - instance options
      Returns:
      BlockingQueue object

    • getBlockingDeque

      <V> RBlockingDequeReactive<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> RBlockingDequeReactive<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

    • getBlockingDeque

      <V> RBlockingDequeReactive<V> getBlockingDeque(PlainOptions options)
      Returns unbounded blocking deque instance with specified options.
      Type Parameters:
      V - type of value
      Parameters:
      options - instance options
      Returns:
      BlockingDeque object

    • getTransferQueue

      <V> RTransferQueueReactive<V> getTransferQueue(String name)
      Returns transfer queue instance by name.
      Type Parameters:
      V - type of values
      Parameters:
      name - name of object
      Returns:
      TransferQueue object

    • getTransferQueue

      <V> RTransferQueueReactive<V> getTransferQueue(String 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

    • getTransferQueue

      <V> RTransferQueueReactive<V> getTransferQueue(PlainOptions options)
      Returns transfer queue instance with specified options.
      Type Parameters:
      V - type of values
      Parameters:
      options - instance options
      Returns:
      TransferQueue object

    • getDeque

      <V> RDequeReactive<V> getDeque(String name)
      Returns deque instance by name.
      Type Parameters:
      V - type of values
      Parameters:
      name - name of object
      Returns:
      Deque object

    • getDeque

      <V> RDequeReactive<V> getDeque(String name, Codec codec)
      Returns deque instance by name using provided codec for deque objects.
      Type Parameters:
      V - type of values
      Parameters:
      name - name of object
      codec - coded for values
      Returns:
      Deque object

    • getDeque

      <V> RDequeReactive<V> getDeque(PlainOptions options)
      Returns unbounded deque instance with specified options.
      Type Parameters:
      V - type of value
      Parameters:
      options - instance options
      Returns:
      Deque object

    • getAtomicLong

      RAtomicLongReactive getAtomicLong(String name)
      Returns "atomic long" instance by name.
      Parameters:
      name - of the "atomic long"
      Returns:
      AtomicLong object

    • getAtomicLong

      RAtomicLongReactive getAtomicLong(CommonOptions options)
      Returns atomicLong instance with specified options.
      Parameters:
      options - instance options
      Returns:
      AtomicLong object

    • getAtomicDouble

      RAtomicDoubleReactive getAtomicDouble(String name)
      Returns "atomic double" instance by name.
      Parameters:
      name - of the "atomic double"
      Returns:
      AtomicLong object

    • getAtomicDouble

      RAtomicDoubleReactive getAtomicDouble(CommonOptions options)
      Returns atomicDouble instance with specified options.
      Parameters:
      options - instance options
      Returns:
      AtomicDouble object

    • getRemoteService

      @Deprecated RRemoteService getRemoteService()
      Deprecated.
      Returns object for remote operations prefixed with the default name (redisson_remote_service)
      Returns:
      RemoteService object

    • getRemoteService

      @Deprecated RRemoteService getRemoteService(Codec codec)
      Deprecated.
      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

    • getRemoteService

      RRemoteService getRemoteService(PlainOptions options)
      Returns object for remote operations prefixed with specified options.
      Parameters:
      options - instance options
      Returns:
      RemoteService object

    • getBitSet

      RBitSetReactive getBitSet(String name)
      Returns bitSet instance by name.
      Parameters:
      name - name of object
      Returns:
      BitSet object

    • getBitSet

      RBitSetReactive getBitSet(CommonOptions options)
      Returns bitSet instance with specified options.
      Parameters:
      options - instance options
      Returns:
      BitSet object

    • getBloomFilter

      <V> RBloomFilterReactive<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> RBloomFilterReactive<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

    • getBloomFilter

      <V> RBloomFilterReactive<V> getBloomFilter(PlainOptions options)
      Returns bloom filter instance with specified options.
      Type Parameters:
      V - type of value
      Parameters:
      options - instance options
      Returns:
      BloomFilter object

    • getFunction

      RFunctionReactive getFunction()
      Returns interface for Redis Function feature
      Returns:
      function object

    • getFunction

      RFunctionReactive getFunction(Codec codec)
      Returns interface for Redis Function feature using provided codec
      Parameters:
      codec - codec for params and result
      Returns:
      function interface

    • getFunction

      RFunctionReactive getFunction(OptionalOptions options)
      Returns interface for Redis Function feature with specified options.
      Parameters:
      options - instance options
      Returns:
      function object

    • getScript

      RScriptReactive getScript()
      Returns script operations object
      Returns:
      Script object

    • getScript

      RScriptReactive getScript(Codec codec)
      Returns script operations object using provided codec.
      Parameters:
      codec - codec for params and result
      Returns:
      Script object

    • getScript

      RScriptReactive getScript(OptionalOptions options)
      Returns script operations object with specified options.
      Parameters:
      options - instance options
      Returns:
      Script object

    • createTransaction

      RTransactionReactive createTransaction(TransactionOptions options)
      Creates transaction with READ_COMMITTED isolation level.
      Parameters:
      options - transaction configuration
      Returns:
      Transaction object

    • createBatch

      RBatchReactive createBatch(BatchOptions options)
      Return batch object which executes group of command in pipeline. See http://redis.io/topics/pipelining
      Parameters:
      options - batch configuration
      Returns:
      Batch object

    • createBatch

      RBatchReactive createBatch()
      Return batch object which executes group of command in pipeline. See http://redis.io/topics/pipelining
      Returns:
      Batch object

    • getKeys

      RKeysReactive getKeys()
      Returns keys operations. Each of Redis/Redisson object associated with own key
      Returns:
      Keys object

    • getKeys

      RKeysReactive getKeys(KeysOptions options)
      Returns interface for operations over Redis keys with specified options. Each of Redis/Redisson object is associated with own key.
      Returns:
      Keys object

    • shutdown

      @Deprecated void shutdown()
      Deprecated.
      Use RedissonClient.shutdown() instead

    • 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

      @Deprecated NodesGroup<Node> getNodesGroup()
      Deprecated.
      Use RedissonClient.getRedisNodes(org.redisson.api.redisnode.RedisNodes) instead
      Returns:
      NodesGroup object

    • getClusterNodesGroup

      @Deprecated NodesGroup<ClusterNode> getClusterNodesGroup()
      Deprecated.
      Use RedissonClient.getRedisNodes(org.redisson.api.redisnode.RedisNodes) instead
      Returns:
      NodesGroup object

    • isShutdown

      boolean isShutdown()
      Returns true if this Redisson instance has been shut down.
      Returns:
      true if this Redisson instance has been shut down otherwise 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 otherwise false

    • getId

      String getId()
      Returns id of this Redisson instance
      Returns:
      id