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

fix SourceQueue docs inconsistencies #21852

Browse source
This commit is contained in:
Andrey Kuznetsov 2016-11-22 16:11:09 +03:00 • committed by Johan Andrén
parent aebfda540d
commit 3bd53c8bc2
2 changed files with 6 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

5
akka-stream/src/main/scala/akka/stream/scaladsl/Source.scala
View file

@ -467,8 +467,9 @@ object Source {
* You can watch accessibility of stream with [[akka.stream.scaladsl.SourceQueue.watchCompletion]].
* It returns future that completes with success when stream is completed or fail when stream is failed.
*
* The buffer can be disabled by using `bufferSize` of 0 and then received message will wait for downstream demand.
* When `bufferSize` is 0 the `overflowStrategy` does not matter.
* The buffer can be disabled by using `bufferSize` of 0 and then received message will wait
* for downstream demand unless there is another message waiting for downstream demand, in that case
* offer result will be completed according to the overflow strategy.
*
* SourceQueue that current source is materialized to is for single thread usage only.
*