final case class ConsistentHashingRoutingLogic(system: ActorSystem, virtualNodesFactor: Int = 0, hashMapping: ConsistentHashMapping = ...) extends RoutingLogic with Product with Serializable

Uses consistent hashing to select a routee 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 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.

system

the actor system hosting this router

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()
Source
ConsistentHashing.scala
Linear Supertypes
Serializable, Serializable, Product, Equals, RoutingLogic, NoSerializationVerificationNeeded, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ConsistentHashingRoutingLogic
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. RoutingLogic
  7. NoSerializationVerificationNeeded
  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. All

Instance Constructors

  1. new ConsistentHashingRoutingLogic(system: ActorSystem)

    Java API

    Java API

    system

    the actor system hosting this router

  2. new ConsistentHashingRoutingLogic(system: ActorSystem, virtualNodesFactor: Int = 0, hashMapping: ConsistentHashMapping = ...)

    system

    the actor system hosting this router

    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. val hashMapping: ConsistentHashMapping
  2. def select(message: Any, routees: IndexedSeq[Routee]): Routee

    Pick the destination for a given message.

    Pick the destination for a given message. Normally it picks one of the passed routees, but in the end it is up to the implementation to return whatever Routee to use for sending a specific message.

    When implemented from Java it can be good to know that routees.apply(index) can be used to get an element from the IndexedSeq.

    Definition Classes
    ConsistentHashingRoutingLogic → RoutingLogic
  3. val system: ActorSystem
  4. val virtualNodesFactor: Int
  5. val vnodes: Int
  6. def withHashMapper(mapper: ConsistentHashMapper): ConsistentHashingRoutingLogic

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

  7. def withVirtualNodesFactor(vnodes: Int): ConsistentHashingRoutingLogic

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