akka.cluster.routing

AdaptiveLoadBalancingRouter

case class AdaptiveLoadBalancingRouter(metricsSelector: MetricsSelector = MixMetricsSelector, nrOfInstances: Int = 0, routees: Iterable[String] = immutable.this.Nil, resizer: Option[Resizer] = scala.None, routerDispatcher: String = ..., supervisorStrategy: SupervisorStrategy = ...) extends DeprecatedRouterConfig with PoolOverrideUnsetConfig[AdaptiveLoadBalancingRouter] with Product with 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. 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.

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 ) @deprecated
Deprecated

(Since version 2.3) Use AdaptiveLoadBalancingPool or AdaptiveLoadBalancingGroup

Source
AdaptiveLoadBalancing.scala
Linear Supertypes
Type Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. AdaptiveLoadBalancingRouter
  2. Product
  3. Equals
  4. PoolOverrideUnsetConfig
  5. DeprecatedRouterConfig
  6. Pool
  7. Group
  8. RouterConfig
  9. Serializable
  10. Serializable
  11. AnyRef
  12. Any
Implicitly
  1. by any2stringadd
  2. by any2stringfmt
  3. by any2ArrowAssoc
  4. by any2Ensuring
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

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

  2. new AdaptiveLoadBalancingRouter(selector: MetricsSelector, routeesPaths: 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

    routeesPaths

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

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

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

  1. final def !=(arg0: AnyRef): Boolean

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

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. def +(other: String): String

    Implicit information
    This member is added by an implicit conversion from AdaptiveLoadBalancingRouter to StringAdd performed by method any2stringadd in scala.Predef.
    Definition Classes
    StringAdd
  5. def ->[B](y: B): (AdaptiveLoadBalancingRouter, B)

    Implicit information
    This member is added by an implicit conversion from AdaptiveLoadBalancingRouter to ArrowAssoc[AdaptiveLoadBalancingRouter] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  6. final def ==(arg0: AnyRef): Boolean

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

    Definition Classes
    Any
  8. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  9. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  10. def createRouter(system: ActorSystem): Router

    Create the actual router, responsible for routing messages to routees.

    Create the actual router, responsible for routing messages to routees.

    system

    the ActorSystem this router belongs to

    Definition Classes
    AdaptiveLoadBalancingRouterRouterConfig
  11. def ensuring(cond: (AdaptiveLoadBalancingRouter) ⇒ Boolean, msg: ⇒ Any): AdaptiveLoadBalancingRouter

    Implicit information
    This member is added by an implicit conversion from AdaptiveLoadBalancingRouter to Ensuring[AdaptiveLoadBalancingRouter] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: (AdaptiveLoadBalancingRouter) ⇒ Boolean): AdaptiveLoadBalancingRouter

    Implicit information
    This member is added by an implicit conversion from AdaptiveLoadBalancingRouter to Ensuring[AdaptiveLoadBalancingRouter] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: Boolean, msg: ⇒ Any): AdaptiveLoadBalancingRouter

    Implicit information
    This member is added by an implicit conversion from AdaptiveLoadBalancingRouter to Ensuring[AdaptiveLoadBalancingRouter] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: Boolean): AdaptiveLoadBalancingRouter

    Implicit information
    This member is added by an implicit conversion from AdaptiveLoadBalancingRouter to Ensuring[AdaptiveLoadBalancingRouter] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  16. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  17. def formatted(fmtstr: String): String

    Implicit information
    This member is added by an implicit conversion from AdaptiveLoadBalancingRouter to StringFormat performed by method any2stringfmt in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  18. final def getClass(): Class[_]

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

    Definition Classes
    Any
  20. def isManagementMessage(msg: Any): Boolean

    Is the message handled by the router head actor or the #routingLogicController actor.

    Is the message handled by the router head actor or the #routingLogicController actor.

    Definition Classes
    RouterConfig
  21. val metricsSelector: MetricsSelector

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

  22. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  23. final def notify(): Unit

    Definition Classes
    AnyRef
  24. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  25. val nrOfInstances: Int

    Initial number of routee instances

    Initial number of routee instances

    Definition Classes
    AdaptiveLoadBalancingRouterPool
  26. final def overrideUnsetConfig(other: RouterConfig): RouterConfig

    Definition Classes
    PoolOverrideUnsetConfig
  27. def paths: Iterable[String]

    Definition Classes
    AdaptiveLoadBalancingRouterGroup
  28. def props(routeeProps: Props): Props

    akka.actor.Props for a pool router based on the settings defined by this instance and the supplied akka.actor.Props for the routees created by the router.

    akka.actor.Props for a pool router based on the settings defined by this instance and the supplied akka.actor.Props for the routees created by the router.

    Definition Classes
    Pool
  29. def props(): Props

    akka.actor.Props for a group router based on the settings defined by this instance.

    akka.actor.Props for a group router based on the settings defined by this instance.

    Definition Classes
    Group
  30. val resizer: Option[Resizer]

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

    Pool with dynamically resizable number of routees return the akka.routing.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.

    Definition Classes
    AdaptiveLoadBalancingRouterPool
  31. val routees: Iterable[String]

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

  32. val routerDispatcher: String

    Dispatcher ID to use for running the “head” actor, which handles supervision, death watch and router management messages

    Dispatcher ID to use for running the “head” actor, which handles supervision, death watch and router management messages

    Definition Classes
    AdaptiveLoadBalancingRouterRouterConfig
  33. def routingLogicController(routingLogic: RoutingLogic): Option[Props]

    Possibility to define an actor for controlling the routing logic from external stimuli (e.

    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.

    Definition Classes
    AdaptiveLoadBalancingRouterRouterConfig
  34. def stopRouterWhenAllRouteesRemoved: Boolean

    Definition Classes
    PoolRouterConfig
  35. val supervisorStrategy: SupervisorStrategy

    SupervisorStrategy for the head actor, i.

    SupervisorStrategy for the head actor, i.e. for supervising the routees of the pool.

    Definition Classes
    AdaptiveLoadBalancingRouterPool
  36. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  37. def usePoolDispatcher: Boolean

    Use a dedicated dispatcher for the routees of the 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.

    Definition Classes
    Pool
  38. def verifyConfig(path: ActorPath): 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
  39. final def wait(): Unit

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

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

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

    Java API for setting routerDispatcher

  43. def withFallback(other: RouterConfig): RouterConfig

    Uses the resizer and/or the supervisor strategy of the given Routerconfig if this RouterConfig doesn't have one, i.

    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.

    Definition Classes
    AdaptiveLoadBalancingRouterRouterConfig
  44. def withResizer(resizer: Resizer): AdaptiveLoadBalancingRouter

    Java API for setting the resizer to be used.

    Java API for setting the resizer to be used.

    Definition Classes
    AdaptiveLoadBalancingRouter → PoolOverrideUnsetConfig
  45. def withSupervisorStrategy(strategy: SupervisorStrategy): AdaptiveLoadBalancingRouter

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

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

    Definition Classes
    AdaptiveLoadBalancingRouter → PoolOverrideUnsetConfig
  46. def [B](y: B): (AdaptiveLoadBalancingRouter, B)

    Implicit information
    This member is added by an implicit conversion from AdaptiveLoadBalancingRouter to ArrowAssoc[AdaptiveLoadBalancingRouter] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Shadowed Implicit Value Members

  1. val self: Any

    Implicit information
    This member is added by an implicit conversion from AdaptiveLoadBalancingRouter to StringAdd performed by method any2stringadd in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (adaptiveLoadBalancingRouter: StringAdd).self
    Definition Classes
    StringAdd
  2. val self: Any

    Implicit information
    This member is added by an implicit conversion from AdaptiveLoadBalancingRouter to StringFormat performed by method any2stringfmt in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (adaptiveLoadBalancingRouter: StringFormat).self
    Definition Classes
    StringFormat

Deprecated Value Members

  1. def x: AdaptiveLoadBalancingRouter

    Implicit information
    This member is added by an implicit conversion from AdaptiveLoadBalancingRouter to ArrowAssoc[AdaptiveLoadBalancingRouter] performed by method any2ArrowAssoc in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (adaptiveLoadBalancingRouter: ArrowAssoc[AdaptiveLoadBalancingRouter]).x
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use leftOfArrow instead

  2. def x: AdaptiveLoadBalancingRouter

    Implicit information
    This member is added by an implicit conversion from AdaptiveLoadBalancingRouter to Ensuring[AdaptiveLoadBalancingRouter] performed by method any2Ensuring in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (adaptiveLoadBalancingRouter: Ensuring[AdaptiveLoadBalancingRouter]).x
    Definition Classes
    Ensuring
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use resultOfEnsuring instead

Inherited from Product

Inherited from Equals

Inherited from PoolOverrideUnsetConfig[AdaptiveLoadBalancingRouter]

Inherited from DeprecatedRouterConfig

Inherited from Pool

Inherited from Group

Inherited from RouterConfig

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from AdaptiveLoadBalancingRouter to StringAdd

Inherited by implicit conversion any2stringfmt from AdaptiveLoadBalancingRouter to StringFormat

Inherited by implicit conversion any2ArrowAssoc from AdaptiveLoadBalancingRouter to ArrowAssoc[AdaptiveLoadBalancingRouter]

Inherited by implicit conversion any2Ensuring from AdaptiveLoadBalancingRouter to Ensuring[AdaptiveLoadBalancingRouter]

Ungrouped