RxJava 2 2.2.21 · io.reactivex.internal.subscriptions.DeferredScalarSubscription

Field Summary

Modifier and Type	Field and Description
pack-priv static final int	CANCELLED Indicates the Subscription has been cancelled.
protected final Subscriber<? super T>	downstream The Subscriber to emit the value to.
pack-priv static final int	FUSED_CONSUMED Indicates this Subscription is in fusion mode and its value has been consumed.
pack-priv static final int	FUSED_EMPTY Indicates this Subscription is in fusion mode and is currently empty.
pack-priv static final int	FUSED_READY Indicates this Subscription is in fusion mode and has a value.
pack-priv static final int	HAS_REQUEST_HAS_VALUE Indicates this Subscription has both request and value.
pack-priv static final int	HAS_REQUEST_NO_VALUE Indicates this Subscription has been requested but there is no value yet.
pack-priv static final int	NO_REQUEST_HAS_VALUE Indicates this Subscription has a value but not requested yet.
pack-priv static final int	NO_REQUEST_NO_VALUE Indicates this Subscription has no value and not requested yet.
private static final long	serialVersionUID Hides io.reactivex.internal.subscriptions.BasicIntQueueSubscription.serialVersionUID.
protected T	value Hides java.util.concurrent.atomic.AtomicInteger.value. The value is stored here if there is no request yet or in fusion mode.

Constructor Summary

Access	Constructor and Description
public	DeferredScalarSubscription(Subscriber<? super T> the Subscriber to wrap, not null (not verified) downstream) Creates a DeferredScalarSubscription by wrapping the given Subscriber.

Method Summary

Modifier and Type	Method and Description
public void	cancel() Implements org.reactivestreams.Subscription.cancel. Request the `Publisher` to stop sending data and clean up resources.
public final void	clear() Implements io.reactivex.internal.fuseable.SimpleQueue.clear. Removes all enqueued items from this queue.
public final void	complete(T the value to signal, not null (not validated) v) Completes this subscription by indicating the given value should be emitted when the first request arrives.
public final boolean	Returns: true if this Subscription has been cancelled isCancelled() Returns true if this Subscription has been cancelled.
public final boolean	isEmpty() Implements io.reactivex.internal.fuseable.SimpleQueue.isEmpty. Returns true if the queue is empty.
public final T	poll() Implements io.reactivex.internal.fuseable.SimpleQueue.poll. Tries to dequeue a value (non-null) or returns null if the queue is empty.
public final void	request(long the strictly positive number of elements to requests to the upstream `Publisher` n) Implements org.reactivestreams.Subscription.request. No events will be sent by a `Publisher` until demand is signaled via this method.
public final int	requestFusion(int the requested fusion mode, allowed values are `SYNC`, `ASYNC`, `ANY` combined with `BOUNDARY` (e.g., `requestFusion(SYNC \| BOUNDARY)`). mode) Implements io.reactivex.internal.fuseable.QueueFuseable.requestFusion. Request a fusion mode from the upstream.
public final boolean	Returns: true if the current thread cancelled tryCancel() Atomically sets a cancelled state and returns true if the current thread did it successfully.

Inherited from io.reactivex.internal.subscriptions.BasicIntQueueSubscription:: offer offer

Field Detail

CANCELLED	back to summary
pack-priv static final int CANCELLED Indicates the Subscription has been cancelled.

downstream	back to summary
protected final Subscriber<? super T> downstream The Subscriber to emit the value to.

FUSED_CONSUMED	back to summary
pack-priv static final int FUSED_CONSUMED Indicates this Subscription is in fusion mode and its value has been consumed.

FUSED_EMPTY	back to summary
pack-priv static final int FUSED_EMPTY Indicates this Subscription is in fusion mode and is currently empty.

FUSED_READY	back to summary
pack-priv static final int FUSED_READY Indicates this Subscription is in fusion mode and has a value.

HAS_REQUEST_HAS_VALUE	back to summary
pack-priv static final int HAS_REQUEST_HAS_VALUE Indicates this Subscription has both request and value.

HAS_REQUEST_NO_VALUE	back to summary
pack-priv static final int HAS_REQUEST_NO_VALUE Indicates this Subscription has been requested but there is no value yet.

NO_REQUEST_HAS_VALUE	back to summary
pack-priv static final int NO_REQUEST_HAS_VALUE Indicates this Subscription has a value but not requested yet.

NO_REQUEST_NO_VALUE	back to summary
pack-priv static final int NO_REQUEST_NO_VALUE Indicates this Subscription has no value and not requested yet.

serialVersionUID	back to summary
private static final long serialVersionUID Hides io.reactivex.internal.subscriptions.BasicIntQueueSubscription.serialVersionUID.

value	back to summary
protected T value Hides java.util.concurrent.atomic.AtomicInteger.value. The value is stored here if there is no request yet or in fusion mode.

value

back to summary

protected T value

Hides java.util.concurrent.atomic.AtomicInteger.value.

The value is stored here if there is no request yet or in fusion mode.

Constructor Detail

DeferredScalarSubscription	back to summary
public DeferredScalarSubscription(Subscriber<? super T> downstream) Creates a DeferredScalarSubscription by wrapping the given Subscriber. Parameters downstream:Subscriber<? super T> the Subscriber to wrap, not null (not verified)

DeferredScalarSubscription

back to summary

public DeferredScalarSubscription(Subscriber<? super T> downstream)

Creates a DeferredScalarSubscription by wrapping the given Subscriber.

Parameters

downstream:Subscriber<? super T>: the Subscriber to wrap, not null (not verified)

Method Detail

cancel back to summary

cancel	back to summary
public void cancel() Implements org.reactivestreams.Subscription.cancel. Doc from org.reactivestreams.Subscription.cancel. Request the `Publisher` to stop sending data and clean up resources. Data may still be sent to meet previously signalled demand after calling cancel. Annotations @Override

public void cancel()

Implements org.reactivestreams.Subscription.cancel.

Doc from org.reactivestreams.Subscription.cancel.

Request the Publisher to stop sending data and clean up resources.

Data may still be sent to meet previously signalled demand after calling cancel.

Annotations

@Override

clear	back to summary
public final void clear() Implements io.reactivex.internal.fuseable.SimpleQueue.clear. Doc from io.reactivex.internal.fuseable.SimpleQueue.clear. Removes all enqueued items from this queue. Annotations @Override

clear

back to summary

public final void clear()

Implements io.reactivex.internal.fuseable.SimpleQueue.clear.

Doc from io.reactivex.internal.fuseable.SimpleQueue.clear.

Removes all enqueued items from this queue.

Annotations

@Override

complete	back to summary
public final void complete(T v) Completes this subscription by indicating the given value should be emitted when the first request arrives. Make sure this is called exactly once. Parameters v:T the value to signal, not null (not validated)

complete

back to summary

public final void complete(T v)

Completes this subscription by indicating the given value should be emitted when the first request arrives.

Make sure this is called exactly once.

Parameters

v:T: the value to signal, not null (not validated)

isCancelled	back to summary
public final boolean isCancelled() Returns true if this Subscription has been cancelled. Returns:boolean true if this Subscription has been cancelled

isCancelled

back to summary

public final boolean isCancelled()

Returns true if this Subscription has been cancelled.

Returns:boolean: true if this Subscription has been cancelled

isEmpty back to summary

isEmpty	back to summary
public final boolean isEmpty() Implements io.reactivex.internal.fuseable.SimpleQueue.isEmpty. Doc from io.reactivex.internal.fuseable.SimpleQueue.isEmpty. Returns true if the queue is empty. Note however that due to potential fused functions in `poll()` it is possible this method returns false but then poll() returns null because the fused function swallowed the available item(s). Returns:boolean true if the queue is empty Annotations @Override

public final boolean isEmpty()

Implements io.reactivex.internal.fuseable.SimpleQueue.isEmpty.

Doc from io.reactivex.internal.fuseable.SimpleQueue.isEmpty.

Returns true if the queue is empty.

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

Returns:boolean

true if the queue is empty

Annotations

@Override

poll back to summary

poll	back to summary
public final T poll() Implements io.reactivex.internal.fuseable.SimpleQueue.poll. Doc from io.reactivex.internal.fuseable.SimpleQueue.poll. Tries to dequeue a value (non-null) or returns null if the queue is empty. If the producer uses `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:T the item or null to indicate an empty queue Annotations @Nullable @Override

public final T poll()

Implements io.reactivex.internal.fuseable.SimpleQueue.poll.

Doc from io.reactivex.internal.fuseable.SimpleQueue.poll.

Tries to dequeue a value (non-null) or returns null if the queue is empty.

If the producer uses 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:T

the item or null to indicate an empty queue

Annotations

@Nullable
@Override

request back to summary

request	back to summary
public final void request(long n) Implements org.reactivestreams.Subscription.request. Doc from org.reactivestreams.Subscription.request. No events will be sent by a `Publisher` until demand is signaled via this method. It can be called however often and whenever needed—but if the outstanding cumulative demand ever becomes Long.MAX_VALUE or more, it may be treated by the `Publisher` as "effectively unbounded". Whatever has been requested can be sent by the `Publisher` so only signal demand for what can be safely handled. A `Publisher` can send less than is requested if the stream ends but then must emit either `Subscriber#onError(Throwable)` or `Subscriber#onComplete()`. Parameters n:long the strictly positive number of elements to requests to the upstream `Publisher` Annotations @Override

public final void request(long n)

Implements org.reactivestreams.Subscription.request.

Doc from org.reactivestreams.Subscription.request.

No events will be sent by a Publisher until demand is signaled via this method.

It can be called however often and whenever needed—but if the outstanding cumulative demand ever becomes Long.MAX_VALUE or more, it may be treated by the Publisher as "effectively unbounded".

Whatever has been requested can be sent by the Publisher so only signal demand for what can be safely handled.

A Publisher can send less than is requested if the stream ends but then must emit either Subscriber#onError(Throwable) or Subscriber#onComplete().

Parameters

n:long: the strictly positive number of elements to requests to the upstream Publisher

Annotations

@Override

requestFusion back to summary

requestFusion	back to summary
public final int requestFusion(int mode) Implements io.reactivex.internal.fuseable.QueueFuseable.requestFusion. Doc from io.reactivex.internal.fuseable.QueueFuseable.requestFusion. 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:int the requested fusion mode, allowed values are `SYNC`, `ASYNC`, `ANY` combined with `BOUNDARY` (e.g., `requestFusion(SYNC \| BOUNDARY)`). Returns:int the established fusion mode: `NONE`, `SYNC`, `ASYNC`. Annotations @Override

public final int requestFusion(int mode)

Implements io.reactivex.internal.fuseable.QueueFuseable.requestFusion.

Doc from io.reactivex.internal.fuseable.QueueFuseable.requestFusion.

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:int: the requested fusion mode, allowed values are SYNC, ASYNC, ANY combined with BOUNDARY (e.g., requestFusion(SYNC | BOUNDARY)).

Returns:int

the established fusion mode: NONE, SYNC, ASYNC.

Annotations

@Override

tryCancel	back to summary
public final boolean tryCancel() Atomically sets a cancelled state and returns true if the current thread did it successfully. Returns:boolean true if the current thread cancelled

tryCancel

back to summary

public final boolean tryCancel()

Atomically sets a cancelled state and returns true if the current thread did it successfully.

Returns:boolean: true if the current thread cancelled

public Class DeferredScalarSubscription<T>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail