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 bounded[F[_], A](capacity: Int)(implicit F: kernel.GenConcurrent[F, _]): F[Queue[F, A]]

   Constructs an empty, bounded queue holding up to capacity elements for F data types that are cats.effect.kernel.GenConcurrent.

   Constructs an empty, bounded queue holding up to capacity elements for F data types that are cats.effect.kernel.GenConcurrent. When the queue is full (contains exactly capacity elements), every next Queue#offer will be backpressured (i.e. the Queue#offer blocks semantically).

   capacity

   the maximum capacity of the queue

   returns

   an empty, bounded queue

6.  implicit def catsInvariantForQueue[F[_]](implicit arg0: Functor[F]): Invariant[[β$0$]Queue[F, β$0$]]
7.  def circularBuffer[F[_], A](capacity: Int)(implicit F: kernel.GenConcurrent[F, _]): F[Queue[F, A]]

   Constructs an empty, bounded, circular buffer queue holding up to capacity elements for F data types that are cats.effect.kernel.GenConcurrent.

   Constructs an empty, bounded, circular buffer queue holding up to capacity elements for F data types that are cats.effect.kernel.GenConcurrent. The queue always keeps at most capacity number of elements, with the oldest element in the queue always being dropped in favor of a new elements arriving in the queue, and the offer effect itself will not semantically block.

   capacity

   the maximum capacity of the queue

   returns

   an empty, bounded, sliding queue

8.  def clone(): AnyRef

   Attributes

   protected[lang]

   Definition Classes

   AnyRef

   Annotations

   @throws(classOf[java.lang.CloneNotSupportedException]) @native()

9.  def dropping[F[_], A](capacity: Int)(implicit F: kernel.GenConcurrent[F, _]): F[Queue[F, A]]

   Constructs an empty, bounded, dropping queue holding up to capacity elements for F data types that are cats.effect.kernel.GenConcurrent.

   Constructs an empty, bounded, dropping queue holding up to capacity elements for F data types that are cats.effect.kernel.GenConcurrent. When the queue is full (contains exactly capacity elements), every next Queue#offer will be ignored, i.e. no other elements can be enqueued until there is sufficient capacity in the queue, and the offer effect itself will not semantically block.

   capacity

   the maximum capacity of the queue

   returns

   an empty, bounded, dropping queue

10.  final def eq(arg0: AnyRef): Boolean

    Definition Classes

    AnyRef

11.  def equals(arg0: AnyRef): Boolean

    Definition Classes

    AnyRef → Any

12.  def finalize(): Unit

    Attributes

    protected[lang]

    Definition Classes

    AnyRef

    Annotations

    @throws(classOf[java.lang.Throwable])

13.  final def getClass(): Class[_ <: AnyRef]

    Definition Classes

    AnyRef → Any

    Annotations

    @native()

14.  def hashCode(): Int

    Definition Classes

    AnyRef → Any

    Annotations

    @native()

15.  final def isInstanceOf[T0]: Boolean

    Definition Classes

    Any

16.  final def ne(arg0: AnyRef): Boolean

    Definition Classes

    AnyRef

17.  final def notify(): Unit

    Definition Classes

    AnyRef

    Annotations

    @native()

18.  final def notifyAll(): Unit

    Definition Classes

    AnyRef

    Annotations

    @native()

19.  final def synchronized[T0](arg0: => T0): T0

    Definition Classes

    AnyRef

20.  def synchronous[F[_], A](implicit F: kernel.GenConcurrent[F, _]): F[Queue[F, A]]

    Constructs a queue through which a single element can pass only in the case when there are at least one taking fiber and at least one offering fiber for F data types that are cats.effect.kernel.GenConcurrent.

    Constructs a queue through which a single element can pass only in the case when there are at least one taking fiber and at least one offering fiber for F data types that are cats.effect.kernel.GenConcurrent. Both Queue#offer and Queue#take semantically block until there is a fiber executing the opposite action, at which point both fibers are freed.

    returns

    a synchronous queue

21.  def toString(): String

    Definition Classes

    AnyRef → Any

22.  def unbounded[F[_], A](implicit F: kernel.GenConcurrent[F, _]): F[Queue[F, A]]

    Constructs an empty, unbounded queue for F data types that are cats.effect.kernel.GenConcurrent.

    Constructs an empty, unbounded queue for F data types that are cats.effect.kernel.GenConcurrent. Queue#offer never blocks semantically, as there is always spare capacity in the queue.

    returns

    an empty, unbounded queue

23.  def unsafeBounded[F[_], A](capacity: Int)(implicit F: kernel.Async[F]): F[unsafe.BoundedQueue[F, A]]

    Creates a new Queue subject to some capacity bound which supports a side-effecting tryOffer function, allowing impure code to directly add values to the queue without indirecting through something like Dispatcher.

    Creates a new Queue subject to some capacity bound which supports a side-effecting tryOffer function, allowing impure code to directly add values to the queue without indirecting through something like Dispatcher. This can improve performance significantly in some common cases. Note that the queue produced by this constructor can be used as a perfectly conventional Queue (as it is a subtype).

    capacity

    the maximum capacity of the queue (must be strictly greater than 1 and less than 32768)

    returns

    an empty bounded queue

    See also

    cats.effect.std.unsafe.BoundedQueue

24.  def unsafeUnbounded[F[_], A](implicit F: kernel.Async[F]): F[UnboundedQueue[F, A]]

    Creates a new unbounded Queue which supports a side-effecting offer function, allowing impure code to directly add values to the queue without indirecting through something like Dispatcher.

    Creates a new unbounded Queue which supports a side-effecting offer function, allowing impure code to directly add values to the queue without indirecting through something like Dispatcher. This can improve performance significantly in some common cases. Note that the queue produced by this constructor can be used as a perfectly conventional Queue (as it is a subtype).

    returns

    an empty unbounded queue

    See also

    cats.effect.std.unsafe.UnboundedQueue

25.  final def wait(): Unit

    Definition Classes

    AnyRef

    Annotations

    @throws(classOf[java.lang.InterruptedException])

26.  final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes

    AnyRef

    Annotations

    @throws(classOf[java.lang.InterruptedException])

27.  final def wait(arg0: Long): Unit

    Definition Classes

    AnyRef

    Annotations

    @throws(classOf[java.lang.InterruptedException]) @native()