public final class ScatterGatherFirstCompletedPool extends java.lang.Object implements Pool, scala.Product, scala.Serializable
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.
Constructor and Description |
---|
ScatterGatherFirstCompletedPool(com.typesafe.config.Config config) |
ScatterGatherFirstCompletedPool(int nr,
scala.concurrent.duration.FiniteDuration within)
Java API
|
ScatterGatherFirstCompletedPool(int nrOfInstances,
scala.Option<Resizer> resizer,
scala.concurrent.duration.FiniteDuration within,
SupervisorStrategy supervisorStrategy,
java.lang.String routerDispatcher,
boolean usePoolDispatcher) |
Modifier and Type | Method and Description |
---|---|
Router |
createRouter(ActorSystem system)
Create the actual router, responsible for routing messages to routees.
|
int |
nrOfInstances()
Initial number of routee instances
|
RouterConfig |
overrideUnsetConfig(RouterConfig other) |
scala.Option<Resizer> |
resizer()
Pool with dynamically resizable number of routees return the
Resizer
to use. |
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.
|
boolean |
usePoolDispatcher()
Use a dedicated dispatcher for the routees of the pool.
|
ScatterGatherFirstCompletedPool |
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 resizer and/or the supervisor strategy of the given Routerconfig
if this RouterConfig doesn't have one, i.e.
|
scala.concurrent.duration.FiniteDuration |
within() |
ScatterGatherFirstCompletedPool |
withResizer(Resizer resizer)
Setting the resizer to be used.
|
ScatterGatherFirstCompletedPool |
withSupervisorStrategy(SupervisorStrategy strategy)
Setting the supervisor strategy to be used for the “head” Router actor.
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
createRouterActor, defaultSupervisorStrategy, enrichWithPoolDispatcher, newRoutee, props, stopRouterWhenAllRouteesRemoved
isManagementMessage, routingLogicController, verifyConfig
public ScatterGatherFirstCompletedPool(int nrOfInstances, scala.Option<Resizer> resizer, scala.concurrent.duration.FiniteDuration within, SupervisorStrategy supervisorStrategy, java.lang.String routerDispatcher, boolean usePoolDispatcher)
public ScatterGatherFirstCompletedPool(com.typesafe.config.Config config)
public ScatterGatherFirstCompletedPool(int nr, scala.concurrent.duration.FiniteDuration within)
nr
- initial number of routees in the poolwithin
- expecting at least one reply within this duration, otherwise
it will reply with AskTimeoutException
in a Status.Failure
public int nrOfInstances()
Pool
nrOfInstances
in interface Pool
public scala.Option<Resizer> resizer()
Pool
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.public scala.concurrent.duration.FiniteDuration within()
public SupervisorStrategy supervisorStrategy()
Pool
supervisorStrategy
in interface Pool
public java.lang.String routerDispatcher()
RouterConfig
routerDispatcher
in interface RouterConfig
public boolean usePoolDispatcher()
Pool
usePoolDispatcher
in interface Pool
public Router createRouter(ActorSystem system)
RouterConfig
createRouter
in interface RouterConfig
system
- the ActorSystem this router belongs topublic ScatterGatherFirstCompletedPool withSupervisorStrategy(SupervisorStrategy strategy)
public ScatterGatherFirstCompletedPool withResizer(Resizer resizer)
public ScatterGatherFirstCompletedPool withDispatcher(java.lang.String dispatcherId)
public RouterConfig withFallback(RouterConfig other)
withFallback
in interface RouterConfig
public RouterConfig overrideUnsetConfig(RouterConfig other)