org.redisson.api

Interface RObjectReactive

All Known Subinterfaces:

RAtomicDoubleReactive, RAtomicLongReactive, RBitSetReactive, RBlockingDequeReactive<V>, RBlockingQueueReactive<V>, RBucketReactive<V>, RCollectionReactive<V>, RDequeReactive<V>, RExpirableReactive, RGeoReactive<V>, RHyperLogLogReactive<V>, RLexSortedSetReactive, RListMultimapReactive<K,V>, RListReactive<V>, RMapCacheReactive<K,V>, RMapReactive<K,V>, RMultimapReactive<K,V>, RPermitExpirableSemaphoreReactive, RQueueReactive<V>, RRateLimiterReactive, RRingBufferReactive<V>, RScoredSortedSetReactive<V>, RSemaphoreReactive, RSetCacheReactive<V>, RSetMultimapReactive<K,V>, RSetReactive<V>, RStreamReactive<K,V>, RTransferQueueReactive<V>

public interface RObjectReactive

Base Reactive interface for all Redisson objects

Author:

Nikita Koksharov

Method Summary

Modifier and Type	Method and Description
reactor.core.publisher.Mono<Integer>	addListener(ObjectListener listener) Adds object event listener
reactor.core.publisher.Mono<Void>	copy(String host, int port, int database, long timeout) Copy object from source Redis instance to destination Redis instance
reactor.core.publisher.Mono<Boolean>	delete() Delete object in mode
reactor.core.publisher.Mono<byte[]>	dump() Returns dump of object
Codec	getCodec()
String	getName()
reactor.core.publisher.Mono<Boolean>	isExists() Check object existence
reactor.core.publisher.Mono<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
reactor.core.publisher.Mono<Boolean>	move(int database) Move object to another database in mode
reactor.core.publisher.Mono<Void>	removeListener(int listenerId) Removes object event listener
reactor.core.publisher.Mono<Void>	rename(String newName) Rename current object key to newName in mode
reactor.core.publisher.Mono<Boolean>	renamenx(String newName) Rename current object key to newName in mode only if new key is not exists
reactor.core.publisher.Mono<Void>	restore(byte[] state) Restores object using its state returned by dump() method.
reactor.core.publisher.Mono<Void>	restore(byte[] state, long timeToLive, TimeUnit timeUnit) Restores object using its state returned by dump() method and set time to live for it.
reactor.core.publisher.Mono<Void>	restoreAndReplace(byte[] state) Restores and replaces object if it already exists.
reactor.core.publisher.Mono<Void>	restoreAndReplace(byte[] state, long timeToLive, TimeUnit timeUnit) Restores and replaces object if it already exists and set time to live for it.
reactor.core.publisher.Mono<Long>	sizeInMemory() Returns bytes amount used by object in Redis memory.
reactor.core.publisher.Mono<Boolean>	touch() Update the last access time of an object.
reactor.core.publisher.Mono<Boolean>	unlink() Delete the objects.

Method Detail

getName

String getName()

getCodec

Codec getCodec()

sizeInMemory

reactor.core.publisher.Mono<Long> sizeInMemory()

Returns bytes amount used by object in Redis memory.

Returns:

size in bytes

restore

reactor.core.publisher.Mono<Void> restore(byte[] state)

Restores object using its state returned by dump() method.

Parameters:

state - - state of object

Returns:

void

restore

reactor.core.publisher.Mono<Void> restore(byte[] state,
                                          long timeToLive,
                                          TimeUnit timeUnit)

Restores object using its state returned by dump() method and set time to live for it.

Parameters:

state - - state of object

timeToLive - - time to live of the object

timeUnit - - time unit

Returns:

void

restoreAndReplace

reactor.core.publisher.Mono<Void> restoreAndReplace(byte[] state)

Restores and replaces object if it already exists.

Parameters:

state - - state of the object

Returns:

void

restoreAndReplace

reactor.core.publisher.Mono<Void> restoreAndReplace(byte[] state,
                                                    long timeToLive,
                                                    TimeUnit timeUnit)

Restores and replaces object if it already exists and set time to live for it.

Parameters:

state - - state of the object

timeToLive - - time to live of the object

timeUnit - - time unit

Returns:

void

dump

reactor.core.publisher.Mono<byte[]> dump()

Returns dump of object

Returns:

dump

touch

reactor.core.publisher.Mono<Boolean> touch()

Update the last access time of an object.

Returns:

true if object was touched else false

unlink

reactor.core.publisher.Mono<Boolean> unlink()

Delete the objects. Actual removal will happen later asynchronously.

Requires Redis 4.0+

Returns:

true if it was exist and deleted else false

copy

reactor.core.publisher.Mono<Void> copy(String host,
                                       int port,
                                       int database,
                                       long timeout)

Copy object from source Redis instance to destination Redis instance

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

migrate

reactor.core.publisher.Mono<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

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

reactor.core.publisher.Mono<Boolean> move(int database)

Move object to another database in mode

Parameters:

database - - number of Redis database

Returns:

true if key was moved false if not

delete

reactor.core.publisher.Mono<Boolean> delete()

Delete object in mode

Returns:

true if object was deleted false if not

rename

reactor.core.publisher.Mono<Void> rename(String newName)

Rename current object key to newName in mode

Parameters:

newName - - new name of object

Returns:

void

renamenx

reactor.core.publisher.Mono<Boolean> renamenx(String newName)

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

Parameters:

newName - - new name of object

Returns:

true if object has been renamed successfully and false otherwise

isExists

reactor.core.publisher.Mono<Boolean> isExists()

Check object existence

Returns:

true if object exists and false otherwise

addListener

reactor.core.publisher.Mono<Integer> addListener(ObjectListener listener)

Adds object event listener

Parameters:

listener - - object event listener

Returns:

listener id

See Also:

ExpiredObjectListener, DeletedObjectListener

removeListener

reactor.core.publisher.Mono<Void> removeListener(int listenerId)

Removes object event listener

Parameters:

listenerId - - listener id

Returns:

void