abstract class Queue[A] extends Dequeue[A] with Enqueue[A]
A Queue is a lightweight, asynchronous queue into which values can be
enqueued and of which elements can be dequeued.
- Alphabetic
- By Inheritance
- Queue
- Enqueue
- Dequeue
- Serializable
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new Queue()
Abstract Value Members
- abstract def awaitShutdown(implicit trace: Trace): UIO[Unit]
Waits until the queue is shutdown.
Waits until the queue is shutdown. The
IOreturned by this method will not resume until the queue has been shutdown. If the queue is already shutdown, theIOwill resume right away.- Definition Classes
- Enqueue
- abstract def capacity: Int
How many elements can hold in the queue
How many elements can hold in the queue
- Definition Classes
- Enqueue
- abstract def isShutdown(implicit trace: Trace): UIO[Boolean]
trueifshutdownhas been called.trueifshutdownhas been called.- Definition Classes
- Enqueue
- abstract def offer(a: A)(implicit trace: Trace): UIO[Boolean]
Places one value in the queue.
Places one value in the queue.
- Definition Classes
- Enqueue
- abstract def offerAll[A1 <: A](as: Iterable[A1])(implicit trace: Trace): UIO[Chunk[A1]]
For Bounded Queue: uses the
BackPressureStrategy, places the values in the queue and always returns no leftovers.For Bounded Queue: uses the
BackPressureStrategy, places the values in the queue and always returns no leftovers. If the queue has reached capacity, then the fiber performing theofferAllwill be suspended until there is room in the queue.For Unbounded Queue: Places all values in the queue and returns no leftovers.
For Sliding Queue: uses
SlidingStrategy If there is room in the queue, it places the values otherwise it removes the old elements and enqueues the new ones. Always returns no leftovers.For Dropping Queue: uses
DroppingStrategy, It places the values in the queue but if there is no room it will not enqueue them and return the leftovers.- Definition Classes
- Enqueue
- abstract def shutdown(implicit trace: Trace): UIO[Unit]
Interrupts any fibers that are suspended on
offerortake.Interrupts any fibers that are suspended on
offerortake. Future calls tooffer*andtake*will be interrupted immediately.- Definition Classes
- Enqueue
- abstract def size(implicit trace: Trace): UIO[Int]
Retrieves the size of the queue.
Retrieves the size of the queue. This may be negative if fibers are suspended waiting for elements to be added to the queue or greater than the capacity if fibers are suspended waiting to add elements to the queue.
- Definition Classes
- Enqueue
- abstract def take(implicit trace: Trace): UIO[A]
Removes the oldest value in the queue.
Removes the oldest value in the queue. If the queue is empty, this will return a computation that resumes when an item has been added to the queue.
- Definition Classes
- Dequeue
- abstract def takeAll(implicit trace: Trace): UIO[Chunk[A]]
Removes all the values in the queue and returns the values.
Removes all the values in the queue and returns the values. If the queue is empty returns an empty collection.
- Definition Classes
- Dequeue
- abstract def takeUpTo(max: Int)(implicit trace: Trace): UIO[Chunk[A]]
Takes up to max number of values in the queue.
Takes up to max number of values in the queue.
- Definition Classes
- Dequeue
Concrete 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[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- final def isEmpty(implicit trace: Trace): UIO[Boolean]
Checks whether the queue is currently empty.
- final def isFull(implicit trace: Trace): UIO[Boolean]
Checks whether the queue is currently full.
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def poll(implicit trace: Trace): UIO[Option[A]]
Take the head option of values in the queue.
Take the head option of values in the queue.
- Definition Classes
- Dequeue
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- final def takeBetween(min: Int, max: Int)(implicit trace: Trace): UIO[Chunk[A]]
Takes a number of elements from the queue between the specified minimum and maximum.
Takes a number of elements from the queue between the specified minimum and maximum. If there are fewer than the minimum number of elements available, suspends until at least the minimum number of elements have been collected.
- Definition Classes
- Dequeue
- final def takeN(n: Int)(implicit trace: Trace): UIO[Chunk[A]]
Takes the specified number of elements from the queue.
Takes the specified number of elements from the queue. If there are fewer than the specified number of elements available, it suspends until they become available.
- Definition Classes
- Dequeue
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()