org.redisson.reactive

Class RedissonSetCacheReactive<V>

java.lang.Object

org.redisson.reactive.RedissonSetCacheReactive<V>

Type Parameters:

V - value

All Implemented Interfaces:

RCollectionReactive<V>, RExpirableReactive, RObjectReactive, RSetCacheReactive<V>

public class RedissonSetCacheReactive<V>
extends Object
implements RSetCacheReactive<V>

Set-based cache with ability to set TTL for each entry via add(Object, long, TimeUnit) method. And therefore has an complex lua-scripts inside. Uses map(value_hash, value) to tie with sorted set which contains expiration record for every value with TTL.

Current Redis implementation doesn't have set entry eviction functionality. Thus values are checked for TTL expiration during any value read operation. If entry expired then it doesn't returns and clean task runs hronous. 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 RSet.

Author:

Nikita Koksharov

Constructor Summary

Constructors

Constructor and Description
RedissonSetCacheReactive(Codec codec, CommandReactiveExecutor commandExecutor, String name, RSetCacheAsync<V> instance)
RedissonSetCacheReactive(Codec codec, EvictionScheduler evictionScheduler, CommandReactiveExecutor commandExecutor, String name)
RedissonSetCacheReactive(CommandReactiveExecutor commandExecutor, String name, RSetCacheAsync<V> instance)
RedissonSetCacheReactive(EvictionScheduler evictionScheduler, CommandReactiveExecutor commandExecutor, String name)

Method Summary

Modifier and Type	Method and Description
org.reactivestreams.Publisher<Integer>	add(V value)
org.reactivestreams.Publisher<Boolean>	add(V value, long ttl, TimeUnit unit)
org.reactivestreams.Publisher<Integer>	addAll(Collection<? extends V> c)
org.reactivestreams.Publisher<Integer>	addAll(org.reactivestreams.Publisher<? extends V> c)
org.reactivestreams.Publisher<Boolean>	clearExpire() Clear an expire timeout or expire date for object in mode.
org.reactivestreams.Publisher<Boolean>	contains(Object o)
org.reactivestreams.Publisher<Boolean>	containsAll(Collection<?> c)
org.reactivestreams.Publisher<Boolean>	delete() Delete object in mode
protected void	encode(Collection<Object> params, Collection<?> values)
protected io.netty.buffer.ByteBuf	encode(Object value)
protected io.netty.buffer.ByteBuf	encodeMapKey(Object value)
protected io.netty.buffer.ByteBuf	encodeMapValue(Object value)
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.
Codec	getCodec()
String	getName()
org.reactivestreams.Publisher<Boolean>	isExists() Check object existence
org.reactivestreams.Publisher<V>	iterator()
org.reactivestreams.Publisher<Void>	migrate(String host, int port, int database, long timeout) 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.core.publisher.Mono<V>	newSucceeded(V result)
<R> org.reactivestreams.Publisher<R>	reactive(Supplier<RFuture<R>> supplier)
org.reactivestreams.Publisher<Set<V>>	readAll() Read all elements at once
org.reactivestreams.Publisher<Long>	remainTimeToLive() Get remaining time to live of object in milliseconds.
org.reactivestreams.Publisher<Boolean>	remove(Object o)
org.reactivestreams.Publisher<Boolean>	removeAll(Collection<?> c)
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
org.reactivestreams.Publisher<Boolean>	retainAll(Collection<?> c)
org.reactivestreams.Publisher<Integer>	size() Returns the number of elements in cache.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.redisson.api.RExpirableReactive

clearExpire, expire, expireAt, expireAt, remainTimeToLive

Methods inherited from interface org.redisson.api.RObjectReactive

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

Constructor Detail

RedissonSetCacheReactive

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

RedissonSetCacheReactive

public RedissonSetCacheReactive(CommandReactiveExecutor commandExecutor,
                                String name,
                                RSetCacheAsync<V> instance)

RedissonSetCacheReactive

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

RedissonSetCacheReactive

public RedissonSetCacheReactive(Codec codec,
                                CommandReactiveExecutor commandExecutor,
                                String name,
                                RSetCacheAsync<V> instance)

Method Detail

size

public org.reactivestreams.Publisher<Integer> size()

Description copied from interface: RSetCacheReactive

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

Specified by:

size in interface RCollectionReactive<V>

Specified by:

size in interface RSetCacheReactive<V>

contains

public org.reactivestreams.Publisher<Boolean> contains(Object o)

Specified by:

contains in interface RCollectionReactive<V>

iterator

public org.reactivestreams.Publisher<V> iterator()

Specified by:

iterator in interface RCollectionReactive<V>

add

public org.reactivestreams.Publisher<Boolean> add(V value,
                                                  long ttl,
                                                  TimeUnit unit)

Specified by:

add in interface RSetCacheReactive<V>

add

public org.reactivestreams.Publisher<Integer> add(V value)

Specified by:

add in interface RCollectionReactive<V>

readAll

public org.reactivestreams.Publisher<Set<V>> readAll()

Description copied from interface: RSetCacheReactive

Read all elements at once

Specified by:

readAll in interface RSetCacheReactive<V>

Returns:

values

remove

public org.reactivestreams.Publisher<Boolean> remove(Object o)

Specified by:

remove in interface RCollectionReactive<V>

containsAll

public org.reactivestreams.Publisher<Boolean> containsAll(Collection<?> c)

Specified by:

containsAll in interface RCollectionReactive<V>

addAll

public org.reactivestreams.Publisher<Integer> addAll(Collection<? extends V> c)

Specified by:

addAll in interface RCollectionReactive<V>

retainAll

public org.reactivestreams.Publisher<Boolean> retainAll(Collection<?> c)

Specified by:

retainAll in interface RCollectionReactive<V>

removeAll

public org.reactivestreams.Publisher<Boolean> removeAll(Collection<?> c)

Specified by:

removeAll in interface RCollectionReactive<V>

addAll

public org.reactivestreams.Publisher<Integer> addAll(org.reactivestreams.Publisher<? extends V> c)

Specified by:

addAll in interface RCollectionReactive<V>

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

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

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

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(Supplier<RFuture<R>> supplier)

newSucceeded

protected <V> reactor.core.publisher.Mono<V> newSucceeded(V result)

getName

public String getName()

Specified by:

getName in interface RObjectReactive

getCodec

public Codec getCodec()

Specified by:

getCodec in interface RObjectReactive

encode

protected void encode(Collection<Object> params,
                      Collection<?> values)

encode

protected io.netty.buffer.ByteBuf encode(Object value)

encodeMapKey

protected io.netty.buffer.ByteBuf encodeMapKey(Object value)

encodeMapValue

protected io.netty.buffer.ByteBuf encodeMapValue(Object value)

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,
                                                   long timeout)

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

timeout - - maximum idle time in any moment of the communication with the destination instance in milliseconds

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

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

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