org.redisson.reactive

Class RedissonBlockingQueueReactive<V>

java.lang.Object

org.redisson.reactive.RedissonListReactive<V>

org.redisson.reactive.RedissonQueueReactive<V>

org.redisson.reactive.RedissonBlockingQueueReactive<V>

All Implemented Interfaces:

RBlockingQueueReactive<V>, RCollectionReactive<V>, RExpirableReactive, RListReactive<V>, RObjectReactive, RQueueReactive<V>

public class RedissonBlockingQueueReactive<V>
extends RedissonQueueReactive<V>
implements RBlockingQueueReactive<V>

Distributed and concurrent implementation of BlockingQueue.

Queue size limited by Redis server memory amount.

Author:

[email protected], Nikita Koksharov

Constructor Summary

Constructors

Constructor and Description
RedissonBlockingQueueReactive(Codec codec, CommandReactiveExecutor commandExecutor, String name)
RedissonBlockingQueueReactive(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>	delete() Delete object in mode
org.reactivestreams.Publisher<Integer>	drainTo(Collection<? super V> c)
org.reactivestreams.Publisher<Integer>	drainTo(Collection<? super V> c, int maxElements)
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<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>	poll(long timeout, TimeUnit unit)
org.reactivestreams.Publisher<V>	pollFromAny(long timeout, TimeUnit unit, String... queueNames) Retrieves and removes first available head element of any queue, waiting up to the specified wait time if necessary for an element to become available in any of defined queues including queue own.
org.reactivestreams.Publisher<V>	pollLastAndOfferFirstTo(String queueName, long timeout, TimeUnit unit)
org.reactivestreams.Publisher<Long>	put(V e)
<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<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<V>	take()

Methods inherited from class org.redisson.reactive.RedissonQueueReactive

offer, peek, poll, pollLastAndOfferFirstTo

Methods inherited from class org.redisson.reactive.RedissonListReactive

add, add, addAll, addAll, addAll, contains, containsAll, descendingIterator, descendingIterator, equals, fastSet, get, hashCode, indexOf, iterator, iterator, lastIndexOf, remove, remove, remove, removeAll, retainAll, set, size

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.redisson.api.RQueueReactive

offer, peek, poll, pollLastAndOfferFirstTo

Methods inherited from interface org.redisson.api.RCollectionReactive

add, addAll, addAll, contains, containsAll, iterator, remove, removeAll, retainAll, size

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

RedissonBlockingQueueReactive

public RedissonBlockingQueueReactive(CommandReactiveExecutor commandExecutor,
                             String name)

RedissonBlockingQueueReactive

public RedissonBlockingQueueReactive(Codec codec,
                             CommandReactiveExecutor commandExecutor,
                             String name)

Method Detail

put

public org.reactivestreams.Publisher<Long> put(V e)

Specified by:

put in interface RBlockingQueueReactive<V>

take

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

Specified by:

take in interface RBlockingQueueReactive<V>

poll

public org.reactivestreams.Publisher<V> poll(long timeout,
                                    TimeUnit unit)

Specified by:

poll in interface RBlockingQueueReactive<V>

pollFromAny

public org.reactivestreams.Publisher<V> pollFromAny(long timeout,
                                           TimeUnit unit,
                                           String... queueNames)

Description copied from interface: RBlockingQueueReactive

Retrieves and removes first available head element of any queue, waiting up to the specified wait time if necessary for an element to become available in any of defined queues including queue own.

Specified by:

pollFromAny in interface RBlockingQueueReactive<V>

Parameters:

timeout - how long to wait before giving up, in units of unit

unit - a TimeUnit determining how to interpret the timeout parameter

queueNames - - names of queue

Returns:

Publisher object with the head of this queue, or null if the specified waiting time elapses before an element is available

pollLastAndOfferFirstTo

public org.reactivestreams.Publisher<V> pollLastAndOfferFirstTo(String queueName,
                                                       long timeout,
                                                       TimeUnit unit)

Specified by:

pollLastAndOfferFirstTo in interface RBlockingQueueReactive<V>

drainTo

public org.reactivestreams.Publisher<Integer> drainTo(Collection<? super V> c)

Specified by:

drainTo in interface RBlockingQueueReactive<V>

drainTo

public org.reactivestreams.Publisher<Integer> drainTo(Collection<? super V> c,
                                             int maxElements)

Specified by:

drainTo in interface RBlockingQueueReactive<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(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

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