akka.routing

ConsistentHashingGroup

final case class ConsistentHashingGroup(paths: Iterable[String], virtualNodesFactor: Int = 0, hashMapping: ConsistentHashMapping = ..., routerDispatcher: String = ...) 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( 1L )
Source
ConsistentHashing.scala
Linear Supertypes
Type Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. ConsistentHashingGroup
  2. Product
  3. Equals
  4. Group
  5. RouterConfig
  6. Serializable
  7. Serializable
  8. AnyRef
  9. Any
Implicitly
  1. by any2stringadd
  2. by any2stringfmt
  3. by any2ArrowAssoc
  4. by any2Ensuring
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

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 = ..., routerDispatcher: String = ...)

    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. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. def +(other: String): String

    Implicit information
    This member is added by an implicit conversion from ConsistentHashingGroup to StringAdd performed by method any2stringadd in scala.Predef.
    Definition Classes
    StringAdd
  5. def ->[B](y: B): (ConsistentHashingGroup, B)

    Implicit information
    This member is added by an implicit conversion from ConsistentHashingGroup to ArrowAssoc[ConsistentHashingGroup] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  6. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  7. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  8. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  9. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  10. 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
    ConsistentHashingGroupRouterConfig
  11. def ensuring(cond: (ConsistentHashingGroup) ⇒ Boolean, msg: ⇒ Any): ConsistentHashingGroup

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

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

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

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

    Definition Classes
    AnyRef
  16. def finalize(): Unit

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

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

    Definition Classes
    AnyRef → Any
  19. val hashMapping: ConsistentHashMapping

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

  20. final def isInstanceOf[T0]: Boolean

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

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

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

    Definition Classes
    AnyRef
  25. val paths: Iterable[String]

    string representation of the actor paths of the routees, messages are sent with akka.actor.ActorSelection to these paths

    string representation of the actor paths of the routees, messages are sent with akka.actor.ActorSelection to these paths

    Definition Classes
    ConsistentHashingGroupGroup
  26. 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
  27. val routerDispatcher: String

    dispatcher to use for the router head actor, which handles router management messages

    dispatcher to use for the router head actor, which handles router management messages

    Definition Classes
    ConsistentHashingGroupRouterConfig
  28. def routingLogicController(routingLogic: RoutingLogic): Option[Props]

    Possibility to define an actor for controlling the routing logic from external stimuli (e.

    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
  29. def stopRouterWhenAllRouteesRemoved: Boolean

    Definition Classes
    RouterConfig
  30. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  31. 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
  32. val virtualNodesFactor: Int

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

  33. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  36. def withDispatcher(dispatcherId: String): ConsistentHashingGroup

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

  37. def withFallback(other: RouterConfig): RouterConfig

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

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

    Definition Classes
    ConsistentHashingGroupRouterConfig
  38. def withHashMapper(mapper: ConsistentHashMapper): ConsistentHashingGroup

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

  39. def withVirtualNodesFactor(vnodes: Int): ConsistentHashingGroup

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

  40. def [B](y: B): (ConsistentHashingGroup, B)

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

Shadowed Implicit Value Members

  1. val self: Any

    Implicit information
    This member is added by an implicit conversion from ConsistentHashingGroup to StringAdd performed by method any2stringadd in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (consistentHashingGroup: StringAdd).self
    Definition Classes
    StringAdd
  2. val self: Any

    Implicit information
    This member is added by an implicit conversion from ConsistentHashingGroup to StringFormat performed by method any2stringfmt in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (consistentHashingGroup: StringFormat).self
    Definition Classes
    StringFormat

Deprecated Value Members

  1. def x: ConsistentHashingGroup

    Implicit information
    This member is added by an implicit conversion from ConsistentHashingGroup to ArrowAssoc[ConsistentHashingGroup] performed by method any2ArrowAssoc in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (consistentHashingGroup: ArrowAssoc[ConsistentHashingGroup]).x
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use leftOfArrow instead

  2. def x: ConsistentHashingGroup

    Implicit information
    This member is added by an implicit conversion from ConsistentHashingGroup to Ensuring[ConsistentHashingGroup] performed by method any2Ensuring in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (consistentHashingGroup: Ensuring[ConsistentHashingGroup]).x
    Definition Classes
    Ensuring
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use resultOfEnsuring instead

Inherited from Product

Inherited from Equals

Inherited from Group

Inherited from RouterConfig

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from ConsistentHashingGroup to StringAdd

Inherited by implicit conversion any2stringfmt from ConsistentHashingGroup to StringFormat

Inherited by implicit conversion any2ArrowAssoc from ConsistentHashingGroup to ArrowAssoc[ConsistentHashingGroup]

Inherited by implicit conversion any2Ensuring from ConsistentHashingGroup to Ensuring[ConsistentHashingGroup]

Ungrouped