+act Clarify usage of FromConfig in doc and API doc #18771 (#20981)

This commit is contained in:
Richard Imaoka 2016-07-18 20:16:36 +09:00 committed by Konrad Malawski
parent df46b203dc
commit 6c82176c30
3 changed files with 15 additions and 11 deletions

View file

@ -66,10 +66,10 @@ This type of router actor comes in two distinct flavors:
messages to the specified path using actor selection, without watching for termination.
The settings for a router actor can be defined in configuration or programmatically.
Although router actors can be defined in the configuration file, they must still be created
programmatically, i.e. you cannot make a router through external configuration alone.
If you define the router actor in the configuration file then these settings will be used
instead of any programmatically provided parameters.
In order to make an actor to make use of an externally configurable router the ``FromConfig`` props wrapper must be used
to denote that the actor accepts routing settings from configuration.
This is in contrast with Remote Deployment where such marker props is not necessary.
If the props of an actor is NOT wrapped in FromConfig it will ignore the router section of the deployment configuration.
You send messages to the routees via the router actor in the same way as for ordinary actors,
i.e. via its ``ActorRef``. The router actor forwards messages onto its routees without changing