public class ScatterGatherFirstCompletedRouter extends java.lang.Object implements DeprecatedRouterConfig, scala.Product, scala.Serializable
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 |
---|
ScatterGatherFirstCompletedRouter(int nr,
scala.concurrent.duration.FiniteDuration w)
Java API: Constructor that sets nrOfInstances to be created.
|
ScatterGatherFirstCompletedRouter(int nrOfInstances,
scala.collection.immutable.Iterable<java.lang.String> routees,
scala.concurrent.duration.FiniteDuration within,
scala.Option<Resizer> resizer,
java.lang.String routerDispatcher,
SupervisorStrategy supervisorStrategy) |
ScatterGatherFirstCompletedRouter(java.lang.Iterable<java.lang.String> routeePaths,
scala.concurrent.duration.FiniteDuration w)
Java API: Constructor that sets the routees to be used.
|
ScatterGatherFirstCompletedRouter(Resizer resizer,
scala.concurrent.duration.FiniteDuration w)
Java API: Constructor that sets the resizer to be used.
|
Modifier and Type | Method and Description |
---|---|
static ScatterGatherFirstCompletedRouter |
apply(scala.collection.immutable.Iterable<ActorRef> routees,
scala.concurrent.duration.FiniteDuration within)
Creates a new ScatterGatherFirstCompletedRouter, routing to the specified routees, timing out after the specified Duration
|
static ScatterGatherFirstCompletedRouter |
create(java.lang.Iterable<ActorRef> routees,
scala.concurrent.duration.FiniteDuration within) |
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.collection.immutable.Iterable<java.lang.String> |
paths() |
scala.Option<Resizer> |
resizer()
Pool with dynamically resizable number of routees return the
Resizer
to use. |
scala.collection.immutable.Iterable<java.lang.String> |
routees() |
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.
|
ScatterGatherFirstCompletedRouter |
withDispatcher(java.lang.String dispatcherId)
Java API for setting routerDispatcher
|
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() |
ScatterGatherFirstCompletedRouter |
withResizer(Resizer resizer)
Java API for setting the resizer to be used.
|
ScatterGatherFirstCompletedRouter |
withSupervisorStrategy(SupervisorStrategy strategy)
Java API for setting the supervisor strategy to be used for the “head”
Router actor.
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
createRouterActor, props, routeeFor
createRouterActor, defaultSupervisorStrategy, enrichWithPoolDispatcher, newRoutee, props, stopRouterWhenAllRouteesRemoved, usePoolDispatcher
isManagementMessage, routingLogicController, verifyConfig
public ScatterGatherFirstCompletedRouter(int nrOfInstances, scala.collection.immutable.Iterable<java.lang.String> routees, scala.concurrent.duration.FiniteDuration within, scala.Option<Resizer> resizer, java.lang.String routerDispatcher, SupervisorStrategy supervisorStrategy)
public ScatterGatherFirstCompletedRouter(int nr, scala.concurrent.duration.FiniteDuration w)
public ScatterGatherFirstCompletedRouter(java.lang.Iterable<java.lang.String> routeePaths, scala.concurrent.duration.FiniteDuration w)
routeePaths
- string representation of the actor paths of the routees that will be looked up
using actorFor
in ActorRefProvider
public ScatterGatherFirstCompletedRouter(Resizer resizer, scala.concurrent.duration.FiniteDuration w)
public static ScatterGatherFirstCompletedRouter apply(scala.collection.immutable.Iterable<ActorRef> routees, scala.concurrent.duration.FiniteDuration within)
public static ScatterGatherFirstCompletedRouter create(java.lang.Iterable<ActorRef> routees, scala.concurrent.duration.FiniteDuration within)
public int nrOfInstances()
Pool
nrOfInstances
in interface Pool
public scala.collection.immutable.Iterable<java.lang.String> routees()
public scala.concurrent.duration.FiniteDuration within()
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 java.lang.String routerDispatcher()
RouterConfig
routerDispatcher
in interface RouterConfig
public SupervisorStrategy supervisorStrategy()
Pool
supervisorStrategy
in interface Pool
public scala.collection.immutable.Iterable<java.lang.String> paths()
public ScatterGatherFirstCompletedRouter withDispatcher(java.lang.String dispatcherId)
public ScatterGatherFirstCompletedRouter withSupervisorStrategy(SupervisorStrategy strategy)
public ScatterGatherFirstCompletedRouter withResizer(Resizer resizer)
public RouterConfig withFallback(RouterConfig other)
withFallback
in interface RouterConfig
public Router createRouter(ActorSystem system)
RouterConfig
createRouter
in interface RouterConfig
system
- the ActorSystem this router belongs topublic RouterConfig overrideUnsetConfig(RouterConfig other)