Skip to content

Commit

Permalink
Merge pull request #928 from akka/wip-misc-docs-2.1-patriknw
Browse files Browse the repository at this point in the history
Cherry-picks of misc docs for 2.1
  • Loading branch information
patriknw committed Dec 6, 2012
2 parents 8362bf9 + cfa9965 commit 66efaa2
Show file tree
Hide file tree
Showing 7 changed files with 9 additions and 16 deletions.
2 changes: 1 addition & 1 deletion akka-docs/rst/cluster/cluster-usage-java.rst
Original file line number Diff line number Diff line change
Expand Up @@ -523,7 +523,7 @@ introduce the extra overhead of another thread.
::

# shorter tick-duration of default scheduler when using cluster
akka.scheduler.tick-duration.tick-duration = 33ms
akka.scheduler.tick-duration = 33ms



2 changes: 1 addition & 1 deletion akka-docs/rst/cluster/cluster-usage-scala.rst
Original file line number Diff line number Diff line change
Expand Up @@ -537,7 +537,7 @@ introduce the extra overhead of another thread.
::

# shorter tick-duration of default scheduler when using cluster
akka.scheduler.tick-duration.tick-duration = 33ms
akka.scheduler.tick-duration = 33ms



6 changes: 1 addition & 5 deletions akka-docs/rst/java/microkernel.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,7 @@ Put your application jar in the ``deploy`` directory to have it automatically
loaded.

To start the kernel use the scripts in the ``bin`` directory, passing the boot
classes for your application.

There is a simple example of an application setup for running with the
microkernel included in the akka download. This can be run with the following
command (on a unix-based system):
classes for your application. Example command (on a unix-based system):

.. code-block:: none
Expand Down
6 changes: 3 additions & 3 deletions akka-docs/rst/scala/io.rst
Original file line number Diff line number Diff line change
Expand Up @@ -138,9 +138,9 @@ Receiving messages from the ``IOManager``:
IO.Iteratee
^^^^^^^^^^^

Included with Akka's IO support is a basic implementation of ``Iteratee``\s. ``Iteratee``\s are an effective way of handling a stream of data without needing to wait for all the data to arrive. This is especially useful when dealing with non blocking IO since we will usually receive data in chunks which may not include enough information to process, or it may contain much more data then we currently need.
Included with Akka's IO support is a basic implementation of ``Iteratee``\s. ``Iteratee``\s are an effective way of handling a stream of data without needing to wait for all the data to arrive. This is especially useful when dealing with non blocking IO since we will usually receive data in chunks which may not include enough information to process, or it may contain much more data than we currently need.

This ``Iteratee`` implementation is much more basic then what is usually found. There is only support for ``ByteString`` input, and enumerators aren't used. The reason for this limited implementation is to reduce the amount of explicit type signatures needed and to keep things simple. It is important to note that Akka's ``Iteratee``\s are completely optional, incoming data can be handled in any way, including other ``Iteratee`` libraries.
This ``Iteratee`` implementation is much more basic than what is usually found. There is only support for ``ByteString`` input, and enumerators aren't used. The reason for this limited implementation is to reduce the amount of explicit type signatures needed and to keep things simple. It is important to note that Akka's ``Iteratee``\s are completely optional, incoming data can be handled in any way, including other ``Iteratee`` libraries.

``Iteratee``\s work by processing the data that it is given and returning either the result (with any unused input) or a continuation if more input is needed. They are monadic, so methods like ``flatMap`` can be used to pass the result of an ``Iteratee`` to another.

Expand Down Expand Up @@ -204,7 +204,7 @@ Following the path we read in the query (if it exists):
.. includecode:: code/docs/io/HTTPServer.scala
:include: read-query

It is much simpler then reading the path since we aren't doing any parsing of the query since there is no standard format of the query string.
It is much simpler than reading the path since we aren't doing any parsing of the query since there is no standard format of the query string.

Both the path and query used the ``readUriPart`` ``Iteratee``, which is next:

Expand Down
6 changes: 1 addition & 5 deletions akka-docs/rst/scala/microkernel.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,7 @@ Put your application jar in the ``deploy`` directory to have it automatically
loaded.

To start the kernel use the scripts in the ``bin`` directory, passing the boot
classes for your application.

There is a simple example of an application setup for running with the
microkernel included in the akka download. This can be run with the following
command (on a unix-based system):
classes for your application. Example command (on a unix-based system):

.. code-block:: none
Expand Down
2 changes: 1 addition & 1 deletion akka-sbt-plugin/sample/project/Build.scala
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import akka.sbt.AkkaKernelPlugin.{ Dist, outputDirectory, distJvmOptions}
object HelloKernelBuild extends Build {
val Organization = "akka.sample"
val Version = "2.1-SNAPSHOT"
val ScalaVersion = "2.10.0-RC1"
val ScalaVersion = "2.10.0-RC3"

lazy val HelloKernel = Project(
id = "hello-kernel",
Expand Down
1 change: 1 addition & 0 deletions project/AkkaBuild.scala
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ object AkkaBuild extends Build {
organization := "com.typesafe.akka",
version := "2.1-SNAPSHOT",
// FIXME: use 2.10.0 for final
// Also change ScalaVersion in akka-sbt-plugin/sample/project/Build.scala
scalaVersion := System.getProperty("akka.scalaVersion", "2.10.0-RC3")
)

Expand Down

0 comments on commit 66efaa2

Please sign in to comment.