public final class AdaptiveLoadBalancingPool extends java.lang.Object implements Pool, scala.Product, scala.Serializable
It uses random selection of routees based on probabilities derived from the remaining capacity of corresponding node.
The configuration parameter trumps the constructor arguments. This means that
if you provide nrOfInstances
during instantiation they will be ignored if
the router is defined in the configuration file for the actor being used.
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(akka.actor.SupervisorStrategy)
. 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.
param: metricsSelector decides what probability to use for selecting a routee, based on remaining capacity as indicated by the node metrics
param: nrOfInstances initial number of routees in the pool
param: supervisorStrategy strategy for supervising the routees, see 'Supervision Setup'
param: routerDispatcher dispatcher to use for the router head actor, which handles supervision, death watch and router management messages
Constructor and Description |
---|
AdaptiveLoadBalancingPool(com.typesafe.config.Config config,
DynamicAccess dynamicAccess) |
AdaptiveLoadBalancingPool(MetricsSelector metricsSelector,
int nr)
Java API
|
AdaptiveLoadBalancingPool(MetricsSelector metricsSelector,
int nrOfInstances,
SupervisorStrategy supervisorStrategy,
java.lang.String routerDispatcher,
boolean usePoolDispatcher) |
Modifier and Type | Method and Description |
---|---|
abstract static boolean |
canEqual(java.lang.Object that) |
Router |
createRouter(ActorSystem system)
Create the actual router, responsible for routing messages to routees.
|
static RouterActor |
createRouterActor() |
static Props |
enrichWithPoolDispatcher(Props routeeProps,
ActorContext context) |
abstract static boolean |
equals(java.lang.Object that) |
static boolean |
isManagementMessage(java.lang.Object msg) |
MetricsSelector |
metricsSelector() |
static Routee |
newRoutee(Props routeeProps,
ActorContext context) |
int |
nrOfInstances() |
int |
nrOfInstances(ActorSystem sys)
Initial number of routee instances
|
abstract static int |
productArity() |
abstract static java.lang.Object |
productElement(int n) |
static scala.collection.Iterator<java.lang.Object> |
productIterator() |
static java.lang.String |
productPrefix() |
static Props |
props(Props routeeProps) |
scala.Option<Resizer> |
resizer()
Pool with dynamically resizable number of routees return the
Resizer
to use. |
java.lang.String |
routerDispatcher()
Dispatcher ID to use for running the “head” actor, which handles
supervision, death watch and router management messages
|
scala.Option<Props> |
routingLogicController(RoutingLogic routingLogic)
Possibility to define an actor for controlling the routing
logic from external stimuli (e.g.
|
static boolean |
stopRouterWhenAllRouteesRemoved() |
SupervisorStrategy |
supervisorStrategy()
SupervisorStrategy for the head actor, i.e.
|
boolean |
usePoolDispatcher()
Use a dedicated dispatcher for the routees of the pool.
|
static void |
verifyConfig(ActorPath path) |
AdaptiveLoadBalancingPool |
withDispatcher(java.lang.String dispatcherId)
Setting the dispatcher to be used for the router head actor, which handles
supervision, death watch and router management messages.
|
RouterConfig |
withFallback(RouterConfig other)
Uses the supervisor strategy of the given RouterConfig
if this RouterConfig doesn't have one
|
AdaptiveLoadBalancingPool |
withSupervisorStrategy(SupervisorStrategy strategy)
Setting the supervisor strategy to be used for the “head” Router actor.
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
createRouterActor, enrichWithPoolDispatcher, newRoutee, props, stopRouterWhenAllRouteesRemoved
isManagementMessage, verifyConfig
public AdaptiveLoadBalancingPool(MetricsSelector metricsSelector, int nrOfInstances, SupervisorStrategy supervisorStrategy, java.lang.String routerDispatcher, boolean usePoolDispatcher)
public AdaptiveLoadBalancingPool(com.typesafe.config.Config config, DynamicAccess dynamicAccess)
public AdaptiveLoadBalancingPool(MetricsSelector metricsSelector, int nr)
metricsSelector
- decides what probability to use for selecting a routee, based
on remaining capacity as indicated by the node metricsnr
- initial number of routees in the poolpublic static boolean isManagementMessage(java.lang.Object msg)
public static void verifyConfig(ActorPath path)
public static Routee newRoutee(Props routeeProps, ActorContext context)
public static Props enrichWithPoolDispatcher(Props routeeProps, ActorContext context)
public static boolean stopRouterWhenAllRouteesRemoved()
public static RouterActor createRouterActor()
public abstract static boolean canEqual(java.lang.Object that)
public abstract static boolean equals(java.lang.Object that)
public abstract static java.lang.Object productElement(int n)
public abstract static int productArity()
public static scala.collection.Iterator<java.lang.Object> productIterator()
public static java.lang.String productPrefix()
public MetricsSelector metricsSelector()
public int nrOfInstances()
nrOfInstances
in interface Pool
public SupervisorStrategy supervisorStrategy()
Pool
supervisorStrategy
in interface Pool
public java.lang.String routerDispatcher()
RouterConfig
routerDispatcher
in interface RouterConfig
public boolean usePoolDispatcher()
Pool
usePoolDispatcher
in interface Pool
public scala.Option<Resizer> resizer()
Pool
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.public int nrOfInstances(ActorSystem sys)
Pool
nrOfInstances
in interface Pool
sys
- (undocumented)public Router createRouter(ActorSystem system)
RouterConfig
createRouter
in interface RouterConfig
system
- the ActorSystem this router belongs topublic scala.Option<Props> routingLogicController(RoutingLogic routingLogic)
RouterConfig
routingLogicController
in interface RouterConfig
routingLogic
- (undocumented)public AdaptiveLoadBalancingPool withSupervisorStrategy(SupervisorStrategy strategy)
strategy
- (undocumented)public AdaptiveLoadBalancingPool withDispatcher(java.lang.String dispatcherId)
dispatcherId
- (undocumented)public RouterConfig withFallback(RouterConfig other)
withFallback
in interface RouterConfig
other
- (undocumented)