Class DeferredScalarDisposable<T>

Type Parameters:
T - the value type received and emitted
All Implemented Interfaces:
Disposable, QueueDisposable<T>, QueueFuseable<T>, SimpleQueue<T>, Serializable
Direct Known Subclasses:
AsyncSubject.AsyncDisposable, DeferredScalarObserver, MaybeToObservable.MaybeToObservableObserver, ObservableCollectWithCollector.CollectorObserver, ObservableFromCompletionStage.CompletionStageHandler, SingleToObservable.SingleToObservableObserver

public class DeferredScalarDisposable<T> extends BasicIntQueueDisposable<T>
Represents a fuseable container for a single value.
See Also:
  • Field Details

    • serialVersionUID

      private static final long serialVersionUID
      See Also:
    • downstream

      protected final Observer<? super T> downstream
      The target of the events.
    • value

      protected T value
      The value stored temporarily when in fusion mode.
    • TERMINATED

      static final int TERMINATED
      Indicates there was a call to complete(T).
      See Also:
    • DISPOSED

      static final int DISPOSED
      Indicates the Disposable has been disposed.
      See Also:
    • FUSED_EMPTY

      static final int FUSED_EMPTY
      Indicates this Disposable is in fusion mode and is currently empty.
      See Also:
    • FUSED_READY

      static final int FUSED_READY
      Indicates this Disposable is in fusion mode and has a value.
      See Also:
    • FUSED_CONSUMED

      static final int FUSED_CONSUMED
      Indicates this Disposable is in fusion mode and its value has been consumed.
      See Also:
  • Constructor Details

    • DeferredScalarDisposable

      public DeferredScalarDisposable(Observer<? super T> downstream)
      Constructs a DeferredScalarDisposable by wrapping the Observer.
      Parameters:
      downstream - the Observer to wrap, not null (not verified)
  • Method Details

    • requestFusion

      public final int requestFusion(int mode)
      Description copied from interface: QueueFuseable
      Request a fusion mode from the upstream.

      This should be called before onSubscribe returns.

      Calling this method multiple times or after onSubscribe finished is not allowed and may result in undefined behavior.

      Parameters:
      mode - the requested fusion mode, allowed values are QueueFuseable.SYNC, QueueFuseable.ASYNC, QueueFuseable.ANY combined with QueueFuseable.BOUNDARY (e.g., requestFusion(SYNC | BOUNDARY)).
      Returns:
      the established fusion mode: QueueFuseable.NONE, QueueFuseable.SYNC, QueueFuseable.ASYNC.
    • complete

      public final void complete(T value)
      Complete the target with a single value or indicate there is a value available in fusion mode.
      Parameters:
      value - the value to signal, not null (not verified)
    • error

      public final void error(Throwable t)
      Complete the target with an error signal.
      Parameters:
      t - the Throwable to signal, not null (not verified)
    • complete

      public final void complete()
      Complete the target without any value.
    • poll

      @Nullable public final T poll()
      Description copied from interface: SimpleQueue
      Tries to dequeue a value (non-null) or returns null if the queue is empty.

      If the producer uses SimpleQueue.offer(Object, Object) and when polling in pairs, if the first poll() returns a non-null item, the second poll() is guaranteed to return a non-null item as well.

      Returns:
      the item or null to indicate an empty queue
    • isEmpty

      public final boolean isEmpty()
      Description copied from interface: SimpleQueue
      Returns true if the queue is empty.

      Note however that due to potential fused functions in SimpleQueue.poll() it is possible this method returns false but then poll() returns null because the fused function swallowed the available item(s).

      Returns:
      true if the queue is empty
    • clear

      public final void clear()
      Description copied from interface: SimpleQueue
      Removes all enqueued items from this queue.
    • dispose

      public void dispose()
      Description copied from interface: Disposable
      Dispose the resource, the operation should be idempotent.
    • tryDispose

      public final boolean tryDispose()
      Try disposing this Disposable and return true if the current thread succeeded.
      Returns:
      true if the current thread succeeded
    • isDisposed

      public final boolean isDisposed()
      Description copied from interface: Disposable
      Returns true if this resource has been disposed.
      Returns:
      true if this resource has been disposed