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 )
Linear Supertypes
Product, Equals, Group, RouterConfig, Serializable, Serializable, AnyRef, Any
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
  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. final def ==(arg0: AnyRef): Boolean

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

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

    Definition Classes
    Any
  7. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @throws( ... )
  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
    AdaptiveLoadBalancingGroupRouterConfig
  9. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  10. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate()
  11. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  12. 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
  13. val metricsSelector: MetricsSelector

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

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

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

    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate()
  16. final def notifyAll(): Unit

    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate()
  17. 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
  18. 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
  19. 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
  20. 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
  21. def stopRouterWhenAllRouteesRemoved: Boolean

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

    Definition Classes
    AnyRef
  23. 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
  24. final def wait(arg0: Long, arg1: Int): Unit

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  26. final def wait(): Unit

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

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

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

Deprecated Value Members

  1. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @Deprecated @deprecated @throws( classOf[java.lang.Throwable] )
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

Inherited from Product

Inherited from Equals

Inherited from Group

Inherited from RouterConfig

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped