akka.routing

ConsistentHashingRouter

case class ConsistentHashingRouter(nrOfInstances: Int = 0, routees: Iterable[String] = immutable.this.Nil, resizer: Option[Resizer] = scala.None, routerDispatcher: String = ..., supervisorStrategy: SupervisorStrategy = Router.defaultSupervisorStrategy, virtualNodesFactor: Int = 0, hashMapping: ConsistentHashMapping = ...) extends RouterConfig with ConsistentHashingLike with OverrideUnsetConfig[ConsistentHashingRouter] with Product with Serializable

A Router that uses consistent hashing to select a connection 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 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.

Please note that providing both 'nrOfInstances' and 'routees' does not make logical sense as this means that the router should both create new actors and use the 'routees' actor(s). In this case the 'nrOfInstances' will be ignored and the 'routees' will be used.
The configuration parameter trumps the constructor arguments. This means that if you provide either 'nrOfInstances' or 'routees' during instantiation they will be ignored if the router is defined in the configuration file for the actor being used.

Supervision Setup

Any routees that are created by a router will be created as the router's children. The router is therefore also the children's supervisor.

The supervision strategy of the router actor can be configured with #withSupervisorStrategy. If no strategy is provided, routers default to a strategy of “always escalate”. This means that errors are passed up to the router's supervisor for handling.

The router's supervisor will treat the error as an error with the router itself. Therefore a directive to stop or restart will cause the router itself to stop or restart. The router, in turn, will cause its children to stop and restart.

routees

string representation of the actor paths of the routees that will be looked up using actorFor in akka.actor.ActorRefProvider

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( 1L )
Linear Supertypes
Serializable, Serializable, Product, Equals, OverrideUnsetConfig[ConsistentHashingRouter], ConsistentHashingLike, RouterConfig, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. ConsistentHashingRouter
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. OverrideUnsetConfig
  7. ConsistentHashingLike
  8. RouterConfig
  9. AnyRef
  10. 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 ConsistentHashingRouter(resizer: Resizer)

    Java API: Constructor that sets the resizer to be used.

  2. new ConsistentHashingRouter(routeePaths: Iterable[String])

    Java API: Constructor that sets the routees to be used.

    Java API: Constructor that sets the routees to be used.

    routeePaths

    string representation of the actor paths of the routees that will be looked up using actorFor in akka.actor.ActorRefProvider

  3. new ConsistentHashingRouter(nr: Int)

    Java API: Constructor that sets nrOfInstances to be created.

  4. new ConsistentHashingRouter(nrOfInstances: Int = 0, routees: Iterable[String] = immutable.this.Nil, resizer: Option[Resizer] = scala.None, routerDispatcher: String = ..., supervisorStrategy: SupervisorStrategy = Router.defaultSupervisorStrategy, virtualNodesFactor: Int = 0, hashMapping: ConsistentHashMapping = ...)

    routees

    string representation of the actor paths of the routees that will be looked up using actorFor in akka.actor.ActorRefProvider

    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: 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 ConsistentHashingRouter to StringAdd performed by method any2stringadd in scala.Predef.
    Definition Classes
    StringAdd
  5. def ->[B](y: B): (ConsistentHashingRouter, B)

    Implicit information
    This member is added by an implicit conversion from ConsistentHashingRouter to ArrowAssoc[ConsistentHashingRouter] 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 createActor(): Router

    The router "head" actor.

    The router "head" actor.

    Definition Classes
    RouterConfig
  11. def createRoute(routeeProvider: RouteeProvider): Route

    Definition Classes
    ConsistentHashingLike
  12. def createRouteeProvider(context: ActorContext, routeeProps: Props): RouteeProvider

    The RouteeProvider responsible for creating or looking up routees.

    The RouteeProvider responsible for creating or looking up routees. It's used in createRoute to register routees, and also from akka.routing.Resizer.

    Definition Classes
    RouterConfig
  13. def ensuring(cond: (ConsistentHashingRouter) ⇒ Boolean, msg: ⇒ Any): ConsistentHashingRouter

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

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

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

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

    Definition Classes
    AnyRef
  18. def finalize(): Unit

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

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

    Definition Classes
    AnyRef → Any
  21. val hashMapping: ConsistentHashMapping

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

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

    Definition Classes
    ConsistentHashingRouterConsistentHashingLike
  22. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  23. final def ne(arg0: AnyRef): Boolean

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

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

    Definition Classes
    AnyRef
  26. val nrOfInstances: Int

  27. final def overrideUnsetConfig(other: RouterConfig): RouterConfig

    Definition Classes
    OverrideUnsetConfig
  28. val resizer: Option[Resizer]

    Routers with dynamically resizable number of routees return the akka.routing.Resizer to use.

    Routers with dynamically resizable number of routees return the akka.routing.Resizer to use. The resizer is invoked once when the router is created, before any messages can be sent to it. Resize is also triggered when messages are sent to the routees, and the resizer is invoked asynchronously, i.e. not necessarily before the message has been sent.

    Definition Classes
    ConsistentHashingRouterRouterConfig
  29. val routees: Iterable[String]

    string representation of the actor paths of the routees that will be looked up using actorFor in akka.actor.ActorRefProvider

    string representation of the actor paths of the routees that will be looked up using actorFor in akka.actor.ActorRefProvider

    Definition Classes
    ConsistentHashingRouterConsistentHashingLike
  30. val routerDispatcher: String

    Dispatcher ID to use for running the “head” actor, i.

    Dispatcher ID to use for running the “head” actor, i.e. the akka.routing.Router.

    Definition Classes
    ConsistentHashingRouterRouterConfig
  31. def stopRouterWhenAllRouteesRemoved: Boolean

    Definition Classes
    RouterConfig
  32. val supervisorStrategy: SupervisorStrategy

    SupervisorStrategy for the created Router actor.

    SupervisorStrategy for the created Router actor.

    Definition Classes
    ConsistentHashingRouterRouterConfig
  33. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  34. def toAll(sender: ActorRef, routees: Iterable[ActorRef]): Iterable[Destination]

    Attributes
    protected
    Definition Classes
    RouterConfig
  35. 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
  36. val virtualNodesFactor: Int

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

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

    Definition Classes
    ConsistentHashingRouterConsistentHashingLike
  37. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  40. def withDispatcher(dispatcherId: String): ConsistentHashingRouter

    Java API for setting routerDispatcher

  41. def withFallback(other: RouterConfig): RouterConfig

    Uses the resizer and/or the supervisor strategy of the given Routerconfig if this RouterConfig doesn't have one, i.

    Uses the resizer and/or the supervisor strategy of the given Routerconfig if this RouterConfig doesn't have one, i.e. the resizer defined in code is used if resizer was not defined in config. Uses the the hashMapping defined in code, since that can't be defined in configuration.

    Definition Classes
    ConsistentHashingRouterRouterConfig
  42. def withHashMapper(mapping: ConsistentHashMapper): ConsistentHashingRouter

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

  43. def withResizer(resizer: Resizer): ConsistentHashingRouter

    Java API for setting the resizer to be used.

    Java API for setting the resizer to be used.

    Definition Classes
    ConsistentHashingRouter → OverrideUnsetConfig
  44. def withSupervisorStrategy(strategy: SupervisorStrategy): ConsistentHashingRouter

    Java API for setting the supervisor strategy to be used for the “head” Router actor.

    Java API for setting the supervisor strategy to be used for the “head” Router actor.

    Definition Classes
    ConsistentHashingRouter → OverrideUnsetConfig
  45. def withVirtualNodesFactor(vnodes: Int): ConsistentHashingRouter

    Java API for setting the number of virtual nodes per node, used in akka.routing.ConsistentHash

  46. def [B](y: B): (ConsistentHashingRouter, B)

    Implicit information
    This member is added by an implicit conversion from ConsistentHashingRouter to ArrowAssoc[ConsistentHashingRouter] 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 ConsistentHashingRouter 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:
    (consistentHashingRouter: StringAdd).self
    Definition Classes
    StringAdd
  2. val self: Any

    Implicit information
    This member is added by an implicit conversion from ConsistentHashingRouter 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:
    (consistentHashingRouter: StringFormat).self
    Definition Classes
    StringFormat

Deprecated Value Members

  1. def x: ConsistentHashingRouter

    Implicit information
    This member is added by an implicit conversion from ConsistentHashingRouter to ArrowAssoc[ConsistentHashingRouter] 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:
    (consistentHashingRouter: ArrowAssoc[ConsistentHashingRouter]).x
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use leftOfArrow instead

  2. def x: ConsistentHashingRouter

    Implicit information
    This member is added by an implicit conversion from ConsistentHashingRouter to Ensuring[ConsistentHashingRouter] 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:
    (consistentHashingRouter: Ensuring[ConsistentHashingRouter]).x
    Definition Classes
    Ensuring
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use resultOfEnsuring instead

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from OverrideUnsetConfig[ConsistentHashingRouter]

Inherited from ConsistentHashingLike

Inherited from RouterConfig

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from ConsistentHashingRouter to StringAdd

Inherited by implicit conversion any2stringfmt from ConsistentHashingRouter to StringFormat

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

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

Ungrouped