Package io.reactivex.rxjava3.operators

Interface QueueDisposable<T>

Type Parameters:

T - the value type transmitted through the queue

All Superinterfaces:

Disposable, QueueFuseable<T>, SimpleQueue<T>

All Known Implementing Classes:

AbstractEmptyQueueFuseable, AsyncSubject.AsyncDisposable, BasicFuseableObserver, BasicIntQueueDisposable, BasicQueueDisposable, CancellableQueueFuseable, DeferredScalarDisposable, DeferredScalarObserver, EmptyDisposable, FlowableFromCompletable.FromCompletableObserver, MaybeFlatMapIterableObservable.FlatMapIterableObserver, MaybeFlattenStreamAsObservable.FlattenStreamMultiObserver, MaybeToObservable.MaybeToObservableObserver, ObservableCollectWithCollector.CollectorObserver, ObservableDistinct.DistinctObserver, ObservableDistinctUntilChanged.DistinctUntilChangedObserver, ObservableDoAfterNext.DoAfterObserver, ObservableDoFinally.DoFinallyObserver, ObservableFilter.FilterObserver, ObservableFlatMapCompletable.FlatMapCompletableMainObserver, ObservableFromArray.FromArrayDisposable, ObservableFromCompletable.FromCompletableObserver, ObservableFromCompletionStage.CompletionStageHandler, ObservableFromIterable.FromIterableDisposable, ObservableFromStream.StreamDisposable, ObservableMap.MapObserver, ObservableMapOptional.MapOptionalObserver, ObservableObserveOn.ObserveOnObserver, ObservableRange.RangeDisposable, ObservableRangeLong.RangeDisposable, ObservableScalarXMap.ScalarDisposable, SingleFlatMapIterableObservable.FlatMapIterableObserver, SingleToObservable.SingleToObservableObserver, UnicastSubject.UnicastQueueDisposable

public interface QueueDisposable<@NonNull T>
extends QueueFuseable<T>, Disposable

An interface extending SimpleQueue and Disposable and allows negotiating the fusion mode between subsequent operators of the Observable base reactive type.

The negotiation happens in subscription time when the upstream calls the onSubscribe with an instance of this interface. The downstream has then the obligation to call QueueFuseable.requestFusion(int) with the appropriate mode before calling request().

In synchronous fusion, all upstream values are either already available or is generated when SimpleQueue.poll() is called synchronously. When the SimpleQueue.poll() returns null, that is the indication if a terminated stream. In this mode, the upstream won't call the onXXX methods.

In asynchronous fusion, upstream values may become available to SimpleQueue.poll() eventually. Upstream signals onError() and onComplete() as usual, however, onNext will be called with null instead of the actual value. Downstream should treat such onNext as indication that SimpleQueue.poll() can be called.

The general rules for consuming the SimpleQueue interface:

• SimpleQueue.poll() and SimpleQueue.clear() has to be called sequentially (from within a serializing drain-loop).
• In addition, callers of SimpleQueue.poll() should be prepared to catch exceptions.
• Due to how computation attaches to the SimpleQueue.poll(), SimpleQueue.poll() may return null even if a preceding SimpleQueue.isEmpty() returned false.

Implementations should only allow calling the following methods and the rest of the SimpleQueue interface methods should throw UnsupportedOperationException:

• SimpleQueue.poll()
• SimpleQueue.isEmpty()
• SimpleQueue.clear()

Since:

3.1.1

See Also:

QueueSubscription

Field Summary

Fields inherited from interface io.reactivex.rxjava3.operators.QueueFuseable

ANY, ASYNC, BOUNDARY, NONE, SYNC

Method Summary

Methods inherited from interface io.reactivex.rxjava3.disposables.Disposable

dispose, isDisposed

Methods inherited from interface io.reactivex.rxjava3.operators.QueueFuseable

requestFusion

Methods inherited from interface io.reactivex.rxjava3.operators.SimpleQueue

clear, isEmpty, offer, offer, poll