io.reactivex.processors

Class UnicastProcessor<T>

java.lang.Object

io.reactivex.Flowable<T>

io.reactivex.processors.FlowableProcessor<T>

io.reactivex.processors.UnicastProcessor<T>

Type Parameters:

T - the value type received and emitted by this Processor subclass

All Implemented Interfaces:

FlowableSubscriber<T>, org.reactivestreams.Processor<T,T>, org.reactivestreams.Publisher<T>, org.reactivestreams.Subscriber<T>

public final class UnicastProcessor<T>
extends FlowableProcessor<T>

Processor that allows only a single Subscriber to subscribe to it during its lifetime.

This processor buffers notifications and replays them to the Subscriber as requested.

This processor holds an unbounded internal buffer.

If more than one Subscriber attempts to subscribe to this Processor, they will receive an IllegalStateException if this Processor hasn't terminated yet, or the Subscribers receive the terminal event (error or completion) if this Processor has terminated.

Since:

2.0

Method Summary

Methods

Modifier and Type	Method and Description
static <T> UnicastProcessor<T>	create() Creates an UnicastSubject with an internal buffer capacity hint 16.
static <T> UnicastProcessor<T>	create(boolean delayError) Creates an UnicastProcessor with default internal buffer capacity hint and delay error flag.
static <T> UnicastProcessor<T>	create(int capacityHint) Creates an UnicastProcessor with the given internal buffer capacity hint.
static <T> UnicastProcessor<T>	create(int capacityHint, java.lang.Runnable onCancelled) Creates an UnicastProcessor with the given internal buffer capacity hint and a callback for the case when the single Subscriber cancels its subscription.
static <T> UnicastProcessor<T>	create(int capacityHint, java.lang.Runnable onCancelled, boolean delayError) Creates an UnicastProcessor with the given internal buffer capacity hint, delay error flag and a callback for the case when the single Subscriber cancels its subscription.
java.lang.Throwable	getThrowable() Returns the error that caused the Subject to terminate or null if the Subject hasn't terminated yet.
boolean	hasComplete() Returns true if the subject has reached a terminal state through a complete event.
boolean	hasSubscribers() Returns true if the subject has subscribers.
boolean	hasThrowable() Returns true if the subject has reached a terminal state through an error event.
void	onComplete()
void	onError(java.lang.Throwable t)
void	onNext(T t)
void	onSubscribe(org.reactivestreams.Subscription s) Implementors of this method should make sure everything that needs to be visible in Subscriber.onNext(Object) is established before calling Subscription.request(long).
protected void	subscribeActual(org.reactivestreams.Subscriber<? super T> s) Operator implementations (both source and intermediate) should implement this method that performs the necessary business logic.

Methods inherited from class io.reactivex.processors.FlowableProcessor

toSerialized

Methods inherited from class io.reactivex.Flowable

all, amb, ambArray, ambWith, any, blockingFirst, blockingFirst, blockingForEach, blockingIterable, blockingIterable, blockingLast, blockingLast, blockingLatest, blockingMostRecent, blockingNext, blockingSingle, blockingSingle, blockingSubscribe, blockingSubscribe, blockingSubscribe, blockingSubscribe, blockingSubscribe, buffer, buffer, buffer, buffer, buffer, buffer, buffer, buffer, buffer, buffer, buffer, buffer, buffer, buffer, buffer, buffer, buffer, buffer, buffer, bufferSize, cache, cacheWithInitialCapacity, cast, collect, collectInto, combineLatest, combineLatest, combineLatest, combineLatest, combineLatest, combineLatest, combineLatest, combineLatest, combineLatest, combineLatest, combineLatest, combineLatest, combineLatest, combineLatestDelayError, combineLatestDelayError, combineLatestDelayError, combineLatestDelayError, combineLatestDelayError, combineLatestDelayError, compose, concat, concat, concat, concat, concat, concat, concatArray, concatArrayDelayError, concatArrayEager, concatArrayEager, concatDelayError, concatDelayError, concatDelayError, concatEager, concatEager, concatEager, concatEager, concatMap, concatMap, concatMapDelayError, concatMapDelayError, concatMapEager, concatMapEager, concatMapEagerDelayError, concatMapEagerDelayError, concatMapIterable, concatMapIterable, concatWith, contains, count, create, debounce, debounce, debounce, defaultIfEmpty, defer, delay, delay, delay, delay, delay, delay, delaySubscription, delaySubscription, delaySubscription, dematerialize, distinct, distinct, distinct, distinctUntilChanged, distinctUntilChanged, distinctUntilChanged, doAfterNext, doAfterTerminate, doFinally, doOnCancel, doOnComplete, doOnEach, doOnEach, doOnError, doOnLifecycle, doOnNext, doOnRequest, doOnSubscribe, doOnTerminate, elementAt, elementAt, elementAtOrError, empty, error, error, filter, first, firstElement, firstOrError, flatMap, flatMap, flatMap, flatMap, flatMap, flatMap, flatMap, flatMap, flatMap, flatMap, flatMap, flatMap, flatMapCompletable, flatMapCompletable, flatMapIterable, flatMapIterable, flatMapIterable, flatMapIterable, flatMapMaybe, flatMapMaybe, flatMapSingle, flatMapSingle, forEach, forEachWhile, forEachWhile, forEachWhile, fromArray, fromCallable, fromFuture, fromFuture, fromFuture, fromFuture, fromIterable, fromPublisher, generate, generate, generate, generate, generate, groupBy, groupBy, groupBy, groupBy, groupBy, groupJoin, hide, ignoreElements, interval, interval, interval, interval, intervalRange, intervalRange, isEmpty, join, just, just, just, just, just, just, just, just, just, just, last, lastElement, lastOrError, lift, map, materialize, merge, merge, merge, merge, merge, merge, merge, merge, mergeArray, mergeArray, mergeArrayDelayError, mergeArrayDelayError, mergeDelayError, mergeDelayError, mergeDelayError, mergeDelayError, mergeDelayError, mergeDelayError, mergeDelayError, mergeDelayError, mergeWith, never, observeOn, observeOn, observeOn, ofType, onBackpressureBuffer, onBackpressureBuffer, onBackpressureBuffer, onBackpressureBuffer, onBackpressureBuffer, onBackpressureBuffer, onBackpressureBuffer, onBackpressureBuffer, onBackpressureDrop, onBackpressureDrop, onBackpressureLatest, onErrorResumeNext, onErrorResumeNext, onErrorReturn, onErrorReturnItem, onExceptionResumeNext, onTerminateDetach, parallel, parallel, parallel, publish, publish, publish, publish, range, rangeLong, rebatchRequests, reduce, reduce, reduceWith, repeat, repeat, repeatUntil, repeatWhen, replay, replay, replay, replay, replay, replay, replay, replay, replay, replay, replay, replay, replay, replay, replay, replay, retry, retry, retry, retry, retry, retryUntil, retryWhen, safeSubscribe, sample, sample, sample, sample, sample, sample, scan, scan, scanWith, sequenceEqual, sequenceEqual, sequenceEqual, sequenceEqual, serialize, share, single, singleElement, singleOrError, skip, skip, skip, skipLast, skipLast, skipLast, skipLast, skipLast, skipLast, skipUntil, skipWhile, sorted, sorted, startWith, startWith, startWith, startWithArray, strict, subscribe, subscribe, subscribe, subscribe, subscribe, subscribe, subscribe, subscribeOn, subscribeWith, switchIfEmpty, switchMap, switchMap, switchMapDelayError, switchMapDelayError, switchOnNext, switchOnNext, switchOnNextDelayError, switchOnNextDelayError, take, take, take, takeLast, takeLast, takeLast, takeLast, takeLast, takeLast, takeLast, takeLast, takeLast, takeUntil, takeUntil, takeWhile, test, test, test, throttleFirst, throttleFirst, throttleLast, throttleLast, throttleWithTimeout, throttleWithTimeout, timeInterval, timeInterval, timeInterval, timeInterval, timeout, timeout, timeout, timeout, timeout, timeout, timeout, timeout, timer, timer, timestamp, timestamp, timestamp, timestamp, to, toFuture, toList, toList, toList, toMap, toMap, toMap, toMultimap, toMultimap, toMultimap, toMultimap, toObservable, toSortedList, toSortedList, toSortedList, toSortedList, unsafeCreate, unsubscribeOn, using, using, window, window, window, window, window, window, window, window, window, window, window, window, window, window, window, window, window, window, window, withLatestFrom, withLatestFrom, withLatestFrom, withLatestFrom, withLatestFrom, withLatestFrom, zip, zip, zip, zip, zip, zip, zip, zip, zip, zip, zip, zip, zipArray, zipIterable, zipWith, zipWith, zipWith, zipWith

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.reactivestreams.Publisher

subscribe

Method Detail

create

@CheckReturnValue
public static <T> UnicastProcessor<T> create()

Creates an UnicastSubject with an internal buffer capacity hint 16.

Type Parameters:

T - the value type

Returns:

an UnicastSubject instance

create

@CheckReturnValue
public static <T> UnicastProcessor<T> create(int capacityHint)

Creates an UnicastProcessor with the given internal buffer capacity hint.

Type Parameters:

T - the value type

Parameters:

capacityHint - the hint to size the internal unbounded buffer

Returns:

an UnicastProcessor instance

create

@CheckReturnValue
public static <T> UnicastProcessor<T> create(boolean delayError)

Creates an UnicastProcessor with default internal buffer capacity hint and delay error flag.

Type Parameters:

T - the value type

Parameters:

delayError - deliver pending onNext events before onError

Returns:

an UnicastProcessor instance

Since:

2.0.8 - experimental

create

@CheckReturnValue
public static <T> UnicastProcessor<T> create(int capacityHint,
                                              java.lang.Runnable onCancelled)

Creates an UnicastProcessor with the given internal buffer capacity hint and a callback for the case when the single Subscriber cancels its subscription.

The callback, if not null, is called exactly once and non-overlapped with any active replay.

Type Parameters:

T - the value type

Parameters:

capacityHint - the hint to size the internal unbounded buffer

onCancelled - the non null callback

Returns:

an UnicastProcessor instance

create

@CheckReturnValue
public static <T> UnicastProcessor<T> create(int capacityHint,
                                              java.lang.Runnable onCancelled,
                                              boolean delayError)

Creates an UnicastProcessor with the given internal buffer capacity hint, delay error flag and a callback for the case when the single Subscriber cancels its subscription.

The callback, if not null, is called exactly once and non-overlapped with any active replay.

Type Parameters:

T - the value type

Parameters:

capacityHint - the hint to size the internal unbounded buffer

onCancelled - the non null callback

delayError - deliver pending onNext events before onError

Returns:

an UnicastProcessor instance

Since:

2.0.8 - experimental

onSubscribe

public void onSubscribe(org.reactivestreams.Subscription s)

Description copied from interface: FlowableSubscriber

Implementors of this method should make sure everything that needs to be visible in Subscriber.onNext(Object) is established before calling Subscription.request(long). In practice this means no initialization should happen after the request() call and additional behavior is thread safe in respect to onNext.

onNext

public void onNext(T t)

onError

public void onError(java.lang.Throwable t)

onComplete

public void onComplete()

subscribeActual

protected void subscribeActual(org.reactivestreams.Subscriber<? super T> s)

Description copied from class: Flowable

Operator implementations (both source and intermediate) should implement this method that performs the necessary business logic.

There is no need to call any of the plugin hooks on the current Flowable instance or the Subscriber.

Specified by:

subscribeActual in class Flowable<T>

Parameters:

s - the incoming Subscriber, never null

hasSubscribers

public boolean hasSubscribers()

Description copied from class: FlowableProcessor

Returns true if the subject has subscribers.

The method is thread-safe.

Specified by:

hasSubscribers in class FlowableProcessor<T>

Returns:

true if the subject has subscribers

getThrowable

public java.lang.Throwable getThrowable()

Description copied from class: FlowableProcessor

Returns the error that caused the Subject to terminate or null if the Subject hasn't terminated yet.

The method is thread-safe.

Specified by:

getThrowable in class FlowableProcessor<T>

Returns:

the error that caused the Subject to terminate or null if the Subject hasn't terminated yet

hasComplete

public boolean hasComplete()

Description copied from class: FlowableProcessor

Returns true if the subject has reached a terminal state through a complete event.

The method is thread-safe.

Specified by:

hasComplete in class FlowableProcessor<T>

Returns:

true if the subject has reached a terminal state through a complete event

See Also:

FlowableProcessor.hasThrowable()

hasThrowable

public boolean hasThrowable()

Description copied from class: FlowableProcessor

Returns true if the subject has reached a terminal state through an error event.

The method is thread-safe.

Specified by:

hasThrowable in class FlowableProcessor<T>

Returns:

true if the subject has reached a terminal state through an error event

See Also:

FlowableProcessor.getThrowable(), FlowableProcessor.hasComplete()