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

=str #18821 fix Sink.queue termination

Browse source
This commit is contained in:
Alexander Golubev 2015-12-04 09:37:32 -05:00
parent 0fb6654f4f
commit 64387583ad
8 changed files with 141 additions and 161 deletions
Download patch file Download diff file Expand all files Collapse all files

18
akka-stream/src/main/scala/akka/stream/javadsl/Sink.scala
View file

@ -203,14 +203,20 @@ object Sink {
* [[akka.stream.SinkQueue.pull]] method is pulling element from the stream and returns ``Future[Option[T]]``.
* `Future` completes when element is available.
*
* `Sink` will request at most `bufferSize` number of elements from
* upstream and then stop back pressure.
* Before calling pull method second time you need to wait until previous Future completes.
* Pull returns Failed future with ''IllegalStateException'' if previous future has not yet completed.
*
* @param bufferSize The size of the buffer in element count
* @param timeout Timeout for ``SinkQueue.pull():Future[Option[T] ]``
* `Sink` will request at most number of elements equal to size of `inputBuffer` from
* upstream and then stop back pressure. You can configure size of input
* buffer by using [[Sink.withAttributes]] method.
*
* For stream completion you need to pull all elements from [[akka.stream.SinkQueue]] including last None
* as completion marker
*
* @see [[akka.stream.SinkQueue]]
*/
def queue[T](bufferSize: Int, timeout: FiniteDuration): Sink[T, SinkQueue[T]] =
new Sink(scaladsl.Sink.queue(bufferSize, timeout))
def queue[T](): Sink[T, SinkQueue[T]] =
new Sink(scaladsl.Sink.queue())
/**
* Creates a Sink that writes incoming [[ByteString]] elements to the given file.