akka.cluster.routing

AdaptiveLoadBalancingPool

final case class AdaptiveLoadBalancingPool(metricsSelector: MetricsSelector = MixMetricsSelector, nrOfInstances: Int = 0, supervisorStrategy: SupervisorStrategy = ..., routerDispatcher: String = ..., usePoolDispatcher: Boolean = false) extends Pool with Product with Serializable

A router pool 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 nrOfInstances 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

nrOfInstances

initial number of routees in the pool

supervisorStrategy

strategy for supervising the routees, see 'Supervision Setup'

routerDispatcher

dispatcher to use for the router head actor, which handles supervision, death watch and router management messages

Annotations
@SerialVersionUID( 1L )
Source
AdaptiveLoadBalancing.scala
Linear Supertypes
Type Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. AdaptiveLoadBalancingPool
  2. Product
  3. Equals
  4. Pool
  5. RouterConfig
  6. Serializable
  7. Serializable
  8. AnyRef
  9. 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 AdaptiveLoadBalancingPool(metricsSelector: MetricsSelector, nr: Int)

    Java API

    Java API

    metricsSelector

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

    nr

    initial number of routees in the pool

  2. new AdaptiveLoadBalancingPool(config: Config, dynamicAccess: DynamicAccess)

  3. new AdaptiveLoadBalancingPool(metricsSelector: MetricsSelector = MixMetricsSelector, nrOfInstances: Int = 0, supervisorStrategy: SupervisorStrategy = ..., routerDispatcher: String = ..., usePoolDispatcher: Boolean = false)

    metricsSelector

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

    nrOfInstances

    initial number of routees in the pool

    supervisorStrategy

    strategy for supervising the routees, see 'Supervision Setup'

    routerDispatcher

    dispatcher to use for the router head actor, which handles supervision, death watch and router management messages

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 AdaptiveLoadBalancingPool to StringAdd performed by method any2stringadd in scala.Predef.
    Definition Classes
    StringAdd
  5. def ->[B](y: B): (AdaptiveLoadBalancingPool, B)

    Implicit information
    This member is added by an implicit conversion from AdaptiveLoadBalancingPool to ArrowAssoc[AdaptiveLoadBalancingPool] 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
    AdaptiveLoadBalancingPoolRouterConfig
  11. def ensuring(cond: (AdaptiveLoadBalancingPool) ⇒ Boolean, msg: ⇒ Any): AdaptiveLoadBalancingPool

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

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

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

    Implicit information
    This member is added by an implicit conversion from AdaptiveLoadBalancingPool to Ensuring[AdaptiveLoadBalancingPool] 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 AdaptiveLoadBalancingPool 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 routees in the pool

    initial number of routees in the pool

    Definition Classes
    AdaptiveLoadBalancingPoolPool
  26. 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
  27. def 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
    AdaptiveLoadBalancingPoolPool
  28. val routerDispatcher: String

    dispatcher to use for the router head actor, which handles supervision, death watch and router management messages

    dispatcher to use for the router head actor, which handles supervision, death watch and router management messages

    Definition Classes
    AdaptiveLoadBalancingPoolRouterConfig
  29. 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
    AdaptiveLoadBalancingPoolRouterConfig
  30. def stopRouterWhenAllRouteesRemoved: Boolean

    Definition Classes
    PoolRouterConfig
  31. val supervisorStrategy: SupervisorStrategy

    strategy for supervising the routees, see 'Supervision Setup'

    strategy for supervising the routees, see 'Supervision Setup'

    Definition Classes
    AdaptiveLoadBalancingPoolPool
  32. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  33. val 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
    AdaptiveLoadBalancingPoolPool
  34. 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
  35. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  38. def withDispatcher(dispatcherId: String): AdaptiveLoadBalancingPool

    Setting the dispatcher to be used for the router head actor, which handles supervision, death watch and router management messages.

  39. def withFallback(other: RouterConfig): RouterConfig

    Uses the supervisor strategy of the given Routerconfig if this RouterConfig doesn't have one

    Uses the supervisor strategy of the given Routerconfig if this RouterConfig doesn't have one

    Definition Classes
    AdaptiveLoadBalancingPoolRouterConfig
  40. def withSupervisorStrategy(strategy: SupervisorStrategy): AdaptiveLoadBalancingPool

    Setting the supervisor strategy to be used for the “head” Router actor.

  41. def [B](y: B): (AdaptiveLoadBalancingPool, B)

    Implicit information
    This member is added by an implicit conversion from AdaptiveLoadBalancingPool to ArrowAssoc[AdaptiveLoadBalancingPool] 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 AdaptiveLoadBalancingPool 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:
    (adaptiveLoadBalancingPool: StringAdd).self
    Definition Classes
    StringAdd
  2. val self: Any

    Implicit information
    This member is added by an implicit conversion from AdaptiveLoadBalancingPool 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:
    (adaptiveLoadBalancingPool: StringFormat).self
    Definition Classes
    StringFormat

Deprecated Value Members

  1. def x: AdaptiveLoadBalancingPool

    Implicit information
    This member is added by an implicit conversion from AdaptiveLoadBalancingPool to ArrowAssoc[AdaptiveLoadBalancingPool] 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:
    (adaptiveLoadBalancingPool: ArrowAssoc[AdaptiveLoadBalancingPool]).x
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use leftOfArrow instead

  2. def x: AdaptiveLoadBalancingPool

    Implicit information
    This member is added by an implicit conversion from AdaptiveLoadBalancingPool to Ensuring[AdaptiveLoadBalancingPool] 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:
    (adaptiveLoadBalancingPool: Ensuring[AdaptiveLoadBalancingPool]).x
    Definition Classes
    Ensuring
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use resultOfEnsuring instead

Inherited from Product

Inherited from Equals

Inherited from Pool

Inherited from RouterConfig

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from AdaptiveLoadBalancingPool to StringAdd

Inherited by implicit conversion any2stringfmt from AdaptiveLoadBalancingPool to StringFormat

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

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

Ungrouped