Package org.redisson.api

Interface RBucketRx<V>

Type Parameters:

V - - the type of object

All Superinterfaces:

RExpirableRx, RObjectRx

All Known Subinterfaces:

RBinaryStreamRx

public interface RBucketRx<V>
extends RExpirableRx

Reactive implementation of object holder. Max size of object is 512MB

Author:

Nikita Koksharov

Method Summary

Modifier and Type	Method	Description
io.reactivex.rxjava3.core.Single<Boolean>	compareAndSet(V expect, V update)	Atomically sets the value to the given updated value only if serialized state of the current value equals to serialized state of the expected value.
io.reactivex.rxjava3.core.Maybe<V>	get()	Retrieves element stored in the holder.
io.reactivex.rxjava3.core.Maybe<V>	getAndClearExpire()	Retrieves current element in the holder and clears expiration date set before.
io.reactivex.rxjava3.core.Maybe<V>	getAndDelete()	Retrieves element in the holder and removes it.
io.reactivex.rxjava3.core.Maybe<V>	getAndExpire(Duration duration)	Retrieves current element in the holder and sets an expiration duration for it.
io.reactivex.rxjava3.core.Maybe<V>	getAndExpire(Instant time)	Retrieves current element in the holder and sets an expiration date for it.
io.reactivex.rxjava3.core.Maybe<V>	getAndSet(V newValue)	Retrieves current element in the holder and replaces it with newValue.
io.reactivex.rxjava3.core.Maybe<V>	getAndSet(V value, long timeToLive, TimeUnit timeUnit)	Retrieves current element in the holder and replaces it with newValue with defined timeToLive interval.
io.reactivex.rxjava3.core.Completable	set(V value)	Stores element into the holder.
io.reactivex.rxjava3.core.Completable	set(V value, long timeToLive, TimeUnit timeUnit)	Stores element into the holder with defined timeToLive interval.
io.reactivex.rxjava3.core.Completable	setAndKeepTTL(V value)	Set value and keep existing TTL.
io.reactivex.rxjava3.core.Single<Boolean>	setIfExists(V value)	Sets value only if it's already exists.
io.reactivex.rxjava3.core.Single<Boolean>	setIfExists(V value, long timeToLive, TimeUnit timeUnit)	Sets value only if it's already exists.
io.reactivex.rxjava3.core.Single<Long>	size()	Returns size of object in bytes
io.reactivex.rxjava3.core.Single<Boolean>	trySet(V value)	Tries to set element atomically into empty holder.
io.reactivex.rxjava3.core.Single<Boolean>	trySet(V value, long timeToLive, TimeUnit timeUnit)	Tries to set element atomically into empty holder with defined timeToLive interval.

Methods inherited from interface org.redisson.api.RExpirableRx

clearExpire, expire, expire, expire, expireAt, expireAt, expireIfGreater, expireIfGreater, expireIfLess, expireIfLess, expireIfNotSet, expireIfNotSet, expireIfSet, expireIfSet, getExpireTime, remainTimeToLive

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

size

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

Returns size of object in bytes

Returns:

object size

trySet

io.reactivex.rxjava3.core.Single<Boolean> trySet(V value)

Tries to set element atomically into empty holder.

Parameters:

value - - value to set

Returns:

true if successful, or false if element was already set

trySet

io.reactivex.rxjava3.core.Single<Boolean> trySet(V value,
                                                 long timeToLive,
                                                 TimeUnit timeUnit)

Tries to set element atomically into empty holder with defined timeToLive interval.

Parameters:

value - - value to set

timeToLive - - time to live interval

timeUnit - - unit of time to live interval

Returns:

true if successful, or false if element was already set

setIfExists

io.reactivex.rxjava3.core.Single<Boolean> setIfExists(V value)

Sets value only if it's already exists.

Parameters:

value - - value to set

Returns:

true if successful, or false if element wasn't set

setIfExists

io.reactivex.rxjava3.core.Single<Boolean> setIfExists(V value,
                                                      long timeToLive,
                                                      TimeUnit timeUnit)

Sets value only if it's already exists.

Parameters:

value - - value to set

timeToLive - - time to live interval

timeUnit - - unit of time to live interval

Returns:

true if successful, or false if element wasn't set

compareAndSet

io.reactivex.rxjava3.core.Single<Boolean> compareAndSet(V expect,
                                                        V update)

Atomically sets the value to the given updated value only if serialized state of the current value equals to serialized state of the expected value.

Parameters:

expect - the expected value

update - the new value

Returns:

true if successful; or false if the actual value was not equal to the expected value.

getAndSet

io.reactivex.rxjava3.core.Maybe<V> getAndSet(V newValue)

Retrieves current element in the holder and replaces it with newValue.

Parameters:

newValue - - value to set

Returns:

previous value

getAndSet

io.reactivex.rxjava3.core.Maybe<V> getAndSet(V value,
                                             long timeToLive,
                                             TimeUnit timeUnit)

Retrieves current element in the holder and replaces it with newValue with defined timeToLive interval.

Parameters:

value - - value to set

timeToLive - - time to live interval

timeUnit - - unit of time to live interval

Returns:

previous value

getAndExpire

io.reactivex.rxjava3.core.Maybe<V> getAndExpire(Duration duration)

Retrieves current element in the holder and sets an expiration duration for it.

Requires Redis 6.2.0 and higher.

Parameters:

duration - of object time to live interval

Returns:

element

getAndExpire

io.reactivex.rxjava3.core.Maybe<V> getAndExpire(Instant time)

Retrieves current element in the holder and sets an expiration date for it.

Requires Redis 6.2.0 and higher.

Parameters:

time - of exact object expiration moment

Returns:

element

getAndClearExpire

io.reactivex.rxjava3.core.Maybe<V> getAndClearExpire()

Retrieves current element in the holder and clears expiration date set before.

Requires Redis 6.2.0 and higher.

Returns:

element

get

io.reactivex.rxjava3.core.Maybe<V> get()

Retrieves element stored in the holder.

Returns:

element

getAndDelete

io.reactivex.rxjava3.core.Maybe<V> getAndDelete()

Retrieves element in the holder and removes it.

Returns:

element

set

io.reactivex.rxjava3.core.Completable set(V value)

Stores element into the holder.

Parameters:

value - - value to set

Returns:

void

set

io.reactivex.rxjava3.core.Completable set(V value,
                                          long timeToLive,
                                          TimeUnit timeUnit)

Stores element into the holder with defined timeToLive interval.

Parameters:

value - - value to set

timeToLive - - time to live interval

timeUnit - - unit of time to live interval

Returns:

void

setAndKeepTTL

io.reactivex.rxjava3.core.Completable setAndKeepTTL(V value)

Set value and keep existing TTL.

Requires Redis 6.0.0 and higher.

Parameters:

value - - value to set

Returns:

void