Trait/Object

zio.stm

TQueue

Related Docs: object TQueue | package stm

Permalink

trait TQueue[A] extends TDequeue[A] with TEnqueue[A]

A TQueue is a transactional queue. Offerors can offer values to the queue and takers can take values from the queue.

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TQueue
  2. TEnqueue
  3. TDequeue
  4. Serializable
  5. Serializable
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def capacity: Int

    Permalink

    The maximum capacity of the queue.

    The maximum capacity of the queue.

    Definition Classes
    TEnqueue
  2. abstract def isShutdown: USTM[Boolean]

    Permalink

    Checks whether the queue is shut down.

    Checks whether the queue is shut down.

    Definition Classes
    TEnqueue
  3. abstract def offer(a: A): ZSTM[Any, Nothing, Boolean]

    Permalink

    Offers a value to the queue, returning whether the value was offered to the queue.

    Offers a value to the queue, returning whether the value was offered to the queue.

    Definition Classes
    TEnqueue
  4. abstract def offerAll(as: Iterable[A]): ZSTM[Any, Nothing, Boolean]

    Permalink

    Offers all of the specified values to the queue, returning whether they were offered to the queue.

    Offers all of the specified values to the queue, returning whether they were offered to the queue.

    Definition Classes
    TEnqueue
  5. abstract def peek: ZSTM[Any, Nothing, A]

    Permalink

    Views the next element in the queue without removing it, retrying if the queue is empty.

    Views the next element in the queue without removing it, retrying if the queue is empty.

    Definition Classes
    TDequeue
  6. abstract def peekOption: ZSTM[Any, Nothing, Option[A]]

    Permalink

    Views the next element in the queue without removing it, returning None if the queue is empty.

    Views the next element in the queue without removing it, returning None if the queue is empty.

    Definition Classes
    TDequeue
  7. abstract def shutdown: USTM[Unit]

    Permalink

    Shuts down the queue.

    Shuts down the queue.

    Definition Classes
    TEnqueue
  8. abstract def size: USTM[Int]

    Permalink

    The current number of values in the queue.

    The current number of values in the queue.

    Definition Classes
    TEnqueue
  9. abstract def take: ZSTM[Any, Nothing, A]

    Permalink

    Takes a value from the queue.

    Takes a value from the queue.

    Definition Classes
    TDequeue
  10. abstract def takeAll: ZSTM[Any, Nothing, Chunk[A]]

    Permalink

    Takes all the values from the queue.

    Takes all the values from the queue.

    Definition Classes
    TDequeue
  11. abstract def takeUpTo(max: Int): ZSTM[Any, Nothing, Chunk[A]]

    Permalink

    Takes up to the specified number of values from the queue.

    Takes up to the specified number of values from the queue.

    Definition Classes
    TDequeue

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. final def awaitShutdown: USTM[Unit]

    Permalink

    Waits for the hub to be shut down.

    Waits for the hub to be shut down.

    Definition Classes
    TQueueTEnqueueTDequeue
  6. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  7. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  8. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  9. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  10. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  11. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  12. final def isEmpty: USTM[Boolean]

    Permalink

    Checks if the queue is empty.

    Checks if the queue is empty.

    Definition Classes
    TQueueTEnqueueTDequeue
  13. final def isFull: USTM[Boolean]

    Permalink

    Checks if the queue is at capacity.

    Checks if the queue is at capacity.

    Definition Classes
    TQueueTEnqueueTDequeue
  14. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  15. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  16. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  17. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  18. final def poll: ZSTM[Any, Nothing, Option[A]]

    Permalink

    Takes a single element from the queue, returning None if the queue is empty.

    Takes a single element from the queue, returning None if the queue is empty.

    Definition Classes
    TDequeue
  19. final def seek(f: (A) ⇒ Boolean): ZSTM[Any, Nothing, A]

    Permalink

    Drops elements from the queue while they do not satisfy the predicate, taking and returning the first element that does satisfy the predicate.

    Drops elements from the queue while they do not satisfy the predicate, taking and returning the first element that does satisfy the predicate. Retries if no elements satisfy the predicate.

    Definition Classes
    TDequeue
  20. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  21. final def takeBetween(min: Int, max: Int): ZSTM[Any, Nothing, Chunk[A]]

    Permalink

    Takes a number of elements from the queue between the specified minimum and maximum.

    Takes a number of elements from the queue between the specified minimum and maximum. If there are fewer than the minimum number of elements available, retries until at least the minimum number of elements have been collected.

    Definition Classes
    TDequeue
  22. final def takeN(n: Int): ZSTM[Any, Nothing, Chunk[A]]

    Permalink

    Takes the specified number of elements from the queue.

    Takes the specified number of elements from the queue. If there are fewer than the specified number of elements available, it retries until they become available.

    Definition Classes
    TDequeue
  23. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  24. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  25. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  26. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from TEnqueue[A]

Inherited from TDequeue[A]

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped