Package org.redisson.api

Interface RClientSideCaching

All Superinterfaces:
RDestroyable
All Known Implementing Classes:
RedissonClientSideCaching
public interface RClientSideCaching extends RDestroyable
Author:
Nikita Koksharov

  • Method Details

    • getBucket

      <V> RBucket<V> getBucket(String name)
      Returns object holder instance by name.
      Type Parameters:
      V - type of value
      Parameters:
      name - name of object
      Returns:
      Bucket object

    • getBucket

      <V> RBucket<V> getBucket(String name, Codec codec)
      Returns object holder instance by name using provided codec for object.
      Type Parameters:
      V - type of value
      Parameters:
      name - name of object
      codec - codec for values
      Returns:
      Bucket object

    • getStream

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

    • getSet

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

    • getSet

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

    • getMap

      <K, V> RMap<K,V> getMap(String name)
      Returns map instance by name.

      NOTE: client side caching feature invalidates whole Map per entry change which is ineffective. Use local cached Map, JSON Store instead.

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

    • getMap

      <K, V> RMap<K,V> getMap(String name, Codec codec)
      Returns map instance by name using provided codec for both map keys and values.

      NOTE: client side caching feature invalidates whole Map per entry change which is ineffective. Use local cached Map, JSON Store instead.

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

    • getScoredSortedSet

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

    • getScoredSortedSet

      <V> RScoredSortedSet<V> getScoredSortedSet(String name, Codec codec)
      Returns Redis Sorted Set instance by name using provided codec for sorted set objects. This sorted set sorts objects by object score.
      Type Parameters:
      V - type of value
      Parameters:
      name - name of object
      codec - codec for values
      Returns:
      ScoredSortedSet object

    • getList

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

    • getList

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

    • getQueue

      <V> RQueue<V> getQueue(String name)
      Returns unbounded queue instance by name.
      Type Parameters:
      V - type of value
      Parameters:
      name - of object
      Returns:
      queue object

    • getQueue

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

    • getDeque

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

    • getDeque

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

    • getBlockingQueue

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

    • getBlockingQueue

      <V> RBlockingQueue<V> getBlockingQueue(String name, Codec codec)
      Returns unbounded blocking queue instance by name using provided codec for queue objects.
      Type Parameters:
      V - type of value
      Parameters:
      name - name of queue
      codec - queue objects codec
      Returns:
      BlockingQueue object

    • getBlockingDeque

      <V> RBlockingDeque<V> getBlockingDeque(String name)
      Returns unbounded blocking deque instance by name.
      Type Parameters:
      V - type of value
      Parameters:
      name - name of object
      Returns:
      BlockingDeque object

    • getBlockingDeque

      <V> RBlockingDeque<V> getBlockingDeque(String name, Codec codec)
      Returns unbounded blocking deque instance by name using provided codec for deque objects.
      Type Parameters:
      V - type of value
      Parameters:
      name - name of object
      codec - deque objects codec
      Returns:
      BlockingDeque object

    • getGeo

      <V> RGeo<V> getGeo(String name)
      Returns geospatial items holder instance by name.
      Type Parameters:
      V - type of value
      Parameters:
      name - name of object
      Returns:
      Geo object

    • getGeo

      <V> RGeo<V> getGeo(String name, Codec codec)
      Returns geospatial items holder instance by name using provided codec for geospatial members.
      Type Parameters:
      V - type of value
      Parameters:
      name - name of object
      codec - codec for value
      Returns:
      Geo object