| layout | title | id |
|---|---|---|
documentation |
ReactiveX - Subject |
subject |
#Subject
A Subject is a sort of bridge or proxy that acts both as an Subscriber and as an Observable. Because it is a Subscriber, it can subscribe to one or more Observables, and because it is an Observable, it can pass through the items it observes by reemitting them, and it can also emit new items.
Because a Subject subscribes to an Observable, it will trigger that Observable to begin emitting items (if that Observable is “cold” — that is, if it waits for a subscription before it begins to emit items). This can have the effect of making the resulting Subject a "hot" Observable variant of the original “cold” Observable.
If you have a Subject and you want to pass it along to some other agent without exposing its Subscriber interface, you can mask it by calling its asObservable method, which will return the Subject as a pure Observable.
There are four subclasses of Subject that are designed for particular use cases:
AsyncSubject emits the last value (and only the last value) emitted by the source Observable, and only after that source Observable completes. (If the source Observable does not emit any values, the AsyncSubject also completes without emitting any values.)
It will also emit this same final value to any subsequent Subscribers. However, if the source Observable terminates with an error, the AsyncSubject will not emit any items, but will simply pass along the error notification from the source Observable.
- javadoc:
AsyncSubject - Reactive Extensions:
AsyncSubject - Introduction to Rx: AsyncSubject
When an Subscriber subscribes to a BehaviorSubject, it begins by emitting the item most recently emitted by the source Observable (or a seed/default value if none has yet been emitted) and then continues to emit any other items emitted later by the source Observable(s).
However, if the source Observable terminates with an error, the BehaviorSubject will not emit any items to subsequent Subscribers, but will simply pass along the error notification from the source Observable.
- javadoc:
BehaviorSubject - Reactive Extensions:
BehaviorSubject - Introduction to Rx: BehaviorSubject
PublishSubject emits to a subscriber only those items that are emitted by the source Observable(s) subsequent to the time of the subscription.
Note that a PublishSubject may begin emitting items immediately upon creation (unless you have taken steps to prevent this), and so there is a risk that one or more items may be lost between the time the Subject is created and the Subscriber subscribes to it. If you need to guarantee delivery of all items from the source Observable, you'll need either to form that Observable with create so that you can manually reintroduce “cold” Observable behavior (checking to see that all subscribers have subscribed before beginning to emit items), or switch to a ReplaySubject.
If the source Observable terminates with an error, the PublishSubject will not emit any items to subsequent Subscribers, but will simply pass along the error notification from the source Observable.
Note: In RxJava's Scala language adaptor, you instantiate a PublishSubject via Subject.
- javadoc:
PublishSubject
ReplaySubject emits to any subscriber all of the items that were emitted by the source Observable(s), regardless of when the subscriber subscribes.
There are also versions of ReplaySubject that will throw away old items once the replay buffer threatens to grow beyond a certain size, or when a specified timespan has passed since the items were originally emitted.
When using ReplaySubject as a Subscriber, take care not to call its onNext( ) method (or its other on methods) from multiple threads, as this could lead to coincident (non-sequential) calls, which violates the Observable contract and creates an ambiguity in the resulting Subject as to which item or emission should be replayed first.
- javadoc:
ReplaySubject - Reactive Extensions:
ReplaySubject - Introduction to Rx: ReplaySubject