io.reactivex.subjects

Class ReplaySubject<T>

java.lang.Object

io.reactivex.Observable<T>

io.reactivex.subjects.Subject<T>

io.reactivex.subjects.ReplaySubject<T>

Type Parameters:

T - the value type

All Implemented Interfaces:

ObservableSource<T>, Observer<T>

public final class ReplaySubject<T>
extends Subject<T>

Replays events (in a configurable bounded or unbounded manner) to current and late Observers.

This subject does not have a public constructor by design; a new empty instance of this ReplaySubject can be created via the following create methods that allow specifying the retention policy for items:

• create() - creates an empty, unbounded ReplaySubject that caches all items and the terminal event it receives.

  

  

• create(int) - creates an empty, unbounded ReplaySubject with a hint about how many total items one expects to retain.
• createWithSize(int) - creates an empty, size-bound ReplaySubject that retains at most the given number of the latest item it receives.

  

• createWithTime(long, TimeUnit, Scheduler) - creates an empty, time-bound ReplaySubject that retains items no older than the specified time amount.

  

• createWithTimeAndSize(long, TimeUnit, Scheduler, int) - creates an empty, time- and size-bound ReplaySubject that retains at most the given number items that are also not older than the specified time amount.

  

Since a Subject is conceptionally derived from the Processor type in the Reactive Streams specification, nulls are not allowed (Rule 2.13) as parameters to onNext(Object) and onError(Throwable). Such calls will result in a NullPointerException being thrown and the subject's state is not changed.

Since a ReplaySubject is an Observable, it does not support backpressure.

When this ReplaySubject is terminated via onError(Throwable) or onComplete(), late Observers will receive the retained/cached items first (if any) followed by the respective terminal event. If the ReplaySubject has a time-bound, the age of the retained/cached items are still considered when replaying and thus it may result in no items being emitted before the terminal event.

Once an Observer has subscribed, it will receive items continuously from that point on. Bounds only affect how many past items a new Observer will receive before it catches up with the live event feed.

Even though ReplaySubject implements the Observer interface, calling onSubscribe is not required (Rule 2.12) if the subject is used as a standalone source. However, calling onSubscribe after the ReplaySubject reached its terminal state will result in the given Disposable being disposed immediately.

Calling onNext(Object), onError(Throwable) and onComplete() is required to be serialized (called from the same thread or called non-overlappingly from different threads through external means of serialization). The Subject.toSerialized() method available to all Subjects provides such serialization and also protects against reentrance (i.e., when a downstream Observer consuming this subject also wants to call onNext(Object) on this subject recursively).

This ReplaySubject supports the standard state-peeking methods hasComplete(), hasThrowable(), getThrowable() and hasObservers() as well as means to read the retained/cached items in a non-blocking and thread-safe manner via hasValue(), getValue(), getValues() or getValues(Object[]).

Note that due to concurrency requirements, a size- and time-bounded ReplaySubject may hold strong references to more source emissions than specified while it isn't terminated yet. Use the cleanupBuffer() to allow such inaccessible items to be cleaned up by GC once no consumer references it anymore.

Scheduler:

ReplaySubject does not operate by default on a particular Scheduler and the Observers get notified on the thread the respective onXXX methods were invoked. Time-bound ReplaySubjects use the given Scheduler in their create methods as time source to timestamp of items received for the age checks.

Error handling:

When the onError(Throwable) is called, the ReplaySubject enters into a terminal state and emits the same Throwable instance to the last set of Observers. During this emission, if one or more Observers dispose their respective Disposables, the Throwable is delivered to the global error handler via RxJavaPlugins.onError(Throwable) (multiple times if multiple Observers cancel at once). If there were no Observers subscribed to this ReplaySubject when the onError() was called, the global error handler is not invoked.

Example usage:

 

  ReplaySubject<Object> subject = ReplaySubject.create();
  subject.onNext("one");
  subject.onNext("two");
  subject.onNext("three");
  subject.onComplete();

  // both of the following will get the onNext/onComplete calls from above
  subject.subscribe(observer1);
  subject.subscribe(observer2);

   

Method Summary

Modifier and Type	Method and Description
void	cleanupBuffer() Makes sure the item cached by the head node in a bounded ReplaySubject is released (as it is never part of a replay).
static <T> ReplaySubject<T>	create() Creates an unbounded replay subject.
static <T> ReplaySubject<T>	create(int capacityHint) Creates an unbounded replay subject with the specified initial buffer capacity.
static <T> ReplaySubject<T>	createWithSize(int maxSize) Creates a size-bounded replay subject.
static <T> ReplaySubject<T>	createWithTime(long maxAge, TimeUnit unit, Scheduler scheduler) Creates a time-bounded replay subject.
static <T> ReplaySubject<T>	createWithTimeAndSize(long maxAge, TimeUnit unit, Scheduler scheduler, int maxSize) Creates a time- and size-bounded replay subject.
Throwable	getThrowable() Returns the error that caused the Subject to terminate or null if the Subject hasn't terminated yet.
T	getValue() Returns a single value the Subject currently has or null if no such value exists.
Object[]	getValues() Returns an Object array containing snapshot all values of the Subject.
T[]	getValues(T[] array) Returns a typed array containing a snapshot of all values of the Subject.
boolean	hasComplete() Returns true if the subject has reached a terminal state through a complete event.
boolean	hasObservers() Returns true if the subject has any Observers.
boolean	hasThrowable() Returns true if the subject has reached a terminal state through an error event.
boolean	hasValue() Returns true if the subject has any value.
void	onComplete() Notifies the Observer that the Observable has finished sending push-based notifications.
void	onError(Throwable t) Notifies the Observer that the Observable has experienced an error condition.
void	onNext(T t) Provides the Observer with a new item to observe.
void	onSubscribe(Disposable d) Provides the Observer with the means of cancelling (disposing) the connection (channel) with the Observable in both synchronous (from within Observer.onNext(Object)) and asynchronous manner.
protected void	subscribeActual(Observer<? super T> observer) Operator implementations (both source and intermediate) should implement this method that performs the necessary business logic and handles the incoming Observers.

Methods inherited from class io.reactivex.subjects.Subject

toSerialized

Methods inherited from class io.reactivex.Observable

all, amb, ambArray, ambWith, any, as, 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, compose, concat, concat, concat, concat, concat, concat, concatArray, concatArrayDelayError, concatArrayEager, concatArrayEager, concatArrayEagerDelayError, concatArrayEagerDelayError, concatDelayError, concatDelayError, concatDelayError, concatEager, concatEager, concatEager, concatEager, concatMap, concatMap, concatMapCompletable, concatMapCompletable, concatMapCompletableDelayError, concatMapCompletableDelayError, concatMapCompletableDelayError, concatMapDelayError, concatMapDelayError, concatMapEager, concatMapEager, concatMapEagerDelayError, concatMapEagerDelayError, concatMapIterable, concatMapIterable, concatMapMaybe, concatMapMaybe, concatMapMaybeDelayError, concatMapMaybeDelayError, concatMapMaybeDelayError, concatMapSingle, concatMapSingle, concatMapSingleDelayError, concatMapSingleDelayError, concatMapSingleDelayError, concatWith, concatWith, concatWith, concatWith, contains, count, create, debounce, debounce, debounce, defaultIfEmpty, defer, delay, delay, delay, delay, delay, delay, delaySubscription, delaySubscription, delaySubscription, dematerialize, dematerialize, distinct, distinct, distinct, distinctUntilChanged, distinctUntilChanged, distinctUntilChanged, doAfterNext, doAfterTerminate, doFinally, doOnComplete, doOnDispose, doOnEach, doOnEach, doOnError, doOnLifecycle, doOnNext, 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, 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, mergeWith, mergeWith, mergeWith, never, observeOn, observeOn, observeOn, ofType, onErrorResumeNext, onErrorResumeNext, onErrorReturn, onErrorReturnItem, onExceptionResumeNext, onTerminateDetach, publish, publish, range, rangeLong, 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, subscribe, subscribe, subscribe, subscribe, subscribe, subscribe, subscribeOn, subscribeWith, switchIfEmpty, switchMap, switchMap, switchMapCompletable, switchMapCompletableDelayError, switchMapDelayError, switchMapDelayError, switchMapMaybe, switchMapMaybeDelayError, switchMapSingle, switchMapSingleDelayError, switchOnNext, switchOnNext, switchOnNextDelayError, switchOnNextDelayError, take, take, take, takeLast, takeLast, takeLast, takeLast, takeLast, takeLast, takeLast, takeLast, takeLast, takeUntil, takeUntil, takeWhile, test, test, throttleFirst, throttleFirst, throttleLast, throttleLast, throttleLatest, throttleLatest, throttleLatest, throttleLatest, throttleWithTimeout, throttleWithTimeout, timeInterval, timeInterval, timeInterval, timeInterval, timeout, timeout, timeout, timeout, timeout, timeout, timeout, timeout, timer, timer, timestamp, timestamp, timestamp, timestamp, to, toFlowable, toFuture, toList, toList, toList, toMap, toMap, toMap, toMultimap, toMultimap, toMultimap, toMultimap, 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, wrap, 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

Method Detail

create

@CheckReturnValue
 @NonNull
public static <T> ReplaySubject<T> create()

Creates an unbounded replay subject.

The internal buffer is backed by an ArrayList and starts with an initial capacity of 16. Once the number of items reaches this capacity, it will grow as necessary (usually by 50%). However, as the number of items grows, this causes frequent array reallocation and copying, and may hurt performance and latency. This can be avoided with the create(int) overload which takes an initial capacity parameter and can be tuned to reduce the array reallocation frequency as needed.

Type Parameters:

T - the type of items observed and emitted by the Subject

Returns:

the created subject

create

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

Creates an unbounded replay subject with the specified initial buffer capacity.

Use this method to avoid excessive array reallocation while the internal buffer grows to accommodate new items. For example, if you know that the buffer will hold 32k items, you can ask the ReplaySubject to preallocate its internal array with a capacity to hold that many items. Once the items start to arrive, the internal array won't need to grow, creating less garbage and no overhead due to frequent array-copying.

Type Parameters:

T - the type of items observed and emitted by the Subject

Parameters:

capacityHint - the initial buffer capacity

Returns:

the created subject

createWithSize

@CheckReturnValue
 @NonNull
public static <T> ReplaySubject<T> createWithSize(int maxSize)

Creates a size-bounded replay subject.

In this setting, the ReplaySubject holds at most size items in its internal buffer and discards the oldest item.

When observers subscribe to a terminated ReplaySubject, they are guaranteed to see at most size onNext events followed by a termination event.

If an observer subscribes while the ReplaySubject is active, it will observe all items in the buffer at that point in time and each item observed afterwards, even if the buffer evicts items due to the size constraint in the mean time. In other words, once an Observer subscribes, it will receive items without gaps in the sequence.

Type Parameters:

T - the type of items observed and emitted by the Subject

Parameters:

maxSize - the maximum number of buffered items

Returns:

the created subject

createWithTime

@CheckReturnValue
 @NonNull
public static <T> ReplaySubject<T> createWithTime(long maxAge,
        TimeUnit unit,
        Scheduler scheduler)

Creates a time-bounded replay subject.

In this setting, the ReplaySubject internally tags each observed item with a timestamp value supplied by the Scheduler and keeps only those whose age is less than the supplied time value converted to milliseconds. For example, an item arrives at T=0 and the max age is set to 5; at T>=5 this first item is then evicted by any subsequent item or termination event, leaving the buffer empty.

Once the subject is terminated, observers subscribing to it will receive items that remained in the buffer after the terminal event, regardless of their age.

If an observer subscribes while the ReplaySubject is active, it will observe only those items from within the buffer that have an age less than the specified time, and each item observed thereafter, even if the buffer evicts items due to the time constraint in the mean time. In other words, once an observer subscribes, it observes items without gaps in the sequence except for any outdated items at the beginning of the sequence.

Note that terminal notifications (onError and onComplete) trigger eviction as well. For example, with a max age of 5, the first item is observed at T=0, then an onComplete notification arrives at T=10. If an observer subscribes at T=11, it will find an empty ReplaySubject with just an onComplete notification.

Type Parameters:

T - the type of items observed and emitted by the Subject

Parameters:

maxAge - the maximum age of the contained items

unit - the time unit of time

scheduler - the Scheduler that provides the current time

Returns:

the created subject

createWithTimeAndSize

@CheckReturnValue
 @NonNull
public static <T> ReplaySubject<T> createWithTimeAndSize(long maxAge,
        TimeUnit unit,
        Scheduler scheduler,
        int maxSize)

Creates a time- and size-bounded replay subject.

In this setting, the ReplaySubject internally tags each received item with a timestamp value supplied by the Scheduler and holds at most size items in its internal buffer. It evicts items from the start of the buffer if their age becomes less-than or equal to the supplied age in milliseconds or the buffer reaches its size limit.

When observers subscribe to a terminated ReplaySubject, they observe the items that remained in the buffer after the terminal notification, regardless of their age, but at most size items.

If an observer subscribes while the ReplaySubject is active, it will observe only those items from within the buffer that have age less than the specified time and each subsequent item, even if the buffer evicts items due to the time constraint in the mean time. In other words, once an observer subscribes, it observes items without gaps in the sequence except for the outdated items at the beginning of the sequence.

Note that terminal notifications (onError and onComplete) trigger eviction as well. For example, with a max age of 5, the first item is observed at T=0, then an onComplete notification arrives at T=10. If an observer subscribes at T=11, it will find an empty ReplaySubject with just an onComplete notification.

Type Parameters:

T - the type of items observed and emitted by the Subject

Parameters:

maxAge - the maximum age of the contained items

unit - the time unit of time

maxSize - the maximum number of buffered items

scheduler - the Scheduler that provides the current time

Returns:

the created subject

subscribeActual

protected void subscribeActual(Observer<? super T> observer)

Description copied from class: Observable

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

There is no need to call any of the plugin hooks on the current Observable instance or the Observer; all hooks and basic safeguards have been applied by Observable.subscribe(Observer) before this method gets called.

Specified by:

subscribeActual in class Observable<T>

Parameters:

observer - the incoming Observer, never null

onSubscribe

public void onSubscribe(Disposable d)

Description copied from interface: Observer

Provides the Observer with the means of cancelling (disposing) the connection (channel) with the Observable in both synchronous (from within Observer.onNext(Object)) and asynchronous manner.

Parameters:

d - the Disposable instance whose Disposable.dispose() can be called anytime to cancel the connection

onNext

public void onNext(T t)

Description copied from interface: Observer

Provides the Observer with a new item to observe.

The Observable may call this method 0 or more times.

The Observable will not call this method again after it calls either Observer.onComplete() or Observer.onError(java.lang.Throwable).

Parameters:

t - the item emitted by the Observable

onError

public void onError(Throwable t)

Description copied from interface: Observer

Notifies the Observer that the Observable has experienced an error condition.

If the Observable calls this method, it will not thereafter call Observer.onNext(T) or Observer.onComplete().

Parameters:

t - the exception encountered by the Observable

onComplete

public void onComplete()

Description copied from interface: Observer

Notifies the Observer that the Observable has finished sending push-based notifications.

The Observable will not call this method if it calls Observer.onError(java.lang.Throwable).

hasObservers

public boolean hasObservers()

Description copied from class: Subject

Returns true if the subject has any Observers.

The method is thread-safe.

Specified by:

hasObservers in class Subject<T>

Returns:

true if the subject has any Observers

getThrowable

@Nullable
public Throwable getThrowable()

Description copied from class: Subject

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 Subject<T>

Returns:

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

getValue

@Nullable
public T getValue()

Returns a single value the Subject currently has or null if no such value exists.

The method is thread-safe.

Returns:

a single value the Subject currently has or null if no such value exists

cleanupBuffer

public void cleanupBuffer()

Makes sure the item cached by the head node in a bounded ReplaySubject is released (as it is never part of a replay).

By default, live bounded buffers will remember one item before the currently receivable one to ensure subscribers can always receive a continuous sequence of items. A terminated ReplaySubject automatically releases this inaccessible item.

The method must be called sequentially, similar to the standard onXXX methods.

History: 2.1.11 - experimental

Since:

2.2

getValues

public Object[] getValues()

Returns an Object array containing snapshot all values of the Subject.

The method is thread-safe.

Returns:

the array containing the snapshot of all values of the Subject

getValues

public T[] getValues(T[] array)

Returns a typed array containing a snapshot of all values of the Subject.

The method follows the conventions of Collection.toArray by setting the array element after the last value to null (if the capacity permits).

The method is thread-safe.

Parameters:

array - the target array to copy values into if it fits

Returns:

the given array if the values fit into it or a new array containing all values

hasComplete

public boolean hasComplete()

Description copied from class: Subject

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

The method is thread-safe.

Specified by:

hasComplete in class Subject<T>

Returns:

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

See Also:

Subject.hasThrowable()

hasThrowable

public boolean hasThrowable()

Description copied from class: Subject

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

The method is thread-safe.

Specified by:

hasThrowable in class Subject<T>

Returns:

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

See Also:

Subject.getThrowable(), Subject.hasComplete()

hasValue

public boolean hasValue()

Returns true if the subject has any value.

The method is thread-safe.

Returns:

true if the subject has any value