io.servicetalk.concurrent.internal

Class ConcurrentUtils

java.lang.Object

io.servicetalk.concurrent.internal.ConcurrentUtils

public final class ConcurrentUtils
extends java.lang.Object

Utilities which can be used for concurrency.

Field Summary

Fields

Modifier and Type	Field and Description
static int	CONCURRENT_EMITTING
static int	CONCURRENT_IDLE

Method Summary

Modifier and Type	Method and Description
static <T,R> long	drainSingleConsumerCollectionDelayThrow(java.util.Collection<T> source, java.util.function.Consumer<T> forEach, java.util.concurrent.atomic.AtomicIntegerFieldUpdater<R> drainActiveUpdater, R flagOwner) Drains the passed single-consumer Collection and ensures that it is empty before returning.
static <T,R> long	drainSingleConsumerQueue(java.util.Queue<T> queue, java.util.function.Consumer<T> forEach, java.util.concurrent.atomic.AtomicIntegerFieldUpdater<R> drainActiveUpdater, R flagOwner) Drains the passed single-consumer Queue and ensures that it is empty before returning.
static <T,R> long	drainSingleConsumerQueueDelayThrow(java.util.Queue<T> queue, java.util.function.Consumer<T> forEach, java.util.concurrent.atomic.AtomicIntegerFieldUpdater<R> drainActiveUpdater, R flagOwner) Drains the passed single-consumer Queue and ensures that it is empty before returning.
static <T> void	executeExclusive(java.lang.Runnable task, java.util.concurrent.atomic.AtomicIntegerFieldUpdater<T> exclusionFlag, T flagOwner) Executes the passed Runnable assuring that concurrent invocations of this method does not concurrently execute the Runnable.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CONCURRENT_IDLE

public static final int CONCURRENT_IDLE

See Also:

Constant Field Values

CONCURRENT_EMITTING

public static final int CONCURRENT_EMITTING

See Also:

Constant Field Values

Method Detail

drainSingleConsumerQueue

public static <T,R> long drainSingleConsumerQueue(java.util.Queue<T> queue,
                                                  java.util.function.Consumer<T> forEach,
                                                  java.util.concurrent.atomic.AtomicIntegerFieldUpdater<R> drainActiveUpdater,
                                                  R flagOwner)

Drains the passed single-consumer Queue and ensures that it is empty before returning. This accounts for any additions to the Queue while drain is in progress. Multiple threads can call this method concurrently but only one thread will actively drain the Queue.

Type Parameters:

T - Type of items stored in the Queue.

R - Type of the object holding the int referred by AtomicIntegerFieldUpdater.

Parameters:

queue - Queue to drain.

forEach - Consumer for each item that is drained.

drainActiveUpdater - An AtomicIntegerFieldUpdater for an int that is used to guard against concurrent drains.

flagOwner - Holding instance for drainActiveUpdater.

Returns:

Number of items drained from the queue.

drainSingleConsumerQueueDelayThrow

public static <T,R> long drainSingleConsumerQueueDelayThrow(java.util.Queue<T> queue,
                                                            java.util.function.Consumer<T> forEach,
                                                            java.util.concurrent.atomic.AtomicIntegerFieldUpdater<R> drainActiveUpdater,
                                                            R flagOwner)

Drains the passed single-consumer Queue and ensures that it is empty before returning. This accounts for any additions to the Queue while drain is in progress. Multiple threads can call this method concurrently but only one thread will actively drain the Queue. Any Throwable thrown by forEach Consumer does not terminate draining but throws all thrown Throwables after drain.

Type Parameters:

T - Type of items stored in the Queue.

R - Type of the object holding the int referred by AtomicIntegerFieldUpdater.

Parameters:

queue - Queue to drain.

forEach - Consumer for each item that is drained.

drainActiveUpdater - An AtomicIntegerFieldUpdater for an int that is used to guard against concurrent drains.

flagOwner - Holding instance for drainActiveUpdater.

Returns:

Number of items drained from the queue.

Throws:

java.lang.RuntimeException - All Throwable thrown by forEach Consumer are added as suppressed causes.

drainSingleConsumerCollectionDelayThrow

public static <T,R> long drainSingleConsumerCollectionDelayThrow(java.util.Collection<T> source,
                                                                 java.util.function.Consumer<T> forEach,
                                                                 java.util.concurrent.atomic.AtomicIntegerFieldUpdater<R> drainActiveUpdater,
                                                                 R flagOwner)

Drains the passed single-consumer Collection and ensures that it is empty before returning. This accounts for any additions to the Collection while drain is in progress. Multiple threads can call this method concurrently but only one thread will actively drain the Collection. Any Throwable thrown by forEach Consumer does not terminate draining but throws all thrown Throwables after drain.

Type Parameters:

T - Type of items stored in the Collection.

R - Type of the object holding the int referred by AtomicIntegerFieldUpdater.

Parameters:

source - Collection to drain.

forEach - Consumer for each item that is drained.

drainActiveUpdater - An AtomicIntegerFieldUpdater for an int that is used to guard against concurrent drains.

flagOwner - Holding instance for drainActiveUpdater.

Returns:

Number of items drained from the collection.

Throws:

java.lang.RuntimeException - All Throwable thrown by forEach Consumer are added as suppressed causes.

executeExclusive

public static <T> void executeExclusive(java.lang.Runnable task,
                                        java.util.concurrent.atomic.AtomicIntegerFieldUpdater<T> exclusionFlag,
                                        T flagOwner)

Executes the passed Runnable assuring that concurrent invocations of this method does not concurrently execute the Runnable. However, any invocation, while another execution is in progress, will trigger execution of the Runnable again after the current execution completes. This process will repeat till no invocation was received during the execution of the Runnable or any execution threw an exception.

Type Parameters:

T - Type of the owner of the flags.

Parameters:

task - Runnable to execute. Any unchecked exception thrown by this task is thrown from this method.

exclusionFlag - AtomicIntegerFieldUpdater to update a flag that guarantees exclusive execution of the task. This flag is assumed to be 0 when this method is invoked and must not be modified elsewhere.

flagOwner - Owning instance of the