|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object akka.routing.BalancingPool
public final class BalancingPool
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.
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(akka.actor.SupervisorStrategy)
. 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.
param: nrOfInstances initial number of routees in the pool
param: supervisorStrategy strategy for supervising the routees, see 'Supervision Setup'
param: routerDispatcher dispatcher to use for the router head actor, which handles supervision, death watch and router management messages
Constructor Summary | |
---|---|
BalancingPool(com.typesafe.config.Config config)
|
|
BalancingPool(int nrOfInstances,
SupervisorStrategy supervisorStrategy,
java.lang.String routerDispatcher)
|
Method Summary | |
---|---|
Router |
createRouter(ActorSystem system)
Create the actual router, responsible for routing messages to routees. |
Routee |
newRoutee(Props routeeProps,
ActorContext context)
INTERNAL API |
int |
nrOfInstances()
Initial number of routee instances |
scala.Option<Resizer> |
resizer()
Resizer cannot be used together with BalancingPool |
java.lang.String |
routerDispatcher()
Dispatcher ID to use for running the “head” actor, which handles supervision, death watch and router management messages |
SupervisorStrategy |
supervisorStrategy()
SupervisorStrategy for the head actor, i.e. |
BalancingPool |
withDispatcher(java.lang.String dispatcherId)
Setting the dispatcher to be used for the router head actor, which handles supervision, death watch and router management messages. |
RouterConfig |
withFallback(RouterConfig other)
Uses the supervisor strategy of the given Routerconfig if this RouterConfig doesn't have one. |
BalancingPool |
withSupervisorStrategy(SupervisorStrategy strategy)
Setting the supervisor strategy to be used for the “head” Router actor. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface akka.routing.Pool |
---|
createRouterActor, enrichWithPoolDispatcher, props, stopRouterWhenAllRouteesRemoved, usePoolDispatcher |
Methods inherited from interface akka.routing.RouterConfig |
---|
isManagementMessage, routingLogicController, verifyConfig |
Methods inherited from interface scala.Product |
---|
productArity, productElement, productIterator, productPrefix |
Methods inherited from interface scala.Equals |
---|
canEqual, equals |
Constructor Detail |
---|
public BalancingPool(int nrOfInstances, SupervisorStrategy supervisorStrategy, java.lang.String routerDispatcher)
public BalancingPool(com.typesafe.config.Config config)
Method Detail |
---|
public int nrOfInstances()
Pool
nrOfInstances
in interface Pool
public SupervisorStrategy supervisorStrategy()
Pool
supervisorStrategy
in interface Pool
public java.lang.String routerDispatcher()
RouterConfig
routerDispatcher
in interface RouterConfig
public Router createRouter(ActorSystem system)
RouterConfig
createRouter
in interface RouterConfig
system
- the ActorSystem this router belongs to
public BalancingPool withSupervisorStrategy(SupervisorStrategy strategy)
strategy
- (undocumented)
public BalancingPool withDispatcher(java.lang.String dispatcherId)
dispatcherId
- (undocumented)
public Routee newRoutee(Props routeeProps, ActorContext context)
newRoutee
in interface Pool
routeeProps
- (undocumented)context
- (undocumented)
public RouterConfig withFallback(RouterConfig other)
withFallback
in interface RouterConfig
other
- (undocumented)
public scala.Option<Resizer> resizer()
resizer
in interface Pool
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |