Class

akka.cluster.metrics

AdaptiveLoadBalancingPool

Related Doc: package metrics

Permalink

final case class AdaptiveLoadBalancingPool(metricsSelector: MetricsSelector = MixMetricsSelector, nrOfInstances: Int = 0, supervisorStrategy: SupervisorStrategy = Pool.defaultSupervisorStrategy, routerDispatcher: String = Dispatchers.DefaultDispatcherId, 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()
Source
ClusterMetricsRouting.scala
Linear Supertypes
Type Hierarchy
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 StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new AdaptiveLoadBalancingPool(metricsSelector: MetricsSelector, nr: Int)

    Permalink

    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)

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

    Permalink

    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: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

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

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  7. def clone(): AnyRef

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

    Permalink
    Definition Classes
    AdaptiveLoadBalancingPool → RouterConfig
  9. def ensuring(cond: (AdaptiveLoadBalancingPool) ⇒ Boolean, msg: ⇒ Any): AdaptiveLoadBalancingPool

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

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

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

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

    Permalink
    Definition Classes
    AnyRef
  14. def finalize(): Unit

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

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

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

    Permalink
    Definition Classes
    Any
  18. def isManagementMessage(msg: Any): Boolean

    Permalink
    Definition Classes
    RouterConfig
  19. val metricsSelector: MetricsSelector

    Permalink

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

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

    Permalink
    Definition Classes
    AnyRef
  21. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  22. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  23. def nrOfInstances(sys: ActorSystem): Int

    Permalink
    Definition Classes
    AdaptiveLoadBalancingPool → Pool
  24. val nrOfInstances: Int

    Permalink

    initial number of routees in the pool

  25. def props(routeeProps: Props): Props

    Permalink
    Definition Classes
    Pool
  26. def resizer: Option[Resizer]

    Permalink
    Definition Classes
    AdaptiveLoadBalancingPool → Pool
  27. val routerDispatcher: String

    Permalink

    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
    AdaptiveLoadBalancingPool → RouterConfig
  28. def routingLogicController(routingLogic: RoutingLogic): Option[Props]

    Permalink
    Definition Classes
    AdaptiveLoadBalancingPool → RouterConfig
  29. def stopRouterWhenAllRouteesRemoved: Boolean

    Permalink
    Definition Classes
    Pool → RouterConfig
  30. val supervisorStrategy: SupervisorStrategy

    Permalink

    strategy for supervising the routees, see 'Supervision Setup'

    strategy for supervising the routees, see 'Supervision Setup'

    Definition Classes
    AdaptiveLoadBalancingPool → Pool
  31. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  32. val usePoolDispatcher: Boolean

    Permalink
    Definition Classes
    AdaptiveLoadBalancingPool → Pool
  33. def verifyConfig(path: ActorPath): Unit

    Permalink
    Definition Classes
    RouterConfig
  34. final def wait(): Unit

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

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

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

    Permalink

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

  38. def withFallback(other: RouterConfig): RouterConfig

    Permalink

    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
    AdaptiveLoadBalancingPool → RouterConfig
  39. def withSupervisorStrategy(strategy: SupervisorStrategy): AdaptiveLoadBalancingPool

    Permalink

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

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

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

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 any2stringadd[AdaptiveLoadBalancingPool]

Inherited by implicit conversion StringFormat from AdaptiveLoadBalancingPool to StringFormat[AdaptiveLoadBalancingPool]

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

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

Ungrouped