Class/Object

com.twitter.concurrent

AsyncQueue

Related Docs: object AsyncQueue | package concurrent

Permalink

class AsyncQueue[T] extends AnyRef

An asynchronous FIFO queue. In addition to providing offer and poll, the queue can be "failed", flushing current pollers.

Note: thread safety is enforced via the intrinsic lock on this which must be acquired for any subclasses which want to serialize operations.

Linear Supertypes

Ordering

Alphabetic
By Inheritance

Inherited

AsyncQueue
AnyRef
Any

Hide All
Show All

Visibility

Public
All

Instance Constructors

new AsyncQueue()

An asynchronous, unbounded, FIFO queue.
An asynchronous, unbounded, FIFO queue. In addition to providing offer and poll, the queue can be "failed", flushing current pollers.
new AsyncQueue(maxPendingOffers: Int)

maxPendingOffers
optional limit on the number of pending offers. The default is unbounded, but any other positive value can be used to limit the max queue size. Note that Int.MaxValue is used to denote unbounded.

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
final def drain(): Try[Queue[T]]

Drains any pending elements into a Try[Queue].
Drains any pending elements into a Try[Queue].
If the queue has been failed and is now empty, a Throw of the exception used to fail will be returned. Otherwise, return a Return(Queue) of the pending elements.
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def fail(exc: Throwable, discard: Boolean): Unit

Fail the queue.
Fail the queue. When discard is true, the queue contents is discarded and all pollers are failed immediately. When this flag is false, subsequent pollers are not failed until the queue becomes empty.
No new elements are admitted to the queue after it has been failed.
final def fail(exc: Throwable): Unit

Fail the queue: current and subsequent pollers will be completed with the given exception; any outstanding messages are discarded.
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def offer(elem: T): Boolean

Insert the given element at the tail of the queue.
Insert the given element at the tail of the queue.
returns
true if the item was successfully added, false otherwise.
final def poll(): Future[T]

Retrieves and removes the head of the queue, completing the returned future when the element is available.
final def size: Int

Returns the current number of pending elements.
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AsyncQueue → AnyRef → Any
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped