Packages

class Queue[F[_], T] extends AnyRef

Nonblocking, concurrent, asynchronous queue.

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Queue
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new Queue(maxSize: Int)(implicit arg0: Effect[F])

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 canOffer: F[Unit]

    Signals that queue size became less than maxSize.

    Signals that queue size became less than maxSize.

    Example:

    1. def aux(): F[Unit] = queue.offer(o).flatMap {
  case false => queue.canOffer *> aux()
  case true => Effect[F].unit
}
aux()
  6. def cancelSignal: F[Unit]

    Resolves only if stream.cancel ran.

  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  8. def close(): F[Unit]

    Immediately stop offering and pulling items from the queue.

  9. def dequeueAll(): F[Seq[T]]
  10. def enqueue(item: T): F[Unit]

    Enqueue item.

    Enqueue item. If maxSize reached waits until queue will decrease.

  11. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  13. def fail(e: Throwable): F[Unit]
  14. def failUnsafe(e: Throwable): Unit
  15. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  16. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  20. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  21. def offer(item: T): F[Boolean]

    Offers item to the queue.

    Offers item to the queue.

    returns

    true is ok and false if maxSize reached or queue is stopped.

  22. def offerUnsafe(item: T): Boolean

    Strict version of offer.

    Strict version of offer. Still thread safe.

  23. def size(): F[Int]

    Returns the size of the queue.

    Returns the size of the queue. This property takes into account canOfferCallbacks and pullCallbacks to determine the real size of the queue after all of them are resolved.

  24. def stop(): F[Unit]

    Disallow to offer new items.

    Disallow to offer new items. Stream ends with last item.

  25. val stream: Stream[F, T]
  26. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  27. def toString(): String
    Definition Classes
    AnyRef → Any
  28. def unsafeClose(): Unit
  29. def unsafeStop(): Unit
  30. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  31. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  32. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

Inherited from AnyRef

Inherited from Any

Ungrouped