Merge pull request #1304 from akka/wip-2839-dispatcher-deploy-config-patriknw

Add dispatcherId to deployment config, see #2839

akka-docs/rst/java/code/docs/dispatcher/DispatcherDocTestBase.java

@@ -30,8 +30,8 @@ import java.util.concurrent.ConcurrentLinkedQueue;
 
 //#imports-custom
 
-import org.junit.After;
-import org.junit.Before;
+import org.junit.AfterClass;
+import org.junit.BeforeClass;
 import org.junit.Test;
 import scala.Option;
 import scala.concurrent.ExecutionContext;
@@ -43,27 +43,37 @@ import akka.testkit.AkkaSpec;
 
 public class DispatcherDocTestBase {
 
-  ActorSystem system;
+  static ActorSystem system;
 
-  @Before
-  public void setUp() {
+  @BeforeClass
+  public static void beforeAll() {
     system = ActorSystem.create("MySystem",
         ConfigFactory.parseString(
           DispatcherDocSpec.config()).withFallback(AkkaSpec.testConf()));
   }
 
-  @After
-  public void tearDown() {
+  @AfterClass
+  public static void afterAll() {
     system.shutdown();
+    system = null;
   }
 
   @Test
-  public void defineDispatcher() {
-    //#defining-dispatcher
+  public void defineDispatcherInConfig() {
+    //#defining-dispatcher-in-config
+    ActorRef myActor =
+      system.actorOf(new Props(MyUntypedActor.class),
+        "myactor");
+    //#defining-dispatcher-in-config
+  }
+
+  @Test
+  public void defineDispatcherInCode() {
+    //#defining-dispatcher-in-code
     ActorRef myActor =
       system.actorOf(new Props(MyUntypedActor.class).withDispatcher("my-dispatcher"),
         "myactor3");
-    //#defining-dispatcher
+    //#defining-dispatcher-in-code
   }
 
   @Test

akka-docs/rst/java/dispatchers.rst

@@ -25,16 +25,8 @@ Dispatchers implement the :class:`ExecutionContext` interface and can thus be us
 Setting the dispatcher for an Actor
 -----------------------------------
 
-So in case you want to give your ``Actor`` a different dispatcher than the default, you need to do two things, of which the first is:
-
-.. includecode:: ../java/code/docs/dispatcher/DispatcherDocTestBase.java#defining-dispatcher
-
-.. note::
-    The "dispatcherId" you specify in withDispatcher is in fact a path into your configuration.
-    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"``
-
-And then you just need to configure that dispatcher in your configuration:
+So in case you want to give your ``Actor`` a different dispatcher than the default, you need to do two things, of which the first is
+is to configure the dispatcher:
 
 .. includecode:: ../scala/code/docs/dispatcher/DispatcherDocSpec.scala#my-dispatcher-config
 
@@ -44,6 +36,24 @@ And here's another example that uses the "thread-pool-executor":
 
 For more options, see the default-dispatcher section of the :ref:`configuration`.
 
+Then you create the actor as usual and define the dispatcher in the deployment configuration.
+
+.. includecode:: ../java/code/docs/dispatcher/DispatcherDocTestBase.java#defining-dispatcher-in-config
+
+.. includecode:: ../scala/code/docs/dispatcher/DispatcherDocSpec.scala#dispatcher-deployment-config
+
+An alternative to the deployment configuration is to define the dispatcher in code.
+If you define the ``dispatcher`` in the deployment configuration then this value will be used instead
+of programmatically provided parameter.
+
+.. includecode:: ../java/code/docs/dispatcher/DispatcherDocTestBase.java#defining-dispatcher-in-code
+
+.. note::
+    The dispatcher you specify in ``withDispatcher`` and the ``dispatcher`` property in the deployment 
+    configuration is in fact a path into your configuration.
+    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"``
+
 Types of dispatchers
 --------------------