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

Amending docs for KillSwitch #20708 (#20716)

Browse source
This commit is contained in:
Stefano Bonetti 2016-06-06 10:28:04 +01:00 • committed by Konrad Malawski
parent 0263774f82
commit fc58fa1f05
2 changed files with 5 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

8
akka-docs/rst/java/stream/stream-dynamic.rst
View file

@ -11,12 +11,12 @@ Controlling graph completion with KillSwitch
A ``KillSwitch`` allows the completion of graphs of ``FlowShape`` from the outside. It consists of a flow element that A ``KillSwitch`` allows the completion of graphs of ``FlowShape`` from the outside. It consists of a flow element that
can be linked to a graph of ``FlowShape`` needing completion control. can be linked to a graph of ``FlowShape`` needing completion control.
The ``KillSwitch`` trait allows to complete or fail the graph(s). The ``KillSwitch`` interface allows to:
.. includecode:: ../../../../akka-stream/src/main/scala/akka/stream/KillSwitch.scala * complete the graph(s) via ``shutdown()``
:include: kill-switch * fail the graph(s) via ``abort(Throwable error)``
After the first call to either ``shutdown`` and ``abort``, all subsequent calls to any of these methods will be ignored. After the first call to either ``shutdown`` or ``abort``, all subsequent calls to any of these methods will be ignored.
Graph completion is performed by both Graph completion is performed by both
* completing its downstream * completing its downstream

2
akka-docs/rst/scala/stream/stream-dynamic.rst
View file

@ -16,7 +16,7 @@ The ``KillSwitch`` trait allows to complete or fail the graph(s).
.. includecode:: ../../../../akka-stream/src/main/scala/akka/stream/KillSwitch.scala .. includecode:: ../../../../akka-stream/src/main/scala/akka/stream/KillSwitch.scala
:include: kill-switch :include: kill-switch
After the first call to either ``shutdown`` and ``abort``, all subsequent calls to any of these methods will be ignored. After the first call to either ``shutdown`` or ``abort``, all subsequent calls to any of these methods will be ignored.
Graph completion is performed by both Graph completion is performed by both
* completing its downstream * completing its downstream