akka.routing
Class ScatterGatherFirstCompletedRouter

java.lang.Object
  extended by akka.routing.ScatterGatherFirstCompletedRouter
All Implemented Interfaces:
RouterConfig, ScatterGatherFirstCompletedLike, java.io.Serializable, scala.Equals, scala.Product

public class ScatterGatherFirstCompletedRouter
extends java.lang.Object
implements RouterConfig, ScatterGatherFirstCompletedLike, scala.Product, scala.Serializable

Simple router that broadcasts the message to all routees, and replies with the first response.
You have to defin the 'within: Duration' parameter (f.e: within = 10 seconds).
Please note that providing both 'nrOfInstances' and 'routees' does not make logical sense as this means that the router should both create new actors and use the 'routees' actor(s). In this case the 'nrOfInstances' will be ignored and the 'routees' will be used.
The configuration parameter trumps the constructor arguments. This means that if you provide either 'nrOfInstances' or 'routees' 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 “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.

See Also:
Serialized Form

Constructor Summary
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.
 
Method Summary
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)
           
 int nrOfInstances()
           
 RouterConfig overrideUnsetConfig(RouterConfig other)
           
 scala.Option<Resizer> resizer()
          Routers 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, i.e.
 SupervisorStrategy supervisorStrategy()
          SupervisorStrategy for the created Router actor.
 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.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface akka.routing.ScatterGatherFirstCompletedLike
createRoute
 
Methods inherited from interface akka.routing.RouterConfig
createActor, createRoute, createRouteeProvider, stopRouterWhenAllRouteesRemoved, toAll, verifyConfig
 
Methods inherited from interface scala.Product
productArity, productElement, productIterator, productPrefix
 
Methods inherited from interface scala.Equals
canEqual, equals
 

Constructor Detail

ScatterGatherFirstCompletedRouter

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)

ScatterGatherFirstCompletedRouter

public ScatterGatherFirstCompletedRouter(int nr,
                                         scala.concurrent.duration.FiniteDuration w)
Java API: Constructor that sets nrOfInstances to be created.


ScatterGatherFirstCompletedRouter

public ScatterGatherFirstCompletedRouter(java.lang.Iterable<java.lang.String> routeePaths,
                                         scala.concurrent.duration.FiniteDuration w)
Java API: Constructor that sets the routees to be used.

Parameters:
routeePaths - string representation of the actor paths of the routees that will be looked up using actorFor in ActorRefProvider

ScatterGatherFirstCompletedRouter

public ScatterGatherFirstCompletedRouter(Resizer resizer,
                                         scala.concurrent.duration.FiniteDuration w)
Java API: Constructor that sets the resizer to be used.

Method Detail

apply

public 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


create

public static ScatterGatherFirstCompletedRouter create(java.lang.Iterable<ActorRef> routees,
                                                       scala.concurrent.duration.FiniteDuration within)

nrOfInstances

public int nrOfInstances()
Specified by:
nrOfInstances in interface ScatterGatherFirstCompletedLike

routees

public scala.collection.immutable.Iterable<java.lang.String> routees()
Specified by:
routees in interface ScatterGatherFirstCompletedLike

within

public scala.concurrent.duration.FiniteDuration within()
Specified by:
within in interface ScatterGatherFirstCompletedLike

resizer

public scala.Option<Resizer> resizer()
Description copied from interface: RouterConfig
Routers 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 RouterConfig

routerDispatcher

public java.lang.String routerDispatcher()
Description copied from interface: RouterConfig
Dispatcher ID to use for running the “head” actor, i.e. the Router.

Specified by:
routerDispatcher in interface RouterConfig

supervisorStrategy

public SupervisorStrategy supervisorStrategy()
Description copied from interface: RouterConfig
SupervisorStrategy for the created Router actor.

Specified by:
supervisorStrategy in interface RouterConfig

withDispatcher

public ScatterGatherFirstCompletedRouter withDispatcher(java.lang.String dispatcherId)
Java API for setting routerDispatcher


withSupervisorStrategy

public ScatterGatherFirstCompletedRouter withSupervisorStrategy(SupervisorStrategy strategy)
Java API for setting the supervisor strategy to be used for the “head” Router actor.


withResizer

public ScatterGatherFirstCompletedRouter withResizer(Resizer resizer)
Java API for setting the resizer to be used.


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

overrideUnsetConfig

public RouterConfig overrideUnsetConfig(RouterConfig other)