Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

2.x: Improve subjects and processors package doc #6434

Merged
merged 1 commit into from Mar 18, 2019
Merged

2.x: Improve subjects and processors package doc #6434

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
22 changes: 20 additions & 2 deletions src/main/java/io/reactivex/processors/package-info.java
View file
Open in desktop
Expand Up @@ -15,7 +15,25 @@
*/

/**
* Classes extending the Flowable base reactive class and implementing
* the Subscriber interface at the same time (aka hot Flowables).
* Classes representing so-called hot backpressure-aware sources, aka <strong>processors</strong>,
* that implement the {@link FlowableProcessor} class,
* the Reactive Streams {@link org.reactivestreams.Processor Processor} interface
* to allow forms of multicasting events to one or more subscribers as well as consuming another
* Reactive Streams {@link org.reactivestreams.Publisher Publisher}.
* <p>
* Available processor implementations:
* <br>
* <ul>
* <li>{@link io.reactivex.processors.AsyncProcessor AsyncProcessor} - replays the very last item</li>
* <li>{@link io.reactivex.processors.BehaviorProcessor BehaviorProcessor} - remembers the latest item</li>
* <li>{@link io.reactivex.processors.MulticastProcessor MulticastProcessor} - coordinates its source with its consumers</li>
* <li>{@link io.reactivex.processors.PublishProcessor PublishProcessor} - dispatches items to current consumers</li>
* <li>{@link io.reactivex.processors.ReplayProcessor ReplayProcessor} - remembers some or all items and replays them to consumers</li>
* <li>{@link io.reactivex.processors.UnicastProcessor UnicastProcessor} - remembers or relays items to a single consumer</li>
* </ul>
* <p>
* The non-backpressured variants of the {@code FlowableProcessor} class are called
* {@link io.reactivex.Subject}s and reside in the {@code io.reactivex.subjects} package.
* @see io.reactivex.subjects
*/
package io.reactivex.processors;
2 changes: 1 addition & 1 deletion src/main/java/io/reactivex/subjects/package-info.java
View file
Open in desktop
Expand Up @@ -29,7 +29,7 @@
* <br>&nbsp;&nbsp;&nbsp;{@link io.reactivex.subjects.BehaviorSubject BehaviorSubject}
* <br>&nbsp;&nbsp;&nbsp;{@link io.reactivex.subjects.PublishSubject PublishSubject}
* <br>&nbsp;&nbsp;&nbsp;{@link io.reactivex.subjects.ReplaySubject ReplaySubject}
* <br>&nbsp;&nbsp;&nbsp;{@link io.reactivex.subjects.UnicastSubject UnicastSubjectSubject}
* <br>&nbsp;&nbsp;&nbsp;{@link io.reactivex.subjects.UnicastSubject UnicastSubject}
* </td>
* <td>{@link io.reactivex.Observable Observable}</td>
* <td>{@link io.reactivex.Observer Observer}</td>
Expand Down