akka.routing
Class BroadcastRouter

java.lang.Object
  akka.routing.BroadcastRouter

All Implemented Interfaces:

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

public class BroadcastRouter
extends java.lang.Object
implements RouterConfig, BroadcastLike, scala.Product, scala.Serializable

A Router that uses broadcasts a message to all its connections.
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(BroadcastRouter(5)))

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

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

See Also:

Serialized Form

Constructor Summary

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

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

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

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

Method Summary

static BroadcastRouter	apply(scala.collection.Iterable<ActorRef> routees) Creates a new BroadcastRouter, routing to the specified routees
static BroadcastRouter	create(java.lang.Iterable<ActorRef> routees)
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.
BroadcastRouter	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.
BroadcastRouter	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.BroadcastLike

createRoute

Methods inherited from interface scala.Product

productArity, productElement, productIterator, productPrefix

Methods inherited from interface scala.Equals

canEqual, equals

Constructor Detail

BroadcastRouter

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

BroadcastRouter

public BroadcastRouter(int nr)

Java API: Constructor that sets nrOfInstances to be created.

BroadcastRouter

public BroadcastRouter(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

BroadcastRouter

public BroadcastRouter(Resizer resizer)

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

Method Detail

apply

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

Creates a new BroadcastRouter, routing to the specified routees

create

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

nrOfInstances

public int nrOfInstances()

Specified by:

nrOfInstances in interface BroadcastLike

routees

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

Specified by:

routees in interface BroadcastLike

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

Java API for setting routerDispatcher

withSupervisorStrategy

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