akka.cluster.routing

AdaptiveLoadBalancingGroup

final case class AdaptiveLoadBalancingGroup(metricsSelector: MetricsSelector = MixMetricsSelector, paths: Iterable[String] = immutable.this.Nil, routerDispatcher: String = ...) extends Group with Product with Serializable

A router group 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 paths during instantiation they will be ignored if the router is defined in the configuration file for the actor being used.

metricsSelector

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

paths

string representation of the actor paths of the routees, messages are sent with akka.actor.ActorSelection to these paths

routerDispatcher

dispatcher to use for the router head actor, which handles 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. AdaptiveLoadBalancingGroup
  2. Product
  3. Equals
  4. Group
  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 AdaptiveLoadBalancingGroup(metricsSelector: MetricsSelector, routeesPaths: Iterable[String])

    Java API

    Java API

    metricsSelector

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

    routeesPaths

    string representation of the actor paths of the routees, messages are sent with akka.actor.ActorSelection to these paths

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

  3. new AdaptiveLoadBalancingGroup(metricsSelector: MetricsSelector = MixMetricsSelector, paths: Iterable[String] = immutable.this.Nil, routerDispatcher: String = ...)

    metricsSelector

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

    paths

    string representation of the actor paths of the routees, messages are sent with akka.actor.ActorSelection to these paths

    routerDispatcher

    dispatcher to use for the router head actor, which handles 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 AdaptiveLoadBalancingGroup to StringAdd performed by method any2stringadd in scala.Predef.
    Definition Classes
    StringAdd
  5. def ->[B](y: B): (AdaptiveLoadBalancingGroup, B)

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

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

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

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

    Implicit information
    This member is added by an implicit conversion from AdaptiveLoadBalancingGroup to Ensuring[AdaptiveLoadBalancingGroup] 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 AdaptiveLoadBalancingGroup 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 paths: Iterable[String]

    string representation of the actor paths of the routees, messages are sent with akka.actor.ActorSelection to these paths

    string representation of the actor paths of the routees, messages are sent with akka.actor.ActorSelection to these paths

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

    dispatcher to use for the router head actor, which handles router management messages

    dispatcher to use for the router head actor, which handles router management messages

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

    Definition Classes
    RouterConfig
  30. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  31. 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
  32. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  35. def withDispatcher(dispatcherId: String): AdaptiveLoadBalancingGroup

    Setting the dispatcher to be used for the router head actor, which handles router management messages

  36. def withFallback(other: RouterConfig): RouterConfig

    Overridable merge strategy, by default completely prefers this (i.

    Overridable merge strategy, by default completely prefers this (i.e. no merge).

    Definition Classes
    RouterConfig
  37. def [B](y: B): (AdaptiveLoadBalancingGroup, B)

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

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

Deprecated Value Members

  1. def x: AdaptiveLoadBalancingGroup

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

    (Since version 2.10.0) Use leftOfArrow instead

  2. def x: AdaptiveLoadBalancingGroup

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

    (Since version 2.10.0) Use resultOfEnsuring instead

Inherited from Product

Inherited from Equals

Inherited from Group

Inherited from RouterConfig

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from AdaptiveLoadBalancingGroup to StringAdd

Inherited by implicit conversion any2stringfmt from AdaptiveLoadBalancingGroup to StringFormat

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

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

Ungrouped