final case class ConsistentHashingGroup(paths: Iterable[String], virtualNodesFactor: Int = 0, hashMapping: ConsistentHashMapping = ConsistentHashingRouter.emptyConsistentHashMapping, routerDispatcher: String = Dispatchers.DefaultDispatcherId) extends Group with Product with Serializable
A router group that uses consistent hashing to select a routee based on the sent message. The selection is described in akka.routing.ConsistentHashingRoutingLogic.
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.
- paths
string representation of the actor paths of the routees, messages are sent with akka.actor.ActorSelection to these paths
- virtualNodesFactor
number of virtual nodes per node, used in akka.routing.ConsistentHash
- hashMapping
partial function from message to the data to use for the consistent hash key
- routerDispatcher
dispatcher to use for the router head actor, which handles router management messages
- Annotations
- @SerialVersionUID()
- Source
- ConsistentHashing.scala
- Alphabetic
- By Inheritance
- ConsistentHashingGroup
- Product
- Equals
- Group
- RouterConfig
- Serializable
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new ConsistentHashingGroup(routeePaths: Iterable[String])
Java API
Java API
- routeePaths
string representation of the actor paths of the routees, messages are sent with akka.actor.ActorSelection to these paths
- new ConsistentHashingGroup(config: Config)
- new ConsistentHashingGroup(paths: Iterable[String], virtualNodesFactor: Int = 0, hashMapping: ConsistentHashMapping = ConsistentHashingRouter.emptyConsistentHashMapping, routerDispatcher: String = Dispatchers.DefaultDispatcherId)
- paths
string representation of the actor paths of the routees, messages are sent with akka.actor.ActorSelection to these paths
- virtualNodesFactor
number of virtual nodes per node, used in akka.routing.ConsistentHash
- hashMapping
partial function from message to the data to use for the consistent hash key
- 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 ConsistentHashingGroup toany2stringadd[ConsistentHashingGroup] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
- def ->[B](y: B): (ConsistentHashingGroup, B)
- Implicit
- This member is added by an implicit conversion from ConsistentHashingGroup toArrowAssoc[ConsistentHashingGroup] 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[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
- 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
- ConsistentHashingGroup → RouterConfig
- def ensuring(cond: (ConsistentHashingGroup) => Boolean, msg: => Any): ConsistentHashingGroup
- Implicit
- This member is added by an implicit conversion from ConsistentHashingGroup toEnsuring[ConsistentHashingGroup] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: (ConsistentHashingGroup) => Boolean): ConsistentHashingGroup
- Implicit
- This member is added by an implicit conversion from ConsistentHashingGroup toEnsuring[ConsistentHashingGroup] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean, msg: => Any): ConsistentHashingGroup
- Implicit
- This member is added by an implicit conversion from ConsistentHashingGroup toEnsuring[ConsistentHashingGroup] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean): ConsistentHashingGroup
- Implicit
- This member is added by an implicit conversion from ConsistentHashingGroup toEnsuring[ConsistentHashingGroup] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- val hashMapping: ConsistentHashMapping
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- 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
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- def paths(system: ActorSystem): Iterable[String]
- Definition Classes
- ConsistentHashingGroup → Group
- val paths: Iterable[String]
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- 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
- 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
- ConsistentHashingGroup → RouterConfig
- 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
- RouterConfig
- def stopRouterWhenAllRouteesRemoved: Boolean
- Definition Classes
- RouterConfig
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- 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
- val virtualNodesFactor: Int
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- def withDispatcher(dispatcherId: String): ConsistentHashingGroup
Setting the dispatcher to be used for the router head actor, which handles router management messages
- def withFallback(other: RouterConfig): RouterConfig
Uses the
hashMappingdefined in code, since that can't be defined in configuration.Uses the
hashMappingdefined in code, since that can't be defined in configuration.- Definition Classes
- ConsistentHashingGroup → RouterConfig
- def withHashMapper(mapper: ConsistentHashMapper): ConsistentHashingGroup
Java API: Setting the mapping from message to the data to use for the consistent hash key.
- def withVirtualNodesFactor(vnodes: Int): ConsistentHashingGroup
Setting the number of virtual nodes per node, used in akka.routing.ConsistentHash
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
(Since version 9)
- def formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from ConsistentHashingGroup toStringFormat[ConsistentHashingGroup] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @deprecated @inline()
- Deprecated
(Since version 2.12.16) Use
formatString.format(value)instead ofvalue.formatted(formatString), or use thef""string interpolator. In Java 15 and later,formattedresolves to the new method in String which has reversed parameters.
- def →[B](y: B): (ConsistentHashingGroup, B)
- Implicit
- This member is added by an implicit conversion from ConsistentHashingGroup toArrowAssoc[ConsistentHashingGroup] 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.