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

The router creates a “head” actor which supervises and/or monitors the routees. Instances are created as children of this actor, hence the children are not supervised by the parent of the router. Common choices are to always escalate (meaning that fault handling is always applied to all children simultaneously; this is the default) or use the parent’s strategy, which will result in routed children being treated individually, but it is possible as well to use Routers to give different supervisor strategies to different groups of children.


 class MyActor extends Actor {
   override val supervisorStrategy = ...

   val poolAsAWhole = context.actorOf(Props[SomeActor].withRouter(ScatterGatherFirstCompletedRouter(5)))

   val poolIndividuals = context.actorOf(Props[SomeActor].withRouter(
     ScatterGatherFirstCompletedRouter(5, supervisorStrategy = this.supervisorStrategy)))

   val specialChild = context.actorOf(Props[SomeActor].withRouter(
     ScatterGatherFirstCompletedRouter(5, supervisorStrategy = OneForOneStrategy() {
       ...
     })))
 }
 

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.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.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()
           
 scala.Option<Resizer> resizer()
          Routers with dynamically resizable number of routees return the Resizer to use.
 scala.collection.Iterable<java.lang.String> routees()
           
 java.lang.String routerDispatcher()
          Dispatcher ID to use for running the “head” actor, i.e. the Router.
 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 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.
 scala.concurrent.duration.FiniteDuration within()
           
 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.RouterConfig
createActor, createRoute, createRouteeProvider, toAll, verifyConfig
 
Methods inherited from interface akka.routing.ScatterGatherFirstCompletedLike
createRoute
 
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.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.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.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.

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.


withFallback

public RouterConfig withFallback(RouterConfig other)
Uses the resizer 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