Enqueue

trait Enqueue[-A] extends Serializable

A queue that can only be enqueued.

class Object
trait Matchable
class Any
class Hub[A]
class Queue[A]

Value members

Abstract methods

def awaitShutdown(implicit trace: Trace): UIO[Unit]

Waits until the queue is shutdown. The IO returned by this method will not resume until the queue has been shutdown. If the queue is already shutdown, the IO will resume right away.

Waits until the queue is shutdown. The IO returned by this method will not resume until the queue has been shutdown. If the queue is already shutdown, the IO will resume right away.

def capacity: Int

How many elements can hold in the queue

How many elements can hold in the queue

def isShutdown(implicit trace: Trace): UIO[Boolean]

true if shutdown has been called.

true if shutdown has been called.

def offer(a: A)(implicit trace: Trace): UIO[Boolean]

Places one value in the queue.

Places one value in the queue.

def offerAll[A1 <: A](as: Iterable[A1])(implicit trace: Trace): UIO[Chunk[A1]]

For Bounded Queue: uses the BackPressure Strategy, places the values in the queue and always returns no leftovers. If the queue has reached capacity, then the fiber performing the offerAll will be suspended until there is room in the queue.

For Bounded Queue: uses the BackPressure Strategy, places the values in the queue and always returns no leftovers. If the queue has reached capacity, then the fiber performing the offerAll will 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 Sliding Strategy 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 Dropping Strategy, It places the values in the queue but if there is no room it will not enqueue them and return the leftovers.

def shutdown(implicit trace: Trace): UIO[Unit]

Interrupts any fibers that are suspended on offer or take. Future calls to offer* and take* will be interrupted immediately.

Interrupts any fibers that are suspended on offer or take. Future calls to offer* and take* will be interrupted immediately.

def size(implicit trace: Trace): UIO[Int]

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.

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.

Concrete methods

def isEmpty(implicit trace: Trace): UIO[Boolean]

Checks whether the queue is currently empty.

Checks whether the queue is currently empty.

def isFull(implicit trace: Trace): UIO[Boolean]

Checks whether the queue is currently full.

Checks whether the queue is currently full.