object ConcurrentQueue extends Serializable
- Source
- ConcurrentQueue.scala
- Alphabetic
- By Inheritance
- ConcurrentQueue
- Serializable
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Type Members
- final class ApplyBuilders[F[_]] extends AnyVal
Returned by the apply builder.
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
- def apply[F[_]](implicit F: Concurrent[F]): ApplyBuilders[F]
Builds an ConcurrentQueue value for
Fdata types that implement theConcurrenttype class.Builds an ConcurrentQueue value for
Fdata types that implement theConcurrenttype class.This builder uses the Partially-Applied Type technique.
- F
is a
cats.effect.Concurrenttype class restriction; this queue is built to work withConcurrentdata types
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def bounded[F[_], A](capacity: Int)(implicit F: Concurrent[F], cs: ContextShift[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.Concurrenttype class restriction; this queue is built to work withConcurrentdata types- cs
is a
ContextShift, needed for triggering async boundaries for fairness reasons, in case there's a need to back-pressure on the internal buffer
- See also
unbounded for building an unbounded queue that can use the entire memory available to the process.
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
- 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() @HotSpotIntrinsicCandidate()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- 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() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- def unbounded[F[_], A](chunkSizeHint: Option[Int] = None)(implicit F: Concurrent[F], cs: ContextShift[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.Concurrenttype class restriction; this queue is built to work withConcurrentdata types- cs
is a
ContextShift, needed for triggering async boundaries for fairness reasons, in case there's a need to back-pressure on the internal buffer
- See also
bounded for building a limited capacity queue.
- def unsafe[F[_], A](capacity: BufferCapacity, channelType: ChannelType = MPMC)(implicit F: Concurrent[F], cs: ContextShift[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.withConfig 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.Concurrenttype class restriction; this queue is built to work withConcurrentdata types- cs
is a
ContextShift, needed for triggering async boundaries for fairness reasons, in case there's a need to back-pressure on the internal buffer
- Annotations
- @UnsafeProtocol() @UnsafeBecauseImpure()
- 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()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- def withConfig[F[_], A](capacity: BufferCapacity, channelType: ChannelType)(implicit F: Concurrent[F], cs: ContextShift[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.Concurrenttype class restriction; this queue is built to work withConcurrentdata types- cs
is a
ContextShift, needed for triggering async boundaries for fairness reasons, in case there's a need to back-pressure on the internal buffer
- Annotations
- @UnsafeProtocol()
This is the API documentation for the Monix library.
Package Overview
monix.execution exposes lower level primitives for dealing with asynchronous execution:
Atomictypes, as alternative tojava.util.concurrent.atomicmonix.catnap exposes pure abstractions built on top of the Cats-Effect type classes:
monix.eval is for dealing with evaluation of results, thus exposing Task and Coeval.
monix.reactive exposes the
Observablepattern:Observableimplementationsmonix.tail exposes Iterant for purely functional pull based streaming:
BatchandBatchCursor, the alternatives to Scala'sIterableandIteratorrespectively that we are using within Iterant's encodingYou can control evaluation with type you choose - be it Task, Coeval, cats.effect.IO or your own as long as you provide correct cats-effect or cats typeclass instance.