RxJava 3 3.1.8 · io.reactivex.rxjava3.internal.subscribers.FutureSubscriber

Modifier and Type	Field and Description
pack-priv Throwable	error
pack-priv final AtomicReference<Subscription>	upstream
pack-priv T	value

Access	Constructor and Description
public	FutureSubscriber()

Method Summary

Modifier and Type	Method and Description
public boolean	cancel(boolean `true` if the thread executing this task should be interrupted (if the thread is known to the implementation); otherwise, in-progress tasks are allowed to complete mayInterruptIfRunning) Implements java.util.concurrent.Future.cancel. Attempts to cancel execution of this task.
public void	cancel() Implements org.reactivestreams.Subscription.cancel. Request the `Publisher` to stop sending data and clean up resources.
public T	get() Implements java.util.concurrent.Future.get. Waits if necessary for the computation to complete, and then retrieves its result.
public T	get(long the maximum time to wait timeout, @NonNull TimeUnit the time unit of the timeout argument unit) Implements java.util.concurrent.Future.get. Waits if necessary for at most the given time for the computation to complete, and then retrieves its result, if available.
public boolean	isCancelled() Implements java.util.concurrent.Future.isCancelled. Returns `true` if this task was cancelled before it completed normally.
public boolean	isDone() Implements java.util.concurrent.Future.isDone. Returns `true` if this task completed.
public void	onComplete() Implements org.reactivestreams.Subscriber.onComplete. Successful terminal state.
public void	onError(Throwable the throwable signaled t) Implements org.reactivestreams.Subscriber.onError. Failed terminal state.
public void	onNext(T the element signaled t) Implements org.reactivestreams.Subscriber.onNext. Data notification sent by the `Publisher` in response to requests to `Subscription#request(long)`.
public void	onSubscribe(Subscription the `Subscription` that allows requesting data via `Subscription#request(long)` s) Implements org.reactivestreams.Subscriber.onSubscribe. Invoked after calling `Publisher#subscribe(Subscriber)`.
public 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.

Inherited from java.util.concurrent.CountDownLatch:: await await countDown getCount toString

error	back to summary
pack-priv Throwable error

upstream	back to summary
pack-priv final AtomicReference<Subscription> upstream

value	back to summary
pack-priv T value

FutureSubscriber	back to summary
public FutureSubscriber()

Method Detail

cancel back to summary

cancel	back to summary
public boolean cancel(boolean mayInterruptIfRunning) Implements java.util.concurrent.Future.cancel. Doc from java.util.concurrent.Future.cancel. Attempts to cancel execution of this task. This method has no effect if the task is already completed or cancelled, or could not be cancelled for some other reason. Otherwise, if this task has not started when `cancel` is called, this task should never run. If the task has already started, then the `mayInterruptIfRunning` parameter determines whether the thread executing this task (when known by the implementation) is interrupted in an attempt to stop the task. The return value from this method does not necessarily indicate whether the task is now cancelled; use `isCancelled`. Parameters mayInterruptIfRunning:boolean `true` if the thread executing this task should be interrupted (if the thread is known to the implementation); otherwise, in-progress tasks are allowed to complete Returns:boolean `false` if the task could not be cancelled, typically because it has already completed; `true` otherwise. If two or more threads cause a task to be cancelled, then at least one of them returns `true`. Implementations may provide stronger guarantees. Annotations @Override

public boolean cancel(boolean mayInterruptIfRunning)

Implements java.util.concurrent.Future.cancel.

Doc from java.util.concurrent.Future.cancel.

Attempts to cancel execution of this task. This method has no effect if the task is already completed or cancelled, or could not be cancelled for some other reason. Otherwise, if this task has not started when cancel is called, this task should never run. If the task has already started, then the mayInterruptIfRunning parameter determines whether the thread executing this task (when known by the implementation) is interrupted in an attempt to stop the task.

The return value from this method does not necessarily indicate whether the task is now cancelled; use isCancelled.

Parameters

mayInterruptIfRunning:boolean: true if the thread executing this task should be interrupted (if the thread is known to the implementation); otherwise, in-progress tasks are allowed to complete

Returns:boolean

false if the task could not be cancelled, typically because it has already completed; true otherwise. If two or more threads cause a task to be cancelled, then at least one of them returns true. Implementations may provide stronger guarantees.

Annotations

@Override

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

get	back to summary
public T get() throws InterruptedException, ExecutionException Implements java.util.concurrent.Future.get. Doc from java.util.concurrent.Future.get. Waits if necessary for the computation to complete, and then retrieves its result. Returns:T the computed result Annotations @Override Exceptions InterruptedException: if the current thread was interrupted while waiting ExecutionException: if the computation threw an exception

get

back to summary

public T get() throws InterruptedException, ExecutionException

Implements java.util.concurrent.Future.get.

Doc from java.util.concurrent.Future.get.

Waits if necessary for the computation to complete, and then retrieves its result.

Returns:T

the computed result

Annotations

@Override

Exceptions

InterruptedException:: if the current thread was interrupted while waiting
ExecutionException:: if the computation threw an exception

get	back to summary
public T get(long timeout, @NonNull TimeUnit unit) throws InterruptedException, ExecutionException, TimeoutException Implements java.util.concurrent.Future.get. Doc from java.util.concurrent.Future.get. Waits if necessary for at most the given time for the computation to complete, and then retrieves its result, if available. Parameters timeout:long the maximum time to wait unit:@NonNull TimeUnit the time unit of the timeout argument Returns:T the computed result Annotations @Override Exceptions InterruptedException: if the current thread was interrupted while waiting ExecutionException: if the computation threw an exception TimeoutException: if the wait timed out

get

back to summary

public T get(long timeout, @NonNull TimeUnit unit) throws InterruptedException, ExecutionException, TimeoutException

Implements java.util.concurrent.Future.get.

Doc from java.util.concurrent.Future.get.

Waits if necessary for at most the given time for the computation to complete, and then retrieves its result, if available.

Parameters

timeout:long: the maximum time to wait
unit:@NonNull TimeUnit: the time unit of the timeout argument

Returns:T

the computed result

Annotations

@Override

Exceptions

InterruptedException:: if the current thread was interrupted while waiting
ExecutionException:: if the computation threw an exception
TimeoutException:: if the wait timed out

isCancelled back to summary

isCancelled	back to summary
public boolean isCancelled() Implements java.util.concurrent.Future.isCancelled. Doc from java.util.concurrent.Future.isCancelled. Returns `true` if this task was cancelled before it completed normally. Returns:boolean `true` if this task was cancelled before it completed Annotations @Override

public boolean isCancelled()

Implements java.util.concurrent.Future.isCancelled.

Doc from java.util.concurrent.Future.isCancelled.

Returns true if this task was cancelled before it completed normally.

Returns:boolean

true if this task was cancelled before it completed

Annotations

@Override

isDone back to summary

isDone	back to summary
public boolean isDone() Implements java.util.concurrent.Future.isDone. Doc from java.util.concurrent.Future.isDone. Returns `true` if this task completed. Completion may be due to normal termination, an exception, or cancellation -- in all of these cases, this method will return `true`. Returns:boolean `true` if this task completed Annotations @Override

public boolean isDone()

Implements java.util.concurrent.Future.isDone.

Doc from java.util.concurrent.Future.isDone.

Returns true if this task completed. Completion may be due to normal termination, an exception, or cancellation -- in all of these cases, this method will return true.

Returns:boolean

true if this task completed

Annotations

@Override

onComplete back to summary

onComplete	back to summary
public void onComplete() Implements org.reactivestreams.Subscriber.onComplete. Doc from org.reactivestreams.Subscriber.onComplete. Successful terminal state. No further events will be sent even if `Subscription#request(long)` is invoked again. Annotations @Override

public void onComplete()

Implements org.reactivestreams.Subscriber.onComplete.

Doc from org.reactivestreams.Subscriber.onComplete.

Successful terminal state.

No further events will be sent even if Subscription#request(long) is invoked again.

Annotations

@Override

onError back to summary

onError	back to summary
public void onError(Throwable t) Implements org.reactivestreams.Subscriber.onError. Doc from org.reactivestreams.Subscriber.onError. Failed terminal state. No further events will be sent even if `Subscription#request(long)` is invoked again. Parameters t:Throwable the throwable signaled Annotations @Override

public void onError(Throwable t)

Implements org.reactivestreams.Subscriber.onError.

Doc from org.reactivestreams.Subscriber.onError.

Failed terminal state.

No further events will be sent even if Subscription#request(long) is invoked again.

Parameters

t:Throwable: the throwable signaled

Annotations

@Override

onNext back to summary

onNext	back to summary
public void onNext(T t) Implements org.reactivestreams.Subscriber.onNext. Doc from org.reactivestreams.Subscriber.onNext. Data notification sent by the `Publisher` in response to requests to `Subscription#request(long)`. Parameters t:T the element signaled Annotations @Override

public void onNext(T t)

Implements org.reactivestreams.Subscriber.onNext.

Doc from org.reactivestreams.Subscriber.onNext.

Data notification sent by the Publisher in response to requests to Subscription#request(long).

Parameters

t:T: the element signaled

Annotations

@Override

onSubscribe back to summary

onSubscribe	back to summary
public void onSubscribe(Subscription s) Implements org.reactivestreams.Subscriber.onSubscribe. Doc from org.reactivestreams.Subscriber.onSubscribe. Invoked after calling `Publisher#subscribe(Subscriber)`. No data will start flowing until `Subscription#request(long)` is invoked. It is the responsibility of this `Subscriber` instance to call `Subscription#request(long)` whenever more data is wanted. The `Publisher` will send notifications only in response to `Subscription#request(long)`. Parameters s:Subscription the `Subscription` that allows requesting data via `Subscription#request(long)` Annotations @Override

public void onSubscribe(Subscription s)

Implements org.reactivestreams.Subscriber.onSubscribe.

Doc from org.reactivestreams.Subscriber.onSubscribe.

Invoked after calling Publisher#subscribe(Subscriber).

No data will start flowing until Subscription#request(long) is invoked.

It is the responsibility of this Subscriber instance to call Subscription#request(long) whenever more data is wanted.

The Publisher will send notifications only in response to Subscription#request(long).

Parameters

s:Subscription: the Subscription that allows requesting data via Subscription#request(long)

Annotations

@Override

request back to summary

request	back to summary
public 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 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 Class FutureSubscriber<T>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail