c

akka.routing

ConsistentHashingGroup

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
Linear Supertypes
Product, Equals, Group, RouterConfig, Serializable, AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ConsistentHashingGroup
  2. Product
  3. Equals
  4. Group
  5. RouterConfig
  6. Serializable
  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 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

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

  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
    ConsistentHashingGroup → 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 paths(system: ActorSystem): Iterable[String]
    Definition Classes
    ConsistentHashingGroup → Group
  5. val paths: Iterable[String]
  6. def productElementNames: Iterator[String]
    Definition Classes
    Product
  7. 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
  8. 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
  9. 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
  10. def stopRouterWhenAllRouteesRemoved: Boolean
    Definition Classes
    RouterConfig
  11. 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
  12. val virtualNodesFactor: Int
  13. def withDispatcher(dispatcherId: String): ConsistentHashingGroup

    Setting the dispatcher to be used for the router head actor, which handles router management messages

  14. def withFallback(other: RouterConfig): RouterConfig

    Uses the hashMapping defined in code, since that can't be defined in configuration.

    Uses the hashMapping defined in code, since that can't be defined in configuration.

    Definition Classes
    ConsistentHashingGroup → RouterConfig
  15. def withHashMapper(mapper: ConsistentHashMapper): ConsistentHashingGroup

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

  16. def withVirtualNodesFactor(vnodes: Int): ConsistentHashingGroup

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