Java API: Constructor that sets the resizer to be used.
Java API: Constructor that sets the resizer to be used.
the selector is responsible for producing weighted mix of routees from the node metrics
Java API: Constructor that sets the routees to be used.
Java API: Constructor that sets the routees to be used.
the selector is responsible for producing weighted mix of routees from the node metrics
string representation of the actor paths of the routees that will be looked up
using actorFor
in akka.actor.ActorRefProvider
Java API: Constructor that sets nrOfInstances to be created.
Java API: Constructor that sets nrOfInstances to be created.
the selector is responsible for producing weighted mix of routees from the node metrics
number of routees to create
decides what probability to use for selecting a routee, based on remaining capacity as indicated by the node metrics
string representation of the actor paths of the routees that will be looked up
using actorFor
in akka.actor.ActorRefProvider
Create the actual router, responsible for routing messages to routees.
Create the actual router, responsible for routing messages to routees.
the ActorSystem this router belongs to
Is the message handled by the router head actor or the #routingLogicController actor.
Is the message handled by the router head actor or the #routingLogicController actor.
decides what probability to use for selecting a routee, based on remaining capacity as indicated by the node metrics
Initial number of routee instances
Initial number of routee instances
akka.actor.Props for a pool router based on the settings defined by this instance and the supplied akka.actor.Props for the routees created by the router.
akka.actor.Props for a pool router based on the settings defined by this instance and the supplied akka.actor.Props for the routees created by the router.
akka.actor.Props for a group router based on the settings defined by this instance.
akka.actor.Props for a group router based on the settings defined by this instance.
Pool with dynamically resizable number of routees return the akka.routing.Resizer to use.
Pool with dynamically resizable number of routees return the akka.routing.Resizer to use. The resizer is invoked once when the router is created, before any messages can be sent to it. Resize is also triggered when messages are sent to the routees, and the resizer is invoked asynchronously, i.e. not necessarily before the message has been sent.
string representation of the actor paths of the routees that will be looked up
using actorFor
in akka.actor.ActorRefProvider
Dispatcher ID to use for running the “head” actor, which handles supervision, death watch and router management messages
Dispatcher ID to use for running the “head” actor, which handles supervision, death watch and router management messages
Possibility to define an actor for controlling the routing logic from external stimuli (e.g.
Possibility to define an actor for controlling the routing logic from external stimuli (e.g. monitoring metrics). This actor will be a child of the router "head" actor. Managment messages not handled by the "head" actor are delegated to this controller actor.
SupervisorStrategy for the head actor, i.e.
SupervisorStrategy for the head actor, i.e. for supervising the routees of the pool.
Use a dedicated dispatcher for the routees of the pool.
Use a dedicated dispatcher for the routees of the pool. The dispatcher is defined in 'pool-dispatcher' configuration property in the deployment section of the router.
Check that everything is there which is needed.
Check that everything is there which is needed. Called in constructor of RoutedActorRef to fail early.
Java API for setting routerDispatcher
Uses the resizer and/or the supervisor strategy of the given Routerconfig if this RouterConfig doesn't have one, i.e.
Uses the resizer and/or the supervisor strategy of the given Routerconfig if this RouterConfig doesn't have one, i.e. the resizer defined in code is used if resizer was not defined in config.
Java API for setting the resizer to be used.
Java API for setting the resizer to be used.
Java API for setting the supervisor strategy to be used for the “head” Router actor.
Java API for setting the supervisor strategy to be used for the “head” Router actor.
A Router that performs load balancing of messages to cluster nodes based on cluster metric data.
It uses random selection of routees based on probabilities derived from the remaining capacity of corresponding node.
Please note that providing both 'nrOfInstances' and 'routees' does not make logical sense as this means that the router should both create new actors and use the 'routees' actor(s). In this case the 'nrOfInstances' will be ignored and the 'routees' will be used.
The configuration parameter trumps the constructor arguments. This means that if you provide either 'nrOfInstances' or 'routees' during instantiation they will be ignored if the router is defined in the configuration file for the actor being used.
Supervision Setup
Any routees that are created by a router will be created as the router's children. The router is therefore also the children's supervisor.
The supervision strategy of the router actor can be configured with #withSupervisorStrategy. If no strategy is provided, routers default to a strategy of “always escalate”. This means that errors are passed up to the router's supervisor for handling.
The router's supervisor will treat the error as an error with the router itself. Therefore a directive to stop or restart will cause the router itself to stop or restart. The router, in turn, will cause its children to stop and restart.
decides what probability to use for selecting a routee, based on remaining capacity as indicated by the node metrics
string representation of the actor paths of the routees that will be looked up using
actorFor
in akka.actor.ActorRefProvider(Since version 2.3) Use AdaptiveLoadBalancingPool or AdaptiveLoadBalancingGroup