AdaptiveLoadBalancingRouter

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.

metricsSelector: decides what probability to use for selecting a routee, based on remaining capacity as indicated by the node metrics
routees: string representation of the actor paths of the routees that will be looked up using actorFor in akka.actor.ActorRefProvider

Annotations: @SerialVersionUID( 1L )

Linear Supertypes

Serializable, Serializable, Product, Equals, AdaptiveLoadBalancingRouterLike, RouterConfig, AnyRef, Any

Instance Constructors

new AdaptiveLoadBalancingRouter(selector: MetricsSelector, resizer: Resizer)

Java API: Constructor that sets the resizer to be used.
Java API: Constructor that sets the resizer to be used.
selector
the selector is responsible for producing weighted mix of routees from the node metrics
new AdaptiveLoadBalancingRouter(selector: MetricsSelector, routeePaths: Iterable[String])

Java API: Constructor that sets the routees to be used.
Java API: Constructor that sets the routees to be used.
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 akka.actor.ActorRefProvider
new AdaptiveLoadBalancingRouter(selector: MetricsSelector, nr: Int)

Java API: Constructor that sets nrOfInstances to be created.
Java API: Constructor that sets nrOfInstances to be created.
selector
the selector is responsible for producing weighted mix of routees from the node metrics
nr
number of routees to create
new AdaptiveLoadBalancingRouter(metricsSelector: MetricsSelector = MixMetricsSelector, nrOfInstances: Int = 0, routees: Iterable[String] = immutable.this.Nil, resizer: Option[Resizer] = scala.None, routerDispatcher: String = ..., supervisorStrategy: SupervisorStrategy = ...)

metricsSelector
decides what probability to use for selecting a routee, based on remaining capacity as indicated by the node metrics
routees
string representation of the actor paths of the routees that will be looked up using actorFor in akka.actor.ActorRefProvider

Value Members

final def !=(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def !=(arg0: Any): Boolean

Definition Classes
Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def ==(arg0: Any): Boolean

Definition Classes
Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws()
def createActor(): Router

The router "head" actor.
The router "head" actor.

Definition Classes
RouterConfig
def createRoute(routeeProvider: RouteeProvider): Route

Definition Classes
AdaptiveLoadBalancingRouterLike
def createRouteeProvider(context: ActorContext, routeeProps: Props): RouteeProvider

The RouteeProvider responsible for creating or looking up routees.
The RouteeProvider responsible for creating or looking up routees. It's used in createRoute to register routees, and also from akka.routing.Resizer.

Definition Classes
RouterConfig
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws()
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
val metricsSelector: MetricsSelector

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

Definition Classes
AdaptiveLoadBalancingRouter → AdaptiveLoadBalancingRouterLike
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val nrOfInstances: Int

Definition Classes
AdaptiveLoadBalancingRouter → AdaptiveLoadBalancingRouterLike
val resizer: Option[Resizer]

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

Definition Classes
AdaptiveLoadBalancingRouter → RouterConfig
val routees: Iterable[String]

string representation of the actor paths of the routees that will be looked up using actorFor in akka.actor.ActorRefProvider
string representation of the actor paths of the routees that will be looked up using actorFor in akka.actor.ActorRefProvider

Definition Classes
AdaptiveLoadBalancingRouter → AdaptiveLoadBalancingRouterLike
val routerDispatcher: String

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

Definition Classes
AdaptiveLoadBalancingRouter → AdaptiveLoadBalancingRouterLike → RouterConfig
val supervisorStrategy: SupervisorStrategy

SupervisorStrategy for the created Router actor.
SupervisorStrategy for the created Router actor.

Definition Classes
AdaptiveLoadBalancingRouter → RouterConfig
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toAll(sender: ActorRef, routees: Iterable[ActorRef]): Iterable[Destination]

Attributes
protected
Definition Classes
RouterConfig
def verifyConfig(): Unit

Check that everything is there which is needed.
Check that everything is there which is needed. Called in constructor of RoutedActorRef to fail early.

Definition Classes
RouterConfig
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws()
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws()
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws()
def withDispatcher(dispatcherId: String): AdaptiveLoadBalancingRouter

Java API for setting routerDispatcher
def withFallback(other: RouterConfig): RouterConfig

Uses the resizer of the given RouterConfig if this RouterConfig doesn't have one, i.
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.

Definition Classes
AdaptiveLoadBalancingRouter → RouterConfig
def withSupervisorStrategy(strategy: SupervisorStrategy): AdaptiveLoadBalancingRouter

Java API for setting the supervisor strategy to be used for the “head” Router actor.

Instance Constructors

new AdaptiveLoadBalancingRouter(selector: MetricsSelector, resizer: Resizer)

new AdaptiveLoadBalancingRouter(selector: MetricsSelector, routeePaths: Iterable[String])

new AdaptiveLoadBalancingRouter(selector: MetricsSelector, nr: Int)

new AdaptiveLoadBalancingRouter(metricsSelector: MetricsSelector = MixMetricsSelector, nrOfInstances: Int = 0, routees: Iterable[String] = immutable.this.Nil, resizer: Option[Resizer] = scala.None, routerDispatcher: String = ..., supervisorStrategy: SupervisorStrategy = ...)

Value Members

final def !=(arg0: AnyRef): Boolean

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: AnyRef): Boolean

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

def createActor(): Router

def createRoute(routeeProvider: RouteeProvider): Route

def createRouteeProvider(context: ActorContext, routeeProps: Props): RouteeProvider

final def eq(arg0: AnyRef): Boolean

def finalize(): Unit

final def getClass(): Class[_]

final def isInstanceOf[T0]: Boolean

val metricsSelector: MetricsSelector

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val nrOfInstances: Int

val resizer: Option[Resizer]

val routees: Iterable[String]

val routerDispatcher: String

val supervisorStrategy: SupervisorStrategy

final def synchronized[T0](arg0: ⇒ T0): T0

def toAll(sender: ActorRef, routees: Iterable[ActorRef]): Iterable[Destination]

def verifyConfig(): Unit

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

def withDispatcher(dispatcherId: String): AdaptiveLoadBalancingRouter

def withFallback(other: RouterConfig): RouterConfig

def withSupervisorStrategy(strategy: SupervisorStrategy): AdaptiveLoadBalancingRouter

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AdaptiveLoadBalancingRouterLike

Inherited from RouterConfig

Inherited from AnyRef

Inherited from Any

Ungrouped