abstract class RingBuffer[A] extends MutableConcurrentQueue[A]

See zio.internal.RingBuffer for details on design, tradeoffs, etc.

Linear Supertypes
MutableConcurrentQueue[A], AnyRef, Any
Known Subclasses
RingBufferArb, RingBufferPow2
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. RingBuffer
  2. MutableConcurrentQueue
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new RingBuffer(capacity: Int)

Abstract Value Members

  1. abstract def posToIdx(pos: Long, capacity: Int): Int
    Attributes
    protected

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. final val capacity: Int

    The maximum number of elements that a queue can hold.

    The maximum number of elements that a queue can hold.

    Definition Classes
    RingBuffer → MutableConcurrentQueue
    Note

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

  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  7. final def dequeuedCount(): Long

    returns

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

    Definition Classes
    RingBuffer → MutableConcurrentQueue
    Note

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

  8. final def enqueuedCount(): Long

    returns

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

    Definition Classes
    RingBuffer → MutableConcurrentQueue
    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.

  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  11. def finalize(): Unit
    Attributes
    protected[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 isEmpty(): Boolean
    Definition Classes
    RingBuffer → MutableConcurrentQueue
  15. final def isFull(): Boolean
    Definition Classes
    RingBuffer → MutableConcurrentQueue
  16. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  17. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  19. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  20. final def offer(a: A): Boolean

    A non-blocking enqueue.

    A non-blocking enqueue.

    returns

    whether the enqueue was successful or not.

    Definition Classes
    RingBuffer → MutableConcurrentQueue
  21. def offerAll(as: Iterable[A]): Chunk[A]

    A non-blocking enqueue of multiple elements.

    A non-blocking enqueue of multiple elements.

    Definition Classes
    MutableConcurrentQueue
  22. final def poll(default: A): A

    A non-blocking dequeue.

    A non-blocking dequeue.

    returns

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

    Definition Classes
    RingBuffer → MutableConcurrentQueue
    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.

  23. def pollUpTo(n: Int): Chunk[A]

    A non-blocking dequeue of multiple elements.

    A non-blocking dequeue of multiple elements.

    Definition Classes
    MutableConcurrentQueue
  24. final def size(): Int

    returns

    the current number of elements inside the queue.

    Definition Classes
    RingBuffer → MutableConcurrentQueue
    Note

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

  25. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  26. def toString(): String
    Definition Classes
    AnyRef → Any
  27. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  28. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  29. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

Inherited from MutableConcurrentQueue[A]

Inherited from AnyRef

Inherited from Any

Ungrouped