akka.cluster.routing

Class AdaptiveLoadBalancingGroup

java.lang.Object

akka.cluster.routing.AdaptiveLoadBalancingGroup

All Implemented Interfaces:

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

Deprecated.

Superseded by akka.cluster.metrics (in akka-cluster-metrics jar). Since 2.4.

public final class AdaptiveLoadBalancingGroup
extends java.lang.Object
implements Group, scala.Product, scala.Serializable

A router group 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 paths during instantiation they will be ignored if the router is defined in the configuration file for the actor being used.

param: metricsSelector decides what probability to use for selecting a routee, based on remaining capacity as indicated by the node metrics

param: paths string representation of the actor paths of the routees, messages are sent with ActorSelection to these paths

param: routerDispatcher dispatcher to use for the router head actor, which handles router management messages

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AdaptiveLoadBalancingGroup(com.typesafe.config.Config config, DynamicAccess dynamicAccess) Deprecated.
AdaptiveLoadBalancingGroup(MetricsSelector metricsSelector, java.lang.Iterable<java.lang.String> routeesPaths) Deprecated. Java API
AdaptiveLoadBalancingGroup(MetricsSelector metricsSelector, scala.collection.immutable.Iterable<java.lang.String> paths, java.lang.String routerDispatcher) Deprecated.

Method Summary

Modifier and Type	Method and Description
abstract static boolean	canEqual(java.lang.Object that) Deprecated.
Router	createRouter(ActorSystem system) Deprecated. Create the actual router, responsible for routing messages to routees.
static RouterActor	createRouterActor() Deprecated.
abstract static boolean	equals(java.lang.Object that) Deprecated.
static boolean	isManagementMessage(java.lang.Object msg) Deprecated.
MetricsSelector	metricsSelector() Deprecated.
scala.collection.immutable.Iterable<java.lang.String>	paths() Deprecated.
scala.collection.immutable.Iterable<java.lang.String>	paths(ActorSystem system) Deprecated.
abstract static int	productArity() Deprecated.
abstract static java.lang.Object	productElement(int n) Deprecated.
static scala.collection.Iterator<java.lang.Object>	productIterator() Deprecated.
static java.lang.String	productPrefix() Deprecated.
static Props	props() Deprecated.
static Routee	routeeFor(java.lang.String path, ActorContext context) Deprecated.
java.lang.String	routerDispatcher() Deprecated. Dispatcher ID to use for running the &ldquo;head&rdquo; actor, which handles supervision, death watch and router management messages
scala.Option<Props>	routingLogicController(RoutingLogic routingLogic) Deprecated. Possibility to define an actor for controlling the routing logic from external stimuli (e.g.
static boolean	stopRouterWhenAllRouteesRemoved() Deprecated.
static void	verifyConfig(ActorPath path) Deprecated.
AdaptiveLoadBalancingGroup	withDispatcher(java.lang.String dispatcherId) Deprecated. Setting the dispatcher to be used for the router head actor, which handles router management messages
static RouterConfig	withFallback(RouterConfig other) Deprecated.

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

isManagementMessage, stopRouterWhenAllRouteesRemoved, verifyConfig, withFallback

Methods inherited from interface scala.Product

$init$, productArity, productElement, productIterator, productPrefix

Methods inherited from interface scala.Equals

canEqual, equals

Constructor Detail

AdaptiveLoadBalancingGroup

public AdaptiveLoadBalancingGroup(MetricsSelector metricsSelector,
                                  scala.collection.immutable.Iterable<java.lang.String> paths,
                                  java.lang.String routerDispatcher)

Deprecated.

AdaptiveLoadBalancingGroup

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

Deprecated.

AdaptiveLoadBalancingGroup

public AdaptiveLoadBalancingGroup(MetricsSelector metricsSelector,
                                  java.lang.Iterable<java.lang.String> routeesPaths)

Deprecated.

Java API

Parameters:

metricsSelector - decides what probability to use for selecting a routee, based on remaining capacity as indicated by the node metrics

routeesPaths - string representation of the actor paths of the routees, messages are sent with ActorSelection to these paths

Method Detail

isManagementMessage

public static boolean isManagementMessage(java.lang.Object msg)

Deprecated.

stopRouterWhenAllRouteesRemoved

public static boolean stopRouterWhenAllRouteesRemoved()

Deprecated.

withFallback

public static RouterConfig withFallback(RouterConfig other)

Deprecated.

verifyConfig

public static void verifyConfig(ActorPath path)

Deprecated.

props

public static Props props()

Deprecated.

routeeFor

public static Routee routeeFor(java.lang.String path,
                               ActorContext context)

Deprecated.

createRouterActor

public static RouterActor createRouterActor()

Deprecated.

canEqual

public abstract static boolean canEqual(java.lang.Object that)

Deprecated.

equals

public abstract static boolean equals(java.lang.Object that)

Deprecated.

productElement

public abstract static java.lang.Object productElement(int n)

Deprecated.

productArity

public abstract static int productArity()

Deprecated.

productIterator

public static scala.collection.Iterator<java.lang.Object> productIterator()

Deprecated.

productPrefix

public static java.lang.String productPrefix()

Deprecated.

metricsSelector

public MetricsSelector metricsSelector()

Deprecated.

paths

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

Deprecated.

Specified by:

paths in interface Group

routerDispatcher

public java.lang.String routerDispatcher()

Deprecated.

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

Returns:

(undocumented)

paths

public scala.collection.immutable.Iterable<java.lang.String> paths(ActorSystem system)

Deprecated.

Specified by:

paths in interface Group

createRouter

public Router createRouter(ActorSystem system)

Deprecated.

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

Returns:

(undocumented)

routingLogicController

public scala.Option<Props> routingLogicController(RoutingLogic routingLogic)

Deprecated.

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. Management messages not handled by the "head" actor are delegated to this controller actor.

Specified by:

routingLogicController in interface RouterConfig

Parameters:

routingLogic - (undocumented)

Returns:

(undocumented)

withDispatcher

public AdaptiveLoadBalancingGroup withDispatcher(java.lang.String dispatcherId)

Deprecated.

Setting the dispatcher to be used for the router head actor, which handles router management messages

Parameters:

dispatcherId - (undocumented)

Returns:

(undocumented)