akka.cluster.routing
Class AdaptiveLoadBalancingPool

java.lang.Object
  extended by akka.cluster.routing.AdaptiveLoadBalancingPool
All Implemented Interfaces:
Pool, RouterConfig, java.io.Serializable, scala.Equals, scala.Product

public final class AdaptiveLoadBalancingPool
extends java.lang.Object
implements Pool, scala.Product, scala.Serializable

A router pool 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.

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.

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(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.

See Also:
Serialized Form

Constructor Summary
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)
           
 
Method Summary
 Router createRouter(ActorSystem system)
          Create the actual router, responsible for routing messages to routees.
 MetricsSelector metricsSelector()
           
 int nrOfInstances()
          Initial number of routee instances
 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.
 SupervisorStrategy supervisorStrategy()
          SupervisorStrategy for the head actor, i.e.
 boolean usePoolDispatcher()
          Use a dedicated dispatcher for the routees of the pool.
 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.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface akka.routing.Pool
createRouterActor, defaultSupervisorStrategy, enrichWithPoolDispatcher, newRoutee, props, stopRouterWhenAllRouteesRemoved
 
Methods inherited from interface akka.routing.RouterConfig
isManagementMessage, verifyConfig
 
Methods inherited from interface scala.Product
productArity, productElement, productIterator, productPrefix
 
Methods inherited from interface scala.Equals
canEqual, equals
 

Constructor Detail

AdaptiveLoadBalancingPool

public AdaptiveLoadBalancingPool(MetricsSelector metricsSelector,
                                 int nrOfInstances,
                                 SupervisorStrategy supervisorStrategy,
                                 java.lang.String routerDispatcher,
                                 boolean usePoolDispatcher)

AdaptiveLoadBalancingPool

public AdaptiveLoadBalancingPool(com.typesafe.config.Config config,
                                 DynamicAccess dynamicAccess)

AdaptiveLoadBalancingPool

public AdaptiveLoadBalancingPool(MetricsSelector metricsSelector,
                                 int nr)
Java API

Parameters:
metricsSelector - decides what probability to use for selecting a routee, based on remaining capacity as indicated by the node metrics
nr - initial number of routees in the pool
Method Detail

metricsSelector

public MetricsSelector metricsSelector()

nrOfInstances

public int nrOfInstances()
Description copied from interface: Pool
Initial number of routee instances

Specified by:
nrOfInstances in interface Pool

supervisorStrategy

public SupervisorStrategy supervisorStrategy()
Description copied from interface: Pool
SupervisorStrategy for the head actor, i.e. for supervising the routees of the pool.

Specified by:
supervisorStrategy in interface Pool

routerDispatcher

public java.lang.String routerDispatcher()
Description copied from interface: RouterConfig
Dispatcher ID to use for running the “head” actor, which handles supervision, death watch and router management messages

Specified by:
routerDispatcher in interface RouterConfig

usePoolDispatcher

public boolean usePoolDispatcher()
Description copied from interface: 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.

Specified by:
usePoolDispatcher in interface Pool

resizer

public scala.Option<Resizer> resizer()
Description copied from interface: Pool
Pool with dynamically resizable number of routees return the 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.

Specified by:
resizer in interface Pool

createRouter

public Router createRouter(ActorSystem system)
Description copied from interface: RouterConfig
Create the actual router, responsible for routing messages to routees.

Specified by:
createRouter in interface RouterConfig
Parameters:
system - the ActorSystem this router belongs to

routingLogicController

public scala.Option<Props> routingLogicController(RoutingLogic routingLogic)
Description copied from interface: RouterConfig
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.

Specified by:
routingLogicController in interface RouterConfig

withSupervisorStrategy

public AdaptiveLoadBalancingPool withSupervisorStrategy(SupervisorStrategy strategy)
Setting the supervisor strategy to be used for the “head” Router actor.


withDispatcher

public 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.


withFallback

public RouterConfig withFallback(RouterConfig other)
Uses the supervisor strategy of the given Routerconfig if this RouterConfig doesn't have one

Specified by:
withFallback in interface RouterConfig