Skip to content

Commit 24ca4f7

Browse files
committed
Javadocs: adding marble diagram, return value for onBackpressureLatest
1 parent 5cb242d commit 24ca4f7

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

src/main/java/rx/Observable.java

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5370,15 +5370,18 @@ public final Observable<T> onBackpressureBlock() {
53705370
* Instructs an Observable that is emitting items faster than its observer can consume them to
53715371
* hold onto the latest value and emit that on request.
53725372
* <p>
5373-
* Its behavior is logically equivalent to toBlocking().latest() with the exception that
5373+
* <img width="640" height="245" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/bp.obp.latest.png" alt="">
5374+
* <p>
5375+
* Its behavior is logically equivalent to {@code toBlocking().latest()} with the exception that
53745376
* the downstream is not blocking while requesting more values.
53755377
* <p>
53765378
* Note that if the upstream Observable does support backpressure, this operator ignores that capability
53775379
* and doesn't propagate any backpressure requests from downstream.
53785380
* <p>
53795381
* Note that due to the nature of how backpressure requests are propagated through subscribeOn/observeOn,
53805382
* requesting more than 1 from downstream doesn't guarantee a continuous delivery of onNext events.
5381-
* @return
5383+
*
5384+
* @return the source Observable modified so that it emits the most recently-received item upon request
53825385
* @Experimental The behavior of this can change at any time.
53835386
* @since (if this graduates from Experimental/Beta to supported, replace this parenthetical with the release number)
53845387
*/

0 commit comments

Comments
 (0)