Class

akka.routing

ConsistentHashingGroup

Related Doc: package routing

Permalink

final case class ConsistentHashingGroup(paths: Iterable[String], virtualNodesFactor: Int = 0, hashMapping: ConsistentHashMapping = ..., 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, 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. Serializable
  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 ConsistentHashingGroup(routeePaths: Iterable[String])

    Permalink

    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)

    Permalink

  3. new ConsistentHashingGroup(paths: Iterable[String], virtualNodesFactor: Int = 0, hashMapping: ConsistentHashMapping = ..., routerDispatcher: String = Dispatchers.DefaultDispatcherId)

    Permalink

    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: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. def +(other: String): String

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

  4. def ->[B](y: B): (ConsistentHashingGroup, B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from ConsistentHashingGroup to ArrowAssoc[ConsistentHashingGroup] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()

  5. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  8. def createRouter(system: ActorSystem): Router

    Permalink

    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

  9. def ensuring(cond: (ConsistentHashingGroup) ⇒ Boolean, msg: ⇒ Any): ConsistentHashingGroup

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

  10. def ensuring(cond: (ConsistentHashingGroup) ⇒ Boolean): ConsistentHashingGroup

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

  11. def ensuring(cond: Boolean, msg: ⇒ Any): ConsistentHashingGroup

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

  12. def ensuring(cond: Boolean): ConsistentHashingGroup

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

  13. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  14. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  15. def formatted(fmtstr: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from ConsistentHashingGroup to StringFormat[ConsistentHashingGroup] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()

  16. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  17. val hashMapping: ConsistentHashMapping

    Permalink

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

  18. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  19. def isManagementMessage(msg: Any): Boolean

    Permalink

    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

    Permalink
    Definition Classes
    AnyRef

  21. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  22. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  23. def paths(system: ActorSystem): Iterable[String]

    Permalink
    Definition Classes
    ConsistentHashingGroup → Group

  24. val paths: Iterable[String]

    Permalink

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

  25. def props(): Props

    Permalink

    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

  26. val routerDispatcher: String

    Permalink

    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
    ConsistentHashingGroup → RouterConfig

  27. def routingLogicController(routingLogic: RoutingLogic): Option[Props]

    Permalink

    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

  28. def stopRouterWhenAllRouteesRemoved: Boolean

    Permalink
    Definition Classes
    RouterConfig

  29. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  30. def verifyConfig(path: ActorPath): Unit

    Permalink

    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

  31. val virtualNodesFactor: Int

    Permalink

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

  32. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  33. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  34. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  35. def withDispatcher(dispatcherId: String): ConsistentHashingGroup

    Permalink

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

  36. def withFallback(other: RouterConfig): RouterConfig

    Permalink

    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

  37. def withHashMapper(mapper: ConsistentHashMapper): ConsistentHashingGroup

    Permalink

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

  38. def withVirtualNodesFactor(vnodes: Int): ConsistentHashingGroup

    Permalink

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

  39. def →[B](y: B): (ConsistentHashingGroup, B)

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

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 any2stringadd[ConsistentHashingGroup]

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

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

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

Ungrouped