c

org.apache.pekko.routing

ConsistentHashingPool

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 pekko.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 pekko.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
Linear Supertypes
Product, Equals, PoolOverrideUnsetConfig[ConsistentHashingPool], Pool, RouterConfig, Serializable, AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ConsistentHashingPool
  2. Product
  3. Equals
  4. PoolOverrideUnsetConfig
  5. Pool
  6. RouterConfig
  7. Serializable
  8. AnyRef
  9. 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 ConsistentHashingPool(nr: Int)

    Java API

    Java API

    nr

    initial number of routees in the pool

  2. new ConsistentHashingPool(config: Config)
  3. 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 pekko.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

  1. 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
  2. val hashMapping: ConsistentHashMapping
  3. 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
  4. def nrOfInstances(sys: ActorSystem): Int
    Definition Classes
    ConsistentHashingPool → Pool
  5. val nrOfInstances: Int
  6. final def overrideUnsetConfig(other: RouterConfig): RouterConfig
    Definition Classes
    PoolOverrideUnsetConfig
  7. def productElementNames: Iterator[String]
    Definition Classes
    Product
  8. def props(routeeProps: Props): Props

    pekko.actor.Props for a pool router based on the settings defined by this instance and the supplied pekko.actor.Props for the routees created by the router.

    pekko.actor.Props for a pool router based on the settings defined by this instance and the supplied pekko.actor.Props for the routees created by the router.

    Definition Classes
    Pool
  9. val resizer: Option[Resizer]

    Pool with dynamically resizable number of routees return the pekko.routing.Resizer to use.

    Pool with dynamically resizable number of routees return the pekko.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
  10. 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
  11. 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
  12. def stopRouterWhenAllRouteesRemoved: Boolean

    Specify that this router should stop itself when all routees have terminated (been removed).

    Specify that this router should stop itself when all routees have terminated (been removed). By Default it is true, unless a resizer is used.

    Definition Classes
    Pool → RouterConfig
  13. 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
  14. 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
  15. 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
  16. val virtualNodesFactor: Int
  17. 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.

  18. 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 hashMapping defined in code, since that can't be defined in configuration.

    Definition Classes
    ConsistentHashingPool → RouterConfig
  19. def withHashMapper(mapper: ConsistentHashMapper): ConsistentHashingPool

    Java API: Setting the mapping from message to the data to use for the consistent hash key.

  20. def withResizer(resizer: Resizer): ConsistentHashingPool

    Setting the resizer to be used.

    Setting the resizer to be used.

    Definition Classes
    ConsistentHashingPool → PoolOverrideUnsetConfig
  21. 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
  22. def withVirtualNodesFactor(vnodes: Int): ConsistentHashingPool

    Setting the number of virtual nodes per node, used in pekko.routing.ConsistentHash