akka.routing

ConsistentHashingPool

final case class ConsistentHashingPool(nrOfInstances: Int, resizer: Option[Resizer] = scala.None, virtualNodesFactor: Int = 0, hashMapping: ConsistentHashMapping = ..., supervisorStrategy: SupervisorStrategy = Pool.defaultSupervisorStrategy, routerDispatcher: String = ..., usePoolDispatcher: Boolean = false) extends Pool with PoolOverrideUnsetConfig[ConsistentHashingPool] with Product with Serializable

A router pool 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 nrOfInstances 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.

nrOfInstances

initial number of routees in the pool

resizer

optional resizer that dynamically adjust the pool size

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

supervisorStrategy

strategy for supervising the routees, see 'Supervision Setup'

routerDispatcher

dispatcher to use for the router head actor, which handles supervision, death watch and router management messages

Annotations
@SerialVersionUID( 1L )
Source
ConsistentHashing.scala
Linear Supertypes
Product, Equals, PoolOverrideUnsetConfig[ConsistentHashingPool], Pool, RouterConfig, Serializable, Serializable, AnyRef, Any
Type Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. ConsistentHashingPool
  2. Product
  3. Equals
  4. PoolOverrideUnsetConfig
  5. Pool
  6. RouterConfig
  7. Serializable
  8. Serializable
  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 ConsistentHashingPool(nr: Int)

    Java API

    Java API

    nr

    initial number of routees in the pool

  2. new ConsistentHashingPool(config: Config)

  3. new ConsistentHashingPool(nrOfInstances: Int, resizer: Option[Resizer] = scala.None, virtualNodesFactor: Int = 0, hashMapping: ConsistentHashMapping = ..., supervisorStrategy: SupervisorStrategy = Pool.defaultSupervisorStrategy, routerDispatcher: String = ..., usePoolDispatcher: Boolean = false)

    nrOfInstances

    initial number of routees in the pool

    resizer

    optional resizer that dynamically adjust the pool size

    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

    supervisorStrategy

    strategy for supervising the routees, see 'Supervision Setup'

    routerDispatcher

    dispatcher to use for the router head actor, which handles supervision, death watch and 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 ConsistentHashingPool to StringAdd performed by method any2stringadd in scala.Predef.
    Definition Classes
    StringAdd
  5. def ->[B](y: B): (ConsistentHashingPool, B)

    Implicit information
    This member is added by an implicit conversion from ConsistentHashingPool to ArrowAssoc[ConsistentHashingPool] 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
    ConsistentHashingPoolRouterConfig
  11. def ensuring(cond: (ConsistentHashingPool) ⇒ Boolean, msg: ⇒ Any): ConsistentHashingPool

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

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

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

    Implicit information
    This member is added by an implicit conversion from ConsistentHashingPool to Ensuring[ConsistentHashingPool] 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 ConsistentHashingPool 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 nrOfInstances: Int

    initial number of routees in the pool

    initial number of routees in the pool

    Definition Classes
    ConsistentHashingPoolPool
  26. final def overrideUnsetConfig(other: RouterConfig): RouterConfig

    Definition Classes
    PoolOverrideUnsetConfig
  27. def props(routeeProps: Props): Props

    akka.actor.Props for a pool router based on the settings defined by this instance and the supplied akka.actor.Props for the routees created by the router.

    akka.actor.Props for a pool router based on the settings defined by this instance and the supplied akka.actor.Props for the routees created by the router.

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

    optional resizer that dynamically adjust the pool size

    optional resizer that dynamically adjust the pool size

    Definition Classes
    ConsistentHashingPoolPool
  29. val routerDispatcher: String

    dispatcher to use for the router head actor, which handles supervision, death watch and router management messages

    dispatcher to use for the router head actor, which handles supervision, death watch and router management messages

    Definition Classes
    ConsistentHashingPoolRouterConfig
  30. 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
  31. def stopRouterWhenAllRouteesRemoved: Boolean

    Definition Classes
    PoolRouterConfig
  32. val supervisorStrategy: SupervisorStrategy

    strategy for supervising the routees, see 'Supervision Setup'

    strategy for supervising the routees, see 'Supervision Setup'

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

    Definition Classes
    AnyRef
  34. val usePoolDispatcher: Boolean

    Use a dedicated dispatcher for the routees of the pool.

    Use a dedicated dispatcher for the routees of the pool. The dispatcher is defined in 'pool-dispatcher' configuration property in the deployment section of the router.

    Definition Classes
    ConsistentHashingPoolPool
  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

  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): ConsistentHashingPool

    Setting the dispatcher to be used for the router head actor, which handles supervision, death watch and router management messages.

  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
    ConsistentHashingPoolRouterConfig
  42. def withHashMapper(mapper: ConsistentHashMapper): ConsistentHashingPool

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

  43. def withResizer(resizer: Resizer): ConsistentHashingPool

    Setting the resizer to be used.

    Setting the resizer to be used.

    Definition Classes
    ConsistentHashingPool → PoolOverrideUnsetConfig
  44. def withSupervisorStrategy(strategy: SupervisorStrategy): ConsistentHashingPool

    Setting the supervisor strategy to be used for the “head” Router actor.

    Setting the supervisor strategy to be used for the “head” Router actor.

    Definition Classes
    ConsistentHashingPool → PoolOverrideUnsetConfig
  45. def withVirtualNodesFactor(vnodes: Int): ConsistentHashingPool

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

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

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

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

Deprecated Value Members

  1. def x: ConsistentHashingPool

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

    (Since version 2.10.0) Use leftOfArrow instead

  2. def x: ConsistentHashingPool

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

    (Since version 2.10.0) Use resultOfEnsuring instead

Inherited from Product

Inherited from Equals

Inherited from PoolOverrideUnsetConfig[ConsistentHashingPool]

Inherited from Pool

Inherited from RouterConfig

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from ConsistentHashingPool to StringAdd

Inherited by implicit conversion any2stringfmt from ConsistentHashingPool to StringFormat

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

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

Ungrouped