Skip to content

Commit

Permalink
javadoc: diagrams for onBackpressureBlock (would benefit from a review)
Browse files Browse the repository at this point in the history
  • Loading branch information
DavidMGross committed Dec 2, 2014
1 parent 294a8e8 commit 57156e3
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions src/main/java/rx/Observable.java
Original file line number Diff line number Diff line change
Expand Up @@ -5059,6 +5059,8 @@ public final Observable<T> onBackpressureDrop() {
* Instructs an Observable that is emitting items faster than its observer can consume them to
* block the producer thread.
* <p>
* <img width="640" height="245" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/bp.obp.block.png" alt="">
* <p>
* The producer side can emit up to {@code maxQueueLength} onNext elements without blocking, but the
* consumer side considers the amount its downstream requested through {@code Producer.request(n)}
* and doesn't emit more than requested even if more is available. For example, using
Expand All @@ -5081,6 +5083,8 @@ public final Observable<T> onBackpressureBlock(int maxQueueLength) {
* Instructs an Observable that is emitting items faster than its observer can consume them to block the
* producer thread if the number of undelivered onNext events reaches the system-wide ring buffer size.
* <p>
* <img width="640" height="245" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/bp.obp.block.png" alt="">
* <p>
* The producer side can emit up to the system-wide ring buffer size onNext elements without blocking, but
* the consumer side considers the amount its downstream requested through {@code Producer.request(n)}
* and doesn't emit more than requested even if available.
Expand Down

0 comments on commit 57156e3

Please sign in to comment.