final case class AdaptiveLoadBalancingGroup(metricsSelector: MetricsSelector = MixMetricsSelector, paths: Iterable[String] = Nil, routerDispatcher: String = Dispatchers.DefaultDispatcherId) 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()
- Source
- ClusterMetricsRouting.scala
Linear Supertypes
Type Hierarchy
Ordering
- Alphabetic
- By Inheritance
Inherited
- AdaptiveLoadBalancingGroup
- Product
- Equals
- Group
- RouterConfig
- Serializable
- Serializable
- AnyRef
- Any
Implicitly
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
Visibility
- Public
- All
Instance Constructors
-
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
- new AdaptiveLoadBalancingGroup(config: Config, dynamicAccess: DynamicAccess)
-
new
AdaptiveLoadBalancingGroup(metricsSelector: MetricsSelector = MixMetricsSelector, paths: Iterable[String] = Nil, routerDispatcher: String = Dispatchers.DefaultDispatcherId)
- 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
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
def
+(other: String): String
- Implicit
- This member is added by an implicit conversion from AdaptiveLoadBalancingGroup to any2stringadd[AdaptiveLoadBalancingGroup] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
-
def
->[B](y: B): (AdaptiveLoadBalancingGroup, B)
- Implicit
- This member is added by an implicit conversion from AdaptiveLoadBalancingGroup to ArrowAssoc[AdaptiveLoadBalancingGroup] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @inline()
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate() @throws( ... )
-
def
createRouter(system: ActorSystem): Router
- Definition Classes
- AdaptiveLoadBalancingGroup → RouterConfig
-
def
ensuring(cond: (AdaptiveLoadBalancingGroup) ⇒ Boolean, msg: ⇒ Any): AdaptiveLoadBalancingGroup
- Implicit
- This member is added by an implicit conversion from AdaptiveLoadBalancingGroup to Ensuring[AdaptiveLoadBalancingGroup] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: (AdaptiveLoadBalancingGroup) ⇒ Boolean): AdaptiveLoadBalancingGroup
- Implicit
- This member is added by an implicit conversion from AdaptiveLoadBalancingGroup to Ensuring[AdaptiveLoadBalancingGroup] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: Boolean, msg: ⇒ Any): AdaptiveLoadBalancingGroup
- Implicit
- This member is added by an implicit conversion from AdaptiveLoadBalancingGroup to Ensuring[AdaptiveLoadBalancingGroup] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: Boolean): AdaptiveLoadBalancingGroup
- Implicit
- This member is added by an implicit conversion from AdaptiveLoadBalancingGroup to Ensuring[AdaptiveLoadBalancingGroup] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from AdaptiveLoadBalancingGroup to StringFormat[AdaptiveLoadBalancingGroup] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @inline()
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
def
isManagementMessage(msg: Any): Boolean
- Definition Classes
- RouterConfig
- val metricsSelector: MetricsSelector
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
def
paths(system: ActorSystem): Iterable[String]
- Definition Classes
- AdaptiveLoadBalancingGroup → Group
- val paths: Iterable[String]
-
def
props(): Props
- Definition Classes
- Group
-
val
routerDispatcher: String
- Definition Classes
- AdaptiveLoadBalancingGroup → RouterConfig
-
def
routingLogicController(routingLogic: RoutingLogic): Option[Props]
- Definition Classes
- AdaptiveLoadBalancingGroup → RouterConfig
-
def
stopRouterWhenAllRouteesRemoved: Boolean
- Definition Classes
- RouterConfig
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
verifyConfig(path: ActorPath): Unit
- Definition Classes
- RouterConfig
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
def
withDispatcher(dispatcherId: String): AdaptiveLoadBalancingGroup
Setting the dispatcher to be used for the router head actor, which handles router management messages
-
def
withFallback(other: RouterConfig): RouterConfig
- Definition Classes
- RouterConfig
-
def
→[B](y: B): (AdaptiveLoadBalancingGroup, B)
- Implicit
- This member is added by an implicit conversion from AdaptiveLoadBalancingGroup to ArrowAssoc[AdaptiveLoadBalancingGroup] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc