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

public final Class SafeSubscriber<T>

extends Object
implements FlowableSubscriber<T>, Subscription
Class Inheritance
All Implemented Interfaces
org.reactivestreams.Subscription, io.reactivex.rxjava3.core.FlowableSubscriber, org.reactivestreams.Subscriber
Type Parameters
<T>
the value type
Imports
org.reactivestreams.*, io.reactivex.rxjava3.annotations.NonNull, io.reactivex.rxjava3.core.FlowableSubscriber, io.reactivex.rxjava3.exceptions.*, io.reactivex.rxjava3.internal.subscriptions.*, io.reactivex.rxjava3.internal.util.ExceptionHelper, io.reactivex.rxjava3.plugins.RxJavaPlugins
Wraps another Subscriber and ensures all onXXX methods conform the protocol (except the requirement for serialized access).

Field Summary

Modifier and TypeField and Description
pack-priv boolean
done

Indicates a terminal state.

pack-priv final Subscriber<? super T>
downstream

The actual Subscriber.

pack-priv Subscription
upstream

The subscription.

Constructor Summary

AccessConstructor and Description
public
SafeSubscriber(@NonNull Subscriber<? super T>
the actual Subscriber to wrap, not null (not validated)
downstream)

Constructs a SafeSubscriber by wrapping the given actual Subscriber.

Method Summary

Modifier and TypeMethod and Description
public void
cancel()

Implements org.reactivestreams.Subscription.cancel.

Request the Publisher to stop sending data and clean up resources.
public void
onComplete()

Implements org.reactivestreams.Subscriber.onComplete.

Successful terminal state.
pack-priv void
onCompleteNoSubscription()

public void
onError(@NonNull 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).
pack-priv void
onNextNoSubscription()

public void
onSubscribe(@NonNull 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.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

doneback to summary
pack-priv boolean done

Indicates a terminal state.

downstreamback to summary
pack-priv final Subscriber<? super T> downstream

The actual Subscriber.

upstreamback to summary
pack-priv Subscription upstream

The subscription.

Constructor Detail

SafeSubscriberback to summary
public SafeSubscriber(@NonNull Subscriber<? super T> downstream)

Constructs a SafeSubscriber by wrapping the given actual Subscriber.

Parameters
downstream:@NonNull Subscriber<? super T>

the actual Subscriber to wrap, not null (not validated)

Method Detail

cancelback 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
onCompleteback 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
onCompleteNoSubscriptionback to summary
pack-priv void onCompleteNoSubscription()
onErrorback to summary
public void onError(@NonNull 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:@NonNull Throwable

the throwable signaled

Annotations
@Override
onNextback 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
onNextNoSubscriptionback to summary
pack-priv void onNextNoSubscription()
onSubscribeback to summary
public void onSubscribe(@NonNull 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:@NonNull Subscription

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

Annotations
@Override
requestback 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