Package org.redisson

Class RedissonRx

java.lang.Object
org.redisson.RedissonRx
All Implemented Interfaces:
RedissonRxClient
public final class RedissonRx extends Object implements RedissonRxClient
Main infrastructure class allows to get access to all Redisson objects on top of Redis server.
Author:
Nikita Koksharov

  • Method Details

    • getCommandExecutor

      public CommandRxExecutor getCommandExecutor()

    • getStream

      public <K, V> RStreamRx<K,V> getStream(String name)
      Description copied from interface: RedissonRxClient
      Returns stream instance by name

      Requires Redis 5.0.0 and higher.

      Specified by:
      getStream in interface RedissonRxClient
      Type Parameters:
      K - type of key
      V - type of value
      Parameters:
      name - of stream
      Returns:
      RStream object

    • getStream

      public <K, V> RStreamRx<K,V> getStream(String name, Codec codec)
      Description copied from interface: RedissonRxClient
      Returns stream instance by name using provided codec for entries.

      Requires Redis 5.0.0 and higher.

      Specified by:
      getStream in interface RedissonRxClient
      Type Parameters:
      K - type of key
      V - type of value
      Parameters:
      name - name of stream
      codec - codec for entry
      Returns:
      RStream object

    • getStream

      public <K, V> RStreamRx<K,V> getStream(PlainOptions options)
      Description copied from interface: RedissonRxClient
      Returns time-series instance with specified options.

      Requires Redis 5.0.0 and higher.

      Specified by:
      getStream in interface RedissonRxClient
      Type Parameters:
      K - type of key
      V - type of value
      Parameters:
      options - instance options
      Returns:
      RStream object

    • getSearch

      public RSearchRx getSearch()
      Description copied from interface: RedissonRxClient
      Returns API for RediSearch module
      Specified by:
      getSearch in interface RedissonRxClient
      Returns:
      RSearch object

    • getSearch

      public RSearchRx getSearch(Codec codec)
      Description copied from interface: RedissonRxClient
      Returns API for RediSearch module using defined codec for attribute values.
      Specified by:
      getSearch in interface RedissonRxClient
      Returns:
      RSearch object

    • getSearch

      public RSearchRx getSearch(OptionalOptions options)
      Description copied from interface: RedissonRxClient
      Returns API for RediSearch module with specified options.
      Specified by:
      getSearch in interface RedissonRxClient
      Parameters:
      options - instance options
      Returns:
      RSearch object

    • getGeo

      public <V> RGeoRx<V> getGeo(String name)
      Description copied from interface: RedissonRxClient
      Returns geospatial items holder instance by name.
      Specified by:
      getGeo in interface RedissonRxClient
      Type Parameters:
      V - type of value
      Parameters:
      name - name of object
      Returns:
      Geo object

    • getGeo

      public <V> RGeoRx<V> getGeo(String name, Codec codec)
      Description copied from interface: RedissonRxClient
      Returns geospatial items holder instance by name using provided codec for geospatial members.
      Specified by:
      getGeo in interface RedissonRxClient
      Type Parameters:
      V - type of value
      Parameters:
      name - name of object
      codec - codec for value
      Returns:
      Geo object

    • getGeo

      public <V> RGeoRx<V> getGeo(PlainOptions options)
      Description copied from interface: RedissonRxClient
      Returns geospatial items holder instance with specified options.
      Specified by:
      getGeo in interface RedissonRxClient
      Type Parameters:
      V - type of value
      Parameters:
      options - instance options
      Returns:
      Geo object

    • getFairLock

      public RLockRx getFairLock(String name)
      Description copied from interface: RedissonRxClient
      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.

      Specified by:
      getFairLock in interface RedissonRxClient
      Parameters:
      name - name of object
      Returns:
      Lock object

    • getFairLock

      public RLockRx getFairLock(CommonOptions options)
      Description copied from interface: RedissonRxClient
      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.

      Specified by:
      getFairLock in interface RedissonRxClient
      Parameters:
      options - instance options
      Returns:
      Lock object

    • getRateLimiter

      public RRateLimiterRx getRateLimiter(String name)
      Description copied from interface: RedissonRxClient
      Returns rate limiter instance by name
      Specified by:
      getRateLimiter in interface RedissonRxClient
      Parameters:
      name - of rate limiter
      Returns:
      RateLimiter object

    • getRateLimiter

      public RRateLimiterRx getRateLimiter(CommonOptions options)
      Description copied from interface: RedissonRxClient
      Returns rate limiter instance with specified options.
      Specified by:
      getRateLimiter in interface RedissonRxClient
      Parameters:
      options - instance options
      Returns:
      RateLimiter object

    • getBinaryStream

      public RBinaryStreamRx getBinaryStream(String name)
      Description copied from interface: RedissonRxClient
      Returns binary stream holder instance by name
      Specified by:
      getBinaryStream in interface RedissonRxClient
      Parameters:
      name - of binary stream
      Returns:
      BinaryStream object

    • getBinaryStream

      public RBinaryStreamRx getBinaryStream(CommonOptions options)
      Description copied from interface: RedissonRxClient
      Returns binary stream holder instance with specified options.
      Specified by:
      getBinaryStream in interface RedissonRxClient
      Parameters:
      options - instance options
      Returns:
      BinaryStream object

    • getSemaphore

      public RSemaphoreRx getSemaphore(String name)
      Description copied from interface: RedissonRxClient
      Returns semaphore instance by name
      Specified by:
      getSemaphore in interface RedissonRxClient
      Parameters:
      name - name of object
      Returns:
      Semaphore object

    • getSemaphore

      public RSemaphoreRx getSemaphore(CommonOptions options)
      Description copied from interface: RedissonRxClient
      Returns semaphore instance with specified options.
      Specified by:
      getSemaphore in interface RedissonRxClient
      Parameters:
      options - instance options
      Returns:
      Semaphore object

    • getPermitExpirableSemaphore

      public RPermitExpirableSemaphoreRx getPermitExpirableSemaphore(String name)
      Description copied from interface: RedissonRxClient
      Returns semaphore instance by name. Supports lease time parameter for each acquired permit.
      Specified by:
      getPermitExpirableSemaphore in interface RedissonRxClient
      Parameters:
      name - name of object
      Returns:
      PermitExpirableSemaphore object

    • getPermitExpirableSemaphore

      public RPermitExpirableSemaphoreRx getPermitExpirableSemaphore(CommonOptions options)
      Description copied from interface: RedissonRxClient
      Returns semaphore instance with specified options. Supports lease time parameter for each acquired permit.
      Specified by:
      getPermitExpirableSemaphore in interface RedissonRxClient
      Parameters:
      options - instance options
      Returns:
      PermitExpirableSemaphore object

    • getReadWriteLock

      public RReadWriteLockRx getReadWriteLock(String name)
      Description copied from interface: RedissonRxClient
      Returns ReadWriteLock instance by name.

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

      Specified by:
      getReadWriteLock in interface RedissonRxClient
      Parameters:
      name - name of object
      Returns:
      Lock object

    • getReadWriteLock

      public RReadWriteLockRx getReadWriteLock(CommonOptions options)
      Description copied from interface: RedissonRxClient
      Returns ReadWriteLock instance with specified options.

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

      Specified by:
      getReadWriteLock in interface RedissonRxClient
      Parameters:
      options - instance options
      Returns:
      Lock object

    • getLock

      public RLockRx getLock(String name)
      Description copied from interface: RedissonRxClient
      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.

      Specified by:
      getLock in interface RedissonRxClient
      Parameters:
      name - name of object
      Returns:
      Lock object

    • getLock

      public RLockRx getLock(CommonOptions options)
      Description copied from interface: RedissonRxClient
      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.

      Specified by:
      getLock in interface RedissonRxClient
      Parameters:
      options - instance options
      Returns:
      Lock object

    • getSpinLock

      public RLockRx getSpinLock(String name)
      Description copied from interface: RedissonRxClient
      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

      Specified by:
      getSpinLock in interface RedissonRxClient
      Parameters:
      name - name of object
      Returns:
      Lock object

    • getSpinLock

      public RLockRx getSpinLock(String name, LockOptions.BackOff backOff)
      Description copied from interface: RedissonRxClient
      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

      Specified by:
      getSpinLock in interface RedissonRxClient
      Parameters:
      name - name of object
      Returns:
      Lock object

    • getFencedLock

      public RFencedLockRx getFencedLock(String name)
      Description copied from interface: RedissonRxClient
      Returns Fenced Lock by name.

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

      Specified by:
      getFencedLock in interface RedissonRxClient
      Parameters:
      name - name of object
      Returns:
      Lock object

    • getFencedLock

      public RFencedLockRx getFencedLock(CommonOptions options)
      Description copied from interface: RedissonRxClient
      Returns Fenced Lock instance with specified options..

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

      Specified by:
      getFencedLock in interface RedissonRxClient
      Parameters:
      options - instance options
      Returns:
      Lock object

    • getMultiLock

      public RLockRx getMultiLock(RLockRx... locks)
      Description copied from interface: RedissonRxClient
      Returns MultiLock instance associated with specified locks
      Specified by:
      getMultiLock in interface RedissonRxClient
      Parameters:
      locks - collection of locks
      Returns:
      MultiLock object

    • getMultiLock

      public RLockRx getMultiLock(String group, Collection<Object> values)
      Description copied from interface: RedissonRxClient
      Returns RedissonFasterMultiLock instance associated with specified group and values
      Specified by:
      getMultiLock in interface RedissonRxClient
      Parameters:
      group - the group of values
      values - lock values
      Returns:
      BatchLock object

    • getMultiLock

      public RLockRx getMultiLock(RLock... locks)
      Specified by:
      getMultiLock in interface RedissonRxClient

    • getRedLock

      public RLockRx getRedLock(RLock... locks)
      Specified by:
      getRedLock in interface RedissonRxClient

    • getCountDownLatch

      public RCountDownLatchRx getCountDownLatch(String name)
      Description copied from interface: RedissonRxClient
      Returns CountDownLatch instance by name.
      Specified by:
      getCountDownLatch in interface RedissonRxClient
      Parameters:
      name - name of object
      Returns:
      CountDownLatch object

    • getCountDownLatch

      public RCountDownLatchRx getCountDownLatch(CommonOptions options)
      Description copied from interface: RedissonRxClient
      Returns countDownLatch instance with specified options.
      Specified by:
      getCountDownLatch in interface RedissonRxClient
      Parameters:
      options - instance options
      Returns:
      CountDownLatch object

    • getMapCache

      public <K, V> RMapCacheRx<K,V> getMapCache(String name, Codec codec)
      Description copied from interface: RedissonRxClient
      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 RedissonRxClient.getMap(String, Codec).

      Specified by:
      getMapCache in interface RedissonRxClient
      Type Parameters:
      K - type of keys
      V - type of values
      Parameters:
      name - name of object
      codec - codec for values
      Returns:
      MapCache object

    • getMapCache

      public <K, V> RMapCacheRx<K,V> getMapCache(String name)
      Description copied from interface: RedissonRxClient
      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 RedissonRxClient.getMap(String).

      Specified by:
      getMapCache in interface RedissonRxClient
      Type Parameters:
      K - type of keys
      V - type of values
      Parameters:
      name - name of object
      Returns:
      MapCache object

    • getMapCache

      public <K, V> RMapCacheRx<K,V> getMapCache(MapCacheOptions<K,V> options)
      Description copied from interface: RedissonRxClient
      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 RedissonRxClient.getMap(org.redisson.api.options.MapOptions).

      Specified by:
      getMapCache in interface RedissonRxClient
      Type Parameters:
      K - type of key
      V - type of value
      Parameters:
      options - instance options
      Returns:
      MapCache object

    • getBucket

      public <V> RBucketRx<V> getBucket(String name)
      Description copied from interface: RedissonRxClient
      Returns object holder instance by name
      Specified by:
      getBucket in interface RedissonRxClient
      Type Parameters:
      V - type of value
      Parameters:
      name - name of object
      Returns:
      Bucket object

    • getBucket

      public <V> RBucketRx<V> getBucket(String name, Codec codec)
      Description copied from interface: RedissonRxClient
      Returns object holder instance by name using provided codec for object.
      Specified by:
      getBucket in interface RedissonRxClient
      Type Parameters:
      V - type of value
      Parameters:
      name - name of object
      codec - codec for value
      Returns:
      Bucket object

    • getBucket

      public <V> RBucketRx<V> getBucket(PlainOptions options)
      Description copied from interface: RedissonRxClient
      Returns object holder instance with specified options.
      Specified by:
      getBucket in interface RedissonRxClient
      Type Parameters:
      V - type of value
      Parameters:
      options - instance options
      Returns:
      Bucket object

    • getBuckets

      public RBucketsRx getBuckets()
      Description copied from interface: RedissonRxClient
      Returns interface for mass operations with Bucket objects.
      Specified by:
      getBuckets in interface RedissonRxClient
      Returns:
      Buckets

    • getBuckets

      public RBucketsRx getBuckets(Codec codec)
      Description copied from interface: RedissonRxClient
      Returns interface for mass operations with Bucket objects using provided codec for object.
      Specified by:
      getBuckets in interface RedissonRxClient
      Parameters:
      codec - codec for bucket objects
      Returns:
      Buckets

    • getBuckets

      public RBucketsRx getBuckets(OptionalOptions options)
      Description copied from interface: RedissonRxClient
      Returns API for mass operations over Bucket objects with specified options.
      Specified by:
      getBuckets in interface RedissonRxClient
      Parameters:
      options - instance options
      Returns:
      Buckets object

    • getJsonBucket

      public <V> RJsonBucketRx<V> getJsonBucket(String name, JsonCodec codec)
      Description copied from interface: RedissonRxClient
      Returns JSON data holder instance by name using provided codec.
      Specified by:
      getJsonBucket in interface RedissonRxClient
      Type Parameters:
      V - type of value
      Parameters:
      name - name of object
      codec - codec for values
      Returns:
      JsonBucket object

    • getJsonBucket

      public <V> RJsonBucketRx<V> getJsonBucket(JsonBucketOptions<V> options)
      Description copied from interface: RedissonRxClient
      Returns JSON data holder instance with specified options.
      Specified by:
      getJsonBucket in interface RedissonRxClient
      Type Parameters:
      V - type of value
      Parameters:
      options - instance options
      Returns:
      JsonBucket object

    • getJsonBuckets

      public RJsonBucketsRx getJsonBuckets(JsonCodec codec)
      Description copied from interface: RedissonRxClient
      Returns API for mass operations over JsonBucket objects using provided codec for JSON object with default path.
      Specified by:
      getJsonBuckets in interface RedissonRxClient
      Parameters:
      codec - using provided codec for JSON object with default path.
      Returns:
      JsonBuckets

    • getHyperLogLog

      public <V> RHyperLogLogRx<V> getHyperLogLog(String name)
      Description copied from interface: RedissonRxClient
      Returns HyperLogLog instance by name.
      Specified by:
      getHyperLogLog in interface RedissonRxClient
      Type Parameters:
      V - type of values
      Parameters:
      name - name of object
      Returns:
      HyperLogLog object

    • getHyperLogLog

      public <V> RHyperLogLogRx<V> getHyperLogLog(String name, Codec codec)
      Description copied from interface: RedissonRxClient
      Returns HyperLogLog instance by name using provided codec for hll objects.
      Specified by:
      getHyperLogLog in interface RedissonRxClient
      Type Parameters:
      V - type of values
      Parameters:
      name - name of object
      codec - codec of values
      Returns:
      HyperLogLog object

    • getHyperLogLog

      public <V> RHyperLogLogRx<V> getHyperLogLog(PlainOptions options)
      Description copied from interface: RedissonRxClient
      Returns HyperLogLog instance with specified options.
      Specified by:
      getHyperLogLog in interface RedissonRxClient
      Type Parameters:
      V - type of value
      Parameters:
      options - instance options
      Returns:
      HyperLogLog object

    • getIdGenerator

      public RIdGeneratorRx getIdGenerator(String name)
      Description copied from interface: RedissonRxClient
      Returns id generator by name.
      Specified by:
      getIdGenerator in interface RedissonRxClient
      Parameters:
      name - name of object
      Returns:
      IdGenerator object

    • getIdGenerator

      public RIdGeneratorRx getIdGenerator(CommonOptions options)
      Description copied from interface: RedissonRxClient
      Returns id generator instance with specified options.
      Specified by:
      getIdGenerator in interface RedissonRxClient
      Parameters:
      options - instance options
      Returns:
      IdGenerator object

    • getList

      public <V> RListRx<V> getList(String name)
      Description copied from interface: RedissonRxClient
      Returns list instance by name.
      Specified by:
      getList in interface RedissonRxClient
      Type Parameters:
      V - type of values
      Parameters:
      name - name of object
      Returns:
      List object

    • getList

      public <V> RListRx<V> getList(String name, Codec codec)
      Description copied from interface: RedissonRxClient
      Returns list instance by name using provided codec for list objects.
      Specified by:
      getList in interface RedissonRxClient
      Type Parameters:
      V - type of values
      Parameters:
      name - name of object
      codec - codec for values
      Returns:
      List object

    • getList

      public <V> RListRx<V> getList(PlainOptions options)
      Description copied from interface: RedissonRxClient
      Returns list instance with specified options.
      Specified by:
      getList in interface RedissonRxClient
      Type Parameters:
      V - type of value
      Parameters:
      options - instance options
      Returns:
      List object

    • getListMultimap

      public <K, V> RListMultimapRx<K,V> getListMultimap(String name)
      Description copied from interface: RedissonRxClient
      Returns List based Multimap instance by name.
      Specified by:
      getListMultimap in interface RedissonRxClient
      Type Parameters:
      K - type of key
      V - type of value
      Parameters:
      name - name of object
      Returns:
      ListMultimap object

    • getListMultimap

      public <K, V> RListMultimapRx<K,V> getListMultimap(String name, Codec codec)
      Description copied from interface: RedissonRxClient
      Returns List based Multimap instance by name using provided codec for both map keys and values.
      Specified by:
      getListMultimap in interface RedissonRxClient
      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

      public <K, V> RListMultimapRx<K,V> getListMultimap(PlainOptions options)
      Description copied from interface: RedissonRxClient
      Returns List based Multimap instance with specified options.
      Specified by:
      getListMultimap in interface RedissonRxClient
      Type Parameters:
      K - type of key
      V - type of value
      Parameters:
      options - instance options
      Returns:
      ListMultimap object

    • getListMultimapCache

      public <K, V> RListMultimapCacheRx<K,V> getListMultimapCache(String name)
      Description copied from interface: RedissonRxClient
      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 RedissonRxClient.getListMultimap(String).
      Specified by:
      getListMultimapCache in interface RedissonRxClient
      Type Parameters:
      K - type of key
      V - type of value
      Parameters:
      name - name of object
      Returns:
      RListMultimapCacheRx object

    • getListMultimapCache

      public <K, V> RListMultimapCacheRx<K,V> getListMultimapCache(String name, Codec codec)
      Description copied from interface: RedissonRxClient
      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 RedissonRxClient.getListMultimap(String, Codec).
      Specified by:
      getListMultimapCache in interface RedissonRxClient
      Type Parameters:
      K - type of key
      V - type of value
      Parameters:
      name - name of object
      codec - codec for keys and values
      Returns:
      RListMultimapCacheRx object

    • getListMultimapCache

      public <K, V> RListMultimapCacheRx<K,V> getListMultimapCache(PlainOptions options)
      Description copied from interface: RedissonRxClient
      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 RedissonRxClient.getSetMultimap(String).

      Specified by:
      getListMultimapCache in interface RedissonRxClient
      Type Parameters:
      K - type of key
      V - type of value
      Parameters:
      options - instance options
      Returns:
      ListMultimapCache object

    • getListMultimapCacheNative

      public <K, V> RListMultimapCacheNativeRx<K,V> getListMultimapCacheNative(String name)
      Description copied from interface: RedissonRxClient
      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.

      Specified by:
      getListMultimapCacheNative in interface RedissonRxClient
      Type Parameters:
      K - type of key
      V - type of value
      Parameters:
      name - name of object
      Returns:
      ListMultimapCache object

    • getListMultimapCacheNative

      public <K, V> RListMultimapCacheNativeRx<K,V> getListMultimapCacheNative(String name, Codec codec)
      Description copied from interface: RedissonRxClient
      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.

      Specified by:
      getListMultimapCacheNative in interface RedissonRxClient
      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

      public <K, V> RListMultimapCacheNativeRx<K,V> getListMultimapCacheNative(PlainOptions options)
      Description copied from interface: RedissonRxClient
      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.

      Specified by:
      getListMultimapCacheNative in interface RedissonRxClient
      Type Parameters:
      K - type of key
      V - type of value
      Parameters:
      options - instance options
      Returns:
      ListMultimapCache object

    • getSetMultimap

      public <K, V> RSetMultimapRx<K,V> getSetMultimap(String name)
      Description copied from interface: RedissonRxClient
      Returns Set based Multimap instance by name.
      Specified by:
      getSetMultimap in interface RedissonRxClient
      Type Parameters:
      K - type of key
      V - type of value
      Parameters:
      name - name of object
      Returns:
      SetMultimap object

    • getSetMultimap

      public <K, V> RSetMultimapRx<K,V> getSetMultimap(String name, Codec codec)
      Description copied from interface: RedissonRxClient
      Returns Set based Multimap instance by name using provided codec for both map keys and values.
      Specified by:
      getSetMultimap in interface RedissonRxClient
      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

      public <K, V> RSetMultimapRx<K,V> getSetMultimap(PlainOptions options)
      Description copied from interface: RedissonRxClient
      Returns Set based Multimap instance with specified options.
      Specified by:
      getSetMultimap in interface RedissonRxClient
      Type Parameters:
      K - type of key
      V - type of value
      Parameters:
      options - instance options
      Returns:
      SetMultimap object

    • getSetMultimapCache

      public <K, V> RSetMultimapCacheRx<K,V> getSetMultimapCache(String name)
      Description copied from interface: RedissonRxClient
      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 RedissonRxClient.getSetMultimap(String).
      Specified by:
      getSetMultimapCache in interface RedissonRxClient
      Type Parameters:
      K - type of key
      V - type of value
      Parameters:
      name - name of object
      Returns:
      RSetMultimapCacheRx object

    • getSetMultimapCache

      public <K, V> RSetMultimapCacheRx<K,V> getSetMultimapCache(String name, Codec codec)
      Description copied from interface: RedissonRxClient
      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 RedissonRxClient.getSetMultimap(String, Codec).
      Specified by:
      getSetMultimapCache in interface RedissonRxClient
      Type Parameters:
      K - type of key
      V - type of value
      Parameters:
      name - name of object
      codec - codec for keys and values
      Returns:
      RSetMultimapCacheRx object

    • getSetMultimapCache

      public <K, V> RSetMultimapCacheRx<K,V> getSetMultimapCache(PlainOptions options)
      Description copied from interface: RedissonRxClient
      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 RedissonRxClient.getSetMultimap(PlainOptions).

      Specified by:
      getSetMultimapCache in interface RedissonRxClient
      Type Parameters:
      K - type of key
      V - type of value
      Parameters:
      options - instance options
      Returns:
      SetMultimapCache object

    • getSetMultimapCacheNative

      public <K, V> RSetMultimapCacheNativeRx<K,V> getSetMultimapCacheNative(String name)
      Description copied from interface: RedissonRxClient
      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.

      Specified by:
      getSetMultimapCacheNative in interface RedissonRxClient
      Type Parameters:
      K - type of key
      V - type of value
      Parameters:
      name - name of object
      Returns:
      SetMultimapCache object

    • getSetMultimapCacheNative

      public <K, V> RSetMultimapCacheNativeRx<K,V> getSetMultimapCacheNative(String name, Codec codec)
      Description copied from interface: RedissonRxClient
      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.

      Specified by:
      getSetMultimapCacheNative in interface RedissonRxClient
      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

      public <K, V> RSetMultimapCacheNativeRx<K,V> getSetMultimapCacheNative(PlainOptions options)
      Description copied from interface: RedissonRxClient
      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.

      Specified by:
      getSetMultimapCacheNative in interface RedissonRxClient
      Type Parameters:
      K - type of key
      V - type of value
      Parameters:
      options - instance options
      Returns:
      SetMultimapCache object

    • getMap

      public <K, V> RMapRx<K,V> getMap(String name)
      Description copied from interface: RedissonRxClient
      Returns map instance by name.
      Specified by:
      getMap in interface RedissonRxClient
      Type Parameters:
      K - type of keys
      V - type of values
      Parameters:
      name - name of object
      Returns:
      Map object

    • getMap

      public <K, V> RMapRx<K,V> getMap(String name, Codec codec)
      Description copied from interface: RedissonRxClient
      Returns map instance by name using provided codec for both map keys and values.
      Specified by:
      getMap in interface RedissonRxClient
      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

      public <K, V> RMapRx<K,V> getMap(MapOptions<K,V> options)
      Description copied from interface: RedissonRxClient
      Returns map instance by name.
      Specified by:
      getMap in interface RedissonRxClient
      Type Parameters:
      K - type of key
      V - type of value
      Parameters:
      options - instance options
      Returns:
      Map object

    • getSet

      public <V> RSetRx<V> getSet(String name)
      Description copied from interface: RedissonRxClient
      Returns set instance by name.
      Specified by:
      getSet in interface RedissonRxClient
      Type Parameters:
      V - type of values
      Parameters:
      name - name of object
      Returns:
      Set object

    • getSet

      public <V> RSetRx<V> getSet(String name, Codec codec)
      Description copied from interface: RedissonRxClient
      Returns set instance by name using provided codec for set objects.
      Specified by:
      getSet in interface RedissonRxClient
      Type Parameters:
      V - type of values
      Parameters:
      name - name of set
      codec - codec for values
      Returns:
      Set object

    • getSet

      public <V> RSetRx<V> getSet(PlainOptions options)
      Description copied from interface: RedissonRxClient
      Returns set instance with specified options.
      Specified by:
      getSet in interface RedissonRxClient
      Type Parameters:
      V - type of value
      Parameters:
      options - instance options
      Returns:
      Set object

    • getScoredSortedSet

      public <V> RScoredSortedSetRx<V> getScoredSortedSet(String name)
      Description copied from interface: RedissonRxClient
      Returns Redis Sorted Set instance by name. This sorted set sorts objects by object score.
      Specified by:
      getScoredSortedSet in interface RedissonRxClient
      Type Parameters:
      V - type of values
      Parameters:
      name - of scored sorted set
      Returns:
      ScoredSortedSet object

    • getScoredSortedSet

      public <V> RScoredSortedSetRx<V> getScoredSortedSet(String name, Codec codec)
      Description copied from interface: RedissonRxClient
      Returns Redis Sorted Set instance by name using provided codec for sorted set objects. This sorted set sorts objects by object score.
      Specified by:
      getScoredSortedSet in interface RedissonRxClient
      Type Parameters:
      V - type of values
      Parameters:
      name - name of scored sorted set
      codec - codec for values
      Returns:
      ScoredSortedSet object

    • getScoredSortedSet

      public <V> RScoredSortedSetRx<V> getScoredSortedSet(PlainOptions options)
      Description copied from interface: RedissonRxClient
      Returns Redis Sorted Set instance with specified options. This sorted set sorts objects by object score.
      Specified by:
      getScoredSortedSet in interface RedissonRxClient
      Type Parameters:
      V - type of value
      Parameters:
      options - instance options
      Returns:
      ScoredSortedSet object

    • getLexSortedSet

      public RLexSortedSetRx getLexSortedSet(String name)
      Description copied from interface: RedissonRxClient
      Returns String based Redis Sorted Set instance by name All elements are inserted with the same score during addition, in order to force lexicographical ordering
      Specified by:
      getLexSortedSet in interface RedissonRxClient
      Parameters:
      name - name of object
      Returns:
      LexSortedSet object

    • getLexSortedSet

      public RLexSortedSetRx getLexSortedSet(CommonOptions options)
      Description copied from interface: RedissonRxClient
      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
      Specified by:
      getLexSortedSet in interface RedissonRxClient
      Parameters:
      options - instance options
      Returns:
      LexSortedSet object

    • getShardedTopic

      public RShardedTopicRx getShardedTopic(String name)
      Description copied from interface: RedissonRxClient
      Returns Sharded Topic instance by name.

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

      Specified by:
      getShardedTopic in interface RedissonRxClient
      Parameters:
      name - name of object
      Returns:
      Topic object

    • getShardedTopic

      public RShardedTopicRx getShardedTopic(String name, Codec codec)
      Description copied from interface: RedissonRxClient
      Returns Sharded Topic instance by name using provided codec for messages.

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

      Specified by:
      getShardedTopic in interface RedissonRxClient
      Parameters:
      name - name of object
      codec - codec for message
      Returns:
      Topic object

    • getShardedTopic

      public RShardedTopicRx getShardedTopic(PlainOptions options)
      Description copied from interface: RedissonRxClient
      Returns Sharded Topic instance with specified options.

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

      Specified by:
      getShardedTopic in interface RedissonRxClient
      Parameters:
      options - instance options
      Returns:
      Topic object

    • getTopic

      public RTopicRx getTopic(String name)
      Description copied from interface: RedissonRxClient
      Returns topic instance by name.
      Specified by:
      getTopic in interface RedissonRxClient
      Parameters:
      name - name of object
      Returns:
      Topic object

    • getTopic

      public RTopicRx getTopic(String name, Codec codec)
      Description copied from interface: RedissonRxClient
      Returns topic instance by name using provided codec for messages.
      Specified by:
      getTopic in interface RedissonRxClient
      Parameters:
      name - name of object
      codec - codec for message
      Returns:
      Topic object

    • getTopic

      public RTopicRx getTopic(PlainOptions options)
      Description copied from interface: RedissonRxClient
      Returns topic instance with specified options.

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

      Specified by:
      getTopic in interface RedissonRxClient
      Parameters:
      options - instance options
      Returns:
      Topic object

    • getReliableTopic

      public RReliableTopicRx getReliableTopic(String name)
      Description copied from interface: RedissonRxClient
      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.

      Specified by:
      getReliableTopic in interface RedissonRxClient
      Parameters:
      name - name of object
      Returns:
      ReliableTopic object

    • getReliableTopic

      public RReliableTopicRx getReliableTopic(String name, Codec codec)
      Description copied from interface: RedissonRxClient
      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.

      Specified by:
      getReliableTopic in interface RedissonRxClient
      Parameters:
      name - name of object
      codec - codec for message
      Returns:
      ReliableTopic object

    • getReliableTopic

      public RReliableTopicRx getReliableTopic(PlainOptions options)
      Description copied from interface: RedissonRxClient
      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.

      Specified by:
      getReliableTopic in interface RedissonRxClient
      Parameters:
      options - instance options
      Returns:
      ReliableTopic object

    • getPatternTopic

      public RPatternTopicRx getPatternTopic(String pattern)
      Description copied from interface: RedissonRxClient
      Returns topic instance satisfies by pattern name. Supported glob-style patterns: h?llo subscribes to hello, hallo and hxllo h*llo subscribes to hllo and heeeello h[ae]llo subscribes to hello and hallo, but not hillo
      Specified by:
      getPatternTopic in interface RedissonRxClient
      Parameters:
      pattern - of the topic
      Returns:
      PatternTopic object

    • getPatternTopic

      public RPatternTopicRx getPatternTopic(String pattern, Codec codec)
      Description copied from interface: RedissonRxClient
      Returns topic instance satisfies by pattern name using provided codec for messages. Supported glob-style patterns: h?llo subscribes to hello, hallo and hxllo h*llo subscribes to hllo and heeeello h[ae]llo subscribes to hello and hallo, but not hillo
      Specified by:
      getPatternTopic in interface RedissonRxClient
      Parameters:
      pattern - of the topic
      codec - codec for message
      Returns:
      PatternTopic object

    • getPatternTopic

      public RPatternTopicRx getPatternTopic(PatternTopicOptions options)
      Description copied from interface: RedissonRxClient
      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
      Specified by:
      getPatternTopic in interface RedissonRxClient
      Parameters:
      options - instance options
      Returns:
      PatterTopic object

    • getQueue

      public <V> RQueueRx<V> getQueue(String name)
      Description copied from interface: RedissonRxClient
      Returns queue instance by name.
      Specified by:
      getQueue in interface RedissonRxClient
      Type Parameters:
      V - type of values
      Parameters:
      name - name of object
      Returns:
      Queue object

    • getQueue

      public <V> RQueueRx<V> getQueue(String name, Codec codec)
      Description copied from interface: RedissonRxClient
      Returns queue instance by name using provided codec for queue objects.
      Specified by:
      getQueue in interface RedissonRxClient
      Type Parameters:
      V - type of values
      Parameters:
      name - name of object
      codec - codec for values
      Returns:
      Queue object

    • getQueue

      public <V> RQueueRx<V> getQueue(PlainOptions options)
      Description copied from interface: RedissonRxClient
      Returns unbounded queue instance with specified options.
      Specified by:
      getQueue in interface RedissonRxClient
      Type Parameters:
      V - type of value
      Parameters:
      options - instance options
      Returns:
      queue object

    • getRingBuffer

      public <V> RRingBufferRx<V> getRingBuffer(String name)
      Description copied from interface: RedissonRxClient
      Returns RingBuffer based queue.
      Specified by:
      getRingBuffer in interface RedissonRxClient
      Type Parameters:
      V - value type
      Parameters:
      name - name of object
      Returns:
      RingBuffer object

    • getRingBuffer

      public <V> RRingBufferRx<V> getRingBuffer(String name, Codec codec)
      Description copied from interface: RedissonRxClient
      Returns RingBuffer based queue.
      Specified by:
      getRingBuffer in interface RedissonRxClient
      Type Parameters:
      V - value type
      Parameters:
      name - name of object
      codec - codec for values
      Returns:
      RingBuffer object

    • getRingBuffer

      public <V> RRingBufferRx<V> getRingBuffer(PlainOptions options)
      Description copied from interface: RedissonRxClient
      Returns RingBuffer based queue instance with specified options.
      Specified by:
      getRingBuffer in interface RedissonRxClient
      Type Parameters:
      V - value type
      Parameters:
      options - instance options
      Returns:
      RingBuffer object

    • getBlockingQueue

      public <V> RBlockingQueueRx<V> getBlockingQueue(String name)
      Description copied from interface: RedissonRxClient
      Returns blocking queue instance by name.
      Specified by:
      getBlockingQueue in interface RedissonRxClient
      Type Parameters:
      V - type of values
      Parameters:
      name - name of object
      Returns:
      BlockingQueue object

    • getBlockingQueue

      public <V> RBlockingQueueRx<V> getBlockingQueue(String name, Codec codec)
      Description copied from interface: RedissonRxClient
      Returns blocking queue instance by name using provided codec for queue objects.
      Specified by:
      getBlockingQueue in interface RedissonRxClient
      Type Parameters:
      V - type of values
      Parameters:
      name - name of object
      codec - code for values
      Returns:
      BlockingQueue object

    • getBlockingQueue

      public <V> RBlockingQueueRx<V> getBlockingQueue(PlainOptions options)
      Description copied from interface: RedissonRxClient
      Returns unbounded blocking queue instance with specified options.
      Specified by:
      getBlockingQueue in interface RedissonRxClient
      Type Parameters:
      V - type of value
      Parameters:
      options - instance options
      Returns:
      BlockingQueue object

    • getDeque

      public <V> RDequeRx<V> getDeque(String name)
      Description copied from interface: RedissonRxClient
      Returns deque instance by name.
      Specified by:
      getDeque in interface RedissonRxClient
      Type Parameters:
      V - type of values
      Parameters:
      name - name of object
      Returns:
      Deque object

    • getDeque

      public <V> RDequeRx<V> getDeque(String name, Codec codec)
      Description copied from interface: RedissonRxClient
      Returns deque instance by name using provided codec for deque objects.
      Specified by:
      getDeque in interface RedissonRxClient
      Type Parameters:
      V - type of values
      Parameters:
      name - name of object
      codec - coded for values
      Returns:
      Deque object

    • getDeque

      public <V> RDequeRx<V> getDeque(PlainOptions options)
      Description copied from interface: RedissonRxClient
      Returns unbounded deque instance with specified options.
      Specified by:
      getDeque in interface RedissonRxClient
      Type Parameters:
      V - type of value
      Parameters:
      options - instance options
      Returns:
      Deque object

    • getTimeSeries

      public <V, L> RTimeSeriesRx<V,L> getTimeSeries(String name)
      Description copied from interface: RedissonRxClient
      Returns time-series instance by name
      Specified by:
      getTimeSeries in interface RedissonRxClient
      Type Parameters:
      V - value type
      L - label type
      Parameters:
      name - name of instance
      Returns:
      RTimeSeries object

    • getTimeSeries

      public <V, L> RTimeSeriesRx<V,L> getTimeSeries(String name, Codec codec)
      Description copied from interface: RedissonRxClient
      Returns time-series instance by name using provided codec for values.
      Specified by:
      getTimeSeries in interface RedissonRxClient
      Type Parameters:
      V - value type
      L - label type
      Parameters:
      name - name of instance
      codec - codec for values
      Returns:
      RTimeSeries object

    • getTimeSeries

      public <V, L> RTimeSeriesRx<V,L> getTimeSeries(PlainOptions options)
      Description copied from interface: RedissonRxClient
      Returns time-series instance with specified options.
      Specified by:
      getTimeSeries in interface RedissonRxClient
      Type Parameters:
      V - value type
      L - label type
      Parameters:
      options - instance options
      Returns:
      RTimeSeries object

    • getSetCache

      public <V> RSetCacheRx<V> getSetCache(String name)
      Description copied from interface: RedissonRxClient
      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 RedissonRxClient.getSet(String, Codec).

      Specified by:
      getSetCache in interface RedissonRxClient
      Type Parameters:
      V - type of values
      Parameters:
      name - name of object
      Returns:
      SetCache object

    • getSetCache

      public <V> RSetCacheRx<V> getSetCache(String name, Codec codec)
      Description copied from interface: RedissonRxClient
      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 RedissonRxClient.getSet(String, Codec).

      Specified by:
      getSetCache in interface RedissonRxClient
      Type Parameters:
      V - type of values
      Parameters:
      name - name of object
      codec - codec for values
      Returns:
      SetCache object

    • getSetCache

      public <V> RSetCacheRx<V> getSetCache(PlainOptions options)
      Description copied from interface: RedissonRxClient
      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 RedissonRxClient.getSet(PlainOptions).

      Specified by:
      getSetCache in interface RedissonRxClient
      Type Parameters:
      V - type of value
      Parameters:
      options - instance options
      Returns:
      SetCache object

    • getAtomicLong

      public RAtomicLongRx getAtomicLong(String name)
      Description copied from interface: RedissonRxClient
      Returns "atomic long" instance by name.
      Specified by:
      getAtomicLong in interface RedissonRxClient
      Parameters:
      name - of the "atomic long"
      Returns:
      AtomicLong object

    • getAtomicLong

      public RAtomicLongRx getAtomicLong(CommonOptions options)
      Description copied from interface: RedissonRxClient
      Returns atomicLong instance with specified options.
      Specified by:
      getAtomicLong in interface RedissonRxClient
      Parameters:
      options - instance options
      Returns:
      AtomicLong object

    • getAtomicDouble

      public RAtomicDoubleRx getAtomicDouble(String name)
      Description copied from interface: RedissonRxClient
      Returns "atomic double" instance by name.
      Specified by:
      getAtomicDouble in interface RedissonRxClient
      Parameters:
      name - of the "atomic double"
      Returns:
      AtomicLong object

    • getAtomicDouble

      public RAtomicDoubleRx getAtomicDouble(CommonOptions options)
      Description copied from interface: RedissonRxClient
      Returns atomicDouble instance with specified options.
      Specified by:
      getAtomicDouble in interface RedissonRxClient
      Parameters:
      options - instance options
      Returns:
      AtomicDouble object

    • getRemoteService

      public RRemoteService getRemoteService()
      Description copied from interface: RedissonRxClient
      Returns object for remote operations prefixed with the default name (redisson_remote_service)
      Specified by:
      getRemoteService in interface RedissonRxClient
      Returns:
      RemoteService object

    • getRemoteService

      public RRemoteService getRemoteService(String name)
      Description copied from interface: RedissonRxClient
      Returns object for remote operations prefixed with the specified name
      Specified by:
      getRemoteService in interface RedissonRxClient
      Parameters:
      name - the name used as the Redis key prefix for the services
      Returns:
      RemoteService object

    • getRemoteService

      public RRemoteService getRemoteService(Codec codec)
      Description copied from interface: RedissonRxClient
      Returns object for remote operations prefixed with the default name (redisson_remote_service) and uses provided codec for method arguments and result.
      Specified by:
      getRemoteService in interface RedissonRxClient
      Parameters:
      codec - codec for response and request
      Returns:
      RemoteService object

    • getRemoteService

      public RRemoteService getRemoteService(String name, Codec codec)
      Description copied from interface: RedissonRxClient
      Returns object for remote operations prefixed with the specified name and uses provided codec for method arguments and result.
      Specified by:
      getRemoteService in interface RedissonRxClient
      Parameters:
      name - the name used as the Redis key prefix for the services
      codec - codec for response and request
      Returns:
      RemoteService object

    • getRemoteService

      public RRemoteService getRemoteService(PlainOptions options)
      Description copied from interface: RedissonRxClient
      Returns object for remote operations prefixed with specified options.
      Specified by:
      getRemoteService in interface RedissonRxClient
      Parameters:
      options - instance options
      Returns:
      RemoteService object

    • getBitSet

      public RBitSetRx getBitSet(String name)
      Description copied from interface: RedissonRxClient
      Returns bitSet instance by name.
      Specified by:
      getBitSet in interface RedissonRxClient
      Parameters:
      name - name of object
      Returns:
      BitSet object

    • getBitSet

      public RBitSetRx getBitSet(CommonOptions options)
      Description copied from interface: RedissonRxClient
      Returns bitSet instance with specified options.
      Specified by:
      getBitSet in interface RedissonRxClient
      Parameters:
      options - instance options
      Returns:
      BitSet object

    • getBloomFilter

      public <V> RBloomFilterRx<V> getBloomFilter(String name)
      Description copied from interface: RedissonRxClient
      Returns bloom filter instance by name.
      Specified by:
      getBloomFilter in interface RedissonRxClient
      Type Parameters:
      V - type of value
      Parameters:
      name - name of object
      Returns:
      BloomFilter object

    • getBloomFilter

      public <V> RBloomFilterRx<V> getBloomFilter(String name, Codec codec)
      Description copied from interface: RedissonRxClient
      Returns bloom filter instance by name using provided codec for objects.
      Specified by:
      getBloomFilter in interface RedissonRxClient
      Type Parameters:
      V - type of value
      Parameters:
      name - name of object
      codec - codec for values
      Returns:
      BloomFilter object

    • getBloomFilter

      public <V> RBloomFilterRx<V> getBloomFilter(PlainOptions options)
      Description copied from interface: RedissonRxClient
      Returns bloom filter instance with specified options.
      Specified by:
      getBloomFilter in interface RedissonRxClient
      Type Parameters:
      V - type of value
      Parameters:
      options - instance options
      Returns:
      BloomFilter object

    • getFunction

      public RFunctionRx getFunction()
      Description copied from interface: RedissonRxClient
      Returns interface for Redis Function feature
      Specified by:
      getFunction in interface RedissonRxClient
      Returns:
      function object

    • getFunction

      public RFunctionRx getFunction(Codec codec)
      Description copied from interface: RedissonRxClient
      Returns interface for Redis Function feature using provided codec
      Specified by:
      getFunction in interface RedissonRxClient
      Parameters:
      codec - codec for params and result
      Returns:
      function interface

    • getFunction

      public RFunctionRx getFunction(OptionalOptions options)
      Description copied from interface: RedissonRxClient
      Returns interface for Redis Function feature with specified options.
      Specified by:
      getFunction in interface RedissonRxClient
      Parameters:
      options - instance options
      Returns:
      function object

    • getScript

      public RScriptRx getScript()
      Description copied from interface: RedissonRxClient
      Returns script operations object
      Specified by:
      getScript in interface RedissonRxClient
      Returns:
      Script object

    • getScript

      public RScriptRx getScript(Codec codec)
      Description copied from interface: RedissonRxClient
      Returns script operations object using provided codec.
      Specified by:
      getScript in interface RedissonRxClient
      Parameters:
      codec - codec for params and result
      Returns:
      Script object

    • getScript

      public RScriptRx getScript(OptionalOptions options)
      Description copied from interface: RedissonRxClient
      Returns script operations object with specified options.
      Specified by:
      getScript in interface RedissonRxClient
      Parameters:
      options - instance options
      Returns:
      Script object

    • createBatch

      public RBatchRx createBatch()
      Description copied from interface: RedissonRxClient
      Return batch object which executes group of command in pipeline. See http://redis.io/topics/pipelining
      Specified by:
      createBatch in interface RedissonRxClient
      Returns:
      Batch object

    • createBatch

      public RBatchRx createBatch(BatchOptions options)
      Description copied from interface: RedissonRxClient
      Return batch object which executes group of command in pipeline. See http://redis.io/topics/pipelining
      Specified by:
      createBatch in interface RedissonRxClient
      Parameters:
      options - batch configuration
      Returns:
      Batch object

    • getKeys

      public RKeysRx getKeys()
      Description copied from interface: RedissonRxClient
      Returns keys operations. Each of Redis/Redisson object associated with own key
      Specified by:
      getKeys in interface RedissonRxClient
      Returns:
      Keys object

    • getKeys

      public RKeysRx getKeys(KeysOptions options)
      Description copied from interface: RedissonRxClient
      Returns interface for operations over Redis keys with specified options. Each of Redis/Redisson object is associated with own key.
      Specified by:
      getKeys in interface RedissonRxClient
      Returns:
      Keys object

    • getConfig

      public Config getConfig()
      Description copied from interface: RedissonRxClient
      Allows to get configuration provided during Redisson instance creation. Further changes on this object not affect Redisson instance.
      Specified by:
      getConfig in interface RedissonRxClient
      Returns:
      Config object

    • getNodesGroup

      public NodesGroup<Node> getNodesGroup()
      Description copied from interface: RedissonRxClient
      Use RedissonClient.getRedisNodes(org.redisson.api.redisnode.RedisNodes) instead
      Specified by:
      getNodesGroup in interface RedissonRxClient
      Returns:
      NodesGroup object

    • getClusterNodesGroup

      public NodesGroup<ClusterNode> getClusterNodesGroup()
      Description copied from interface: RedissonRxClient
      Use RedissonClient.getRedisNodes(org.redisson.api.redisnode.RedisNodes) instead
      Specified by:
      getClusterNodesGroup in interface RedissonRxClient
      Returns:
      NodesGroup object

    • shutdown

      public void shutdown()
      Description copied from interface: RedissonRxClient
      Use RedissonClient.shutdown() instead
      Specified by:
      shutdown in interface RedissonRxClient

    • isShutdown

      public boolean isShutdown()
      Description copied from interface: RedissonRxClient
      Returns true if this Redisson instance has been shut down.
      Specified by:
      isShutdown in interface RedissonRxClient
      Returns:
      true if this Redisson instance has been shut down otherwise false

    • isShuttingDown

      public boolean isShuttingDown()
      Description copied from interface: RedissonRxClient
      Returns true if this Redisson instance was started to be shutdown or was shutdown RedissonRxClient.isShutdown() already.
      Specified by:
      isShuttingDown in interface RedissonRxClient
      Returns:
      true if this Redisson instance was started to be shutdown or was shutdown RedissonRxClient.isShutdown() already otherwise false

    • getMapCache

      public <K, V> RMapCacheRx<K,V> getMapCache(String name, Codec codec, MapCacheOptions<K,V> options)
      Description copied from interface: RedissonRxClient
      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 RedissonRxClient.getMap(String, Codec, MapOptions).

      Specified by:
      getMapCache in interface RedissonRxClient
      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

      public <K, V> RMapCacheRx<K,V> getMapCache(String name, MapCacheOptions<K,V> options)
      Description copied from interface: RedissonRxClient
      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 RedissonRxClient.getMap(String, MapOptions).

      Specified by:
      getMapCache in interface RedissonRxClient
      Type Parameters:
      K - type of key
      V - type of value
      Parameters:
      name - name of object
      options - map options
      Returns:
      MapCache object

    • getMapCacheNative

      public <K, V> RMapCacheNativeRx<K,V> getMapCacheNative(String name)
      Description copied from interface: RedissonRxClient
      Returns map instance by name. Supports entry eviction with a given TTL.

      Requires Redis 7.4.0 and higher.

      Specified by:
      getMapCacheNative in interface RedissonRxClient
      Type Parameters:
      K - type of key
      V - type of value
      Parameters:
      name - name of object
      Returns:
      Map object

    • getMapCacheNative

      public <K, V> RMapCacheNativeRx<K,V> getMapCacheNative(String name, Codec codec)
      Description copied from interface: RedissonRxClient
      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.

      Specified by:
      getMapCacheNative in interface RedissonRxClient
      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

      public <K, V> RMapCacheNativeRx<K,V> getMapCacheNative(MapOptions<K,V> options)
      Description copied from interface: RedissonRxClient
      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.

      Specified by:
      getMapCacheNative in interface RedissonRxClient
      Type Parameters:
      K - type of key
      V - type of value
      Parameters:
      options - instance options
      Returns:
      Map object

    • getMap

      public <K, V> RMapRx<K,V> getMap(String name, MapOptions<K,V> options)
      Description copied from interface: RedissonRxClient
      Returns map instance by name.
      Specified by:
      getMap in interface RedissonRxClient
      Type Parameters:
      K - type of key
      V - type of value
      Parameters:
      name - name of object
      options - map options
      Returns:
      Map object

    • getMap

      public <K, V> RMapRx<K,V> getMap(String name, Codec codec, MapOptions<K,V> options)
      Description copied from interface: RedissonRxClient
      Returns map instance by name using provided codec for both map keys and values.
      Specified by:
      getMap in interface RedissonRxClient
      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

    • getLocalCachedMap

      public <K, V> RLocalCachedMapRx<K,V> getLocalCachedMap(String name, LocalCachedMapOptions<K,V> options)
      Description copied from interface: RedissonRxClient
      Returns local cached map instance by name. Configured by parameters of options-object.
      Specified by:
      getLocalCachedMap in interface RedissonRxClient
      Type Parameters:
      K - type of key
      V - type of value
      Parameters:
      name - name of object
      options - local map options
      Returns:
      LocalCachedMap object

    • getLocalCachedMap

      public <K, V> RLocalCachedMapRx<K,V> getLocalCachedMap(String name, Codec codec, LocalCachedMapOptions<K,V> options)
      Description copied from interface: RedissonRxClient
      Returns local cached map instance by name using provided codec. Configured by parameters of options-object.
      Specified by:
      getLocalCachedMap in interface RedissonRxClient
      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

      public <K, V> RLocalCachedMapRx<K,V> getLocalCachedMap(LocalCachedMapOptions<K,V> options)
      Description copied from interface: RedissonRxClient
      Returns local cached map instance with specified options.
      Specified by:
      getLocalCachedMap in interface RedissonRxClient
      Type Parameters:
      K - type of key
      V - type of value
      Parameters:
      options - instance options
      Returns:
      LocalCachedMap object

    • getLocalCachedMapCache

      public <K, V> RLocalCachedMapCacheRx<K,V> getLocalCachedMapCache(String name, LocalCachedMapCacheOptions<K,V> options)
      Description copied from interface: RedissonRxClient
      Returns local cached map cache instance by name. Configured by parameters of options-object.
      Specified by:
      getLocalCachedMapCache in interface RedissonRxClient
      Type Parameters:
      K - type of key
      V - type of value
      Parameters:
      name - - name of object
      options - - local map options
      Returns:
      LocalCachedMapCache object

    • getLocalCachedMapCache

      public <K, V> RLocalCachedMapCacheRx<K,V> getLocalCachedMapCache(String name, Codec codec, LocalCachedMapCacheOptions<K,V> options)
      Description copied from interface: RedissonRxClient
      Returns local cached map cache instance by name using provided codec. Configured by parameters of options-object.
      Specified by:
      getLocalCachedMapCache in interface RedissonRxClient
      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

    • createTransaction

      public RTransactionRx createTransaction(TransactionOptions options)
      Description copied from interface: RedissonRxClient
      Creates transaction with READ_COMMITTED isolation level.
      Specified by:
      createTransaction in interface RedissonRxClient
      Parameters:
      options - transaction configuration
      Returns:
      Transaction object

    • getBlockingDeque

      public <V> RBlockingDequeRx<V> getBlockingDeque(String name)
      Description copied from interface: RedissonRxClient
      Returns unbounded blocking deque instance by name.
      Specified by:
      getBlockingDeque in interface RedissonRxClient
      Type Parameters:
      V - type of value
      Parameters:
      name - name of object
      Returns:
      BlockingDeque object

    • getBlockingDeque

      public <V> RBlockingDequeRx<V> getBlockingDeque(String name, Codec codec)
      Description copied from interface: RedissonRxClient
      Returns unbounded blocking deque instance by name using provided codec for deque objects.
      Specified by:
      getBlockingDeque in interface RedissonRxClient
      Type Parameters:
      V - type of value
      Parameters:
      name - name of object
      codec - deque objects codec
      Returns:
      BlockingDeque object

    • getBlockingDeque

      public <V> RBlockingDequeRx<V> getBlockingDeque(PlainOptions options)
      Description copied from interface: RedissonRxClient
      Returns unbounded blocking deque instance with specified options.
      Specified by:
      getBlockingDeque in interface RedissonRxClient
      Type Parameters:
      V - type of value
      Parameters:
      options - instance options
      Returns:
      BlockingDeque object

    • getTransferQueue

      public <V> RTransferQueueRx<V> getTransferQueue(String name)
      Description copied from interface: RedissonRxClient
      Returns transfer queue instance by name.
      Specified by:
      getTransferQueue in interface RedissonRxClient
      Type Parameters:
      V - type of values
      Parameters:
      name - name of object
      Returns:
      TransferQueue object

    • getTransferQueue

      public <V> RTransferQueueRx<V> getTransferQueue(String name, Codec codec)
      Description copied from interface: RedissonRxClient
      Returns transfer queue instance by name using provided codec for queue objects.
      Specified by:
      getTransferQueue in interface RedissonRxClient
      Type Parameters:
      V - type of values
      Parameters:
      name - name of object
      codec - code for values
      Returns:
      TransferQueue object

    • getTransferQueue

      public <V> RTransferQueueRx<V> getTransferQueue(PlainOptions options)
      Description copied from interface: RedissonRxClient
      Returns transfer queue instance with specified options.
      Specified by:
      getTransferQueue in interface RedissonRxClient
      Type Parameters:
      V - type of values
      Parameters:
      options - instance options
      Returns:
      TransferQueue object

    • getId

      public String getId()
      Description copied from interface: RedissonRxClient
      Returns id of this Redisson instance
      Specified by:
      getId in interface RedissonRxClient
      Returns:
      id