akka.routing

Class BroadcastGroup

java.lang.Object

akka.routing.BroadcastGroup

All Implemented Interfaces:

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

public final class BroadcastGroup
extends java.lang.Object
implements Group, scala.Product, scala.Serializable

A router group that broadcasts a message to all its routees.

The configuration parameter trumps the constructor arguments. This means that if you provide paths during instantiation they will be ignored if the router is defined in the configuration file for the actor being used.

param: paths string representation of the actor paths of the routees, messages are sent with ActorSelection to these paths

param: routerDispatcher dispatcher to use for the router head actor, which handles router management messages

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
BroadcastGroup(com.typesafe.config.Config config)
BroadcastGroup(java.lang.Iterable<java.lang.String> routeePaths) Java API
BroadcastGroup(scala.collection.immutable.Iterable<java.lang.String> paths, java.lang.String routerDispatcher)

Method Summary

Modifier and Type	Method and Description
Router	createRouter(ActorSystem system) Create the actual router, responsible for routing messages to routees.
scala.collection.immutable.Iterable<java.lang.String>	paths()
java.lang.String	routerDispatcher() Dispatcher ID to use for running the &ldquo;head&rdquo; actor, which handles supervision, death watch and router management messages
BroadcastGroup	withDispatcher(java.lang.String dispatcherId) Setting the dispatcher to be used for the router head actor, which handles router management messages

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

isManagementMessage, routingLogicController, stopRouterWhenAllRouteesRemoved, verifyConfig, withFallback

Methods inherited from interface scala.Product

productArity, productElement, productIterator, productPrefix

Methods inherited from interface scala.Equals

canEqual, equals

Constructor Detail

BroadcastGroup

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

BroadcastGroup

public BroadcastGroup(com.typesafe.config.Config config)

BroadcastGroup

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

Java API

Parameters:

routeePaths - string representation of the actor paths of the routees, messages are sent with ActorSelection to these paths

Method Detail

paths

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

Specified by:

paths in interface Group

routerDispatcher

public java.lang.String routerDispatcher()

Description copied from interface: RouterConfig

Dispatcher ID to use for running the “head” actor, which handles supervision, death watch and router management messages

Specified by:

routerDispatcher in interface RouterConfig

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)

withDispatcher

public BroadcastGroup withDispatcher(java.lang.String dispatcherId)

Setting the dispatcher to be used for the router head actor, which handles router management messages

Parameters:

dispatcherId - (undocumented)

Returns:

(undocumented)