org.redisson.api

Interface RBatch

All Known Implementing Classes:

RedissonBatch

public interface RBatch

Interface for using pipeline feature.

All method invocations on objects from this interface are batched to separate queue and could be executed later with execute() or executeAsync() methods.

Please be aware, atomicity is not guaranteed.

Author:

Nikita Koksharov

Method Summary

Methods

Modifier and Type	Method and Description
List<?>	execute() Executes all operations accumulated during async methods invocations.
RFuture<List<?>>	executeAsync() Executes all operations accumulated during async methods invocations asynchronously.
void	executeSkipResult() Executes all operations accumulated during async methods invocations.
RFuture<Void>	executeSkipResultAsync() Executes all operations accumulated during async methods invocations asynchronously, Command replies are skipped such approach saves response bandwidth.
RAtomicDoubleAsync	getAtomicDouble(String name) Returns atomicDouble instance by name.
RAtomicLongAsync	getAtomicLong(String name) Returns atomicLong instance by name.
RBitSetAsync	getBitSet(String name)
<V> RBlockingDequeAsync<V>	getBlockingDeque(String name) Returns blocking deque instance by name.
<V> RBlockingDequeAsync<V>	getBlockingDeque(String name, Codec codec)
<V> RBlockingQueueAsync<V>	getBlockingQueue(String name) Returns blocking queue instance by name.
<V> RBlockingQueueAsync<V>	getBlockingQueue(String name, Codec codec)
<V> RBucketAsync<V>	getBucket(String name) Returns object holder by name
<V> RBucketAsync<V>	getBucket(String name, Codec codec)
<V> RDequeAsync<V>	getDeque(String name) Returns deque instance by name.
<V> RDequeAsync<V>	getDeque(String name, Codec codec)
<V> RGeoAsync<V>	getGeo(String name) Returns geospatial items holder instance by name.
<V> RGeoAsync<V>	getGeo(String name, Codec codec) Returns geospatial items holder instance by name using provided codec for geospatial members.
<V> RHyperLogLogAsync<V>	getHyperLogLog(String name) Returns HyperLogLog object
<V> RHyperLogLogAsync<V>	getHyperLogLog(String name, Codec codec)
RKeysAsync	getKeys() Returns keys operations.
RLexSortedSetAsync	getLexSortedSet(String name) Returns String based Redis Sorted Set instance by name All elements are inserted with the same score during addition, in order to force lexicographical ordering
<V> RListAsync<V>	getList(String name) Returns list instance by name.
<V> RListAsync<V>	getList(String name, Codec codec)
<K,V> RMultimapAsync<K,V>	getListMultimap(String name) Returns List based MultiMap instance by name.
<K,V> RMultimapAsync<K,V>	getListMultimap(String name, Codec codec) Returns List based MultiMap instance by name using provided codec for both map keys and values.
<K,V> RMultimapAsync<K,V>	getListMultimapCache(String name) Returns List based Multimap instance by name.
<K,V> RMultimapAsync<K,V>	getListMultimapCache(String name, Codec codec) Returns List based Multimap instance by name using provided codec for both map keys and values.
<K,V> RMapAsync<K,V>	getMap(String name) Returns map instance by name.
<K,V> RMapAsync<K,V>	getMap(String name, Codec codec)
<K,V> RMapCacheAsync<K,V>	getMapCache(String name) Returns map-based cache instance by name.
<K,V> RMapCacheAsync<K,V>	getMapCache(String name, Codec codec) Returns map-based cache instance by name using provided codec for both cache keys and values.
<V> RQueueAsync<V>	getQueue(String name) Returns queue instance by name.
<V> RQueueAsync<V>	getQueue(String name, Codec codec)
<V> RScoredSortedSetAsync<V>	getScoredSortedSet(String name) Returns Redis Sorted Set instance by name
<V> RScoredSortedSetAsync<V>	getScoredSortedSet(String name, Codec codec)
RScriptAsync	getScript() Returns script operations object
<V> RSetAsync<V>	getSet(String name) Returns set instance by name.
<V> RSetAsync<V>	getSet(String name, Codec codec)
<V> RSetCacheAsync<V>	getSetCache(String name) Returns set-based cache instance by name.
<V> RSetCacheAsync<V>	getSetCache(String name, Codec codec) Returns set-based cache instance by name using provided codec for values.
<K,V> RMultimapAsync<K,V>	getSetMultimap(String name) Returns Set based MultiMap instance by name.
<K,V> RMultimapAsync<K,V>	getSetMultimap(String name, Codec codec) Returns Set based MultiMap instance by name using provided codec for both map keys and values.
<K,V> RMultimapCacheAsync<K,V>	getSetMultimapCache(String name) Returns Set based Multimap instance by name.
<K,V> RMultimapCacheAsync<K,V>	getSetMultimapCache(String name, Codec codec) Returns Set based Multimap instance by name using provided codec for both map keys and values.
<M> RTopicAsync<M>	getTopic(String name) Returns topic instance by name.
<M> RTopicAsync<M>	getTopic(String name, Codec codec)
RBatch	retryAttempts(int retryAttempts) Defines attempts amount to re-send Redis commands batch if it hasn't been sent already.
RBatch	retryInterval(long retryInterval, TimeUnit unit) Defines time interval for another one attempt send Redis commands batch if it hasn't been sent already.
RBatch	timeout(long timeout, TimeUnit unit) Defines timeout for Redis response.

Method Detail

getGeo

<V> RGeoAsync<V> getGeo(String name)

Returns geospatial items holder instance by name.

Type Parameters:

V - type of object

Parameters:

name - - name of object

Returns:

Geo object

getGeo

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

getSetMultimap

<K,V> RMultimapAsync<K,V> getSetMultimap(String name)

Returns Set based MultiMap instance by name.

Type Parameters:

K - type of key

V - type of value

Parameters:

name - - name of object

Returns:

Multimap object

getSetMultimap

<K,V> RMultimapAsync<K,V> getSetMultimap(String name,
                                       Codec codec)

Returns Set based MultiMap instance by name using provided codec for both map keys and values.

Type Parameters:

K - type of key

V - type of value

Parameters:

name - - name of object

codec - - provided codec

Returns:

Multimap object

getSetMultimapCache

<K,V> RMultimapCacheAsync<K,V> getSetMultimapCache(String name)

Returns Set based Multimap instance by name. Supports key-entry eviction with a given TTL value.

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

Type Parameters:

K - type of key

V - type of value

Parameters:

name - - name of object

Returns:

SetMultimapCache object

getSetMultimapCache

<K,V> RMultimapCacheAsync<K,V> getSetMultimapCache(String name,
                                                 Codec codec)

Returns Set based Multimap instance by name using provided codec for both map keys and values. Supports key-entry eviction with a given TTL value.

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

Type Parameters:

K - type of key

V - type of value

Parameters:

name - - name of object

codec - - provided codec

Returns:

SetMultimapCache object

getSetCache

<V> RSetCacheAsync<V> getSetCache(String name)

Returns set-based cache instance by name. Uses map (value_hash, value) under the hood for minimal memory consumption. Supports value eviction with a given TTL value.

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

Type Parameters:

V - type of value

Parameters:

name - - name of object

Returns:

SetCache object

getSetCache

<V> RSetCacheAsync<V> getSetCache(String name,
                                Codec codec)

Returns set-based cache instance by name using provided codec for values. Uses map (value_hash, value) under the hood for minimal memory consumption. Supports value eviction with a given TTL value.

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

Type Parameters:

V - type of value

Parameters:

name - - name of object

codec - - codec for values

Returns:

SetCache object

getMapCache

<K,V> RMapCacheAsync<K,V> getMapCache(String name,
                                    Codec codec)

Returns map-based cache instance by name using provided codec for both cache keys and values. Supports entry eviction with a given TTL value.

If eviction is not required then it's better to use regular map getMap(String, Codec).

Type Parameters:

K - type of key

V - type of value

Parameters:

name - - name of object

codec - - codec for keys and values

Returns:

MapCache object

getMapCache

<K,V> RMapCacheAsync<K,V> getMapCache(String name)

Returns map-based cache instance by name. Supports entry eviction with a given TTL value.

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

Type Parameters:

K - type of key

V - type of value

Parameters:

name - - name of object

Returns:

MapCache object

getBucket

<V> RBucketAsync<V> getBucket(String name)

Returns object holder by name

Type Parameters:

V - type of object

Parameters:

name - - name of object

Returns:

Bucket object

getBucket

<V> RBucketAsync<V> getBucket(String name,
                            Codec codec)

getHyperLogLog

<V> RHyperLogLogAsync<V> getHyperLogLog(String name)

Returns HyperLogLog object

Type Parameters:

V - type of object

Parameters:

name - - name of object

Returns:

HyperLogLog object

getHyperLogLog

<V> RHyperLogLogAsync<V> getHyperLogLog(String name,
                                      Codec codec)

getList

<V> RListAsync<V> getList(String name)

Returns list instance by name.

Type Parameters:

V - type of object

Parameters:

name - - name of object

Returns:

List object

getList

<V> RListAsync<V> getList(String name,
                        Codec codec)

getListMultimap

<K,V> RMultimapAsync<K,V> getListMultimap(String name)

Returns List based MultiMap instance by name.

Type Parameters:

K - type of key

V - type of value

Parameters:

name - - name of object

Returns:

ListMultimap object

getListMultimap

<K,V> RMultimapAsync<K,V> getListMultimap(String name,
                                        Codec codec)

Returns List based MultiMap instance by name using provided codec for both map keys and values.

Type Parameters:

K - type of key

V - type of value

Parameters:

name - - name of object

codec - - codec for keys and values

Returns:

ListMultimap object

getListMultimapCache

<K,V> RMultimapAsync<K,V> getListMultimapCache(String name)

Returns List based Multimap instance by name. Supports key-entry eviction with a given TTL value.

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

Type Parameters:

K - type of key

V - type of value

Parameters:

name - - name of object

Returns:

ListMultimapCache object

getListMultimapCache

<K,V> RMultimapAsync<K,V> getListMultimapCache(String name,
                                             Codec codec)

Returns List based Multimap instance by name using provided codec for both map keys and values. Supports key-entry eviction with a given TTL value.

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

Type Parameters:

K - type of key

V - type of value

Parameters:

name - - name of object

codec - - codec for keys and values

Returns:

ListMultimapCache object

getMap

<K,V> RMapAsync<K,V> getMap(String name)

Returns map instance by name.

Type Parameters:

K - type of key

V - type of value

Parameters:

name - - name of object

Returns:

Map object

getMap

<K,V> RMapAsync<K,V> getMap(String name,
                          Codec codec)

getSet

<V> RSetAsync<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> RSetAsync<V> getSet(String name,
                      Codec codec)

getTopic

<M> RTopicAsync<M> getTopic(String name)

Returns topic instance by name.

Type Parameters:

M - type of message

Parameters:

name - - name of object

Returns:

Topic object

getTopic

<M> RTopicAsync<M> getTopic(String name,
                          Codec codec)

getQueue

<V> RQueueAsync<V> getQueue(String name)

Returns queue instance by name.

Type Parameters:

V - type of value

Parameters:

name - - name of object

Returns:

Queue object

getQueue

<V> RQueueAsync<V> getQueue(String name,
                          Codec codec)

getBlockingQueue

<V> RBlockingQueueAsync<V> getBlockingQueue(String name)

Returns blocking queue instance by name.

Type Parameters:

V - type of value

Parameters:

name - - name of object

Returns:

BlockingQueue object

getBlockingQueue

<V> RBlockingQueueAsync<V> getBlockingQueue(String name,
                                          Codec codec)

getDeque

<V> RDequeAsync<V> getDeque(String name)

Returns deque instance by name.

Type Parameters:

V - type of value

Parameters:

name - - name of object

Returns:

Deque object

getDeque

<V> RDequeAsync<V> getDeque(String name,
                          Codec codec)

getBlockingDeque

<V> RBlockingDequeAsync<V> getBlockingDeque(String name)

Returns blocking deque instance by name.

Type Parameters:

V - type of value

Parameters:

name - - name of object

Returns:

BlockingDeque object

getBlockingDeque

<V> RBlockingDequeAsync<V> getBlockingDeque(String name,
                                          Codec codec)

getAtomicLong

RAtomicLongAsync getAtomicLong(String name)

Returns atomicLong instance by name.

Parameters:

name - - name of object

Returns:

AtomicLong object

getAtomicDouble

RAtomicDoubleAsync getAtomicDouble(String name)

Returns atomicDouble instance by name.

Parameters:

name - - name of object

Returns:

AtomicDouble object

getScoredSortedSet

<V> RScoredSortedSetAsync<V> getScoredSortedSet(String name)

Returns Redis Sorted Set instance by name

Type Parameters:

V - type of value

Parameters:

name - - name of object

Returns:

ScoredSortedSet object

getScoredSortedSet

<V> RScoredSortedSetAsync<V> getScoredSortedSet(String name,
                                              Codec codec)

getLexSortedSet

RLexSortedSetAsync getLexSortedSet(String name)

Returns String based Redis Sorted Set instance by name All elements are inserted with the same score during addition, in order to force lexicographical ordering

Parameters:

name - - name of object

Returns:

LexSortedSet object

getBitSet

RBitSetAsync getBitSet(String name)

getScript

RScriptAsync getScript()

Returns script operations object

Returns:

Script object

getKeys

RKeysAsync getKeys()

Returns keys operations. Each of Redis/Redisson object associated with own key

Returns:

Keys object

execute

List<?> execute()
                throws RedisException

Executes all operations accumulated during async methods invocations.

If cluster configuration used then operations are grouped by slot ids and may be executed on different servers. Thus command execution order could be changed

Returns:

List with result object for each command

Throws:

RedisException - in case of any error

executeAsync

RFuture<List<?>> executeAsync()

Executes all operations accumulated during async methods invocations asynchronously.

In cluster configurations operations grouped by slot ids so may be executed on different servers. Thus command execution order could be changed

Returns:

List with result object for each command

executeSkipResult

void executeSkipResult()

Executes all operations accumulated during async methods invocations. Command replies are skipped such approach saves response bandwidth.

If cluster configuration used then operations are grouped by slot ids and may be executed on different servers. Thus command execution order could be changed.

NOTE: Redis 3.2+ required

Throws:

RedisException - in case of any error

executeSkipResultAsync

RFuture<Void> executeSkipResultAsync()

Executes all operations accumulated during async methods invocations asynchronously, Command replies are skipped such approach saves response bandwidth.

If cluster configuration used then operations are grouped by slot ids and may be executed on different servers. Thus command execution order could be changed

NOTE: Redis 3.2+ required

Returns:

void

Throws:

RedisException - in case of any error

timeout

RBatch timeout(long timeout,
             TimeUnit unit)

Defines timeout for Redis response. Starts to countdown when Redis command has been successfully sent.

0 value means use Config.setTimeout value instead.

Default is 0

Parameters:

timeout - value

unit - value

Returns:

self instance

retryInterval

RBatch retryInterval(long retryInterval,
                   TimeUnit unit)

Defines time interval for another one attempt send Redis commands batch if it hasn't been sent already.

0 value means use Config.setRetryInterval value instead.

Default is 0

Parameters:

retryInterval - value

unit - value

Returns:

self instance

retryAttempts

RBatch retryAttempts(int retryAttempts)

Defines attempts amount to re-send Redis commands batch if it hasn't been sent already.

0 value means use Config.setRetryAttempts value instead.

Default is 0

Parameters:

retryAttempts - value

Returns:

self instance