Packages

abstract class MutableConcurrentQueue[A] extends AnyRef

A MutableConcurrentQueue interface to use under the hood in ZIO.

The implementation at minimum: 1. Should be non-blocking and ideally lock-free. 2. Should provide basic metrics such as how many elements were enqueued/dequeued.

Attributes
protected[zio]
Note

this is declared as abstract class since invokevirtual is slightly cheaper than invokeinterface.

Linear Supertypes
AnyRef, Any
Known Subclasses
OneElementConcurrentQueue
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. MutableConcurrentQueue
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new MutableConcurrentQueue()

Abstract Value Members

  1. abstract val capacity: Int

    The maximum number of elements that a queue can hold.

    The maximum number of elements that a queue can hold.

    Note

    that unbounded queues can still implement this interface with capacity = MAX_INT.

  2. abstract def dequeuedCount(): Long

    returns

    the number of elements that have ever been taken from the queue.

    Note

    if you know how much time the queue is alive, you can calculate the rate at which elements are being dequeued.

  3. abstract def enqueuedCount(): Long

    returns

    the number of elements that have ever been added to the queue.

    Note

    that scala.Long is used here, since scala.Int will be overflowed really quickly for busy queues.

    ,

    if you know how much time the queue is alive, you can calculate the rate at which elements are being enqueued.

  4. abstract def isEmpty(): Boolean
  5. abstract def isFull(): Boolean
  6. abstract def offer(a: A): Boolean

    A non-blocking enqueue.

    A non-blocking enqueue.

    returns

    whether the enqueue was successful or not.

  7. abstract def poll(default: A): A

    A non-blocking dequeue.

    A non-blocking dequeue.

    returns

    either an element from the queue, or the default param.

    Note

    that if there's no meaningful default for your type, you can always use poll(null). Not the best, but reasonable price to pay for lower heap churn from not using scala.Option here.

  8. abstract def size(): Int

    returns

    the current number of elements inside the queue.

    Note

    that this method can be non-atomic and return the approximate number in a concurrent setting.

Concrete 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[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  16. def toString(): String
    Definition Classes
    AnyRef → Any
  17. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  18. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

Inherited from AnyRef

Inherited from Any

Ungrouped