Packages

object ConcurrentQueue extends Serializable

Source
ConcurrentQueue.scala
Linear Supertypes
Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ConcurrentQueue
  2. Serializable
  3. Serializable
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. final class ApplyBuilders[F[_]] extends AnyVal

    Returned by the apply builder.

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. def apply[F[_]](implicit F: Async[F]): ApplyBuilders[F]

    Builds an ConcurrentQueue value for F data types that are either Async.

    Builds an ConcurrentQueue value for F data types that are either Async.

    This builder uses the Partially-Applied Type technique.

  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def bounded[F[_], A](capacity: Int)(implicit F: Async[F], timer: Timer[F]): F[ConcurrentQueue[F, A]]

    Builds a limited capacity and back-pressured ConcurrentQueue.

    Builds a limited capacity and back-pressured ConcurrentQueue.

    capacity

    is the maximum capacity of the internal buffer; note that due to performance optimizations, the capacity of the internal buffer can get rounded to a power of 2, so the actual capacity may be slightly different than the one specified

    F

    is a cats.effect.Async type class restriction; this queue is built to work with any Async data type

    timer

    is a Timer, needed for asynchronous waiting on poll when the queue is empty or for back-pressuring offer when the queue is full

    See also

    unbounded for building an unbounded queue that can use the entire memory available to the process.

  7. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  8. def custom[F[_], A](capacity: BufferCapacity, channelType: ChannelType)(implicit F: Async[F], timer: Timer[F]): F[ConcurrentQueue[F, A]]

    Builds an ConcurrentQueue with fined tuned config parameters.

    Builds an ConcurrentQueue with fined tuned config parameters.

    UNSAFE PROTOCOL: This is unsafe due to problems that can happen via selecting the wrong ChannelType, so use with care.

    capacity

    specifies the BufferCapacity, which can be either "bounded" (with a maximum capacity), or "unbounded"

    channelType

    (UNSAFE) specifies the concurrency scenario, for fine tuning the performance

    F

    is a cats.effect.Async type class restriction; this queue is built to work with any Async data type

    timer

    is a Timer, needed for asynchronous waiting on poll when the queue is empty or for back-pressuring offer when the queue is full

    Annotations
    @UnsafeProtocol()
  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[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. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  19. def toString(): String
    Definition Classes
    AnyRef → Any
  20. def unbounded[F[_], A](chunkSizeHint: Option[Int] = None)(implicit F: Async[F], timer: Timer[F]): F[ConcurrentQueue[F, A]]

    Builds an unlimited ConcurrentQueue that can use the entire memory available to the process.

    Builds an unlimited ConcurrentQueue that can use the entire memory available to the process.

    chunkSizeHint

    is an optimization parameter — the underlying implementation may use an internal buffer that uses linked arrays, in which case the "chunk size" represents the size of a chunk; providing it is just a hint, it may or may not be used

    F

    is a cats.effect.Async type class restriction; this queue is built to work with any Async data type

    timer

    is a Timer, needed for asynchronous waiting on poll when the queue is empty or for back-pressuring offer when the queue is full

    See also

    bounded for building a limited capacity queue.

  21. def unsafe[F[_], A](capacity: BufferCapacity, channelType: ChannelType = MPMC)(implicit F: Async[F], timer: Timer[F]): ConcurrentQueue[F, A]

    The unsafe version of the ConcurrentQueue.bounded builder.

    The unsafe version of the ConcurrentQueue.bounded builder.

    UNSAFE PROTOCOL: This is unsafe due to problems that can happen via selecting the wrong ChannelType, so use with care.

    UNSAFE BECAUSE IMPURE: this builder violates referential transparency, as the queue keeps internal, shared state. Only use when you know what you're doing, otherwise prefer ConcurrentQueue.custom or ConcurrentQueue.bounded.

    capacity

    specifies the BufferCapacity, which can be either "bounded" (with a maximum capacity), or "unbounded"

    channelType

    (UNSAFE) specifies the concurrency scenario, for fine tuning the performance

    F

    is a cats.effect.Async type class restriction; this queue is built to work with any Async data type

    timer

    is a Timer, needed for asynchronous waiting on poll when the queue is empty or for back-pressuring offer when the queue is full

    Annotations
    @UnsafeProtocol() @UnsafeBecauseImpure()
  22. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  23. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  24. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped