akka.routing

Class ScatterGatherFirstCompletedPool

java.lang.Object

akka.routing.ScatterGatherFirstCompletedPool

All Implemented Interfaces:

Pool, PoolOverrideUnsetConfig<ScatterGatherFirstCompletedPool>, RouterConfig, java.io.Serializable, scala.Equals, scala.Product

public final class ScatterGatherFirstCompletedPool
extends java.lang.Object
implements Pool, PoolOverrideUnsetConfig<ScatterGatherFirstCompletedPool>, scala.Product, scala.Serializable

A router pool that broadcasts the message to all routees, and replies with the first response.

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(akka.actor.SupervisorStrategy). If no strategy is provided, routers default to a strategy of &ldquo;always escalate&rdquo;. 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: resizer optional resizer that dynamically adjust the pool size

param: within expecting at least one reply within this duration, otherwise it will reply with AskTimeoutException in a Status.Failure

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 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)

Method Summary

Modifier and Type	Method and Description
abstract static boolean	canEqual(java.lang.Object that)
Router	createRouter(ActorSystem system) Create the actual router, responsible for routing messages to routees.
static RouterActor	createRouterActor()
static Props	enrichWithPoolDispatcher(Props routeeProps, ActorContext context)
abstract static boolean	equals(java.lang.Object that)
static boolean	isManagementMessage(java.lang.Object msg)
static Routee	newRoutee(Props routeeProps, ActorContext context)
int	nrOfInstances()
int	nrOfInstances(ActorSystem sys) Initial number of routee instances
static RouterConfig	overrideUnsetConfig(RouterConfig other)
abstract static int	productArity()
abstract static java.lang.Object	productElement(int n)
static scala.collection.Iterator<java.lang.Object>	productIterator()
static java.lang.String	productPrefix()
static Props	props(Props routeeProps)
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 &ldquo;head&rdquo; actor, which handles supervision, death watch and router management messages
static scala.Option<Props>	routingLogicController(RoutingLogic routingLogic)
static boolean	stopRouterWhenAllRouteesRemoved()
SupervisorStrategy	supervisorStrategy() SupervisorStrategy for the head actor, i.e.
boolean	usePoolDispatcher() Use a dedicated dispatcher for the routees of the pool.
static void	verifyConfig(ActorPath path)
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 &ldquo;head&rdquo; 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.PoolOverrideUnsetConfig

overrideUnsetConfig

Methods inherited from interface akka.routing.Pool

createRouterActor, enrichWithPoolDispatcher, newRoutee, props, stopRouterWhenAllRouteesRemoved

Methods inherited from interface akka.routing.RouterConfig

isManagementMessage, routingLogicController, verifyConfig

Methods inherited from interface scala.Product

$init$, productArity, productElement, productIterator, productPrefix

Methods inherited from interface scala.Equals

canEqual, equals

Constructor Detail

ScatterGatherFirstCompletedPool

public ScatterGatherFirstCompletedPool(int nrOfInstances,
                                       scala.Option<Resizer> resizer,
                                       scala.concurrent.duration.FiniteDuration within,
                                       SupervisorStrategy supervisorStrategy,
                                       java.lang.String routerDispatcher,
                                       boolean usePoolDispatcher)

ScatterGatherFirstCompletedPool

public ScatterGatherFirstCompletedPool(com.typesafe.config.Config config)

ScatterGatherFirstCompletedPool

public ScatterGatherFirstCompletedPool(int nr,
                                       scala.concurrent.duration.FiniteDuration within)

Java API

Parameters:

nr - initial number of routees in the pool

within - expecting at least one reply within this duration, otherwise it will reply with AskTimeoutException in a Status.Failure

Method Detail

routingLogicController

public static scala.Option<Props> routingLogicController(RoutingLogic routingLogic)

isManagementMessage

public static boolean isManagementMessage(java.lang.Object msg)

verifyConfig

public static void verifyConfig(ActorPath path)

newRoutee

public static Routee newRoutee(Props routeeProps,
                               ActorContext context)

enrichWithPoolDispatcher

public static Props enrichWithPoolDispatcher(Props routeeProps,
                                             ActorContext context)

props

public static Props props(Props routeeProps)

stopRouterWhenAllRouteesRemoved

public static boolean stopRouterWhenAllRouteesRemoved()

createRouterActor

public static RouterActor createRouterActor()

overrideUnsetConfig

public static final RouterConfig overrideUnsetConfig(RouterConfig other)

canEqual

public abstract static boolean canEqual(java.lang.Object that)

equals

public abstract static boolean equals(java.lang.Object that)

productElement

public abstract static java.lang.Object productElement(int n)

productArity

public abstract static int productArity()

productIterator

public static scala.collection.Iterator<java.lang.Object> productIterator()

productPrefix

public static java.lang.String productPrefix()

nrOfInstances

public int nrOfInstances()

Specified by:

nrOfInstances in interface Pool

resizer

public scala.Option<Resizer> resizer()

Description copied from interface: Pool

Pool with dynamically resizable number of routees return the 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.

Specified by:

resizer in interface Pool

Returns:

(undocumented)

within

public scala.concurrent.duration.FiniteDuration within()

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 interface Pool

Returns:

(undocumented)

routerDispatcher

public java.lang.String routerDispatcher()

Description copied from interface: RouterConfig

Dispatcher ID to use for running the &ldquo;head&rdquo; actor, which handles supervision, death watch and router management messages

Specified by:

routerDispatcher in interface RouterConfig

Returns:

(undocumented)

usePoolDispatcher

public boolean usePoolDispatcher()

Description copied from interface: 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.

Specified by:

usePoolDispatcher in interface Pool

Returns:

(undocumented)

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 interface RouterConfig

Parameters:

system - the ActorSystem this router belongs to

Returns:

(undocumented)

nrOfInstances

public int nrOfInstances(ActorSystem sys)

Description copied from interface: Pool

Initial number of routee instances

Specified by:

nrOfInstances in interface Pool

Parameters:

sys - (undocumented)

Returns:

(undocumented)

withSupervisorStrategy

public ScatterGatherFirstCompletedPool withSupervisorStrategy(SupervisorStrategy strategy)

Setting the supervisor strategy to be used for the &ldquo;head&rdquo; Router actor.

Specified by:

withSupervisorStrategy in interface PoolOverrideUnsetConfig<ScatterGatherFirstCompletedPool>

Parameters:

strategy - (undocumented)

Returns:

(undocumented)

withResizer

public ScatterGatherFirstCompletedPool withResizer(Resizer resizer)

Setting the resizer to be used.

Specified by:

withResizer in interface PoolOverrideUnsetConfig<ScatterGatherFirstCompletedPool>

Parameters:

resizer - (undocumented)

Returns:

(undocumented)

withDispatcher

public 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.

Parameters:

dispatcherId - (undocumented)

Returns:

(undocumented)

withFallback

public 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. the resizer defined in code is used if resizer was not defined in config.

Specified by:

withFallback in interface RouterConfig

Parameters:

other - (undocumented)

Returns:

(undocumented)