Package com.ibm.asyncutil.iteration

Class AsyncQueues

java.lang.Object

com.ibm.asyncutil.iteration.AsyncQueues

public final class AsyncQueues
extends Object

Methods to construct various multi-producer-single-consumer (mpsc) AsyncQueues.

See Also:

AsyncQueue, BoundedAsyncQueue

Method Summary

Modifier and Type	Method	Description
static <T> BoundedAsyncQueue<T>	bounded()	Creates a bounded AsyncQueue.
static <T> BoundedAsyncQueue<T>	buffered(int maxBuffer)	Creates a buffered AsyncQueue.
static <T> AsyncQueue<T>	unbounded()	Creates an unbounded AsyncQueue.

Methods inherited from class java.lang.Object

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

Method Detail

unbounded

public static <T> AsyncQueue<T> unbounded()

Creates an unbounded AsyncQueue.

Sends on an unbounded queue always complete synchronously, and throttling must be managed by the senders to ensure senders don't get too far ahead of the consumer. See AsyncQueue for details.

Returns:

an AsyncQueue

See Also:

AsyncQueue

bounded

public static <T> BoundedAsyncQueue<T> bounded()

Creates a bounded AsyncQueue.

This queue can only accept one value at a time until it is consumed. This may be useful when you want to produce work potentially in parallel, but want to be throttled at the rate at which you can consume this work. See BoundedAsyncQueue for details.

Returns:

a BoundedAsyncQueue

buffered

public static <T> BoundedAsyncQueue<T> buffered(int maxBuffer)

Creates a buffered AsyncQueue.

This queue can accept up to maxBuffer values before the futures returned by send become delayed. See BoundedAsyncQueue for details

Type Parameters:

T - the type of elements in the returned queue

Parameters:

maxBuffer - the maximum number of values that the queue will accept before applying backpressure to senders

Returns:

a BoundedAsyncQueue with a buffer size of maxBuffer elements