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

mention BoxedUnit in the Java QuickStart

Browse source
This commit is contained in:
Roland Kuhn 2015-02-27 14:05:14 +01:00
parent f1e9c2629c
commit 176ac8be83
2 changed files with 12 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

16
akka-docs-dev/rst/java/stream-quickstart.rst
View file

@ -33,10 +33,16 @@ Let's assume we have a stream of tweets readily available, in Akka this is expre
.. includecode:: ../../../akka-samples/akka-docs-java-lambda/src/test/java/docs/stream/TwitterStreamQuickstartDocTest.java#tweet-source
Streams always start flowing from a :class:`Source<Out>` then can continue through :class:`Flow<In,Out>` elements or
more advanced graph elements to finally be consumed by a :class:`Sink<In>`. Both Sources and Flows provide stream operations
that can be used to transform the flowing data, a :class:`Sink` however does not since its the "end of stream" and its
behavior depends on the type of :class:`Sink` used.
Streams always start flowing from a :class:`Source<Out>` then can continue
through :class:`Flow<In,Out>` elements or more advanced graph elements to
finally be consumed by a :class:`Sink<In>`. The first type
parameter—:class:`Tweet` in this case—designates the kind of elements produced
by the source while the second one describes the object that is created during
materialization (see below)—:class:`BoxedUnit` (from the ``scala.runtime``
package) means that no value is produced, it is the generic equivalent of
``void``. Both Sources and Flows provide stream operations that can be used to
transform the flowing data, a :class:`Sink` however does not since its the "end
of stream" and its behavior depends on the type of :class:`Sink` used.
In our case let's say we want to find all twitter handles of users which tweet about ``#akka``, the operations should look
familiar to anyone who has used the Scala Collections library, however they operate on streams and not collections of data:
@ -46,7 +52,7 @@ familiar to anyone who has used the Scala Collections library, however they oper
Finally in order to :ref:`materialize <stream-materialization-java>` and run the stream computation we need to attach
the Flow to a :class:`Sink<T>` that will get the flow running. The simplest way to do this is to call
``runWith(sink)`` on a ``Source<Out>``. For convenience a number of common Sinks are predefined and collected as static methods on
the `Sink class <http://doc.akka.io/japi/akka-stream-and-http-experimental/1.0-M2/akka/stream/javadsl/Sink.html>`_.
the `Sink class <http://doc.akka.io/japi/akka-stream-and-http-experimental/1.0-M4/akka/stream/javadsl/Sink.html>`_.
For now let's simply print each author:
.. includecode:: ../../../akka-samples/akka-docs-java-lambda/src/test/java/docs/stream/TwitterStreamQuickstartDocTest.java#authors-foreachsink-println

2
akka-docs-dev/rst/scala/stream-quickstart.rst
View file

@ -47,7 +47,7 @@ familiar to anyone who has used the Scala Collections library, however they oper
Finally in order to :ref:`materialize <stream-materialization-scala>` and run the stream computation we need to attach
the Flow to a :class:`Sink` that will get the flow running. The simplest way to do this is to call
``runWith(sink)`` on a ``Source``. For convenience a number of common Sinks are predefined and collected as methods on
the :class:``Sink`` `companion object <http://doc.akka.io/api/akka-stream-and-http-experimental/1.0-M2-SNAPSHOT/#akka.stream.scaladsl.Sink$>`_.
the :class:``Sink`` `companion object <http://doc.akka.io/api/akka-stream-and-http-experimental/1.0-M4/#akka.stream.scaladsl.Sink$>`_.
For now let's simply print each author:
.. includecode:: code/docs/stream/TwitterStreamQuickstartDocSpec.scala#authors-foreachsink-println