akka.cluster.routing
Class AdaptiveLoadBalancingRouter

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

public class AdaptiveLoadBalancingRouter
extends java.lang.Object
implements DeprecatedRouterConfig, scala.Product, scala.Serializable

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(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
AdaptiveLoadBalancingRouter(MetricsSelector selector, int nr)
          Java API: Constructor that sets nrOfInstances to be created.
AdaptiveLoadBalancingRouter(MetricsSelector metricsSelector, int nrOfInstances, scala.collection.immutable.Iterable<java.lang.String> routees, scala.Option<Resizer> resizer, java.lang.String routerDispatcher, SupervisorStrategy supervisorStrategy)
           
AdaptiveLoadBalancingRouter(MetricsSelector selector, java.lang.Iterable<java.lang.String> routeesPaths)
          Java API: Constructor that sets the routees to be used.
AdaptiveLoadBalancingRouter(MetricsSelector selector, Resizer resizer)
          Java API: Constructor that sets the resizer to be used.
 
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.collection.immutable.Iterable<java.lang.String> paths()
           
 scala.Option<Resizer> resizer()
          Pool with dynamically resizable number of routees return the Resizer to use.
 scala.collection.immutable.Iterable<java.lang.String> routees()
           
 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.
 AdaptiveLoadBalancingRouter withDispatcher(java.lang.String dispatcherId)
          Java API for setting routerDispatcher
 RouterConfig withFallback(RouterConfig other)
          Uses the resizer and/or the supervisor strategy of the given Routerconfig if this RouterConfig doesn't have one, i.e.
 AdaptiveLoadBalancingRouter withResizer(Resizer resizer)
          Java API for setting the resizer to be used.
 AdaptiveLoadBalancingRouter withSupervisorStrategy(SupervisorStrategy strategy)
          Java API for 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.Group
createRouterActor, props, routeeFor
 
Methods inherited from interface akka.routing.Pool
createRouterActor, defaultSupervisorStrategy, enrichWithPoolDispatcher, newRoutee, props, stopRouterWhenAllRouteesRemoved, usePoolDispatcher
 
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

AdaptiveLoadBalancingRouter

public AdaptiveLoadBalancingRouter(MetricsSelector metricsSelector,
                                   int nrOfInstances,
                                   scala.collection.immutable.Iterable<java.lang.String> routees,
                                   scala.Option<Resizer> resizer,
                                   java.lang.String routerDispatcher,
                                   SupervisorStrategy supervisorStrategy)

AdaptiveLoadBalancingRouter

public AdaptiveLoadBalancingRouter(MetricsSelector selector,
                                   int nr)
Java API: Constructor that sets nrOfInstances to be created.

Parameters:
selector - the selector is responsible for producing weighted mix of routees from the node metrics
nr - number of routees to create

AdaptiveLoadBalancingRouter

public AdaptiveLoadBalancingRouter(MetricsSelector selector,
                                   java.lang.Iterable<java.lang.String> routeesPaths)
Java API: Constructor that sets the routees to be used.

Parameters:
selector - the selector is responsible for producing weighted mix of routees from the node metrics
routeesPaths - string representation of the actor paths of the routees that will be looked up using actorFor in ActorRefProvider

AdaptiveLoadBalancingRouter

public AdaptiveLoadBalancingRouter(MetricsSelector selector,
                                   Resizer resizer)
Java API: Constructor that sets the resizer to be used.

Parameters:
selector - the selector is responsible for producing weighted mix of routees from the node metrics
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

routees

public scala.collection.immutable.Iterable<java.lang.String> routees()

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

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

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

paths

public scala.collection.immutable.Iterable<java.lang.String> paths()
Specified by:
paths in interface Group

withDispatcher

public AdaptiveLoadBalancingRouter withDispatcher(java.lang.String dispatcherId)
Java API for setting routerDispatcher


withSupervisorStrategy

public AdaptiveLoadBalancingRouter withSupervisorStrategy(SupervisorStrategy strategy)
Java API for setting the supervisor strategy to be used for the “head” Router actor.


withResizer

public AdaptiveLoadBalancingRouter withResizer(Resizer resizer)
Java API for setting the resizer to be used.


withFallback

public RouterConfig withFallback(RouterConfig other)
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.

Specified by:
withFallback in interface RouterConfig

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