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

=str 21049 gaps in Source/Sink sections of stages-overview documentation

Browse source
This commit is contained in:
Alexander Golubev 2016-08-12 17:31:48 -04:00
parent 2f85cf0fb8
commit d3cbcf9342
2 changed files with 35 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

17
akka-docs/rst/java/stream/stages-overview.rst
View file

@ -323,6 +323,23 @@ Invoke a callback when the stream has completed or failed.
**backpressures** never **backpressures** never
lazyInit
^^^^^^^^
Invoke sinkFactory function to create a real sink upon receiving the first element. Internal ``Sink`` will not be created if there are no elements,
because of completion or error. `fallback` will be invoked if there was no elements and completed is received from upstream.
**cancels** never
**backpressures** when initialized and when created sink backpressures
queue
^^^^^
Materialize a ``SinkQueue`` that can be pulled to trigger demand through the sink. The queue contains
a buffer in case stream emitting elements faster than queue pulling them.
**cancels** when ``SinkQueue.cancel`` is called
**backpressures** when buffer has some space
fold fold
^^^^ ^^^^

19
akka-docs/rst/scala/stream/stages-overview.rst
View file

@ -168,7 +168,7 @@ Wrap any resource that can be opened, queried for next element (in a blocking wa
**completes** when read function returns ``None`` **completes** when read function returns ``None``
unfoldAsyncResource unfoldResourceAsync
^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^
Wrap any resource that can be opened, queried for next element (in a blocking way) and closed using three distinct functions into a source. Wrap any resource that can be opened, queried for next element (in a blocking way) and closed using three distinct functions into a source.
Functions return ``Future`` to achieve asynchronous processing Functions return ``Future`` to achieve asynchronous processing
@ -312,6 +312,23 @@ Invoke a callback when the stream has completed or failed.
**backpressures** never **backpressures** never
lazyInit
^^^^^^^^
Invoke sinkFactory function to create a real sink upon receiving the first element. Internal ``Sink`` will not be created if there are no elements,
because of completion or error. `fallback` will be invoked if there was no elements and completed is received from upstream.
**cancels** never
**backpressures** when initialized and when created sink backpressures
queue
^^^^^
Materialize a ``SinkQueue`` that can be pulled to trigger demand through the sink. The queue contains
a buffer in case stream emitting elements faster than queue pulling them.
**cancels** when ``SinkQueue.cancel`` is called
**backpressures** when buffer has some space
fold fold
^^^^ ^^^^