akka.routing
Class RandomRouter

java.lang.Object
  akka.routing.RandomRouter

All Implemented Interfaces:

RandomLike, RouterConfig, java.io.Serializable, scala.Equals, scala.Product

public class RandomRouter
extends java.lang.Object
implements RouterConfig, RandomLike, scala.Product, scala.Serializable

A Router that randomly selects one of the target connections to send a message to.
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(RandomRouter(5)))

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

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

See Also:

Serialized Form

Constructor Summary

RandomRouter(int nr)
Java API: Constructor that sets nrOfInstances to be created.

RandomRouter(int nrOfInstances, scala.collection.immutable.Iterable<java.lang.String> routees, scala.Option<Resizer> resizer, java.lang.String routerDispatcher, SupervisorStrategy supervisorStrategy)

RandomRouter(java.lang.Iterable<java.lang.String> routeePaths)
Java API: Constructor that sets the routees to be used.

RandomRouter(Resizer resizer)
Java API: Constructor that sets the resizer to be used.

Method Summary

static RandomRouter	apply(scala.collection.immutable.Iterable<ActorRef> routees) Creates a new RandomRouter, routing to the specified routees
static RandomRouter	create(java.lang.Iterable<ActorRef> routees)
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. the Router.
SupervisorStrategy	supervisorStrategy() SupervisorStrategy for the created Router actor.
RandomRouter	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. the resizer defined in code is used if resizer was not defined in config.
RandomRouter	withResizer(Resizer resizer) Java API for setting the resizer to be used.
RandomRouter	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.RandomLike

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

RandomRouter

public RandomRouter(int nrOfInstances,
                    scala.collection.immutable.Iterable<java.lang.String> routees,
                    scala.Option<Resizer> resizer,
                    java.lang.String routerDispatcher,
                    SupervisorStrategy supervisorStrategy)

RandomRouter

public RandomRouter(int nr)

Java API: Constructor that sets nrOfInstances to be created.

RandomRouter

public RandomRouter(java.lang.Iterable<java.lang.String> routeePaths)

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

RandomRouter

public RandomRouter(Resizer resizer)

Java API: Constructor that sets the resizer to be used.

Method Detail

apply

public static RandomRouter apply(scala.collection.immutable.Iterable<ActorRef> routees)

Creates a new RandomRouter, routing to the specified routees

create

public static RandomRouter create(java.lang.Iterable<ActorRef> routees)

nrOfInstances

public int nrOfInstances()

Specified by:

nrOfInstances in interface RandomLike

routees

public scala.collection.immutable.Iterable<java.lang.String> routees()

Specified by:

routees in interface RandomLike

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 RandomRouter withDispatcher(java.lang.String dispatcherId)

Java API for setting routerDispatcher

withSupervisorStrategy

public RandomRouter withSupervisorStrategy(SupervisorStrategy strategy)

Java API for setting the supervisor strategy to be used for the “head” Router actor.

withResizer

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