c

zio.temporal.workflow

ZWorkflowQueue

final class ZWorkflowQueue[E] extends ZQueueConsumer[E] with ZQueueProducer[E]

Linear Supertypes
ZQueueProducer[E], ZQueueConsumer[E], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ZWorkflowQueue
  2. ZQueueProducer
  3. ZQueueConsumer
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

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 cancellableOffer(e: E, timeout: zio.Duration): Boolean

    Inserts the specified element into this queue, waiting up to the specified wait time if necessary for space to become available.

    Inserts the specified element into this queue, waiting up to the specified wait time if necessary for space to become available.

    e

    the element to add

    timeout

    how long to wait before giving up

    returns

    true if successful, or false if the specified waiting time elapses before space is available

    Definition Classes
    ZWorkflowQueue → ZQueueProducer
    Exceptions thrown

    ClassCastException if the class of the specified element prevents it from being added to this queue

    IllegalArgumentException if some property of the specified element prevents it from being added to this queue

    NullPointerException if the specified element is null

    io.temporal.failure.CanceledFailure if surrounding io.temporal.workflow.CancellationScope is canceled while waiting

  6. def cancellablePoll(timeout: zio.Duration): Option[E]

    Retrieves and removes the head of this queue, waiting up to the specified wait time if necessary for an element to become available.

    Retrieves and removes the head of this queue, waiting up to the specified wait time if necessary for an element to become available.

    timeout

    how long to wait before giving up

    returns

    the head of this queue wrapped in Some, or None if the specified waiting time elapses before an element is available

    Definition Classes
    ZQueueConsumer
    Exceptions thrown

    io.temporal.failure.CanceledFailure if surrounding io.temporal.workflow.CancellationScope is canceled while waiting

  7. def cancellablePut(e: E): Unit

    Inserts the specified element into this queue, waiting if necessary for space to become available.

    Inserts the specified element into this queue, waiting if necessary for space to become available.

    e

    the element to add

    Definition Classes
    ZWorkflowQueue → ZQueueProducer
    Exceptions thrown

    ClassCastException if the class of the specified element prevents it from being added to this queue

    IllegalArgumentException if some property of the specified element prevents it from being added to this queue

    NullPointerException if the specified element is null

    io.temporal.failure.CanceledFailure if surrounding io.temporal.workflow.CancellationScope is canceled while waiting

  8. def cancellableTake(): E

    Retrieves and removes the head of this queue, waiting if necessary until an element becomes available.

    Retrieves and removes the head of this queue, waiting if necessary until an element becomes available.

    returns

    the head of this queue

    Definition Classes
    ZQueueConsumer
    Exceptions thrown

    io.temporal.failure.CanceledFailure if surrounding io.temporal.workflow.CancellationScope is canceled while waiting

  9. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  10. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  11. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  12. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  13. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  14. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  15. def map[R](f: (E) => R): ZQueueConsumer[R]

    Returns a queue consisting of the results of applying the given function to the elements of this queue.

    Returns a queue consisting of the results of applying the given function to the elements of this queue.

    f

    a non-interfering, stateless function to apply to each element

    returns

    the new queue backed by this one.

    Definition Classes
    ZQueueConsumer
  16. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  18. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  19. def offer(e: E, timeout: zio.Duration): Boolean

    Inserts the specified element into this queue, waiting up to the specified wait time if necessary for space to become available.

    Inserts the specified element into this queue, waiting up to the specified wait time if necessary for space to become available. It is not unblocked in case of the enclosing CancellationScope cancellation. Use cancellableOffer instead.

    e

    the element to add

    timeout

    how long to wait before giving up

    returns

    true if successful, or false if the specified waiting time elapses before space is available

    Definition Classes
    ZWorkflowQueue → ZQueueProducer
    Exceptions thrown

    ClassCastException if the class of the specified element prevents it from being added to this queue

    IllegalArgumentException if some property of the specified element prevents it from being added to this queue

    NullPointerException if the specified element is null

  20. def offer(e: E): Boolean

    Inserts the specified element into this queue if it is possible to do so immediately without violating capacity restrictions, returning true upon success and false if no space is currently available.

    Inserts the specified element into this queue if it is possible to do so immediately without violating capacity restrictions, returning true upon success and false if no space is currently available.

    e

    the element to add

    returns

    true if the element was added to this queue, else false

    Definition Classes
    ZWorkflowQueue → ZQueueProducer
    Exceptions thrown

    ClassCastException if the class of the specified element prevents it from being added to this queue

    IllegalArgumentException if some property of the specified element prevents it from being added to this queue

    NullPointerException if the specified element is null

  21. def peek(): Option[E]

    Retrieves the head of this queue keeping it in the queue if it is not empty without blocking.

    Retrieves the head of this queue keeping it in the queue if it is not empty without blocking.

    returns

    the head of this queue wrapped in Some, or None if the queue is empty

    Definition Classes
    ZQueueConsumer
  22. def poll(timeout: zio.Duration): Option[E]

    Retrieves and removes the head of this queue, waiting up to the specified wait time if necessary for an element to become available.

    Retrieves and removes the head of this queue, waiting up to the specified wait time if necessary for an element to become available. It is not unblocked in case of the enclosing CancellationScope cancellation. Use cancellablePoll instead.

    timeout

    how long to wait before giving up.

    returns

    the head of this queue wrapped in Some, or None if the specified waiting time elapses before an element is available

    Definition Classes
    ZQueueConsumer
  23. def poll(): Option[E]

    Retrieves and removes the head of this queue if it is not empty without blocking.

    Retrieves and removes the head of this queue if it is not empty without blocking.

    returns

    the head of this queue wrapped in Some, or None if the queue is empty

    Definition Classes
    ZQueueConsumer
  24. def put(e: E): Unit

    Inserts the specified element into this queue, waiting if necessary for space to become available.

    Inserts the specified element into this queue, waiting if necessary for space to become available. It is not unblocked in case of the enclosing CancellationScope cancellation. Use cancellablePut instead.

    e

    the element to add

    Definition Classes
    ZWorkflowQueue → ZQueueProducer
    Exceptions thrown

    ClassCastException if the class of the specified element prevents it from being added to this queue

    IllegalArgumentException if some property of the specified element prevents it from being added to this queue

    NullPointerException if the specified element is null

  25. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  26. def take(): E

    Retrieves and removes the head of this queue, waiting if necessary until an element becomes available.

    Retrieves and removes the head of this queue, waiting if necessary until an element becomes available. It is not unblocked in case of the enclosing * CancellationScope cancellation. Use cancellableTake instead.

    returns

    the head of this queue

    Definition Classes
    ZQueueConsumer
  27. val toJava: WorkflowQueue[E]
  28. def toString(): String
    Definition Classes
    AnyRef → Any
  29. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  30. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  31. 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

    (Since version 9)

Inherited from ZQueueProducer[E]

Inherited from ZQueueConsumer[E]

Inherited from AnyRef

Inherited from Any

Ungrouped