Package org.redisson.api

Interface RMapCacheRx<K,V>

Type Parameters:

K - key

V - value

All Superinterfaces:

RDestroyable, RExpirableRx, RMapRx<K,V>, RObjectRx

public interface RMapCacheRx<K,V>
extends RMapRx<K,V>, RDestroyable

Map-based cache with ability to set TTL for each entry via put(Object, Object, long, TimeUnit) or putIfAbsent(Object, Object, long, TimeUnit) method. And therefore has an complex lua-scripts inside.

Current redis implementation doesnt have map entry eviction functionality. Thus entries are checked for TTL expiration during any key/value/entry read operation. If key/value/entry expired then it doesn't returns and clean task runs asynchronous. Clean task deletes removes 100 expired entries at once. In addition there is EvictionScheduler. This scheduler deletes expired entries in time interval between 5 seconds to 2 hours.

If eviction is not required then it's better to use RedissonMapReactive.

Author:

Nikita Koksharov

Method Summary

Modifier and Type	Method	Description
io.reactivex.rxjava3.core.Single<Boolean>	fastPut(K key, V value, long ttl, TimeUnit unit)	Stores value mapped by key with specified time to live.
io.reactivex.rxjava3.core.Single<Boolean>	fastPut(K key, V value, long ttl, TimeUnit ttlUnit, long maxIdleTime, TimeUnit maxIdleUnit)	Stores value mapped by key with specified time to live and max idle time.
io.reactivex.rxjava3.core.Single<Boolean>	fastPutIfAbsent(K key, V value, long ttl, TimeUnit ttlUnit, long maxIdleTime, TimeUnit maxIdleUnit)	If the specified key is not already associated with a value, associate it with the given value.
io.reactivex.rxjava3.core.Maybe<V>	getWithTTLOnly(K key)	Returns the value mapped by defined key or null if value is absent.
io.reactivex.rxjava3.core.Maybe<V>	put(K key, V value, long ttl, TimeUnit unit)	Stores value mapped by key with specified time to live.
io.reactivex.rxjava3.core.Maybe<V>	put(K key, V value, long ttl, TimeUnit ttlUnit, long maxIdleTime, TimeUnit maxIdleUnit)	Stores value mapped by key with specified time to live and max idle time.
io.reactivex.rxjava3.core.Maybe<V>	putIfAbsent(K key, V value, long ttl, TimeUnit unit)	If the specified key is not already associated with a value, associate it with the given value.
io.reactivex.rxjava3.core.Maybe<V>	putIfAbsent(K key, V value, long ttl, TimeUnit ttlUnit, long maxIdleTime, TimeUnit maxIdleUnit)	If the specified key is not already associated with a value, associate it with the given value.
io.reactivex.rxjava3.core.Single<Long>	remainTimeToLive(K key)	Remaining time to live of map entry associated with a key.
io.reactivex.rxjava3.core.Completable	setMaxSize(int maxSize)	Sets max size of the map.
io.reactivex.rxjava3.core.Completable	setMaxSize(int maxSize, EvictionMode mode)	Sets max size of the map and overrides current value.
io.reactivex.rxjava3.core.Single<Integer>	size()	Returns the number of entries in cache.
io.reactivex.rxjava3.core.Single<Boolean>	trySetMaxSize(int maxSize)	Tries to set max size of the map.
io.reactivex.rxjava3.core.Single<Boolean>	trySetMaxSize(int maxSize, EvictionMode mode)	Tries to set max size of the map.
io.reactivex.rxjava3.core.Single<Boolean>	updateEntryExpiration(K key, long ttl, TimeUnit ttlUnit, long maxIdleTime, TimeUnit maxIdleUnit)	Updates time to live and max idle time of specified entry by key.

Methods inherited from interface org.redisson.api.RDestroyable

destroy

Methods inherited from interface org.redisson.api.RExpirableRx

clearExpire, expire, expireAt, expireAt, expireAt, remainTimeToLive

Methods inherited from interface org.redisson.api.RMapRx

addAndGet, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entryIterator, entryIterator, entryIterator, entryIterator, fastPut, fastPutIfAbsent, fastPutIfExists, fastRemove, get, getAll, getFairLock, getLock, getPermitExpirableSemaphore, getReadWriteLock, getSemaphore, keyIterator, keyIterator, keyIterator, keyIterator, loadAll, loadAll, merge, put, putAll, putIfAbsent, putIfExists, randomEntries, randomKeys, readAllEntrySet, readAllKeySet, readAllMap, readAllValues, remove, remove, replace, replace, valueIterator, valueIterator, valueIterator, valueIterator, valueSize

Methods inherited from interface org.redisson.api.RObjectRx

addListener, copy, delete, dump, getCodec, getIdleTime, getName, isExists, migrate, move, removeListener, rename, renamenx, restore, restore, restoreAndReplace, restoreAndReplace, sizeInMemory, touch, unlink

Method Detail

setMaxSize

io.reactivex.rxjava3.core.Completable setMaxSize(int maxSize)

Sets max size of the map. Superfluous elements are evicted using LRU algorithm.

Parameters:

maxSize - - max size

Returns:

void

setMaxSize

io.reactivex.rxjava3.core.Completable setMaxSize(int maxSize,
                                                 EvictionMode mode)

Sets max size of the map and overrides current value. Superfluous elements are evicted using defined algorithm.

Parameters:

maxSize - - max size

mode - - eviction mode

trySetMaxSize

io.reactivex.rxjava3.core.Single<Boolean> trySetMaxSize(int maxSize)

Tries to set max size of the map. Superfluous elements are evicted using LRU algorithm.

Parameters:

maxSize - - max size

Returns:

true if max size has been successfully set, otherwise false.

trySetMaxSize

io.reactivex.rxjava3.core.Single<Boolean> trySetMaxSize(int maxSize,
                                                        EvictionMode mode)

Tries to set max size of the map. Superfluous elements are evicted using defined algorithm.

Parameters:

maxSize - - max size

mode - - eviction mode

Returns:

true if max size has been successfully set, otherwise false.

putIfAbsent

io.reactivex.rxjava3.core.Maybe<V> putIfAbsent(K key,
                                               V value,
                                               long ttl,
                                               TimeUnit unit)

If the specified key is not already associated with a value, associate it with the given value.

Stores value mapped by key with specified time to live. Entry expires after specified time to live. If the map previously contained a mapping for the key, the old value is replaced by the specified value.

Parameters:

key - - map key

value - - map value

ttl - - time to live for key\value entry. If 0 then stores infinitely.

unit - - time unit

Returns:

previous associated value

putIfAbsent

io.reactivex.rxjava3.core.Maybe<V> putIfAbsent(K key,
                                               V value,
                                               long ttl,
                                               TimeUnit ttlUnit,
                                               long maxIdleTime,
                                               TimeUnit maxIdleUnit)

If the specified key is not already associated with a value, associate it with the given value.

Stores value mapped by key with specified time to live and max idle time. Entry expires when specified time to live or max idle time has expired.

If the map previously contained a mapping for the key, the old value is replaced by the specified value.

Parameters:

key - - map key

value - - map value

ttl - - time to live for key\value entry. If 0 then time to live doesn't affect entry expiration.

ttlUnit - - time unit

maxIdleTime - - max idle time for key\value entry. If 0 then max idle time doesn't affect entry expiration.

maxIdleUnit - - time unit

if maxIdleTime and ttl params are equal to 0 then entry stores infinitely.

Returns:

previous associated value

put

io.reactivex.rxjava3.core.Maybe<V> put(K key,
                                       V value,
                                       long ttl,
                                       TimeUnit unit)

Stores value mapped by key with specified time to live. Entry expires after specified time to live. If the map previously contained a mapping for the key, the old value is replaced by the specified value.

Parameters:

key - - map key

value - - map value

ttl - - time to live for key\value entry. If 0 then stores infinitely.

unit - - time unit

Returns:

previous associated value

put

io.reactivex.rxjava3.core.Maybe<V> put(K key,
                                       V value,
                                       long ttl,
                                       TimeUnit ttlUnit,
                                       long maxIdleTime,
                                       TimeUnit maxIdleUnit)

Stores value mapped by key with specified time to live and max idle time. Entry expires when specified time to live or max idle time has expired.

If the map previously contained a mapping for the key, the old value is replaced by the specified value.

Parameters:

key - - map key

value - - map value

ttl - - time to live for key\value entry. If 0 then time to live doesn't affect entry expiration.

ttlUnit - - time unit

maxIdleTime - - max idle time for key\value entry. If 0 then max idle time doesn't affect entry expiration.

maxIdleUnit - - time unit

if maxIdleTime and ttl params are equal to 0 then entry stores infinitely.

Returns:

previous associated value

fastPut

io.reactivex.rxjava3.core.Single<Boolean> fastPut(K key,
                                                  V value,
                                                  long ttl,
                                                  TimeUnit unit)

Stores value mapped by key with specified time to live. Entry expires after specified time to live.

If the map previously contained a mapping for the key, the old value is replaced by the specified value.

Works faster than usual put(Object, Object, long, TimeUnit) as it not returns previous value.

Parameters:

key - - map key

value - - map value

ttl - - time to live for key\value entry. If 0 then stores infinitely.

unit - - time unit

Returns:

true if key is a new key in the hash and value was set. false if key already exists in the hash and the value was updated.

fastPut

io.reactivex.rxjava3.core.Single<Boolean> fastPut(K key,
                                                  V value,
                                                  long ttl,
                                                  TimeUnit ttlUnit,
                                                  long maxIdleTime,
                                                  TimeUnit maxIdleUnit)

Stores value mapped by key with specified time to live and max idle time. Entry expires when specified time to live or max idle time has expired.

If the map previously contained a mapping for the key, the old value is replaced by the specified value.

Works faster than usual put(Object, Object, long, TimeUnit, long, TimeUnit) as it not returns previous value.

Parameters:

key - - map key

value - - map value

ttl - - time to live for key\value entry. If 0 then time to live doesn't affect entry expiration.

ttlUnit - - time unit

maxIdleTime - - max idle time for key\value entry. If 0 then max idle time doesn't affect entry expiration.

maxIdleUnit - - time unit

if maxIdleTime and ttl params are equal to 0 then entry stores infinitely.

Returns:

true if key is a new key in the hash and value was set. false if key already exists in the hash and the value was updated.

fastPutIfAbsent

io.reactivex.rxjava3.core.Single<Boolean> fastPutIfAbsent(K key,
                                                          V value,
                                                          long ttl,
                                                          TimeUnit ttlUnit,
                                                          long maxIdleTime,
                                                          TimeUnit maxIdleUnit)

If the specified key is not already associated with a value, associate it with the given value.

Stores value mapped by key with specified time to live and max idle time. Entry expires when specified time to live or max idle time has expired.

Works faster than usual putIfAbsent(Object, Object, long, TimeUnit, long, TimeUnit) as it not returns previous value.

Parameters:

key - - map key

value - - map value

ttl - - time to live for key\value entry. If 0 then time to live doesn't affect entry expiration.

ttlUnit - - time unit

maxIdleTime - - max idle time for key\value entry. If 0 then max idle time doesn't affect entry expiration.

maxIdleUnit - - time unit

if maxIdleTime and ttl params are equal to 0 then entry stores infinitely.

Returns:

true if key is a new key in the hash and value was set. false if key already exists in the hash

updateEntryExpiration

io.reactivex.rxjava3.core.Single<Boolean> updateEntryExpiration(K key,
                                                                long ttl,
                                                                TimeUnit ttlUnit,
                                                                long maxIdleTime,
                                                                TimeUnit maxIdleUnit)

Updates time to live and max idle time of specified entry by key. Entry expires when specified time to live or max idle time was reached.

Returns false if entry already expired or doesn't exist, otherwise returns true.

Parameters:

key - - map key

ttl - - time to live for key\value entry. If 0 then time to live doesn't affect entry expiration.

ttlUnit - - time unit

maxIdleTime - - max idle time for key\value entry. If 0 then max idle time doesn't affect entry expiration.

maxIdleUnit - - time unit

if maxIdleTime and ttl params are equal to 0 then entry stores infinitely.

Returns:

returns false if entry already expired or doesn't exist, otherwise returns true.

getWithTTLOnly

io.reactivex.rxjava3.core.Maybe<V> getWithTTLOnly(K key)

Returns the value mapped by defined key or null if value is absent.

If map doesn't contain value for specified key and MapLoader is defined then value will be loaded in read-through mode.

Idle time of entry is not taken into account. Entry last access time isn't modified if map limited by size.

Parameters:

key - the key

Returns:

the value mapped by defined key or null if value is absent

size

io.reactivex.rxjava3.core.Single<Integer> size()

Returns the number of entries in cache. This number can reflects expired entries too due to non realtime cleanup process.

Specified by:

size in interface RMapRx<K,V>

Returns:

size

remainTimeToLive

io.reactivex.rxjava3.core.Single<Long> remainTimeToLive(K key)

Remaining time to live of map entry associated with a key.

Parameters:

key - - map key

Returns:

time in milliseconds -2 if the key does not exist. -1 if the key exists but has no associated expire.