akka.routing
Class BroadcastRouter

java.lang.Object
  akka.routing.BroadcastRouter

All Implemented Interfaces:

DeprecatedRouterConfig, Group, Pool, PoolOverrideUnsetConfig<BroadcastRouter>, RouterConfig, java.io.Serializable, scala.Equals, scala.Product

public class BroadcastRouter
extends java.lang.Object
implements DeprecatedRouterConfig, PoolOverrideUnsetConfig<BroadcastRouter>, scala.Product, scala.Serializable

See Also:

Serialized Form

Constructor Summary

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

BroadcastRouter(int nrOfInstances, scala.collection.immutable.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.immutable.Iterable<ActorRef> routees) Creates a new BroadcastRouter, routing to the specified routees
static BroadcastRouter	create(java.lang.Iterable<ActorRef> routees)
Router	createRouter(ActorSystem system) Create the actual router, responsible for routing messages to routees.
int	nrOfInstances() Initial number of routee instances
scala.collection.immutable.Iterable<java.lang.String>	paths()
scala.Option<Resizer>	resizer() Pool 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 &ldquo;head&rdquo; actor, which handles supervision, death watch and router management messages
SupervisorStrategy	supervisorStrategy() SupervisorStrategy for the head actor, i.e.
BroadcastRouter	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.
BroadcastRouter	withResizer(Resizer resizer) Java API for setting the resizer to be used.
BroadcastRouter	withSupervisorStrategy(SupervisorStrategy strategy) Java API for 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.Group

createRouterActor, props, routeeFor

Methods inherited from interface akka.routing.PoolOverrideUnsetConfig

overrideUnsetConfig

Methods inherited from interface akka.routing.Pool

createRouterActor, enrichWithPoolDispatcher, newRoutee, props, stopRouterWhenAllRouteesRemoved, usePoolDispatcher

Methods inherited from interface akka.routing.RouterConfig

isManagementMessage, routingLogicController, verifyConfig

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

Parameters:

nr - (undocumented)

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.

Parameters:

resizer - (undocumented)

Method Detail

apply

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

Creates a new BroadcastRouter, routing to the specified routees

Parameters:

routees - (undocumented)

Returns:

(undocumented)

create

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

nrOfInstances

public int nrOfInstances()

Description copied from interface: Pool

Initial number of routee instances

Specified by:

nrOfInstances in interface Pool

Returns:

(undocumented)

routees

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

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)

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)

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)

paths

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

Specified by:

paths in interface Group

withDispatcher

public BroadcastRouter withDispatcher(java.lang.String dispatcherId)

Java API for setting routerDispatcher

Parameters:

dispatcherId - (undocumented)

Returns:

(undocumented)

withSupervisorStrategy

public BroadcastRouter withSupervisorStrategy(SupervisorStrategy strategy)

Java API for setting the supervisor strategy to be used for the &ldquo;head&rdquo; Router actor.

Specified by:

withSupervisorStrategy in interface PoolOverrideUnsetConfig<BroadcastRouter>

Parameters:

strategy - (undocumented)

Returns:

(undocumented)

withResizer

public BroadcastRouter withResizer(Resizer resizer)

Java API for setting the resizer to be used.

Specified by:

withResizer in interface PoolOverrideUnsetConfig<BroadcastRouter>

Parameters:

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

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)