Packages

c

akka.cluster.routing

ClusterRouterPool

final case class ClusterRouterPool(local: Pool, settings: ClusterRouterPoolSettings) extends Pool with ClusterRouterConfigBase with Product with Serializable

akka.routing.RouterConfig implementation for deployment on cluster nodes. Delegates other duties to the local akka.routing.RouterConfig, which makes it possible to mix this with the built-in routers such as akka.routing.RoundRobinGroup or custom routers.

Annotations
@SerialVersionUID()
Source
ClusterRouterConfig.scala
Linear Supertypes
Product, Equals, ClusterRouterConfigBase, Pool, RouterConfig, Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ClusterRouterPool
  2. Product
  3. Equals
  4. ClusterRouterConfigBase
  5. Pool
  6. RouterConfig
  7. Serializable
  8. Serializable
  9. AnyRef
  10. 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 ClusterRouterPool(local: Pool, settings: ClusterRouterPoolSettings)

Value Members

  1. 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
    ClusterRouterConfigBase → RouterConfig
  2. 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
    ClusterRouterConfigBase → RouterConfig
  3. val local: Pool
    Definition Classes
    ClusterRouterPool → ClusterRouterConfigBase
  4. def nrOfInstances(sys: ActorSystem): Int

    Initial number of routee instances

    Initial number of routee instances

    Definition Classes
    ClusterRouterPool → Pool
  5. 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
  6. def resizer: Option[Resizer]

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

    Pool 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
    ClusterRouterPool → Pool
  7. def routerDispatcher: String

    Dispatcher ID to use for running the “head” actor, which handles supervision, death watch and router management messages

    Dispatcher ID to use for running the “head” actor, which handles supervision, death watch and router management messages

    Definition Classes
    ClusterRouterConfigBase → RouterConfig
  8. def routingLogicController(routingLogic: RoutingLogic): Option[Props]

    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
    ClusterRouterConfigBase → RouterConfig
  9. val settings: ClusterRouterPoolSettings
    Definition Classes
    ClusterRouterPool → ClusterRouterConfigBase
  10. def stopRouterWhenAllRouteesRemoved: Boolean
    Definition Classes
    ClusterRouterConfigBase → RouterConfig
  11. def supervisorStrategy: SupervisorStrategy

    SupervisorStrategy for the head actor, i.e.

    SupervisorStrategy for the head actor, i.e. for supervising the routees of the pool.

    Definition Classes
    ClusterRouterPool → Pool
  12. def 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
    Pool
  13. 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
  14. def withFallback(other: RouterConfig): RouterConfig

    Overridable merge strategy, by default completely prefers this (i.e.

    Overridable merge strategy, by default completely prefers this (i.e. no merge).

    Definition Classes
    ClusterRouterPool → RouterConfig