final case class ConsistentHashingPool(nrOfInstances: Int, resizer: Option[Resizer] = None, virtualNodesFactor: Int = 0, hashMapping: ConsistentHashMapping = ConsistentHashingRouter.emptyConsistentHashMapping, supervisorStrategy: SupervisorStrategy = Pool.defaultSupervisorStrategy, routerDispatcher: String = Dispatchers.DefaultDispatcherId, usePoolDispatcher: Boolean = false) extends Pool with PoolOverrideUnsetConfig[ConsistentHashingPool] with Product with Serializable
A router pool 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 nrOfInstances during instantiation they will be ignored if
the router is defined in the configuration file for the actor being used.
Supervision Setup
Any routees that are created by a router will be created as the router's children. The router is therefore also the children's supervisor.
The supervision strategy of the router actor can be configured with #withSupervisorStrategy. If no strategy is provided, routers default to a strategy of “always escalate”. This means that errors are passed up to the router's supervisor for handling.
The router's supervisor will treat the error as an error with the router itself. Therefore a directive to stop or restart will cause the router itself to stop or restart. The router, in turn, will cause its children to stop and restart.
- nrOfInstances
initial number of routees in the pool
- resizer
optional resizer that dynamically adjust the pool size
- 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
- supervisorStrategy
strategy for supervising the routees, see 'Supervision Setup'
- routerDispatcher
dispatcher to use for the router head actor, which handles supervision, death watch and router management messages
- Annotations
- @SerialVersionUID()
- Source
- ConsistentHashing.scala
- Alphabetic
- By Inheritance
- ConsistentHashingPool
- Product
- Equals
- PoolOverrideUnsetConfig
- Pool
- RouterConfig
- Serializable
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new ConsistentHashingPool(nr: Int)
Java API
Java API
- nr
initial number of routees in the pool
- new ConsistentHashingPool(config: Config)
- new ConsistentHashingPool(nrOfInstances: Int, resizer: Option[Resizer] = None, virtualNodesFactor: Int = 0, hashMapping: ConsistentHashMapping = ConsistentHashingRouter.emptyConsistentHashMapping, supervisorStrategy: SupervisorStrategy = Pool.defaultSupervisorStrategy, routerDispatcher: String = Dispatchers.DefaultDispatcherId, usePoolDispatcher: Boolean = false)
- nrOfInstances
initial number of routees in the pool
- resizer
optional resizer that dynamically adjust the pool size
- 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
- supervisorStrategy
strategy for supervising the routees, see 'Supervision Setup'
- routerDispatcher
dispatcher to use for the router head actor, which handles supervision, death watch and 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 ConsistentHashingPool toany2stringadd[ConsistentHashingPool] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
- def ->[B](y: B): (ConsistentHashingPool, B)
- Implicit
- This member is added by an implicit conversion from ConsistentHashingPool toArrowAssoc[ConsistentHashingPool] 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
- ConsistentHashingPool → RouterConfig
- def ensuring(cond: (ConsistentHashingPool) => Boolean, msg: => Any): ConsistentHashingPool
- Implicit
- This member is added by an implicit conversion from ConsistentHashingPool toEnsuring[ConsistentHashingPool] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: (ConsistentHashingPool) => Boolean): ConsistentHashingPool
- Implicit
- This member is added by an implicit conversion from ConsistentHashingPool toEnsuring[ConsistentHashingPool] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean, msg: => Any): ConsistentHashingPool
- Implicit
- This member is added by an implicit conversion from ConsistentHashingPool toEnsuring[ConsistentHashingPool] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean): ConsistentHashingPool
- Implicit
- This member is added by an implicit conversion from ConsistentHashingPool toEnsuring[ConsistentHashingPool] 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 nrOfInstances(sys: ActorSystem): Int
- Definition Classes
- ConsistentHashingPool → Pool
- val nrOfInstances: Int
- final def overrideUnsetConfig(other: RouterConfig): RouterConfig
- Definition Classes
- PoolOverrideUnsetConfig
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- def props(routeeProps: Props): Props
akka.actor.Props for a pool router based on the settings defined by this instance and the supplied akka.actor.Props for the routees created by the router.
akka.actor.Props for a pool router based on the settings defined by this instance and the supplied akka.actor.Props for the routees created by the router.
- Definition Classes
- Pool
- val resizer: Option[Resizer]
Pool with dynamically resizable number of routees return the akka.routing.Resizer to use.
Pool with dynamically resizable number of routees return the akka.routing.Resizer to use. The resizer is invoked once when the router is created, before any messages can be sent to it. Resize is also triggered when messages are sent to the routees, and the resizer is invoked asynchronously, i.e. not necessarily before the message has been sent.
- Definition Classes
- ConsistentHashingPool → Pool
- 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
- ConsistentHashingPool → 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
- Pool → RouterConfig
- val supervisorStrategy: SupervisorStrategy
SupervisorStrategy for the head actor, i.e.
SupervisorStrategy for the head actor, i.e. for supervising the routees of the pool.
- Definition Classes
- ConsistentHashingPool → Pool
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- val usePoolDispatcher: Boolean
Use a dedicated dispatcher for the routees of the pool.
Use a dedicated dispatcher for the routees of the pool. The dispatcher is defined in 'pool-dispatcher' configuration property in the deployment section of the router.
- Definition Classes
- ConsistentHashingPool → Pool
- 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): ConsistentHashingPool
Setting the dispatcher to be used for the router head actor, which handles supervision, death watch and router management messages.
- def withFallback(other: RouterConfig): RouterConfig
Uses the resizer and/or the supervisor strategy of the given RouterConfig if this RouterConfig doesn't have one, i.e.
Uses the resizer and/or the supervisor strategy of the given RouterConfig if this RouterConfig doesn't have one, i.e. the resizer defined in code is used if resizer was not defined in config. Uses the
hashMappingdefined in code, since that can't be defined in configuration.- Definition Classes
- ConsistentHashingPool → RouterConfig
- def withHashMapper(mapper: ConsistentHashMapper): ConsistentHashingPool
Java API: Setting the mapping from message to the data to use for the consistent hash key.
- def withResizer(resizer: Resizer): ConsistentHashingPool
Setting the resizer to be used.
Setting the resizer to be used.
- Definition Classes
- ConsistentHashingPool → PoolOverrideUnsetConfig
- def withSupervisorStrategy(strategy: SupervisorStrategy): ConsistentHashingPool
Setting the supervisor strategy to be used for the “head” Router actor.
Setting the supervisor strategy to be used for the “head” Router actor.
- Definition Classes
- ConsistentHashingPool → PoolOverrideUnsetConfig
- def withVirtualNodesFactor(vnodes: Int): ConsistentHashingPool
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 ConsistentHashingPool toStringFormat[ConsistentHashingPool] 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): (ConsistentHashingPool, B)
- Implicit
- This member is added by an implicit conversion from ConsistentHashingPool toArrowAssoc[ConsistentHashingPool] 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.