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
  1. Alphabetic
  2. By Inheritance
Inherited
  1. AsyncQueue
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. 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.

  2. 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

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  6. 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.

  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  9. 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.

  10. 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.

  11. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  12. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  13. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  14. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  15. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  17. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  18. 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.

  19. final def poll(): Future[T]

    Retrieves and removes the head of the queue, completing the returned future when the element is available.

  20. final def size: Int

    Returns the current number of pending elements.

  21. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  22. def toString(): String
    Definition Classes
    AsyncQueue → AnyRef → Any
  23. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  24. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  25. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped