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 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 = The router creates a “head” actor which supervises and/or monitors the routees. Instances are created as children of this actor, hence the children are not supervised by the parent of the router. Common choices are to always escalate (meaning that fault handling is always applied to all children simultaneously; this is the default) or use the parent’s strategy, which will result in routed children being treated individually, but it is possible as well to use Routers to give different supervisor strategies to different groups of children.

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.ConsistantHash

hashMapping

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

Annotations
@SerialVersionUID( 1L )
Linear Supertypes
Serializable, Serializable, Product, Equals, ConsistentHashingLike, RouterConfig, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. ConsistentHashingRouter
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. ConsistentHashingLike
  7. RouterConfig
  8. AnyRef
  9. Any
  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.ConsistantHash

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

    Definition Classes
    AnyRef

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

    Definition Classes
    Any

  6. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  7. def clone(): AnyRef

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

  8. def createActor(): Router

    The router "head" actor.

    The router "head" actor.

    Definition Classes
    RouterConfig

  9. def createRoute(routeeProvider: RouteeProvider): Route

    Definition Classes
    ConsistentHashingLike

  10. 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

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

    Definition Classes
    AnyRef

  12. def finalize(): Unit

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

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

    Definition Classes
    AnyRef → Any

  14. 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
    ConsistentHashingRouter → ConsistentHashingLike

  15. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  16. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  17. final def notify(): Unit

    Definition Classes
    AnyRef

  18. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  19. val nrOfInstances: Int

    Definition Classes
    ConsistentHashingRouter → ConsistentHashingLike

  20. 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.

    Definition Classes
    ConsistentHashingRouter → RouterConfig

  21. 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
    ConsistentHashingRouter → ConsistentHashingLike

  22. 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
    ConsistentHashingRouter → RouterConfig

  23. val supervisorStrategy: SupervisorStrategy

    SupervisorStrategy for the created Router actor.

    SupervisorStrategy for the created Router actor.

    Definition Classes
    ConsistentHashingRouter → RouterConfig

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

    Definition Classes
    AnyRef

  25. def toAll(sender: ActorRef, routees: Iterable[ActorRef]): Iterable[Destination]

    Attributes
    protected
    Definition Classes
    RouterConfig

  26. def verifyConfig(): 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

  27. val virtualNodesFactor: Int

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

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

    Definition Classes
    ConsistentHashingRouter → ConsistentHashingLike

  28. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws()

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

    Definition Classes
    AnyRef
    Annotations
    @throws()

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

    Definition Classes
    AnyRef
    Annotations
    @throws()

  31. def withDispatcher(dispatcherId: String): ConsistentHashingRouter

    Java API for setting routerDispatcher

  32. def withFallback(other: RouterConfig): RouterConfig

    Uses the resizer of the given RouterConfig if this RouterConfig doesn't have one, i.

    Uses the resizer 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
    ConsistentHashingRouter → RouterConfig

  33. def withHashMapper(mapping: ConsistentHashMapper): ConsistentHashingRouter

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

  34. def withSupervisorStrategy(strategy: SupervisorStrategy): ConsistentHashingRouter

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

  35. def withVirtualNodesFactor(vnodes: Int): ConsistentHashingRouter

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

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from ConsistentHashingLike

Inherited from RouterConfig

Inherited from AnyRef

Inherited from Any

Ungrouped