org.redisson.reactive

Class RedissonMapCacheReactive<K,V>

java.lang.Object

org.redisson.reactive.RedissonMapReactive<K,V>

org.redisson.reactive.RedissonMapCacheReactive<K,V>

Type Parameters:

K - key

V - value

All Implemented Interfaces:

RExpirableReactive, RMapCacheReactive<K,V>, RMapReactive<K,V>, RObjectReactive

public class RedissonMapCacheReactive<K,V>
extends RedissonMapReactive<K,V>
implements RMapCacheReactive<K,V>

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

Constructor Summary

Constructors

Constructor and Description
RedissonMapCacheReactive(Codec codec, EvictionScheduler evictionScheduler, CommandReactiveExecutor commandExecutor, String name)
RedissonMapCacheReactive(EvictionScheduler evictionScheduler, CommandReactiveExecutor commandExecutor, String name)

Method Summary

Methods

Modifier and Type	Method and Description
org.reactivestreams.Publisher<Boolean>	clearExpire() Clear an expire timeout or expire date for object in mode.
org.reactivestreams.Publisher<Boolean>	containsKey(Object key)
org.reactivestreams.Publisher<Boolean>	containsValue(Object value)
org.reactivestreams.Publisher<Boolean>	delete() Delete object in mode
org.reactivestreams.Publisher<Boolean>	expire(long timeToLive, TimeUnit timeUnit) Set a timeout for object in mode.
org.reactivestreams.Publisher<Boolean>	expireAt(Date timestamp) Set an expire date for object in mode.
org.reactivestreams.Publisher<Boolean>	expireAt(long timestamp) Set an expire date for object in mode.
org.reactivestreams.Publisher<Long>	fastRemove(K... keys) Removes keys from map by one operation in manner Works faster than RMap.remove but not returning the value associated with key
org.reactivestreams.Publisher<V>	get(K key)
org.reactivestreams.Publisher<Map<K,V>>	getAll(Set<K> keys)
Codec	getCodec()
String	getName()
org.reactivestreams.Publisher<Boolean>	isExists() Check object existence
org.reactivestreams.Publisher<Void>	migrate(String host, int port, int database) Transfer a object from a source Redis instance to a destination Redis instance in mode
org.reactivestreams.Publisher<Boolean>	move(int database) Move object to another database in mode
protected <V> reactor.rx.Stream<V>	newSucceeded(V result)
org.reactivestreams.Publisher<V>	put(K key, V value, long ttl, TimeUnit unit)
org.reactivestreams.Publisher<V>	putIfAbsent(K key, V value, long ttl, TimeUnit unit)
<R> org.reactivestreams.Publisher<R>	reactive(RFuture<R> future)
org.reactivestreams.Publisher<Long>	remainTimeToLive() Get remaining time to live of object in milliseconds.
org.reactivestreams.Publisher<V>	remove(K key)
org.reactivestreams.Publisher<Boolean>	remove(Object key, Object value)
org.reactivestreams.Publisher<Void>	rename(String newName) Rename current object key to newName in mode
org.reactivestreams.Publisher<Boolean>	renamenx(String newName) Rename current object key to newName in mode only if new key is not exists

Methods inherited from class org.redisson.reactive.RedissonMapReactive

addAndGet, entryIterator, equals, fastPut, hashCode, keyIterator, put, putAll, putIfAbsent, replace, replace, size, valueIterator

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.redisson.api.RMapCacheReactive

size

Methods inherited from interface org.redisson.api.RMapReactive

addAndGet, entryIterator, fastPut, keyIterator, put, putAll, putIfAbsent, replace, replace, valueIterator

Methods inherited from interface org.redisson.api.RExpirableReactive

expireAt, remainTimeToLive

Methods inherited from interface org.redisson.api.RObjectReactive

getCodec, getName, isExists, migrate, move, rename, renamenx

Constructor Detail

RedissonMapCacheReactive

public RedissonMapCacheReactive(EvictionScheduler evictionScheduler,
                        CommandReactiveExecutor commandExecutor,
                        String name)

RedissonMapCacheReactive

public RedissonMapCacheReactive(Codec codec,
                        EvictionScheduler evictionScheduler,
                        CommandReactiveExecutor commandExecutor,
                        String name)

Method Detail

containsKey

public org.reactivestreams.Publisher<Boolean> containsKey(Object key)

Specified by:

containsKey in interface RMapReactive<K,V>

Overrides:

containsKey in class RedissonMapReactive<K,V>

containsValue

public org.reactivestreams.Publisher<Boolean> containsValue(Object value)

Specified by:

containsValue in interface RMapReactive<K,V>

Overrides:

containsValue in class RedissonMapReactive<K,V>

getAll

public org.reactivestreams.Publisher<Map<K,V>> getAll(Set<K> keys)

Specified by:

getAll in interface RMapReactive<K,V>

Overrides:

getAll in class RedissonMapReactive<K,V>

putIfAbsent

public org.reactivestreams.Publisher<V> putIfAbsent(K key,
                                           V value,
                                           long ttl,
                                           TimeUnit unit)

Specified by:

putIfAbsent in interface RMapCacheReactive<K,V>

remove

public org.reactivestreams.Publisher<Boolean> remove(Object key,
                                            Object value)

Specified by:

remove in interface RMapReactive<K,V>

Overrides:

remove in class RedissonMapReactive<K,V>

get

public org.reactivestreams.Publisher<V> get(K key)

Specified by:

get in interface RMapReactive<K,V>

Overrides:

get in class RedissonMapReactive<K,V>

put

public org.reactivestreams.Publisher<V> put(K key,
                                   V value,
                                   long ttl,
                                   TimeUnit unit)

Specified by:

put in interface RMapCacheReactive<K,V>

remove

public org.reactivestreams.Publisher<V> remove(K key)

Specified by:

remove in interface RMapReactive<K,V>

Overrides:

remove in class RedissonMapReactive<K,V>

fastRemove

public org.reactivestreams.Publisher<Long> fastRemove(K... keys)

Description copied from interface: RMapReactive

Removes keys from map by one operation in manner Works faster than RMap.remove but not returning the value associated with key

Specified by:

fastRemove in interface RMapReactive<K,V>

Overrides:

fastRemove in class RedissonMapReactive<K,V>

Parameters:

keys - - map keys

Returns:

the number of keys that were removed from the hash, not including specified but non existing keys

delete

public org.reactivestreams.Publisher<Boolean> delete()

Description copied from interface: RObjectReactive

Delete object in mode

Specified by:

delete in interface RObjectReactive

Returns:

true if object was deleted false if not

expire

public org.reactivestreams.Publisher<Boolean> expire(long timeToLive,
                                            TimeUnit timeUnit)

Description copied from interface: RExpirableReactive

Set a timeout for object in mode. After the timeout has expired, the key will automatically be deleted.

Specified by:

expire in interface RExpirableReactive

Parameters:

timeToLive - - timeout before object will be deleted

timeUnit - - timeout time unit

Returns:

true if the timeout was set and false if not

expireAt

public org.reactivestreams.Publisher<Boolean> expireAt(long timestamp)

Description copied from interface: RExpirableReactive

Set an expire date for object in mode. When expire date comes the key will automatically be deleted.

Specified by:

expireAt in interface RExpirableReactive

Parameters:

timestamp - - expire date in milliseconds (Unix timestamp)

Returns:

true if the timeout was set and false if not

clearExpire

public org.reactivestreams.Publisher<Boolean> clearExpire()

Description copied from interface: RExpirableReactive

Clear an expire timeout or expire date for object in mode. Object will not be deleted.

Specified by:

clearExpire in interface RExpirableReactive

Returns:

true if the timeout was cleared and false if not

expireAt

public org.reactivestreams.Publisher<Boolean> expireAt(Date timestamp)

Description copied from interface: RExpirableReactive

Set an expire date for object in mode. When expire date comes the key will automatically be deleted.

Specified by:

expireAt in interface RExpirableReactive

Parameters:

timestamp - - expire date

Returns:

true if the timeout was set and false if not

remainTimeToLive

public org.reactivestreams.Publisher<Long> remainTimeToLive()

Description copied from interface: RExpirableReactive

Get remaining time to live of object in milliseconds.

Specified by:

remainTimeToLive in interface RExpirableReactive

Returns:

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

reactive

public <R> org.reactivestreams.Publisher<R> reactive(RFuture<R> future)

newSucceeded

protected <V> reactor.rx.Stream<V> newSucceeded(V result)

getName

public String getName()

Specified by:

getName in interface RObjectReactive

getCodec

public Codec getCodec()

Specified by:

getCodec in interface RObjectReactive

rename

public org.reactivestreams.Publisher<Void> rename(String newName)

Description copied from interface: RObjectReactive

Rename current object key to newName in mode

Specified by:

rename in interface RObjectReactive

Parameters:

newName - - new name of object

Returns:

void

migrate

public org.reactivestreams.Publisher<Void> migrate(String host,
                                          int port,
                                          int database)

Description copied from interface: RObjectReactive

Transfer a object from a source Redis instance to a destination Redis instance in mode

Specified by:

migrate in interface RObjectReactive

Parameters:

host - - destination host

port - - destination port

database - - destination database

Returns:

void

move

public org.reactivestreams.Publisher<Boolean> move(int database)

Description copied from interface: RObjectReactive

Move object to another database in mode

Specified by:

move in interface RObjectReactive

Parameters:

database - - number of Redis database

Returns:

true if key was moved false if not

renamenx

public org.reactivestreams.Publisher<Boolean> renamenx(String newName)

Description copied from interface: RObjectReactive

Rename current object key to newName in mode only if new key is not exists

Specified by:

renamenx in interface RObjectReactive

Parameters:

newName - - new name of object

Returns:

true if object has been renamed successfully and false otherwise

isExists

public org.reactivestreams.Publisher<Boolean> isExists()

Description copied from interface: RObjectReactive

Check object existence

Specified by:

isExists in interface RObjectReactive

Returns:

true if object exists and false otherwise