RxJava 3 3.1.8 · io.reactivex.rxjava3.internal.util.QueueDrainHelper

Modifier and Type	Field and Description
pack-priv static final long	COMPLETED_MASK
pack-priv static final long	REQUESTED_MASK

Access	Constructor and Description
private	QueueDrainHelper() Utility class.

Method Summary

Modifier and Type	Method and Description
public static <T, U> boolean	checkTerminated(boolean d, boolean empty, Subscriber<?> s, boolean delayError, SimpleQueue<?> q, QueueDrain<T, U> qd)
public static <T, U> boolean	checkTerminated(boolean d, boolean empty, Observer<?> observer, boolean delayError, SimpleQueue<?> q, Disposable disposable, ObservableQueueDrain<T, U> qd)
public static < the value type of the queue T> SimpleQueue<T>	Returns: the queue instance createQueue(int the capacity hint, negative value will create an array-based SPSC queue capacityHint) Creates a queue: spsc-array if capacityHint is positive and spsc-linked-array if capacityHint is negative; in both cases, the capacity is the absolute value of prefetch.
public static <T, U> void	drainLoop(SimplePlainQueue<T> q, Observer<? super U> a, boolean delayError, Disposable dispose, ObservableQueueDrain<T, U> qd)
public static < the queue value type T, the emission value type U> void	drainMaxLoop(SimplePlainQueue<T> the queue q, Subscriber<? super U> the subscriber a, boolean true if errors should be delayed after all normal items delayError, Disposable the disposable to call when termination happens and cleanup is necessary dispose, QueueDrain<T, U> the QueueDrain instance that gives status information to the drain logic qd) Drain the queue but give up with an error if there aren't enough requests.
pack-priv static boolean	isCancelled(BooleanSupplier cancelled)
public static < the value type emitted T> void	postComplete(Subscriber<? super T> the target Subscriber to send events to actual, Queue<T> the queue to drain if in the post-complete state queue, AtomicLong holds the request amount and the post-completed flag state, BooleanSupplier a supplier that returns true if the drain has been cancelled isCancelled) Signals the completion of the main sequence and switches to post-completion replay mode.
pack-priv static < the value type T> boolean	Returns: true if the queue was completely drained or the drain process was cancelled postCompleteDrain(long the current request amount n, Subscriber<? super T> the target Subscriber to send events to actual, Queue<T> the queue to drain if in the post-complete state queue, AtomicLong holds the request amount and the post-completed flag state, BooleanSupplier a supplier that returns true if the drain has been cancelled isCancelled) Drains the queue based on the outstanding requests in post-completed mode (only!).
public static < the value type emitted T> boolean	Returns: true if the state indicates a completion state. postCompleteRequest(long the request amount, positive (not validated) n, Subscriber<? super T> the target Subscriber to send events to actual, Queue<T> the queue to drain if in the post-complete state queue, AtomicLong holds the request amount and the post-completed flag state, BooleanSupplier a supplier that returns true if the drain has been cancelled isCancelled) Accumulates requests (not validated) and handles the completed mode draining of the queue based on the requests.
public static void	request(Subscription the Subscription to request from s, int the prefetch value prefetch) Requests `Long#MAX_VALUE` if prefetch is negative or the exact amount if prefetch is positive.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

COMPLETED_MASK	back to summary
pack-priv static final long COMPLETED_MASK

REQUESTED_MASK	back to summary
pack-priv static final long REQUESTED_MASK

QueueDrainHelper	back to summary
private QueueDrainHelper() Utility class.

Method Detail

checkTerminated	back to summary
public static <T, U> boolean checkTerminated(boolean d, boolean empty, Subscriber<?> s, boolean delayError, SimpleQueue<?> q, QueueDrain<T, U> qd)

checkTerminated	back to summary
public static <T, U> boolean checkTerminated(boolean d, boolean empty, Observer<?> observer, boolean delayError, SimpleQueue<?> q, Disposable disposable, ObservableQueueDrain<T, U> qd)

createQueue	back to summary
public static <T> SimpleQueue<T> createQueue(int capacityHint) Creates a queue: spsc-array if capacityHint is positive and spsc-linked-array if capacityHint is negative; in both cases, the capacity is the absolute value of prefetch. Parameters <T> the value type of the queue capacityHint:int the capacity hint, negative value will create an array-based SPSC queue Returns:SimpleQueue<T> the queue instance

createQueue

back to summary

public static <T> SimpleQueue<T> createQueue(int capacityHint)

Creates a queue: spsc-array if capacityHint is positive and spsc-linked-array if capacityHint is negative; in both cases, the capacity is the absolute value of prefetch.

Parameters

<T>: the value type of the queue
capacityHint:int: the capacity hint, negative value will create an array-based SPSC queue

Returns:SimpleQueue<T>

the queue instance

drainLoop	back to summary
public static <T, U> void drainLoop(SimplePlainQueue<T> q, Observer<? super U> a, boolean delayError, Disposable dispose, ObservableQueueDrain<T, U> qd)

drainMaxLoop	back to summary
public static <T, U> void drainMaxLoop(SimplePlainQueue<T> q, 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. Parameters <T> the queue value type <U> the emission value type q:SimplePlainQueue<T> the queue a:Subscriber<? super U> the subscriber delayError:boolean true if errors should be delayed after all normal items dispose:Disposable the disposable to call when termination happens and cleanup is necessary qd:QueueDrain<T, U> the QueueDrain instance that gives status information to the drain logic

drainMaxLoop

back to summary

public static <T, U> void drainMaxLoop(SimplePlainQueue<T> q, 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.

Parameters

<T>: the queue value type
<U>: the emission value type
q:SimplePlainQueue<T>: the queue
a:Subscriber<? super U>: the subscriber
delayError:boolean: true if errors should be delayed after all normal items
dispose:Disposable: the disposable to call when termination happens and cleanup is necessary
qd:QueueDrain<T, U>: the QueueDrain instance that gives status information to the drain logic

isCancelled	back to summary
pack-priv static boolean isCancelled(BooleanSupplier cancelled)

postComplete back to summary

postComplete	back to summary
public static <T> void postComplete(Subscriber<? super T> actual, Queue<T> queue, AtomicLong state, BooleanSupplier isCancelled) Signals the completion of the main sequence and switches to post-completion replay mode. Don't modify the queue after calling this method! Post-completion backpressure handles the case when a source produces values based on requests when it is active but more values are available even after its completion. In this case, the onComplete() can't just emit the contents of the queue but has to coordinate with the requested amounts. This requires two distinct modes: active and completed. In active mode, requests flow through and the queue is not accessed but in completed mode, requests no-longer reach the upstream but help in draining the queue. The algorithm utilizes the most significant bit (bit 63) of a long value (AtomicLong) since request amount only goes up to `Long#MAX_VALUE` (bits 0-62) and negative values aren't allowed. Parameters <T> the value type emitted actual:Subscriber<? super T> the target Subscriber to send events to queue:Queue<T> the queue to drain if in the post-complete state state:AtomicLong holds the request amount and the post-completed flag isCancelled:BooleanSupplier a supplier that returns true if the drain has been cancelled

public static <T> void postComplete(Subscriber<? super T> actual, Queue<T> queue, AtomicLong state, BooleanSupplier isCancelled)

Signals the completion of the main sequence and switches to post-completion replay mode.

Don't modify the queue after calling this method!

Post-completion backpressure handles the case when a source produces values based on requests when it is active but more values are available even after its completion. In this case, the onComplete() can't just emit the contents of the queue but has to coordinate with the requested amounts. This requires two distinct modes: active and completed. In active mode, requests flow through and the queue is not accessed but in completed mode, requests no-longer reach the upstream but help in draining the queue.

The algorithm utilizes the most significant bit (bit 63) of a long value (AtomicLong) since request amount only goes up to Long#MAX_VALUE (bits 0-62) and negative values aren't allowed.

Parameters

<T>: the value type emitted
actual:Subscriber<? super T>: the target Subscriber to send events to
queue:Queue<T>: the queue to drain if in the post-complete state
state:AtomicLong: holds the request amount and the post-completed flag
isCancelled:BooleanSupplier: a supplier that returns true if the drain has been cancelled

postCompleteDrain	back to summary
pack-priv static <T> boolean postCompleteDrain(long n, Subscriber<? super T> actual, Queue<T> queue, AtomicLong state, BooleanSupplier isCancelled) Drains the queue based on the outstanding requests in post-completed mode (only!). Parameters <T> the value type n:long the current request amount actual:Subscriber<? super T> the target Subscriber to send events to queue:Queue<T> the queue to drain if in the post-complete state state:AtomicLong holds the request amount and the post-completed flag isCancelled:BooleanSupplier a supplier that returns true if the drain has been cancelled Returns:boolean true if the queue was completely drained or the drain process was cancelled

postCompleteDrain

back to summary

pack-priv static <T> boolean postCompleteDrain(long n, Subscriber<? super T> actual, Queue<T> queue, AtomicLong state, BooleanSupplier isCancelled)

Drains the queue based on the outstanding requests in post-completed mode (only!).

Parameters

<T>: the value type
n:long: the current request amount
actual:Subscriber<? super T>: the target Subscriber to send events to
queue:Queue<T>: the queue to drain if in the post-complete state
state:AtomicLong: holds the request amount and the post-completed flag
isCancelled:BooleanSupplier: a supplier that returns true if the drain has been cancelled

Returns:boolean

true if the queue was completely drained or the drain process was cancelled

postCompleteRequest	back to summary
public static <T> boolean postCompleteRequest(long n, Subscriber<? super T> actual, Queue<T> queue, AtomicLong state, BooleanSupplier isCancelled) Accumulates requests (not validated) and handles the completed mode draining of the queue based on the requests. Post-completion backpressure handles the case when a source produces values based on requests when it is active but more values are available even after its completion. In this case, the onComplete() can't just emit the contents of the queue but has to coordinate with the requested amounts. This requires two distinct modes: active and completed. In active mode, requests flow through and the queue is not accessed but in completed mode, requests no-longer reach the upstream but help in draining the queue. Parameters <T> the value type emitted n:long the request amount, positive (not validated) actual:Subscriber<? super T> the target Subscriber to send events to queue:Queue<T> the queue to drain if in the post-complete state state:AtomicLong holds the request amount and the post-completed flag isCancelled:BooleanSupplier a supplier that returns true if the drain has been cancelled Returns:boolean true if the state indicates a completion state.

postCompleteRequest

back to summary

public static <T> boolean postCompleteRequest(long n, Subscriber<? super T> actual, Queue<T> queue, AtomicLong state, BooleanSupplier isCancelled)

Accumulates requests (not validated) and handles the completed mode draining of the queue based on the requests.

Parameters

<T>: the value type emitted
n:long: the request amount, positive (not validated)
actual:Subscriber<? super T>: the target Subscriber to send events to
queue:Queue<T>: the queue to drain if in the post-complete state
state:AtomicLong: holds the request amount and the post-completed flag
isCancelled:BooleanSupplier: a supplier that returns true if the drain has been cancelled

Returns:boolean

true if the state indicates a completion state.

request back to summary

request	back to summary
public static void request(Subscription s, int prefetch) Requests `Long#MAX_VALUE` if prefetch is negative or the exact amount if prefetch is positive. Parameters s:Subscription the Subscription to request from prefetch:int the prefetch value

public static void request(Subscription s, int prefetch)

Requests Long#MAX_VALUE if prefetch is negative or the exact amount if prefetch is positive.

Parameters

s:Subscription: the Subscription to request from
prefetch:int: the prefetch value

public final Class QueueDrainHelper

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail