raboof/pekko
1
0
Fork 0
Code Issues Pull requests Projects Releases 6 Packages Wiki Activity Actions 11

Correct the backpressure API comment for buffer

Browse source
This commit is contained in:
Richard Imaoka 2017-06-28 00:07:19 +09:00
parent c636f3540f
commit 4f10d45376
5 changed files with 30 additions and 20 deletions
Download patch file Download diff file Expand all files Collapse all files

10
akka-stream/src/main/scala/akka/stream/javadsl/SubSource.scala
View file

@ -952,10 +952,12 @@ class SubSource[+Out, +Mat](delegate: scaladsl.SubFlow[Out, Mat, scaladsl.Source
*
* '''Emits when''' downstream stops backpressuring and there is a pending element in the buffer
*
* '''Backpressures when''' depending on OverflowStrategy
* * Backpressure - backpressures when buffer is full
* * DropHead, DropTail, DropBuffer - never backpressures
* * Fail - fails the stream if buffer gets full
* '''Backpressures when''' downstream backpressures or depending on OverflowStrategy:
* <ul>
* <li>Backpressure - backpressures when buffer is full</li>
* <li>DropHead, DropTail, DropBuffer - never backpressures</li>
* <li>Fail - fails the stream if buffer gets full</li>
* </ul>
*
* '''Completes when''' upstream completes and buffered elements has been drained
*