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
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. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from ConsistentHashingRoutingLogic to any2stringadd[ConsistentHashingRoutingLogic] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (ConsistentHashingRoutingLogic, B)
    Implicit
    This member is added by an implicit conversion from ConsistentHashingRoutingLogic to ArrowAssoc[ConsistentHashingRoutingLogic] 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[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  8. def ensuring(cond: (ConsistentHashingRoutingLogic) ⇒ Boolean, msg: ⇒ Any): ConsistentHashingRoutingLogic
    Implicit
    This member is added by an implicit conversion from ConsistentHashingRoutingLogic to Ensuring[ConsistentHashingRoutingLogic] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (ConsistentHashingRoutingLogic) ⇒ Boolean): ConsistentHashingRoutingLogic
    Implicit
    This member is added by an implicit conversion from ConsistentHashingRoutingLogic to Ensuring[ConsistentHashingRoutingLogic] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: ⇒ Any): ConsistentHashingRoutingLogic
    Implicit
    This member is added by an implicit conversion from ConsistentHashingRoutingLogic to Ensuring[ConsistentHashingRoutingLogic] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): ConsistentHashingRoutingLogic
    Implicit
    This member is added by an implicit conversion from ConsistentHashingRoutingLogic to Ensuring[ConsistentHashingRoutingLogic] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from ConsistentHashingRoutingLogic to StringFormat[ConsistentHashingRoutingLogic] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  14. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  15. val hashMapping: ConsistentHashMapping
  16. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  17. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  19. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  20. 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
    ConsistentHashingRoutingLogicRoutingLogic
  21. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  22. val system: ActorSystem
  23. val virtualNodesFactor: Int
  24. val vnodes: Int
  25. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  26. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  27. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  28. def withHashMapper(mapper: ConsistentHashMapper): ConsistentHashingRoutingLogic

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

  29. def withVirtualNodesFactor(vnodes: Int): ConsistentHashingRoutingLogic

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

  30. def [B](y: B): (ConsistentHashingRoutingLogic, B)
    Implicit
    This member is added by an implicit conversion from ConsistentHashingRoutingLogic to ArrowAssoc[ConsistentHashingRoutingLogic] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated @deprecated
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from RoutingLogic

Inherited from AnyRef

Inherited from Any

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

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

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

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

Ungrouped