hu.akarnokd.rxjava2.internal.util

Enum QueueDrainHelper

java.lang.Object

java.lang.Enum<QueueDrainHelper>

hu.akarnokd.rxjava2.internal.util.QueueDrainHelper

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<QueueDrainHelper>

public enum QueueDrainHelper
extends java.lang.Enum<QueueDrainHelper>

Utility class to help with the queue-drain serialization idiom.

Method Summary

Modifier and Type	Method and Description
static <T,U> boolean	checkTerminated(boolean d, boolean empty, NbpObservable.NbpSubscriber<?> s, boolean delayError, java.util.Queue<?> q, Disposable disposable, NbpQueueDrain<T,U> qd)
static <T,U> boolean	checkTerminated(boolean d, boolean empty, org.reactivestreams.Subscriber<?> s, boolean delayError, java.util.Queue<?> q, QueueDrain<T,U> qd)
static <T,U> void	drainLoop(java.util.Queue<T> q, NbpObservable.NbpSubscriber<? super U> a, boolean delayError, Disposable dispose, NbpQueueDrain<T,U> qd)
static <T,U> void	drainLoop(java.util.Queue<T> q, org.reactivestreams.Subscriber<? super U> a, boolean delayError, QueueDrain<T,U> qd)
static <T,U> void	drainMaxLoop(java.util.Queue<T> q, org.reactivestreams.Subscriber<? super U> a, boolean delayError, Disposable dispose, QueueDrain<T,U> qd) Drain the queue but give up with an error if there aren't enough requests.
static <T> void	queueDrain(java.util.concurrent.atomic.AtomicIntegerFieldUpdater<T> updater, T instance, java.lang.Runnable fastPath, java.lang.Runnable queue, java.lang.Runnable drain) A fast-path queue-drain serialization logic.
static <T> void	queueDrain(java.util.concurrent.atomic.AtomicInteger instance, java.lang.Runnable fastPath, java.lang.Runnable queue, java.lang.Runnable drain) A fast-path queue-drain serialization logic.
static <T> void	queueDrainIf(java.util.concurrent.atomic.AtomicInteger instance, BooleanSupplier fastPath, BooleanSupplier queue, java.lang.Runnable drain) A fast-path queue-drain serialization logic with the ability to leave the state in fastpath/drain mode or not continue after the call to queue.
static <T> void	queueDrainIf(java.util.concurrent.atomic.AtomicIntegerFieldUpdater<T> updater, T instance, BooleanSupplier fastPath, BooleanSupplier queue, java.lang.Runnable drain) A fast-path queue-drain serialization logic with the ability to leave the state in fastpath/drain mode or not continue after the call to queue.
static <T> void	queueDrainLoop(java.util.concurrent.atomic.AtomicIntegerFieldUpdater<T> updater, T instance, java.lang.Runnable fastPath, java.lang.Runnable queue, java.lang.Runnable drain) A fast-path queue-drain serialization logic where the drain is looped until the instance state reaches 0 again.
static <T> void	queueDrainLoop(java.util.concurrent.atomic.AtomicInteger instance, java.lang.Runnable fastPath, java.lang.Runnable queue, java.lang.Runnable drain) A fast-path queue-drain serialization logic where the drain is looped until the instance state reaches 0 again.
static <T> void	queueDrainLoopIf(java.util.concurrent.atomic.AtomicInteger instance, BooleanSupplier fastPath, BooleanSupplier queue, BooleanSupplier drain) A fast-path queue-drain serialization logic with looped drain call and the ability to leave the state in fastpath/drain mode or not continue after the call to queue.
static <T> void	queueDrainLoopIf(java.util.concurrent.atomic.AtomicIntegerFieldUpdater<T> updater, T instance, BooleanSupplier fastPath, BooleanSupplier queue, BooleanSupplier drain) A fast-path queue-drain serialization logic with looped drain call and the ability to leave the state in fastpath/drain mode or not continue after the call to queue.
static QueueDrainHelper	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static QueueDrainHelper[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

values

public static QueueDrainHelper[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (QueueDrainHelper c : QueueDrainHelper.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static QueueDrainHelper valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

queueDrain

public static <T> void queueDrain(java.util.concurrent.atomic.AtomicIntegerFieldUpdater<T> updater,
                                  T instance,
                                  java.lang.Runnable fastPath,
                                  java.lang.Runnable queue,
                                  java.lang.Runnable drain)

A fast-path queue-drain serialization logic.

The decrementing of the state is left to the drain callback.

Type Parameters:

T - the instance type

Parameters:

updater - the field updater

instance - the instance holding the field

fastPath - called if the instance is uncontended.

queue - called if the instance is contended to queue up work

drain - called if the instance transitions to the drain state successfully

queueDrainIf

public static <T> void queueDrainIf(java.util.concurrent.atomic.AtomicIntegerFieldUpdater<T> updater,
                                    T instance,
                                    BooleanSupplier fastPath,
                                    BooleanSupplier queue,
                                    java.lang.Runnable drain)

A fast-path queue-drain serialization logic with the ability to leave the state in fastpath/drain mode or not continue after the call to queue.

The decrementing of the state is left to the drain callback.

Type Parameters:

T - the instance type

Parameters:

updater - the field updater

instance - the instance holding the field

fastPath -

queue -

drain -

queueDrainLoop

public static <T> void queueDrainLoop(java.util.concurrent.atomic.AtomicIntegerFieldUpdater<T> updater,
                                      T instance,
                                      java.lang.Runnable fastPath,
                                      java.lang.Runnable queue,
                                      java.lang.Runnable drain)

A fast-path queue-drain serialization logic where the drain is looped until the instance state reaches 0 again.

Type Parameters:

T - the instance type

Parameters:

updater - the field updater

instance - the instance holding the field

fastPath -

queue -

drain -

queueDrainLoopIf

public static <T> void queueDrainLoopIf(java.util.concurrent.atomic.AtomicIntegerFieldUpdater<T> updater,
                                        T instance,
                                        BooleanSupplier fastPath,
                                        BooleanSupplier queue,
                                        BooleanSupplier drain)

A fast-path queue-drain serialization logic with looped drain call and the ability to leave the state in fastpath/drain mode or not continue after the call to queue.

Type Parameters:

T - the instance type

Parameters:

updater - the field updater

instance - the instance holding the field

fastPath -

queue -

drain -

queueDrain

public static <T> void queueDrain(java.util.concurrent.atomic.AtomicInteger instance,
                                  java.lang.Runnable fastPath,
                                  java.lang.Runnable queue,
                                  java.lang.Runnable drain)

A fast-path queue-drain serialization logic.

The decrementing of the state is left to the drain callback.

Type Parameters:

T - the instance type

Parameters:

instance -

fastPath - called if the instance is uncontended.

queue - called if the instance is contended to queue up work

drain - called if the instance transitions to the drain state successfully

queueDrainIf

public static <T> void queueDrainIf(java.util.concurrent.atomic.AtomicInteger instance,
                                    BooleanSupplier fastPath,
                                    BooleanSupplier queue,
                                    java.lang.Runnable drain)

A fast-path queue-drain serialization logic with the ability to leave the state in fastpath/drain mode or not continue after the call to queue.

The decrementing of the state is left to the drain callback.

Type Parameters:

T - the instance type

Parameters:

instance -

fastPath -

queue -

drain -

queueDrainLoop

public static <T> void queueDrainLoop(java.util.concurrent.atomic.AtomicInteger instance,
                                      java.lang.Runnable fastPath,
                                      java.lang.Runnable queue,
                                      java.lang.Runnable drain)

A fast-path queue-drain serialization logic where the drain is looped until the instance state reaches 0 again.

Type Parameters:

T - the instance type

Parameters:

instance -

fastPath -

queue -

drain -

queueDrainLoopIf

public static <T> void queueDrainLoopIf(java.util.concurrent.atomic.AtomicInteger instance,
                                        BooleanSupplier fastPath,
                                        BooleanSupplier queue,
                                        BooleanSupplier drain)

A fast-path queue-drain serialization logic with looped drain call and the ability to leave the state in fastpath/drain mode or not continue after the call to queue.

Type Parameters:

T - the instance type

Parameters:

instance -

fastPath -

queue -

drain -

drainLoop

public static <T,U> void drainLoop(java.util.Queue<T> q,
                                   org.reactivestreams.Subscriber<? super U> a,
                                   boolean delayError,
                                   QueueDrain<T,U> qd)

drainMaxLoop

public static <T,U> void drainMaxLoop(java.util.Queue<T> q,
                                      org.reactivestreams.Subscriber<? super U> a,
                                      boolean delayError,
                                      Disposable dispose,
                                      QueueDrain<T,U> qd)

Drain the queue but give up with an error if there aren't enough requests.

Type Parameters:

T - the queue value type

U - the emission value type

Parameters:

q - the queue

a - the subscriber

delayError - true if errors should be delayed after all normal items

dispose - the disposable to call when termination happens and cleanup is necessary

qd - the QueueDrain instance that gives status information to the drain logic

checkTerminated

public static <T,U> boolean checkTerminated(boolean d,
                                            boolean empty,
                                            org.reactivestreams.Subscriber<?> s,
                                            boolean delayError,
                                            java.util.Queue<?> q,
                                            QueueDrain<T,U> qd)

drainLoop

public static <T,U> void drainLoop(java.util.Queue<T> q,
                                   NbpObservable.NbpSubscriber<? super U> a,
                                   boolean delayError,
                                   Disposable dispose,
                                   NbpQueueDrain<T,U> qd)

checkTerminated

public static <T,U> boolean checkTerminated(boolean d,
                                            boolean empty,
                                            NbpObservable.NbpSubscriber<?> s,
                                            boolean delayError,
                                            java.util.Queue<?> q,
                                            Disposable disposable,
                                            NbpQueueDrain<T,U> qd)