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

Improve Source.queue scala doc based on user feedback (#24734)

Browse source
This commit is contained in:
Christopher Batey 2018-03-15 18:01:24 -07:00 • committed by Konrad `ktoso` Malawski
parent d8b9bb1b3a
commit 2bd21c1691
2 changed files with 10 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

7
akka-stream/src/main/scala/akka/stream/javadsl/Queue.scala
View file

@ -23,8 +23,11 @@ trait SourceQueue[T] {
* - completes with `Dropped` when stream dropped offered element
* - completes with `QueueClosed` when stream is completed during future is active
* - completes with `Failure(f)` when failure to enqueue element from upstream
* - fails when stream is completed or you cannot call offer in this moment because of implementation rules
* (like for backpressure mode and full buffer you need to wait for last offer call Future completion)
* - fails when stream is completed
*
* Additionally when using the backpressure overflowStrategy:
* - If the buffer is full the Future won't be completed until there is space in the buffer
* - Calling offer before the Future is completed in this case will return a failed Future
*
* @param elem element to send to a stream
*/

7
akka-stream/src/main/scala/akka/stream/scaladsl/Queue.scala
View file

@ -23,8 +23,11 @@ trait SourceQueue[T] {
* - completes with `Dropped` when stream dropped offered element
* - completes with `QueueClosed` when stream is completed during future is active
* - completes with `Failure(f)` when failure to enqueue element from upstream
* - fails when stream is completed or you cannot call offer in this moment because of implementation rules
* (like for backpressure mode and full buffer you need to wait for last offer call Future completion)
* - fails when stream is completed
*
* Additionally when using the backpressure overflowStrategy:
* - If the buffer is full the Future won't be completed until there is space in the buffer
* - Calling offer before the Future is completed in this case will return a failed Future
*
* @param elem element to send to a stream
*/