|
|
|
@ -34,18 +34,20 @@ public interface RedissonClient {
|
|
|
|
|
/**
|
|
|
|
|
* Returns geospatial items holder instance by <code>name</code>.
|
|
|
|
|
*
|
|
|
|
|
* @param name
|
|
|
|
|
* @return
|
|
|
|
|
* @param <V> type of value
|
|
|
|
|
* @param name - name of object
|
|
|
|
|
* @return Geo object
|
|
|
|
|
*/
|
|
|
|
|
<V> RGeo<V> getGeo(String name);
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Returns geospatial items holder instance by <code>name</code>
|
|
|
|
|
* using provided codec for geospatial members.
|
|
|
|
|
*
|
|
|
|
|
* @param name
|
|
|
|
|
* @param geospatial member codec
|
|
|
|
|
* @return
|
|
|
|
|
*
|
|
|
|
|
* @param <V> type of value
|
|
|
|
|
* @param name - name of object
|
|
|
|
|
* @param codec - codec for value
|
|
|
|
|
* @return Geo object
|
|
|
|
|
*/
|
|
|
|
|
<V> RGeo<V> getGeo(String name, Codec codec);
|
|
|
|
|
|
|
|
|
@ -54,10 +56,10 @@ public interface RedissonClient {
|
|
|
|
|
* Supports value eviction with a given TTL value.
|
|
|
|
|
*
|
|
|
|
|
* <p>If eviction is not required then it's better to use regular map {@link #getSet(String, Codec)}.</p>
|
|
|
|
|
*
|
|
|
|
|
* @param name
|
|
|
|
|
* @param codec
|
|
|
|
|
* @return
|
|
|
|
|
*
|
|
|
|
|
* @param <V> type of value
|
|
|
|
|
* @param name - name of object
|
|
|
|
|
* @return SetCache object
|
|
|
|
|
*/
|
|
|
|
|
<V> RSetCache<V> getSetCache(String name);
|
|
|
|
|
|
|
|
|
@ -66,10 +68,11 @@ public interface RedissonClient {
|
|
|
|
|
* Supports value eviction with a given TTL value.
|
|
|
|
|
*
|
|
|
|
|
* <p>If eviction is not required then it's better to use regular map {@link #getSet(String, Codec)}.</p>
|
|
|
|
|
*
|
|
|
|
|
* @param name
|
|
|
|
|
* @param codec
|
|
|
|
|
* @return
|
|
|
|
|
*
|
|
|
|
|
* @param <V> type of value
|
|
|
|
|
* @param name - name of object
|
|
|
|
|
* @param codec - codec for values
|
|
|
|
|
* @return SetCache object
|
|
|
|
|
*/
|
|
|
|
|
<V> RSetCache<V> getSetCache(String name, Codec codec);
|
|
|
|
|
|
|
|
|
@ -80,9 +83,11 @@ public interface RedissonClient {
|
|
|
|
|
*
|
|
|
|
|
* <p>If eviction is not required then it's better to use regular map {@link #getMap(String, Codec)}.</p>
|
|
|
|
|
*
|
|
|
|
|
* @param name
|
|
|
|
|
* @param codec
|
|
|
|
|
* @return
|
|
|
|
|
* @param <K> type of key
|
|
|
|
|
* @param <V> type of value
|
|
|
|
|
* @param name - name of object
|
|
|
|
|
* @param codec - codec for keys and values
|
|
|
|
|
* @return MapCache object
|
|
|
|
|
*/
|
|
|
|
|
<K, V> RMapCache<K, V> getMapCache(String name, Codec codec);
|
|
|
|
|
|
|
|
|
@ -92,16 +97,19 @@ public interface RedissonClient {
|
|
|
|
|
*
|
|
|
|
|
* <p>If eviction is not required then it's better to use regular map {@link #getMap(String)}.</p>
|
|
|
|
|
*
|
|
|
|
|
* @param name
|
|
|
|
|
* @return
|
|
|
|
|
* @param <K> type of key
|
|
|
|
|
* @param <V> type of value
|
|
|
|
|
* @param name - name of object
|
|
|
|
|
* @return MapCache object
|
|
|
|
|
*/
|
|
|
|
|
<K, V> RMapCache<K, V> getMapCache(String name);
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Returns object holder instance by name.
|
|
|
|
|
*
|
|
|
|
|
* @param name of object
|
|
|
|
|
* @return
|
|
|
|
|
* @param <V> type of value
|
|
|
|
|
* @param name - name of object
|
|
|
|
|
* @return Bucket object
|
|
|
|
|
*/
|
|
|
|
|
<V> RBucket<V> getBucket(String name);
|
|
|
|
|
|
|
|
|
@ -109,16 +117,17 @@ public interface RedissonClient {
|
|
|
|
|
* Returns object holder instance by name
|
|
|
|
|
* using provided codec for object.
|
|
|
|
|
*
|
|
|
|
|
* @param name of object
|
|
|
|
|
* @param object codec
|
|
|
|
|
* @return
|
|
|
|
|
* @param <V> type of value
|
|
|
|
|
* @param name - name of object
|
|
|
|
|
* @param codec - codec for values
|
|
|
|
|
* @return Bucket object
|
|
|
|
|
*/
|
|
|
|
|
<V> RBucket<V> getBucket(String name, Codec codec);
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Returns interface for mass operations with Bucket objects.
|
|
|
|
|
*
|
|
|
|
|
* @return
|
|
|
|
|
* @return Buckets
|
|
|
|
|
*/
|
|
|
|
|
RBuckets getBuckets();
|
|
|
|
|
|
|
|
|
@ -126,51 +135,58 @@ public interface RedissonClient {
|
|
|
|
|
* Returns interface for mass operations with Bucket objects
|
|
|
|
|
* using provided codec for object.
|
|
|
|
|
*
|
|
|
|
|
* @return
|
|
|
|
|
* @param codec - codec for bucket objects
|
|
|
|
|
* @return Buckets
|
|
|
|
|
*/
|
|
|
|
|
RBuckets getBuckets(Codec codec);
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Returns HyperLogLog instance by name.
|
|
|
|
|
*
|
|
|
|
|
* @param name of object
|
|
|
|
|
* @return
|
|
|
|
|
* @param <V> type of value
|
|
|
|
|
* @param name - name of object
|
|
|
|
|
* @return HyperLogLog object
|
|
|
|
|
*/
|
|
|
|
|
<V> RHyperLogLog<V> getHyperLogLog(String name);
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Returns HyperLogLog instance by name
|
|
|
|
|
* using provided codec for hll objects.
|
|
|
|
|
*
|
|
|
|
|
* @param name of object
|
|
|
|
|
* @param object codec
|
|
|
|
|
* @return
|
|
|
|
|
*
|
|
|
|
|
* @param <V> type of value
|
|
|
|
|
* @param name - name of object
|
|
|
|
|
* @param codec - codec for values
|
|
|
|
|
* @return HyperLogLog object
|
|
|
|
|
*/
|
|
|
|
|
<V> RHyperLogLog<V> getHyperLogLog(String name, Codec codec);
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Returns list instance by name.
|
|
|
|
|
*
|
|
|
|
|
* @param name of object
|
|
|
|
|
* @return
|
|
|
|
|
* @param <V> type of value
|
|
|
|
|
* @param name - name of object
|
|
|
|
|
* @return List object
|
|
|
|
|
*/
|
|
|
|
|
<V> RList<V> getList(String name);
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Returns list instance by name
|
|
|
|
|
* using provided codec for list objects.
|
|
|
|
|
*
|
|
|
|
|
* @param name of object
|
|
|
|
|
* @param list object codec
|
|
|
|
|
* @return
|
|
|
|
|
*
|
|
|
|
|
* @param <V> type of value
|
|
|
|
|
* @param name - name of object
|
|
|
|
|
* @param codec - codec for values
|
|
|
|
|
* @return List object
|
|
|
|
|
*/
|
|
|
|
|
<V> RList<V> getList(String name, Codec codec);
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Returns List based Multimap instance by name.
|
|
|
|
|
*
|
|
|
|
|
* @param name
|
|
|
|
|
* @return
|
|
|
|
|
*
|
|
|
|
|
* @param <K> type of key
|
|
|
|
|
* @param <V> type of value
|
|
|
|
|
* @param name - name of object
|
|
|
|
|
* @return ListMultimap object
|
|
|
|
|
*/
|
|
|
|
|
<K, V> RListMultimap<K, V> getListMultimap(String name);
|
|
|
|
|
|
|
|
|
@ -178,9 +194,11 @@ public interface RedissonClient {
|
|
|
|
|
* Returns List based Multimap instance by name
|
|
|
|
|
* using provided codec for both map keys and values.
|
|
|
|
|
*
|
|
|
|
|
* @param name
|
|
|
|
|
* @param codec
|
|
|
|
|
* @return
|
|
|
|
|
* @param <K> type of key
|
|
|
|
|
* @param <V> type of value
|
|
|
|
|
* @param name - name of object
|
|
|
|
|
* @param codec - codec for keys and values
|
|
|
|
|
* @return ListMultimap object
|
|
|
|
|
*/
|
|
|
|
|
<K, V> RListMultimap<K, V> getListMultimap(String name, Codec codec);
|
|
|
|
|
|
|
|
|
@ -190,8 +208,10 @@ public interface RedissonClient {
|
|
|
|
|
*
|
|
|
|
|
* <p>If eviction is not required then it's better to use regular map {@link #getSetMultimap(String)}.</p>
|
|
|
|
|
*
|
|
|
|
|
* @param name
|
|
|
|
|
* @return
|
|
|
|
|
* @param <K> type of key
|
|
|
|
|
* @param <V> type of value
|
|
|
|
|
* @param name - name of object
|
|
|
|
|
* @return ListMultimapCache object
|
|
|
|
|
*/
|
|
|
|
|
<K, V> RListMultimapCache<K, V> getListMultimapCache(String name);
|
|
|
|
|
|
|
|
|
@ -202,8 +222,11 @@ public interface RedissonClient {
|
|
|
|
|
*
|
|
|
|
|
* <p>If eviction is not required then it's better to use regular map {@link #getSetMultimap(String, Codec)}.</p>
|
|
|
|
|
*
|
|
|
|
|
* @param name
|
|
|
|
|
* @return
|
|
|
|
|
* @param <K> type of key
|
|
|
|
|
* @param <V> type of value
|
|
|
|
|
* @param name - name of object
|
|
|
|
|
* @param codec - codec for keys and values
|
|
|
|
|
* @return ListMultimapCache object
|
|
|
|
|
*/
|
|
|
|
|
<K, V> RListMultimapCache<K, V> getListMultimapCache(String name, Codec codec);
|
|
|
|
|
|
|
|
|
@ -211,9 +234,11 @@ public interface RedissonClient {
|
|
|
|
|
* Returns local cached map instance by name.
|
|
|
|
|
* Configured by parameters of options-object.
|
|
|
|
|
*
|
|
|
|
|
* @param name
|
|
|
|
|
* @param options
|
|
|
|
|
* @return
|
|
|
|
|
* @param <K> type of key
|
|
|
|
|
* @param <V> type of value
|
|
|
|
|
* @param name - name of object
|
|
|
|
|
* @param options - local map options
|
|
|
|
|
* @return LocalCachedMap object
|
|
|
|
|
*/
|
|
|
|
|
<K, V> RLocalCachedMap<K, V> getLocalCachedMap(String name, LocalCachedMapOptions options);
|
|
|
|
|
|
|
|
|
@ -221,18 +246,22 @@ public interface RedissonClient {
|
|
|
|
|
* Returns local cached map instance by name
|
|
|
|
|
* using provided codec. Configured by parameters of options-object.
|
|
|
|
|
*
|
|
|
|
|
* @param name
|
|
|
|
|
* @param codec
|
|
|
|
|
* @param options
|
|
|
|
|
* @return
|
|
|
|
|
* @param <K> type of key
|
|
|
|
|
* @param <V> type of value
|
|
|
|
|
* @param name - name of object
|
|
|
|
|
* @param codec - codec for keys and values
|
|
|
|
|
* @param options - local map options
|
|
|
|
|
* @return LocalCachedMap object
|
|
|
|
|
*/
|
|
|
|
|
<K, V> RLocalCachedMap<K, V> getLocalCachedMap(String name, Codec codec, LocalCachedMapOptions options);
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Returns map instance by name.
|
|
|
|
|
*
|
|
|
|
|
* @param name of map
|
|
|
|
|
* @return
|
|
|
|
|
* @param <K> type of key
|
|
|
|
|
* @param <V> type of value
|
|
|
|
|
* @param name - name of object
|
|
|
|
|
* @return Map object
|
|
|
|
|
*/
|
|
|
|
|
<K, V> RMap<K, V> getMap(String name);
|
|
|
|
|
|
|
|
|
@ -240,17 +269,21 @@ public interface RedissonClient {
|
|
|
|
|
* Returns map instance by name
|
|
|
|
|
* using provided codec for both map keys and values.
|
|
|
|
|
*
|
|
|
|
|
* @param name of map
|
|
|
|
|
* @param map key and value codec
|
|
|
|
|
* @return
|
|
|
|
|
* @param <K> type of key
|
|
|
|
|
* @param <V> type of value
|
|
|
|
|
* @param name - name of object
|
|
|
|
|
* @param codec - codec for keys and values
|
|
|
|
|
* @return Map object
|
|
|
|
|
*/
|
|
|
|
|
<K, V> RMap<K, V> getMap(String name, Codec codec);
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Returns Set based Multimap instance by name.
|
|
|
|
|
*
|
|
|
|
|
* @param name
|
|
|
|
|
* @return
|
|
|
|
|
* @param <K> type of key
|
|
|
|
|
* @param <V> type of value
|
|
|
|
|
* @param name - name of object
|
|
|
|
|
* @return SetMultimap object
|
|
|
|
|
*/
|
|
|
|
|
<K, V> RSetMultimap<K, V> getSetMultimap(String name);
|
|
|
|
|
|
|
|
|
@ -258,9 +291,11 @@ public interface RedissonClient {
|
|
|
|
|
* Returns Set based Multimap instance by name
|
|
|
|
|
* using provided codec for both map keys and values.
|
|
|
|
|
*
|
|
|
|
|
* @param name
|
|
|
|
|
* @param codec
|
|
|
|
|
* @return
|
|
|
|
|
* @param <K> type of key
|
|
|
|
|
* @param <V> type of value
|
|
|
|
|
* @param name - name of object
|
|
|
|
|
* @param codec - codec for keys and values
|
|
|
|
|
* @return SetMultimap object
|
|
|
|
|
*/
|
|
|
|
|
<K, V> RSetMultimap<K, V> getSetMultimap(String name, Codec codec);
|
|
|
|
|
|
|
|
|
@ -270,8 +305,10 @@ public interface RedissonClient {
|
|
|
|
|
*
|
|
|
|
|
* <p>If eviction is not required then it's better to use regular map {@link #getSetMultimap(String)}.</p>
|
|
|
|
|
*
|
|
|
|
|
* @param name
|
|
|
|
|
* @return
|
|
|
|
|
* @param <K> type of key
|
|
|
|
|
* @param <V> type of value
|
|
|
|
|
* @param name - name of object
|
|
|
|
|
* @return SetMultimapCache object
|
|
|
|
|
*/
|
|
|
|
|
<K, V> RSetMultimapCache<K, V> getSetMultimapCache(String name);
|
|
|
|
|
|
|
|
|
@ -282,16 +319,19 @@ public interface RedissonClient {
|
|
|
|
|
*
|
|
|
|
|
* <p>If eviction is not required then it's better to use regular map {@link #getSetMultimap(String, Codec)}.</p>
|
|
|
|
|
*
|
|
|
|
|
* @param name
|
|
|
|
|
* @return
|
|
|
|
|
* @param <K> type of key
|
|
|
|
|
* @param <V> type of value
|
|
|
|
|
* @param name - name of object
|
|
|
|
|
* @param codec - codec for keys and values
|
|
|
|
|
* @return SetMultimapCache object
|
|
|
|
|
*/
|
|
|
|
|
<K, V> RSetMultimapCache<K, V> getSetMultimapCache(String name, Codec codec);
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Returns semaphore instance by name
|
|
|
|
|
*
|
|
|
|
|
* @param name of semaphore
|
|
|
|
|
* @return
|
|
|
|
|
* @param name - name of object
|
|
|
|
|
* @return Semaphore object
|
|
|
|
|
*/
|
|
|
|
|
RSemaphore getSemaphore(String name);
|
|
|
|
|
|
|
|
|
@ -299,63 +339,66 @@ public interface RedissonClient {
|
|
|
|
|
* Returns semaphore instance by name.
|
|
|
|
|
* Supports lease time parameter for each acquired permit.
|
|
|
|
|
*
|
|
|
|
|
* @param name
|
|
|
|
|
* @return
|
|
|
|
|
* @param name - name of object
|
|
|
|
|
* @return PermitExpirableSemaphore object
|
|
|
|
|
*/
|
|
|
|
|
RPermitExpirableSemaphore getPermitExpirableSemaphore(String name);
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Returns lock instance by name.
|
|
|
|
|
* <p/>
|
|
|
|
|
* <p>
|
|
|
|
|
* Implements a <b>non-fair</b> locking so doesn't guarantees an acquire order by threads.
|
|
|
|
|
*
|
|
|
|
|
* @param name of lock
|
|
|
|
|
* @return
|
|
|
|
|
* @param name - name of object
|
|
|
|
|
* @return Lock object
|
|
|
|
|
*/
|
|
|
|
|
RLock getLock(String name);
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Returns lock instance by name.
|
|
|
|
|
* <p/>
|
|
|
|
|
* <p>
|
|
|
|
|
* Implements a <b>fair</b> locking so it guarantees an acquire order by threads.
|
|
|
|
|
*
|
|
|
|
|
* @param name
|
|
|
|
|
* @return
|
|
|
|
|
* @param name - name of object
|
|
|
|
|
* @return Lock object
|
|
|
|
|
*/
|
|
|
|
|
RLock getFairLock(String name);
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Returns readWriteLock instance by name.
|
|
|
|
|
*
|
|
|
|
|
* @param name
|
|
|
|
|
* @return
|
|
|
|
|
* @param name - name of object
|
|
|
|
|
* @return Lock object
|
|
|
|
|
*/
|
|
|
|
|
RReadWriteLock getReadWriteLock(String name);
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Returns set instance by name.
|
|
|
|
|
*
|
|
|
|
|
* @param name of set
|
|
|
|
|
* @return
|
|
|
|
|
*
|
|
|
|
|
* @param <V> type of value
|
|
|
|
|
* @param name - name of object
|
|
|
|
|
* @return Lock object
|
|
|
|
|
*/
|
|
|
|
|
<V> RSet<V> getSet(String name);
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Returns set instance by name
|
|
|
|
|
* using provided codec for set objects.
|
|
|
|
|
*
|
|
|
|
|
* @param name of set
|
|
|
|
|
* @param set object codec
|
|
|
|
|
* @return
|
|
|
|
|
*
|
|
|
|
|
* @param <V> type of value
|
|
|
|
|
* @param name - name of object
|
|
|
|
|
* @param codec - codec for values
|
|
|
|
|
* @return Set object
|
|
|
|
|
*/
|
|
|
|
|
<V> RSet<V> getSet(String name, Codec codec);
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Returns sorted set instance by name.
|
|
|
|
|
* This sorted set uses comparator to sort objects.
|
|
|
|
|
*
|
|
|
|
|
* @param name of sorted set
|
|
|
|
|
* @return
|
|
|
|
|
*
|
|
|
|
|
* @param <V> type of value
|
|
|
|
|
* @param name - name of object
|
|
|
|
|
* @return SortedSet object
|
|
|
|
|
*/
|
|
|
|
|
<V> RSortedSet<V> getSortedSet(String name);
|
|
|
|
|
|
|
|
|
@ -363,19 +406,21 @@ public interface RedissonClient {
|
|
|
|
|
* Returns sorted set instance by name
|
|
|
|
|
* using provided codec for sorted set objects.
|
|
|
|
|
* This sorted set sorts objects using comparator.
|
|
|
|
|
*
|
|
|
|
|
* @param name of sorted set
|
|
|
|
|
* @param sorted set object codec
|
|
|
|
|
* @return
|
|
|
|
|
*
|
|
|
|
|
* @param <V> type of value
|
|
|
|
|
* @param name - name of object
|
|
|
|
|
* @param codec - codec for values
|
|
|
|
|
* @return SortedSet object
|
|
|
|
|
*/
|
|
|
|
|
<V> RSortedSet<V> getSortedSet(String name, Codec codec);
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Returns Redis Sorted Set instance by name.
|
|
|
|
|
* This sorted set sorts objects by object score.
|
|
|
|
|
*
|
|
|
|
|
* @param name of scored sorted set
|
|
|
|
|
* @return
|
|
|
|
|
*
|
|
|
|
|
* @param <V> type of value
|
|
|
|
|
* @param name - name of object
|
|
|
|
|
* @return ScoredSortedSet object
|
|
|
|
|
*/
|
|
|
|
|
<V> RScoredSortedSet<V> getScoredSortedSet(String name);
|
|
|
|
|
|
|
|
|
@ -383,10 +428,11 @@ public interface RedissonClient {
|
|
|
|
|
* Returns Redis Sorted Set instance by name
|
|
|
|
|
* using provided codec for sorted set objects.
|
|
|
|
|
* This sorted set sorts objects by object score.
|
|
|
|
|
*
|
|
|
|
|
* @param name of scored sorted set
|
|
|
|
|
* @param scored sorted set object codec
|
|
|
|
|
* @return
|
|
|
|
|
*
|
|
|
|
|
* @param <V> type of value
|
|
|
|
|
* @param name - name of object
|
|
|
|
|
* @param codec - codec for values
|
|
|
|
|
* @return ScoredSortedSet object
|
|
|
|
|
*/
|
|
|
|
|
<V> RScoredSortedSet<V> getScoredSortedSet(String name, Codec codec);
|
|
|
|
|
|
|
|
|
@ -394,17 +440,18 @@ public interface RedissonClient {
|
|
|
|
|
* 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
|
|
|
|
|
*
|
|
|
|
|
* @param name
|
|
|
|
|
* @return
|
|
|
|
|
*
|
|
|
|
|
* @param name - name of object
|
|
|
|
|
* @return LexSortedSet object
|
|
|
|
|
*/
|
|
|
|
|
RLexSortedSet getLexSortedSet(String name);
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Returns topic instance by name.
|
|
|
|
|
*
|
|
|
|
|
* @param name of topic
|
|
|
|
|
* @return
|
|
|
|
|
*
|
|
|
|
|
* @param <M> type of message
|
|
|
|
|
* @param name - name of object
|
|
|
|
|
* @return Topic object
|
|
|
|
|
*/
|
|
|
|
|
<M> RTopic<M> getTopic(String name);
|
|
|
|
|
|
|
|
|
@ -412,9 +459,10 @@ public interface RedissonClient {
|
|
|
|
|
* Returns topic instance by name
|
|
|
|
|
* using provided codec for messages.
|
|
|
|
|
*
|
|
|
|
|
* @param name of topic
|
|
|
|
|
* @param message codec
|
|
|
|
|
* @return
|
|
|
|
|
* @param <M> type of message
|
|
|
|
|
* @param name - name of object
|
|
|
|
|
* @param codec - codec for message
|
|
|
|
|
* @return Topic object
|
|
|
|
|
*/
|
|
|
|
|
<M> RTopic<M> getTopic(String name, Codec codec);
|
|
|
|
|
|
|
|
|
@ -425,9 +473,10 @@ public interface RedissonClient {
|
|
|
|
|
* 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
|
|
|
|
|
*
|
|
|
|
|
*
|
|
|
|
|
* @param <M> type of message
|
|
|
|
|
* @param pattern of the topic
|
|
|
|
|
* @return
|
|
|
|
|
* @return PatterTopic object
|
|
|
|
|
*/
|
|
|
|
|
<M> RPatternTopic<M> getPatternTopic(String pattern);
|
|
|
|
|
|
|
|
|
@ -439,18 +488,20 @@ public interface RedissonClient {
|
|
|
|
|
* 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
|
|
|
|
|
*
|
|
|
|
|
*
|
|
|
|
|
* @param <M> type of message
|
|
|
|
|
* @param pattern of the topic
|
|
|
|
|
* @param message codec
|
|
|
|
|
* @return
|
|
|
|
|
* @param codec - codec for message
|
|
|
|
|
* @return PatterTopic object
|
|
|
|
|
*/
|
|
|
|
|
<M> RPatternTopic<M> getPatternTopic(String pattern, Codec codec);
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Returns unbounded queue instance by name.
|
|
|
|
|
*
|
|
|
|
|
* @param name of queue
|
|
|
|
|
* @return
|
|
|
|
|
* @param <V> type of value
|
|
|
|
|
* @param name - name of object
|
|
|
|
|
* @return Queue object
|
|
|
|
|
*/
|
|
|
|
|
<V> RQueue<V> getQueue(String name);
|
|
|
|
|
|
|
|
|
@ -458,121 +509,131 @@ public interface RedissonClient {
|
|
|
|
|
* Returns unbounded queue instance by name
|
|
|
|
|
* using provided codec for queue objects.
|
|
|
|
|
*
|
|
|
|
|
* @param name of queue
|
|
|
|
|
* @param queue objects codec
|
|
|
|
|
* @return
|
|
|
|
|
* @param <V> type of value
|
|
|
|
|
* @param name - name of object
|
|
|
|
|
* @param codec - codec for message
|
|
|
|
|
* @return Queue object
|
|
|
|
|
*/
|
|
|
|
|
<V> RQueue<V> getQueue(String name, Codec codec);
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Returns unbounded blocking queue instance by name.
|
|
|
|
|
*
|
|
|
|
|
* @param name of queue
|
|
|
|
|
* @return
|
|
|
|
|
*
|
|
|
|
|
* @param <V> type of value
|
|
|
|
|
* @param name - name of object
|
|
|
|
|
* @return BlockingQueue object
|
|
|
|
|
*/
|
|
|
|
|
<V> RBlockingQueue<V> getBlockingQueue(String name);
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Returns unbounded blocking queue instance by name
|
|
|
|
|
* using provided codec for queue objects.
|
|
|
|
|
*
|
|
|
|
|
* @param name of queue
|
|
|
|
|
* @param queue objects codec
|
|
|
|
|
* @return
|
|
|
|
|
*
|
|
|
|
|
* @param <V> type of value
|
|
|
|
|
* @param name - name of queue
|
|
|
|
|
* @param codec - queue objects codec
|
|
|
|
|
* @return BlockingQueue object
|
|
|
|
|
*/
|
|
|
|
|
<V> RBlockingQueue<V> getBlockingQueue(String name, Codec codec);
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Returns bounded blocking queue instance by name.
|
|
|
|
|
*
|
|
|
|
|
* @param <V> type of value
|
|
|
|
|
* @param name of queue
|
|
|
|
|
* @return
|
|
|
|
|
* @return BoundedBlockingQueue object
|
|
|
|
|
*/
|
|
|
|
|
<V> RBoundedBlockingQueue<V> getBoundedBlockingQueue(String name);
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Returns bounded blocking queue instance by name
|
|
|
|
|
* using provided codec for queue objects.
|
|
|
|
|
*
|
|
|
|
|
* @param name of queue
|
|
|
|
|
* @param queue objects codec
|
|
|
|
|
* @return
|
|
|
|
|
*
|
|
|
|
|
* @param <V> type of value
|
|
|
|
|
* @param name - name of queue
|
|
|
|
|
* @param codec - codec for values
|
|
|
|
|
* @return BoundedBlockingQueue object
|
|
|
|
|
*/
|
|
|
|
|
<V> RBoundedBlockingQueue<V> getBoundedBlockingQueue(String name, Codec codec);
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Returns unbounded deque instance by name.
|
|
|
|
|
*
|
|
|
|
|
* @param name of deque
|
|
|
|
|
* @return
|
|
|
|
|
*
|
|
|
|
|
* @param <V> type of value
|
|
|
|
|
* @param name - name of object
|
|
|
|
|
* @return Deque object
|
|
|
|
|
*/
|
|
|
|
|
<V> RDeque<V> getDeque(String name);
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Returns unbounded deque instance by name
|
|
|
|
|
* using provided codec for deque objects.
|
|
|
|
|
*
|
|
|
|
|
* @param name of deque
|
|
|
|
|
* @param deque objects codec
|
|
|
|
|
* @return
|
|
|
|
|
*
|
|
|
|
|
* @param <V> type of value
|
|
|
|
|
* @param name - name of object
|
|
|
|
|
* @param codec - codec for values
|
|
|
|
|
* @return Deque object
|
|
|
|
|
*/
|
|
|
|
|
<V> RDeque<V> getDeque(String name, Codec codec);
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Returns unbounded blocking deque instance by name.
|
|
|
|
|
*
|
|
|
|
|
* @param name of deque
|
|
|
|
|
* @return
|
|
|
|
|
*
|
|
|
|
|
* @param <V> type of value
|
|
|
|
|
* @param name - name of object
|
|
|
|
|
* @return BlockingDeque object
|
|
|
|
|
*/
|
|
|
|
|
<V> RBlockingDeque<V> getBlockingDeque(String name);
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Returns unbounded blocking deque instance by name
|
|
|
|
|
* using provided codec for deque objects.
|
|
|
|
|
*
|
|
|
|
|
* @param name of deque
|
|
|
|
|
* @param deque objects codec
|
|
|
|
|
* @return
|
|
|
|
|
*
|
|
|
|
|
* @param <V> type of value
|
|
|
|
|
* @param name - name of object
|
|
|
|
|
* @param codec - deque objects codec
|
|
|
|
|
* @return BlockingDeque object
|
|
|
|
|
*/
|
|
|
|
|
<V> RBlockingDeque<V> getBlockingDeque(String name, Codec codec);
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Returns atomicLong instance by name.
|
|
|
|
|
*
|
|
|
|
|
* @param name of atomicLong
|
|
|
|
|
* @return
|
|
|
|
|
* @param name - name of object
|
|
|
|
|
* @return AtomicLong object
|
|
|
|
|
*/
|
|
|
|
|
RAtomicLong getAtomicLong(String name);
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Returns atomicDouble instance by name.
|
|
|
|
|
*
|
|
|
|
|
* @param name of atomicLong
|
|
|
|
|
* @return
|
|
|
|
|
* @param name - name of object
|
|
|
|
|
* @return AtomicDouble object
|
|
|
|
|
*/
|
|
|
|
|
RAtomicDouble getAtomicDouble(String name);
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Returns countDownLatch instance by name.
|
|
|
|
|
*
|
|
|
|
|
* @param name of countDownLatch
|
|
|
|
|
* @return
|
|
|
|
|
* @param name - name of object
|
|
|
|
|
* @return CountDownLatch object
|
|
|
|
|
*/
|
|
|
|
|
RCountDownLatch getCountDownLatch(String name);
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Returns bitSet instance by name.
|
|
|
|
|
*
|
|
|
|
|
* @param name of bitSet
|
|
|
|
|
* @return
|
|
|
|
|
* @param name - name of object
|
|
|
|
|
* @return BitSet object
|
|
|
|
|
*/
|
|
|
|
|
RBitSet getBitSet(String name);
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Returns bloom filter instance by name.
|
|
|
|
|
*
|
|
|
|
|
* @param name of bloom filter
|
|
|
|
|
* @return
|
|
|
|
|
*
|
|
|
|
|
* @param <V> type of value
|
|
|
|
|
* @param name - name of object
|
|
|
|
|
* @return BloomFilter object
|
|
|
|
|
*/
|
|
|
|
|
<V> RBloomFilter<V> getBloomFilter(String name);
|
|
|
|
|
|
|
|
|
@ -580,22 +641,25 @@ public interface RedissonClient {
|
|
|
|
|
* Returns bloom filter instance by name
|
|
|
|
|
* using provided codec for objects.
|
|
|
|
|
*
|
|
|
|
|
* @param name of bloom filter
|
|
|
|
|
* @return
|
|
|
|
|
* @param <V> type of value
|
|
|
|
|
* @param name - name of object
|
|
|
|
|
* @param codec - codec for values
|
|
|
|
|
* @return BloomFilter object
|
|
|
|
|
*/
|
|
|
|
|
<V> RBloomFilter<V> getBloomFilter(String name, Codec codec);
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Returns script operations object
|
|
|
|
|
*
|
|
|
|
|
* @return
|
|
|
|
|
* @return Script object
|
|
|
|
|
*/
|
|
|
|
|
RScript getScript();
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Returns ScheduledExecutorService by name
|
|
|
|
|
*
|
|
|
|
|
* @return
|
|
|
|
|
* @param name - name of object
|
|
|
|
|
* @return ScheduledExecutorService object
|
|
|
|
|
*/
|
|
|
|
|
RScheduledExecutorService getExecutorService(String name);
|
|
|
|
|
|
|
|
|
@ -603,14 +667,16 @@ public interface RedissonClient {
|
|
|
|
|
* Returns ScheduledExecutorService by name
|
|
|
|
|
* using provided codec for task, response and request serialization
|
|
|
|
|
*
|
|
|
|
|
* @return
|
|
|
|
|
* @param name - name of object
|
|
|
|
|
* @param codec - codec for task, response and request
|
|
|
|
|
* @return ScheduledExecutorService object
|
|
|
|
|
*/
|
|
|
|
|
RScheduledExecutorService getExecutorService(Codec codec, String name);
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Returns object for remote operations prefixed with the default name (redisson_remote_service)
|
|
|
|
|
*
|
|
|
|
|
* @return
|
|
|
|
|
* @return RemoteService object
|
|
|
|
|
*/
|
|
|
|
|
RRemoteService getRemoteSerivce();
|
|
|
|
|
|
|
|
|
@ -618,15 +684,16 @@ public interface RedissonClient {
|
|
|
|
|
* Returns object for remote operations prefixed with the default name (redisson_remote_service)
|
|
|
|
|
* and uses provided codec for method arguments and result.
|
|
|
|
|
*
|
|
|
|
|
* @return
|
|
|
|
|
* @param codec - codec for response and request
|
|
|
|
|
* @return RemoteService object
|
|
|
|
|
*/
|
|
|
|
|
RRemoteService getRemoteSerivce(Codec codec);
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Returns object for remote operations prefixed with the specified name
|
|
|
|
|
*
|
|
|
|
|
* @param name The name used as the Redis key prefix for the services
|
|
|
|
|
* @return
|
|
|
|
|
* @param name - the name used as the Redis key prefix for the services
|
|
|
|
|
* @return RemoteService object
|
|
|
|
|
*/
|
|
|
|
|
RRemoteService getRemoteSerivce(String name);
|
|
|
|
|
|
|
|
|
@ -634,8 +701,9 @@ public interface RedissonClient {
|
|
|
|
|
* Returns object for remote operations prefixed with the specified name
|
|
|
|
|
* and uses provided codec for method arguments and result.
|
|
|
|
|
*
|
|
|
|
|
* @param name The name used as the Redis key prefix for the services
|
|
|
|
|
* @return
|
|
|
|
|
* @param name - the name used as the Redis key prefix for the services
|
|
|
|
|
* @param codec - codec for response and request
|
|
|
|
|
* @return RemoteService object
|
|
|
|
|
*/
|
|
|
|
|
RRemoteService getRemoteSerivce(String name, Codec codec);
|
|
|
|
|
|
|
|
|
@ -645,7 +713,7 @@ public interface RedissonClient {
|
|
|
|
|
*
|
|
|
|
|
* See <a href="http://redis.io/topics/pipelining">http://redis.io/topics/pipelining</a>
|
|
|
|
|
*
|
|
|
|
|
* @return
|
|
|
|
|
* @return Batch object
|
|
|
|
|
*/
|
|
|
|
|
RBatch createBatch();
|
|
|
|
|
|
|
|
|
@ -653,7 +721,7 @@ public interface RedissonClient {
|
|
|
|
|
* Returns interface with methods for Redis keys.
|
|
|
|
|
* Each of Redis/Redisson object associated with own key
|
|
|
|
|
*
|
|
|
|
|
* @return
|
|
|
|
|
* @return Keys object
|
|
|
|
|
*/
|
|
|
|
|
RKeys getKeys();
|
|
|
|
|
|
|
|
|
@ -661,7 +729,7 @@ public interface RedissonClient {
|
|
|
|
|
* Returns RedissonAttachedLiveObjectService which can be used to
|
|
|
|
|
* retrieve live REntity(s)
|
|
|
|
|
*
|
|
|
|
|
* @return
|
|
|
|
|
* @return LiveObjectService object
|
|
|
|
|
*/
|
|
|
|
|
RLiveObjectService getLiveObjectService();
|
|
|
|
|
|
|
|
|
@ -698,14 +766,14 @@ public interface RedissonClient {
|
|
|
|
|
/**
|
|
|
|
|
* Returns the CodecProvider instance
|
|
|
|
|
*
|
|
|
|
|
* @return CodecProvider
|
|
|
|
|
* @return CodecProvider object
|
|
|
|
|
*/
|
|
|
|
|
public CodecProvider getCodecProvider();
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Returns the ResolverProvider instance
|
|
|
|
|
*
|
|
|
|
|
* @return resolverProvider
|
|
|
|
|
* @return ResolverProvider object
|
|
|
|
|
*/
|
|
|
|
|
public ResolverProvider getResolverProvider();
|
|
|
|
|
|
|
|
|
@ -713,21 +781,21 @@ public interface RedissonClient {
|
|
|
|
|
/**
|
|
|
|
|
* Get Redis nodes group for server operations
|
|
|
|
|
*
|
|
|
|
|
* @return
|
|
|
|
|
* @return NodesGroup object
|
|
|
|
|
*/
|
|
|
|
|
NodesGroup<Node> getNodesGroup();
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Get Redis cluster nodes group for server operations
|
|
|
|
|
*
|
|
|
|
|
* @return
|
|
|
|
|
* @return ClusterNodesGroup object
|
|
|
|
|
*/
|
|
|
|
|
ClusterNodesGroup getClusterNodesGroup();
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Returns {@code true} if this Redisson instance has been shut down.
|
|
|
|
|
*
|
|
|
|
|
* @return
|
|
|
|
|
* @return code true} if this Redisson instance has been shut down overwise <code>false</code>
|
|
|
|
|
*/
|
|
|
|
|
boolean isShutdown();
|
|
|
|
|
|
|
|
|
@ -735,7 +803,8 @@ public interface RedissonClient {
|
|
|
|
|
* Returns {@code true} if this Redisson instance was started to be shutdown
|
|
|
|
|
* or was shutdown {@link #isShutdown()} already.
|
|
|
|
|
*
|
|
|
|
|
* @return
|
|
|
|
|
* @return {@code true} if this Redisson instance was started to be shutdown
|
|
|
|
|
* or was shutdown {@link #isShutdown()} already.
|
|
|
|
|
*/
|
|
|
|
|
boolean isShuttingDown();
|
|
|
|
|
|
|
|
|
|