org.redisson.api

Interface RQueueAsync<V>

Type Parameters:

V - the type of elements held in this collection

All Superinterfaces:

RCollectionAsync<V>, RExpirableAsync, RObjectAsync

All Known Subinterfaces:

RBlockingDeque<V>, RBlockingDequeAsync<V>, RBlockingQueue<V>, RBlockingQueueAsync<V>, RBoundedBlockingQueue<V>, RBoundedBlockingQueueAsync<V>, RDelayedQueue<V>, RDeque<V>, RDequeAsync<V>, RPriorityBlockingDeque<V>, RPriorityBlockingQueue<V>, RQueue<V>, RRingBuffer<V>, RRingBufferAsync<V>

All Known Implementing Classes:

RedissonBlockingDeque, RedissonBlockingQueue, RedissonBoundedBlockingQueue, RedissonDelayedQueue, RedissonDeque, RedissonPriorityBlockingDeque, RedissonPriorityBlockingQueue, RedissonQueue, RedissonRingBuffer

public interface RQueueAsync<V>
extends RCollectionAsync<V>

Queue backed by Redis

Author:

Nikita Koksharov

Method Summary

Modifier and Type	Method and Description
RFuture<Boolean>	offerAsync(V e) Inserts the specified element into this queue.
RFuture<V>	peekAsync() Retrieves the head of this queue in async mode.
RFuture<V>	pollAsync() Retrieves and removes the head of this queue in async mode.
RFuture<List<V>>	pollAsync(int limit) Retrieves and removes the head elements of this queue.
RFuture<V>	pollLastAndOfferFirstToAsync(String queueName) Retrieves and removes last available tail element of this queue queue and adds it at the head of queueName.
RFuture<List<V>>	readAllAsync() Returns all queue elements at once

Methods inherited from interface org.redisson.api.RCollectionAsync

addAllAsync, addAsync, containsAllAsync, containsAsync, removeAllAsync, removeAsync, retainAllAsync, sizeAsync

Methods inherited from interface org.redisson.api.RExpirableAsync

clearExpireAsync, expireAsync, expireAtAsync, expireAtAsync, remainTimeToLiveAsync

Methods inherited from interface org.redisson.api.RObjectAsync

addListenerAsync, copyAsync, deleteAsync, dumpAsync, isExistsAsync, migrateAsync, moveAsync, removeListenerAsync, renameAsync, renamenxAsync, restoreAndReplaceAsync, restoreAndReplaceAsync, restoreAsync, restoreAsync, sizeInMemoryAsync, touchAsync, unlinkAsync

Method Detail

peekAsync

RFuture<V> peekAsync()

Retrieves the head of this queue in async mode.

Returns:

the head of this queue, or null

pollAsync

RFuture<V> pollAsync()

Retrieves and removes the head of this queue in async mode.

Returns:

the head of this queue, or null

offerAsync

RFuture<Boolean> offerAsync(V e)

Inserts the specified element into this queue.

Parameters:

e - the element to add

Returns:

true if successful, or false

Throws:

ClassCastException - if the class of the specified element prevents it from being added to this queue

NullPointerException - if the specified element is null

pollLastAndOfferFirstToAsync

RFuture<V> pollLastAndOfferFirstToAsync(String queueName)

Retrieves and removes last available tail element of this queue queue and adds it at the head of queueName.

Parameters:

queueName - - names of destination queue

Returns:

the tail of this queue, or null if the specified waiting time elapses before an element is available

readAllAsync

RFuture<List<V>> readAllAsync()

Returns all queue elements at once

Returns:

elements

pollAsync

RFuture<List<V>> pollAsync(int limit)

Retrieves and removes the head elements of this queue. Elements amount limited by limit param.

Returns:

list of head elements