akka.cluster.routing
Class AdaptiveLoadBalancingRouter

java.lang.Object
  akka.cluster.routing.AdaptiveLoadBalancingRouter

All Implemented Interfaces:

AdaptiveLoadBalancingRouterLike, RouterConfig, java.io.Serializable, scala.Equals, scala.Product

public class AdaptiveLoadBalancingRouter
extends java.lang.Object
implements RouterConfig, AdaptiveLoadBalancingRouterLike, 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 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

The router creates a “head” actor which supervises and/or monitors the routees. Instances are created as children of this actor, hence the children are not supervised by the parent of the router. Common choices are to always escalate (meaning that fault handling is always applied to all children simultaneously; this is the default) or use the parent’s strategy, which will result in routed children being treated individually, but it is possible as well to use Routers to give different supervisor strategies to different groups of children.

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.Iterable<java.lang.String> routees, scala.Option<Resizer> resizer, java.lang.String routerDispatcher, SupervisorStrategy supervisorStrategy)

AdaptiveLoadBalancingRouter(MetricsSelector selector, java.lang.Iterable<java.lang.String> routeePaths)
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

MetricsSelector	metricsSelector()
int	nrOfInstances()
scala.Option<Resizer>	resizer() Routers with dynamically resizable number of routees return the Resizer to use.
scala.collection.Iterable<java.lang.String>	routees()
java.lang.String	routerDispatcher() Dispatcher ID to use for running the “head” actor, i.e. the Router.
SupervisorStrategy	supervisorStrategy() SupervisorStrategy for the created Router actor.
AdaptiveLoadBalancingRouter	withDispatcher(java.lang.String dispatcherId) Java API for setting routerDispatcher
RouterConfig	withFallback(RouterConfig other) Uses the resizer 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.
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.RouterConfig

createActor, createRoute, createRouteeProvider, toAll, verifyConfig

Methods inherited from interface akka.cluster.routing.AdaptiveLoadBalancingRouterLike

createRoute

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.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> routeePaths)

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

routeePaths - 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()

Specified by:

metricsSelector in interface AdaptiveLoadBalancingRouterLike

nrOfInstances

public int nrOfInstances()

Specified by:

nrOfInstances in interface AdaptiveLoadBalancingRouterLike

routees

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

Specified by:

routees in interface AdaptiveLoadBalancingRouterLike

resizer

public scala.Option<Resizer> resizer()

Description copied from interface: RouterConfig

Routers with dynamically resizable number of routees return the Resizer to use.

Specified by:

resizer in interface RouterConfig

routerDispatcher

public java.lang.String routerDispatcher()

Description copied from interface: RouterConfig

Dispatcher ID to use for running the “head” actor, i.e. the Router.

Specified by:

routerDispatcher in interface AdaptiveLoadBalancingRouterLike

Specified by:

routerDispatcher in interface RouterConfig

supervisorStrategy

public SupervisorStrategy supervisorStrategy()

Description copied from interface: RouterConfig

SupervisorStrategy for the created Router actor.

Specified by:

supervisorStrategy in interface RouterConfig

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.

withFallback

public RouterConfig withFallback(RouterConfig other)

Uses the resizer 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