c

akka.routing

BalancingPool

final case class BalancingPool(nrOfInstances: Int, supervisorStrategy: SupervisorStrategy = Pool.defaultSupervisorStrategy, routerDispatcher: String = Dispatchers.DefaultDispatcherId) extends Pool with Product with Serializable

A router pool that will try to redistribute work from busy routees to idle routees. All routees share the same mailbox.

Although the technique used in this implementation is commonly known as "work stealing", the actual implementation is probably best described as "work donating" because the actor of which work is being stolen takes the initiative.

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

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()
Source
Balancing.scala
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. BalancingPool
  2. Product
  3. Equals
  4. Pool
  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 BalancingPool(nr: Int)

    Java API

    Java API

    nr

    initial number of routees in the pool

  2. new BalancingPool(config: Config)
  3. new BalancingPool(nrOfInstances: Int, supervisorStrategy: SupervisorStrategy = Pool.defaultSupervisorStrategy, routerDispatcher: String = Dispatchers.DefaultDispatcherId)

    nrOfInstances

    initial number of routees in the pool

    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: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from BalancingPool to any2stringadd[BalancingPool] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (BalancingPool, B)
    Implicit
    This member is added by an implicit conversion from BalancingPool to ArrowAssoc[BalancingPool] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  8. 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
    BalancingPoolRouterConfig
  9. def ensuring(cond: (BalancingPool) ⇒ Boolean, msg: ⇒ Any): BalancingPool
    Implicit
    This member is added by an implicit conversion from BalancingPool to Ensuring[BalancingPool] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: (BalancingPool) ⇒ Boolean): BalancingPool
    Implicit
    This member is added by an implicit conversion from BalancingPool to Ensuring[BalancingPool] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean, msg: ⇒ Any): BalancingPool
    Implicit
    This member is added by an implicit conversion from BalancingPool to Ensuring[BalancingPool] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean): BalancingPool
    Implicit
    This member is added by an implicit conversion from BalancingPool to Ensuring[BalancingPool] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from BalancingPool to StringFormat[BalancingPool] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  15. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  16. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  17. 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
  18. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  20. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  21. def nrOfInstances(sys: ActorSystem): Int
    Definition Classes
    BalancingPoolPool
  22. val nrOfInstances: Int
  23. 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
  24. val resizer: Option[Resizer]

    Resizer cannot be used together with BalancingPool

    Resizer cannot be used together with BalancingPool

    Definition Classes
    BalancingPoolPool
  25. val 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
    BalancingPoolRouterConfig
  26. 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
    RouterConfig
  27. def stopRouterWhenAllRouteesRemoved: Boolean
    Definition Classes
    PoolRouterConfig
  28. val 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
    BalancingPoolPool
  29. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  30. 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
  31. 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
  32. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  33. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  34. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  35. def withDispatcher(dispatcherId: String): BalancingPool

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

  36. def withFallback(other: RouterConfig): RouterConfig

    Uses the supervisor strategy of the given RouterConfig if this RouterConfig doesn't have one.

    Uses the supervisor strategy of the given RouterConfig if this RouterConfig doesn't have one.

    Definition Classes
    BalancingPoolRouterConfig
  37. def withSupervisorStrategy(strategy: SupervisorStrategy): BalancingPool

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

  38. def [B](y: B): (BalancingPool, B)
    Implicit
    This member is added by an implicit conversion from BalancingPool to ArrowAssoc[BalancingPool] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated @deprecated
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

Inherited from Product

Inherited from Equals

Inherited from Pool

Inherited from RouterConfig

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from BalancingPool to any2stringadd[BalancingPool]

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

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

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

Ungrouped