ZQueueProducer

zio.temporal.workflow.ZQueueProducer
trait ZQueueProducer[E]

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class ZWorkflowQueue[E]

Members list

Value members

Abstract methods

def cancellableOffer(e: E, timeout: 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.

Value parameters

e

the element to add

timeout

how long to wait before giving up

Attributes

Returns

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

Throws
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

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.

Value parameters

e

the element to add

Attributes

Throws
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

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.

Value parameters

e

the element to add

Attributes

Returns

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

Throws
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

def offer(e: E, timeout: Duration): Boolean

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.

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.

Value parameters

e

the element to add

timeout

how long to wait before giving up

Attributes

Returns

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

Throws
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

def put(e: E): Unit

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.

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.

Value parameters

e

the element to add

Attributes

Throws
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