Skip to content

Commit 40fb162

Browse files
committed
fix javadoc
1 parent 47ab38f commit 40fb162

File tree

2 files changed

+19
-7
lines changed

2 files changed

+19
-7
lines changed

src/main/java/rx/Producer.java

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,10 +23,16 @@ public interface Producer {
2323
/**
2424
* Request a certain maximum number of items from this Producer. This is a way of requesting backpressure.
2525
* To disable backpressure, pass {@code Long.MAX_VALUE} to this method.
26-
* <p>
27-
* Requests are additive but if the total requests overflows {@code Long.MAX_VALUE} then the total requests
28-
* is set to {@code Long.MAX_VALUE}. Arriving at {@code Long.MAX_VALUE} by addition of requests cannot be
29-
* assumed to disable backpressure.
26+
* * <p>
27+
* Requests are additive but if a sequence of requests totals more than {@code Long.MAX_VALUE} then
28+
* {@code Long.MAX_VALUE} requests will be actioned and the extras <i>may</i> be ignored. Arriving at
29+
* {@code Long.MAX_VALUE} by addition of requests cannot be assumed to disable backpressure. For example,
30+
* the code below may result in {@code Long.MAX_VALUE} requests being actioned only.
31+
*
32+
* <pre>
33+
* request(100);
34+
* request(Long.MAX_VALUE-1);
35+
* </pre>
3036
*
3137
* @param n the maximum number of items you want this Producer to produce, or {@code Long.MAX_VALUE} if you
3238
* want the Producer to produce items at its own pace

src/main/java/rx/Subscriber.java

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -90,9 +90,15 @@ public void onStart() {
9090
* This is a way of requesting backpressure. To disable backpressure, pass {@code Long.MAX_VALUE} to this
9191
* method.
9292
* <p>
93-
* Requests are additive but if the total requests overflows {@code Long.MAX_VALUE} then the total requests
94-
* is set to {@code Long.MAX_VALUE}. Arriving at {@code Long.MAX_VALUE} by addition of requests cannot be
95-
* assumed to disable backpressure.
93+
* Requests are additive but if a sequence of requests totals more than {@code Long.MAX_VALUE} then
94+
* {@code Long.MAX_VALUE} requests will be actioned and the extras <i>may</i> be ignored. Arriving at
95+
* {@code Long.MAX_VALUE} by addition of requests cannot be assumed to disable backpressure. For example,
96+
* the code below may result in {@code Long.MAX_VALUE} requests being actioned only.
97+
*
98+
* <pre>
99+
* request(100);
100+
* request(Long.MAX_VALUE-1);
101+
* </pre>
96102
*
97103
* @param n the maximum number of items you want the Observable to emit to the Subscriber at this time, or
98104
* {@code Long.MAX_VALUE} if you want the Observable to emit items at its own pace

0 commit comments

Comments
 (0)