c

akka.cluster.metrics

AdaptiveLoadBalancingPool

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. AnyRef
  8. 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)

    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 = Pool.defaultSupervisorStrategy, routerDispatcher: String = Dispatchers.DefaultDispatcherId, 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: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from AdaptiveLoadBalancingPool toany2stringadd[AdaptiveLoadBalancingPool] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (AdaptiveLoadBalancingPool, B)
    Implicit
    This member is added by an implicit conversion from AdaptiveLoadBalancingPool toArrowAssoc[AdaptiveLoadBalancingPool] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  8. 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
  9. def ensuring(cond: (AdaptiveLoadBalancingPool) => Boolean, msg: => Any): AdaptiveLoadBalancingPool
    Implicit
    This member is added by an implicit conversion from AdaptiveLoadBalancingPool toEnsuring[AdaptiveLoadBalancingPool] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: (AdaptiveLoadBalancingPool) => Boolean): AdaptiveLoadBalancingPool
    Implicit
    This member is added by an implicit conversion from AdaptiveLoadBalancingPool toEnsuring[AdaptiveLoadBalancingPool] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean, msg: => Any): AdaptiveLoadBalancingPool
    Implicit
    This member is added by an implicit conversion from AdaptiveLoadBalancingPool toEnsuring[AdaptiveLoadBalancingPool] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean): AdaptiveLoadBalancingPool
    Implicit
    This member is added by an implicit conversion from AdaptiveLoadBalancingPool toEnsuring[AdaptiveLoadBalancingPool] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from AdaptiveLoadBalancingPool toStringFormat[AdaptiveLoadBalancingPool] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  15. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  16. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  17. 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
  18. val metricsSelector: MetricsSelector
  19. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  21. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  22. def nrOfInstances(sys: ActorSystem): Int
    Definition Classes
    AdaptiveLoadBalancingPoolPool
  23. val nrOfInstances: Int
  24. def productElementNames: Iterator[String]
    Definition Classes
    Product
  25. 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
  26. 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
  27. 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
    AdaptiveLoadBalancingPoolRouterConfig
  28. def routingLogicController(routingLogic: RoutingLogic): Option[Props]

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

    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.

    Definition Classes
    AdaptiveLoadBalancingPoolRouterConfig
  29. def stopRouterWhenAllRouteesRemoved: Boolean
    Definition Classes
    PoolRouterConfig
  30. val supervisorStrategy: SupervisorStrategy

    SupervisorStrategy for the head actor, i.e.

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

    Definition Classes
    AdaptiveLoadBalancingPoolPool
  31. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  32. 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
  33. 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
  34. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  35. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  36. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  37. 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.

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

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

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated @deprecated
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

  2. def [B](y: B): (AdaptiveLoadBalancingPool, B)
    Implicit
    This member is added by an implicit conversion from AdaptiveLoadBalancingPool toArrowAssoc[AdaptiveLoadBalancingPool] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from Product

Inherited from Equals

Inherited from Pool

Inherited from RouterConfig

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromAdaptiveLoadBalancingPool to any2stringadd[AdaptiveLoadBalancingPool]

Inherited by implicit conversion StringFormat fromAdaptiveLoadBalancingPool to StringFormat[AdaptiveLoadBalancingPool]

Inherited by implicit conversion Ensuring fromAdaptiveLoadBalancingPool to Ensuring[AdaptiveLoadBalancingPool]

Inherited by implicit conversion ArrowAssoc fromAdaptiveLoadBalancingPool to ArrowAssoc[AdaptiveLoadBalancingPool]

Ungrouped