Class BalancingPool
- java.lang.Object
-
- org.apache.pekko.routing.BalancingPool
-
- All Implemented Interfaces:
java.io.Serializable
,Pool
,RouterConfig
,scala.Equals
,scala.Product
public final class BalancingPool extends java.lang.Object implements Pool, scala.Product, java.io.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(org.apache.pekko.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
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description BalancingPool(int nr)
Java APIBalancingPool(int nrOfInstances, SupervisorStrategy supervisorStrategy, java.lang.String routerDispatcher)
BalancingPool(com.typesafe.config.Config config)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static SupervisorStrategy
$lessinit$greater$default$2()
static java.lang.String
$lessinit$greater$default$3()
static BalancingPool
apply(int nrOfInstances, SupervisorStrategy supervisorStrategy, java.lang.String routerDispatcher)
static SupervisorStrategy
apply$default$2()
static java.lang.String
apply$default$3()
boolean
canEqual(java.lang.Object x$1)
BalancingPool
copy(int nrOfInstances, SupervisorStrategy supervisorStrategy, java.lang.String routerDispatcher)
int
copy$default$1()
SupervisorStrategy
copy$default$2()
java.lang.String
copy$default$3()
Router
createRouter(ActorSystem system)
Create the actual router, responsible for routing messages to routees.boolean
equals(java.lang.Object x$1)
int
hashCode()
int
nrOfInstances()
int
nrOfInstances(ActorSystem sys)
Initial number of routee instancesint
productArity()
java.lang.Object
productElement(int x$1)
java.lang.String
productElementName(int x$1)
scala.collection.Iterator<java.lang.Object>
productIterator()
java.lang.String
productPrefix()
scala.Option<Resizer>
resizer()
Resizer cannot be used together with BalancingPooljava.lang.String
routerDispatcher()
Dispatcher ID to use for running the “head” actor, which handles supervision, death watch and router management messagesSupervisorStrategy
supervisorStrategy()
SupervisorStrategy for the head actor, i.e.java.lang.String
toString()
static scala.Option<scala.Tuple3<java.lang.Object,SupervisorStrategy,java.lang.String>>
unapply(BalancingPool x$0)
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, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.apache.pekko.routing.Pool
createRouterActor, enrichWithPoolDispatcher, props, stopRouterWhenAllRouteesRemoved, usePoolDispatcher
-
Methods inherited from interface org.apache.pekko.routing.RouterConfig
isManagementMessage, routingLogicController, verifyConfig
-
-
-
-
Constructor Detail
-
BalancingPool
public BalancingPool(int nrOfInstances, SupervisorStrategy supervisorStrategy, java.lang.String routerDispatcher)
-
BalancingPool
public BalancingPool(com.typesafe.config.Config config)
-
BalancingPool
public BalancingPool(int nr)
Java API- Parameters:
nr
- initial number of routees in the pool
-
-
Method Detail
-
$lessinit$greater$default$2
public static SupervisorStrategy $lessinit$greater$default$2()
-
$lessinit$greater$default$3
public static java.lang.String $lessinit$greater$default$3()
-
apply
public static BalancingPool apply(int nrOfInstances, SupervisorStrategy supervisorStrategy, java.lang.String routerDispatcher)
-
apply$default$2
public static SupervisorStrategy apply$default$2()
-
apply$default$3
public static java.lang.String apply$default$3()
-
unapply
public static scala.Option<scala.Tuple3<java.lang.Object,SupervisorStrategy,java.lang.String>> unapply(BalancingPool x$0)
-
nrOfInstances
public int nrOfInstances()
-
supervisorStrategy
public SupervisorStrategy supervisorStrategy()
Description copied from interface:Pool
SupervisorStrategy for the head actor, i.e. for supervising the routees of the pool.- Specified by:
supervisorStrategy
in interfacePool
-
routerDispatcher
public java.lang.String routerDispatcher()
Description copied from interface:RouterConfig
Dispatcher ID to use for running the “head” actor, which handles supervision, death watch and router management messages- Specified by:
routerDispatcher
in interfaceRouterConfig
-
createRouter
public Router createRouter(ActorSystem system)
Description copied from interface:RouterConfig
Create the actual router, responsible for routing messages to routees.- Specified by:
createRouter
in interfaceRouterConfig
- Parameters:
system
- the ActorSystem this router belongs to
-
withSupervisorStrategy
public BalancingPool withSupervisorStrategy(SupervisorStrategy strategy)
Setting the supervisor strategy to be used for the “head” Router actor.
-
withDispatcher
public 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.
-
nrOfInstances
public int nrOfInstances(ActorSystem sys)
Description copied from interface:Pool
Initial number of routee instances- Specified by:
nrOfInstances
in interfacePool
-
withFallback
public RouterConfig withFallback(RouterConfig other)
Uses the supervisor strategy of the given RouterConfig if this RouterConfig doesn't have one.- Specified by:
withFallback
in interfaceRouterConfig
-
resizer
public scala.Option<Resizer> resizer()
Resizer cannot be used together with BalancingPool
-
copy
public BalancingPool copy(int nrOfInstances, SupervisorStrategy supervisorStrategy, java.lang.String routerDispatcher)
-
copy$default$1
public int copy$default$1()
-
copy$default$2
public SupervisorStrategy copy$default$2()
-
copy$default$3
public java.lang.String copy$default$3()
-
productPrefix
public java.lang.String productPrefix()
- Specified by:
productPrefix
in interfacescala.Product
-
productArity
public int productArity()
- Specified by:
productArity
in interfacescala.Product
-
productElement
public java.lang.Object productElement(int x$1)
- Specified by:
productElement
in interfacescala.Product
-
productIterator
public scala.collection.Iterator<java.lang.Object> productIterator()
- Specified by:
productIterator
in interfacescala.Product
-
canEqual
public boolean canEqual(java.lang.Object x$1)
- Specified by:
canEqual
in interfacescala.Equals
-
productElementName
public java.lang.String productElementName(int x$1)
- Specified by:
productElementName
in interfacescala.Product
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
equals
public boolean equals(java.lang.Object x$1)
- Specified by:
equals
in interfacescala.Equals
- Overrides:
equals
in classjava.lang.Object
-
-