net.kuujo.vertigo.cluster.data

Interface AsyncQueue<T>

Type Parameters:

T - The queue data type.

All Superinterfaces:

AsyncCollection<T>

All Known Implementing Classes:

DefaultAsyncQueue

public interface AsyncQueue<T>
extends AsyncCollection<T>

Asynchronous queue.

If the current Vert.x instance is a Hazelcast clustered instance, the queue will be backed by a Hazelcast queue. Otherwise, the queue will be backed by a Vert.x shared data map.

Author:

Jordan Halterman

Method Summary

Methods

Modifier and Type	Method and Description
void	element(org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<T>> resultHandler) Retrieves but does not remove the head of the queue.
void	offer(T value) Inserts the element into the queue if it's immediately possible to do so.
void	offer(T value, org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<Boolean>> doneHandler) Inserts the element into the queue if it's immediately possible to do so.
void	peek(org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<T>> resultHandler) Retrieves but does not remove the head of the queue.
void	poll(org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<T>> resultHandler) Retrieves and removed the head of the queue.
void	remove(org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<T>> resultHandler) Retrieves and removed the head of the queue.

Methods inherited from interface net.kuujo.vertigo.cluster.data.AsyncCollection

add, add, clear, clear, contains, isEmpty, name, remove, remove, size

Method Detail

offer

void offer(T value)

Inserts the element into the queue if it's immediately possible to do so.

Parameters:

value - The value to insert.

offer

void offer(T value,
         org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<Boolean>> doneHandler)

Inserts the element into the queue if it's immediately possible to do so.

Parameters:

value - The value to insert.

doneHandler - An asynchronous handler to be called once complete.

element

void element(org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<T>> resultHandler)

Retrieves but does not remove the head of the queue.

Parameters:

resultHandler - An asynchronous handler to be called with the result.

peek

void peek(org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<T>> resultHandler)

Retrieves but does not remove the head of the queue. If there is no value at the head of the queue then the result value will be null.

Parameters:

resultHandler - An asynchronous handler to be called with the result.

poll

void poll(org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<T>> resultHandler)

Retrieves and removed the head of the queue. If there is no value at the head of the queue then the result value will be null.

Parameters:

resultHandler - An asynchronous handler to be called with the result.

remove

void remove(org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<T>> resultHandler)

Retrieves and removed the head of the queue.

Parameters:

resultHandler - An asynchronous handler to be called with the result.