c

akka.cluster.metrics

AdaptiveLoadBalancingRoutingLogic

final case class AdaptiveLoadBalancingRoutingLogic(system: ActorSystem, metricsSelector: MetricsSelector = MixMetricsSelector) extends RoutingLogic with NoSerializationVerificationNeeded with Product with Serializable

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.

system

the actor system hosting this router

metricsSelector

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

Source
ClusterMetricsRouting.scala
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. AdaptiveLoadBalancingRoutingLogic
  2. Serializable
  3. Product
  4. Equals
  5. RoutingLogic
  6. NoSerializationVerificationNeeded
  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. Protected

Instance Constructors

  1. new AdaptiveLoadBalancingRoutingLogic(system: ActorSystem, metricsSelector: MetricsSelector = MixMetricsSelector)

    system

    the actor system hosting this router

    metricsSelector

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

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 AdaptiveLoadBalancingRoutingLogic toany2stringadd[AdaptiveLoadBalancingRoutingLogic] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (AdaptiveLoadBalancingRoutingLogic, B)
    Implicit
    This member is added by an implicit conversion from AdaptiveLoadBalancingRoutingLogic toArrowAssoc[AdaptiveLoadBalancingRoutingLogic] 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[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  8. def ensuring(cond: (AdaptiveLoadBalancingRoutingLogic) => Boolean, msg: => Any): AdaptiveLoadBalancingRoutingLogic
    Implicit
    This member is added by an implicit conversion from AdaptiveLoadBalancingRoutingLogic toEnsuring[AdaptiveLoadBalancingRoutingLogic] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (AdaptiveLoadBalancingRoutingLogic) => Boolean): AdaptiveLoadBalancingRoutingLogic
    Implicit
    This member is added by an implicit conversion from AdaptiveLoadBalancingRoutingLogic toEnsuring[AdaptiveLoadBalancingRoutingLogic] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: => Any): AdaptiveLoadBalancingRoutingLogic
    Implicit
    This member is added by an implicit conversion from AdaptiveLoadBalancingRoutingLogic toEnsuring[AdaptiveLoadBalancingRoutingLogic] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): AdaptiveLoadBalancingRoutingLogic
    Implicit
    This member is added by an implicit conversion from AdaptiveLoadBalancingRoutingLogic toEnsuring[AdaptiveLoadBalancingRoutingLogic] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  14. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  15. final def metricsChanged(event: ClusterMetricsChanged): Unit
    Annotations
    @tailrec()
  16. val metricsSelector: MetricsSelector
  17. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  19. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  20. def productElementNames: Iterator[String]
    Definition Classes
    Product
  21. def select(message: Any, routees: IndexedSeq[Routee]): Routee

    Pick the destination for a given message.

    Pick the destination for a given message. Normally it picks one of the passed routees, but in the end it is up to the implementation to return whatever Routee to use for sending a specific message.

    When implemented from Java it can be good to know that routees.apply(index) can be used to get an element from the IndexedSeq.

    Definition Classes
    AdaptiveLoadBalancingRoutingLogicRoutingLogic
  22. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  23. val system: ActorSystem
  24. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  25. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  26. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated
  2. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from AdaptiveLoadBalancingRoutingLogic toStringFormat[AdaptiveLoadBalancingRoutingLogic] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  3. def [B](y: B): (AdaptiveLoadBalancingRoutingLogic, B)
    Implicit
    This member is added by an implicit conversion from AdaptiveLoadBalancingRoutingLogic toArrowAssoc[AdaptiveLoadBalancingRoutingLogic] 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 Serializable

Inherited from Product

Inherited from Equals

Inherited from RoutingLogic

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromAdaptiveLoadBalancingRoutingLogic to any2stringadd[AdaptiveLoadBalancingRoutingLogic]

Inherited by implicit conversion StringFormat fromAdaptiveLoadBalancingRoutingLogic to StringFormat[AdaptiveLoadBalancingRoutingLogic]

Inherited by implicit conversion Ensuring fromAdaptiveLoadBalancingRoutingLogic to Ensuring[AdaptiveLoadBalancingRoutingLogic]

Inherited by implicit conversion ArrowAssoc fromAdaptiveLoadBalancingRoutingLogic to ArrowAssoc[AdaptiveLoadBalancingRoutingLogic]

Ungrouped