Top Description Fields Constructors Methods
io.reactivex.rxjava3.subscribers

public abstract Class DefaultSubscriber<T>

extends Object
implements FlowableSubscriber<T>
Class Inheritance
All Implemented Interfaces
io.reactivex.rxjava3.core.FlowableSubscriber, org.reactivestreams.Subscriber
Known Direct Subclasses
io.reactivex.rxjava3.internal.operators.flowable.BlockingFlowableMostRecent.MostRecentSubscriber
Type Parameters
<T>
the value type

Example


Flowable.range(1, 5)
    .subscribe(new DefaultSubscriber<Integer>() {
        @Override public void onStart() {
            System.out.println("Start!");
            request(1);
        }
        @Override public void onNext(Integer t) {
            if (t == 3) {
                cancel();
            }
            System.out.println(t);
            request(1);
        }
        @Override public void onError(Throwable t) {
            t.printStackTrace();
        }
        @Override public void onComplete() {
            System.out.println("Done!");
        }
    });
Imports
org.reactivestreams.Subscription, io.reactivex.rxjava3.core.FlowableSubscriber, io.reactivex.rxjava3.internal.subscriptions.SubscriptionHelper, io.reactivex.rxjava3.internal.util.EndConsumerHelper

Abstract base implementation of a Subscriber with support for requesting via request(long), cancelling via via cancel() (both synchronously) and calls onStart() when the subscription happens.

All pre-implemented final methods are thread-safe.

The default onStart() requests Long#MAX_VALUE by default. Override the method to request a custom positive amount.

Note that calling request(long) from onStart() may trigger an immediate, asynchronous emission of data to onNext(Object). Make sure all initialization happens before the call to request() in onStart(). Calling request(long) inside onNext(Object) can happen at any time because by design, onNext calls from upstream are non-reentrant and non-overlapping.

Use the protected cancel() to cancel the sequence from within an onNext implementation.

Like all other consumers, DefaultSubscriber can be subscribed only once. Any subsequent attempt to subscribe it to a new source will yield an IllegalStateException with message "It is not allowed to subscribe with a(n) <class name> multiple times.".

Implementation of onStart(), onNext(Object), onError(Throwable) and onComplete() are not allowed to throw any unchecked exceptions. If for some reason this can't be avoided, use io.reactivex.rxjava3.core.Flowable#safeSubscribe(org.reactivestreams.Subscriber) instead of the standard subscribe() method.

Field Summary

Modifier and TypeField and Description
pack-priv Subscription

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
protected final void
cancel()

Cancels the upstream's Subscription.

protected void
onStart()

Called once the subscription has been set on this observer; override this to perform initialization or issue an initial request.

public final void
protected final void
request(long
the request amount, positive
n
)

Requests from the upstream Subscription.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

upstreamback to summary
pack-priv Subscription upstream

Constructor Detail

DefaultSubscriberback to summary
public DefaultSubscriber()

Method Detail

cancelback to summary
protected final void cancel()

Cancels the upstream's Subscription.

onStartback to summary
protected void onStart()

Called once the subscription has been set on this observer; override this to perform initialization or issue an initial request.

The default implementation requests Long#MAX_VALUE.

onSubscribeback to summary
public final 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
requestback to summary
protected final void request(long n)

Requests from the upstream Subscription.

Parameters
n:long

the request amount, positive