akka.routing

ConsistentHashingRouter

Related Docs: object ConsistentHashingRouter | package routing

case class ConsistentHashingRouter(nrOfInstances: Int = 0, routees: Iterable[String] = Nil, resizer: Option[Resizer] = None, routerDispatcher: String = Dispatchers.DefaultDispatcherId, supervisorStrategy: SupervisorStrategy = Pool.defaultSupervisorStrategy, virtualNodesFactor: Int = 0, hashMapping: ConsistentHashMapping = ...) extends DeprecatedRouterConfig with PoolOverrideUnsetConfig[ConsistentHashingRouter] with Product with Serializable

A Router that uses consistent hashing to select a connection based on the sent message.

There is 3 ways to define what data to use for the consistent hash key.

1. You can define hashMapping / withHashMapper of the router to map incoming messages to their consistent hash key. This makes the decision transparent for the sender.

2. The messages may implement akka.routing.ConsistentHashingRouter.ConsistentHashable. The key is part of the message and it's convenient to define it together with the message definition.

3. The messages can be be wrapped in a akka.routing.ConsistentHashingRouter.ConsistentHashableEnvelope to define what data to use for the consistent hash key. The sender knows the key to use.

These ways to define the consistent hash key can be use together and at the same time for one router. The hashMapping is tried first.

Please note that providing both 'nrOfInstances' and 'routees' does not make logical sense as this means that the router should both create new actors and use the 'routees' actor(s). In this case the 'nrOfInstances' will be ignored and the 'routees' will be used.
The configuration parameter trumps the constructor arguments. This means that if you provide either 'nrOfInstances' or 'routees' 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.

routees

string representation of the actor paths of the routees that will be looked up using actorFor in akka.actor.ActorRefProvider

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

Annotations
@SerialVersionUID() @deprecated
Deprecated

(Since version 2.3) Use ConsistentHashingPool or ConsistentHashingGroup

Source
ConsistentHashing.scala
Linear Supertypes
Type Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. ConsistentHashingRouter
  2. Product
  3. Equals
  4. PoolOverrideUnsetConfig
  5. DeprecatedRouterConfig
  6. Pool
  7. Group
  8. RouterConfig
  9. Serializable
  10. Serializable
  11. AnyRef
  12. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ConsistentHashingRouter(resizer: Resizer)

    Java API: Constructor that sets the resizer to be used.

  2. new ConsistentHashingRouter(routeePaths: Iterable[String])

    Java API: Constructor that sets the routees to be used.

    Java API: Constructor that sets the routees to be used.

    routeePaths

    string representation of the actor paths of the routees that will be looked up using actorFor in akka.actor.ActorRefProvider

  3. new ConsistentHashingRouter(nr: Int)

    Java API: Constructor that sets nrOfInstances to be created.

  4. new ConsistentHashingRouter(nrOfInstances: Int = 0, routees: Iterable[String] = Nil, resizer: Option[Resizer] = None, routerDispatcher: String = Dispatchers.DefaultDispatcherId, supervisorStrategy: SupervisorStrategy = Pool.defaultSupervisorStrategy, virtualNodesFactor: Int = 0, hashMapping: ConsistentHashMapping = ...)

    routees

    string representation of the actor paths of the routees that will be looked up using actorFor in akka.actor.ActorRefProvider

    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

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 information
    This member is added by an implicit conversion from ConsistentHashingRouter to any2stringadd[ConsistentHashingRouter] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (ConsistentHashingRouter, B)

    Implicit information
    This member is added by an implicit conversion from ConsistentHashingRouter to ArrowAssoc[ConsistentHashingRouter] 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[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. 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
    ConsistentHashingRouterRouterConfig
  9. def ensuring(cond: (ConsistentHashingRouter) ⇒ Boolean, msg: ⇒ Any): ConsistentHashingRouter

    Implicit information
    This member is added by an implicit conversion from ConsistentHashingRouter to Ensuring[ConsistentHashingRouter] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: (ConsistentHashingRouter) ⇒ Boolean): ConsistentHashingRouter

    Implicit information
    This member is added by an implicit conversion from ConsistentHashingRouter to Ensuring[ConsistentHashingRouter] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean, msg: ⇒ Any): ConsistentHashingRouter

    Implicit information
    This member is added by an implicit conversion from ConsistentHashingRouter to Ensuring[ConsistentHashingRouter] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean): ConsistentHashingRouter

    Implicit information
    This member is added by an implicit conversion from ConsistentHashingRouter to Ensuring[ConsistentHashingRouter] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  14. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  15. def formatted(fmtstr: String): String

    Implicit information
    This member is added by an implicit conversion from ConsistentHashingRouter to StringFormat[ConsistentHashingRouter] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  16. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  17. val hashMapping: ConsistentHashMapping

    partial function from message to the data to use for the consistent hash key

  18. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  19. 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
  20. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  21. final def notify(): Unit

    Definition Classes
    AnyRef
  22. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  23. val nrOfInstances: Int

    Initial number of routee instances

    Initial number of routee instances

    Definition Classes
    ConsistentHashingRouterPool
  24. final def overrideUnsetConfig(other: RouterConfig): RouterConfig

    Definition Classes
    PoolOverrideUnsetConfig
  25. def paths: Iterable[String]

    Definition Classes
    ConsistentHashingRouterGroup
  26. 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
  27. 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
  28. 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
    ConsistentHashingRouterPool
  29. val routees: Iterable[String]

    string representation of the actor paths of the routees that will be looked up using actorFor in akka.actor.ActorRefProvider

  30. 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
    ConsistentHashingRouterRouterConfig
  31. 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. Managment messages not handled by the "head" actor are delegated to this controller actor.

    Definition Classes
    RouterConfig
  32. def stopRouterWhenAllRouteesRemoved: Boolean

    Definition Classes
    PoolRouterConfig
  33. 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
    ConsistentHashingRouterPool
  34. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  35. def 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
    Pool
  36. 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
  37. val virtualNodesFactor: Int

    number of virtual nodes per node, used in akka.routing.ConsistentHash

  38. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  39. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  40. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  41. def withDispatcher(dispatcherId: String): ConsistentHashingRouter

    Java API for setting routerDispatcher

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

    Definition Classes
    ConsistentHashingRouterRouterConfig
  43. def withHashMapper(mapping: ConsistentHashMapper): ConsistentHashingRouter

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

  44. def withResizer(resizer: Resizer): ConsistentHashingRouter

    Java API for setting the resizer to be used.

    Java API for setting the resizer to be used.

    Definition Classes
    ConsistentHashingRouter → PoolOverrideUnsetConfig
  45. def withSupervisorStrategy(strategy: SupervisorStrategy): ConsistentHashingRouter

    Java API for setting the supervisor strategy to be used for the “head” Router actor.

    Java API for setting the supervisor strategy to be used for the “head” Router actor.

    Definition Classes
    ConsistentHashingRouter → PoolOverrideUnsetConfig
  46. def withVirtualNodesFactor(vnodes: Int): ConsistentHashingRouter

    Java API for setting the number of virtual nodes per node, used in akka.routing.ConsistentHash

  47. def [B](y: B): (ConsistentHashingRouter, B)

    Implicit information
    This member is added by an implicit conversion from ConsistentHashingRouter to ArrowAssoc[ConsistentHashingRouter] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from Product

Inherited from Equals

Inherited from PoolOverrideUnsetConfig[ConsistentHashingRouter]

Inherited from DeprecatedRouterConfig

Inherited from Pool

Inherited from Group

Inherited from RouterConfig

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from ConsistentHashingRouter to any2stringadd[ConsistentHashingRouter]

Inherited by implicit conversion StringFormat from ConsistentHashingRouter to StringFormat[ConsistentHashingRouter]

Inherited by implicit conversion Ensuring from ConsistentHashingRouter to Ensuring[ConsistentHashingRouter]

Inherited by implicit conversion ArrowAssoc from ConsistentHashingRouter to ArrowAssoc[ConsistentHashingRouter]

Ungrouped