From 7b55a8780200da3530e862b647f50c25868f78b1 Mon Sep 17 00:00:00 2001 From: Konrad Malawski Date: Thu, 15 Oct 2015 11:01:10 +0200 Subject: [PATCH] =doc explain parallelism-max in more detail --- akka-docs/rst/java/dispatchers.rst | 10 +++++++++- akka-docs/rst/scala/dispatchers.rst | 10 +++++++++- 2 files changed, 18 insertions(+), 2 deletions(-) diff --git a/akka-docs/rst/java/dispatchers.rst b/akka-docs/rst/java/dispatchers.rst index bff8045513..f01831eac1 100644 --- a/akka-docs/rst/java/dispatchers.rst +++ b/akka-docs/rst/java/dispatchers.rst @@ -1,7 +1,7 @@ .. _dispatchers-java: Dispatchers -=================== +=========== An Akka ``MessageDispatcher`` is what makes Akka Actors "tick", it is the engine of the machine so to speak. All ``MessageDispatcher`` implementations are also an ``ExecutionContext``, which means that they can be used @@ -34,6 +34,12 @@ is to configure the dispatcher: .. includecode:: ../scala/code/docs/dispatcher/DispatcherDocSpec.scala#my-dispatcher-config +.. note:: + Note that the ``parallelism-max`` does not set the upper bound on the total number of threads + allocated by the ForkJoinPool. It is a setting specifically talking about the number of *hot* + threads the pool keep running in order to reduce the latency of handling a new incoming task. + You can read more about parallelism in the JDK's `ForkJoinPool documentation`_. + And here's another example that uses the "thread-pool-executor": .. includecode:: ../scala/code/docs/dispatcher/DispatcherDocSpec.scala#my-thread-pool-dispatcher-config @@ -58,6 +64,8 @@ of programmatically provided parameter. So in this example it's a top-level section, but you could for instance put it as a sub-section, where you'd use periods to denote sub-sections, like this: ``"foo.bar.my-dispatcher"`` +.. _ForkJoinPool documentation: https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/ForkJoinPool.html + Types of dispatchers -------------------- diff --git a/akka-docs/rst/scala/dispatchers.rst b/akka-docs/rst/scala/dispatchers.rst index 4c05ff8e5e..cf88e47a72 100644 --- a/akka-docs/rst/scala/dispatchers.rst +++ b/akka-docs/rst/scala/dispatchers.rst @@ -1,7 +1,7 @@ .. _dispatchers-scala: Dispatchers -=================== +=========== An Akka ``MessageDispatcher`` is what makes Akka Actors "tick", it is the engine of the machine so to speak. All ``MessageDispatcher`` implementations are also an ``ExecutionContext``, which means that they can be used @@ -34,6 +34,12 @@ is to configure the dispatcher: .. includecode:: ../scala/code/docs/dispatcher/DispatcherDocSpec.scala#my-dispatcher-config +.. note:: + Note that the ``parallelism-max`` does not set the upper bound on the total number of threads + allocated by the ForkJoinPool. It is a setting specifically talking about the number of *hot* + threads the pool keep running in order to reduce the latency of handling a new incoming task. + You can read more about parallelism in the JDK's `ForkJoinPool documentation`_. + And here's another example that uses the "thread-pool-executor": .. includecode:: ../scala/code/docs/dispatcher/DispatcherDocSpec.scala#my-thread-pool-dispatcher-config @@ -58,6 +64,8 @@ of programmatically provided parameter. So in this example it's a top-level section, but you could for instance put it as a sub-section, where you'd use periods to denote sub-sections, like this: ``"foo.bar.my-dispatcher"`` +.. _ForkJoinPool documentation: https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/ForkJoinPool.html + Types of dispatchers --------------------