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

Fixing broken code include for Dataflow docs

Browse source
This commit is contained in:
Viktor Klang 2012-09-21 11:46:22 +02:00
parent e414c2a3b7
commit 32b6557154
1 changed files with 9 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

15
akka-docs/scala/dataflow.rst
View file

@ -24,11 +24,13 @@ Scala's Delimited Continuations plugin is required to use the Dataflow API. To e
.. code-block:: scala .. code-block:: scala
autoCompilerPlugins := true, autoCompilerPlugins := true,
libraryDependencies <+= scalaVersion { v => compilerPlugin("org.scala-lang.plugins" % "continuations" % <scalaVersion>) }, libraryDependencies <+= scalaVersion {
v => compilerPlugin("org.scala-lang.plugins" % "continuations" % <scalaVersion>)
},
scalacOptions += "-P:continuations:enable", scalacOptions += "-P:continuations:enable",
You will also need to include a dependency on ``akka-dataflow` You will also need to include a dependency on ``akka-dataflow``:
.. code-block:: scala .. code-block:: scala
@ -54,7 +56,7 @@ The flow
The ``flow`` method acts as the delimiter of dataflow expressions (this also neatly aligns with the concept of delimited continuations), The ``flow`` method acts as the delimiter of dataflow expressions (this also neatly aligns with the concept of delimited continuations),
and flow-expressions compose. At this point you might wonder what the ``flow``-construct brings to the table that for-comprehensions don't, and flow-expressions compose. At this point you might wonder what the ``flow``-construct brings to the table that for-comprehensions don't,
and that is the use of the CPS plugin that makes the look _look like_ it is synchronous, but in reality is asynchronous and non-blocking. and that is the use of the CPS plugin that makes the *look like* it is synchronous, but in reality is asynchronous and non-blocking.
The result of a call to ``flow`` is a Future with the resulting value of the flow. The result of a call to ``flow`` is a Future with the resulting value of the flow.
To be able to use the ``flow`` method, you need to import: To be able to use the ``flow`` method, you need to import:
@ -62,7 +64,8 @@ To be able to use the ``flow`` method, you need to import:
.. includecode:: code/docs/dataflow/DataflowDocSpec.scala .. includecode:: code/docs/dataflow/DataflowDocSpec.scala
:include: import-akka-dataflow :include: import-akka-dataflow
The ``flow`` method will, just like Futures and Promises, require an implicit ``ExecutionContext`` in scope. for the examples here we will use: The ``flow`` method will, just like Futures and Promises, require an implicit ``ExecutionContext`` in scope.
For the examples here we will use:
.. includecode:: code/docs/dataflow/DataflowDocSpec.scala .. includecode:: code/docs/dataflow/DataflowDocSpec.scala
:include: import-global-implicit :include: import-global-implicit
@ -91,7 +94,7 @@ Working with variables
Inside the flow method you can use Promises as Dataflow variables: Inside the flow method you can use Promises as Dataflow variables:
.. includecode:: code/docs/dataflow/DataflowDocSpec.scala .. includecode:: code/docs/dataflow/DataflowDocSpec.scala
:include: #dataflow-variable-a :include: dataflow-variable-a
Flow compared to for Flow compared to for
-------------------- --------------------
@ -99,7 +102,7 @@ Flow compared to for
Should I use Dataflow or for-comprehensions? Should I use Dataflow or for-comprehensions?
.. includecode:: code/docs/dataflow/DataflowDocSpec.scala .. includecode:: code/docs/dataflow/DataflowDocSpec.scala
:include: #for-vs-flow :include: for-vs-flow
Conclusions: Conclusions: