akka.routing

BroadcastRouter

case class BroadcastRouter (nrOfInstances: Int, routees: Iterable[String], resizer: Option[Resizer], routerDispatcher: String, supervisorStrategy: SupervisorStrategy) extends RouterConfig with BroadcastLike with Product with 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(RoundRobinRouter(5))) val poolIndividuals = context.actorOf(Props[SomeActor].withRouter( RoundRobinRouter(5, supervisorStrategy = this.supervisorStrategy))) val specialChild = context.actorOf(Props[SomeActor].withRouter( RoundRobinRouter(5, supervisorStrategy = OneForOneStrategy() { ... }))) } }}}

routees

string representation of the actor paths of the routees that will be looked up using actorFor in ActorRefProvider

Linear Supertypes
Serializable, Serializable, Product, Equals, BroadcastLike, RouterConfig, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Hide All
  2. Show all
  1. BroadcastRouter
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. BroadcastLike
  7. RouterConfig
  8. AnyRef
  9. Any
Visibility
  1. Public
  2. All

Instance Constructors

  1. new BroadcastRouter (resizer: Resizer)

    Constructor that sets the resizer to be used.

    Constructor that sets the resizer to be used. Java API

  2. new BroadcastRouter (routeePaths: Iterable[String])

    Constructor that sets the routees to be used.

    Constructor that sets the routees to be used. Java API

    routeePaths

    string representation of the actor paths of the routees that will be looked up using actorFor in ActorRefProvider

  3. new BroadcastRouter (nr: Int)

    Constructor that sets nrOfInstances to be created.

    Constructor that sets nrOfInstances to be created. Java API

  4. new BroadcastRouter (nrOfInstances: Int, routees: Iterable[String], resizer: Option[Resizer], routerDispatcher: String, supervisorStrategy: SupervisorStrategy)

    routees

    string representation of the actor paths of the routees that will be looked up using actorFor in ActorRefProvider

Value Members

  1. def != (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef
  2. def != (arg0: Any): Boolean

    Attributes
    final
    Definition Classes
    Any
  3. def ## (): Int

    Attributes
    final
    Definition Classes
    AnyRef → Any
  4. def == (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef
  5. def == (arg0: Any): Boolean

    Attributes
    final
    Definition Classes
    Any
  6. def asInstanceOf [T0] : T0

    Attributes
    final
    Definition Classes
    Any
  7. def canEqual (arg0: Any): Boolean

    Definition Classes
    BroadcastRouter → Equals
  8. def clone (): AnyRef

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  9. def createActor (): Router

    Definition Classes
    RouterConfig
  10. def createRoute (props: Props, routeeProvider: RouteeProvider): Route

    Definition Classes
    BroadcastLike
  11. def createRouteeProvider (context: ActorContext): RouteeProvider

    Definition Classes
    RouterConfig
  12. def eq (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef
  13. def equals (arg0: Any): Boolean

    Definition Classes
    BroadcastRouter → Equals → AnyRef → Any
  14. def finalize (): Unit

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  15. def getClass (): java.lang.Class[_]

    Attributes
    final
    Definition Classes
    AnyRef → Any
  16. def hashCode (): Int

    Definition Classes
    BroadcastRouter → AnyRef → Any
  17. def isInstanceOf [T0] : Boolean

    Attributes
    final
    Definition Classes
    Any
  18. def ne (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef
  19. def notify (): Unit

    Attributes
    final
    Definition Classes
    AnyRef
  20. def notifyAll (): Unit

    Attributes
    final
    Definition Classes
    AnyRef
  21. val nrOfInstances : Int

    Definition Classes
    BroadcastRouterBroadcastLike
  22. def productArity : Int

    Definition Classes
    BroadcastRouter → Product
  23. def productElement (arg0: Int): Any

    Definition Classes
    BroadcastRouter → Product
  24. def productIterator : Iterator[Any]

    Definition Classes
    Product
  25. def productPrefix : String

    Definition Classes
    BroadcastRouter → Product
  26. val resizer : Option[Resizer]

    Routers with dynamically resizable number of routees return the Resizer to use.

    Routers with dynamically resizable number of routees return the Resizer to use.

    Definition Classes
    BroadcastRouterRouterConfig
  27. val routees : Iterable[String]

    string representation of the actor paths of the routees that will be looked up using actorFor in ActorRefProvider

    string representation of the actor paths of the routees that will be looked up using actorFor in ActorRefProvider

    Definition Classes
    BroadcastRouterBroadcastLike
  28. val routerDispatcher : String

    Dispatcher ID to use for running the “head” actor, i.

    Dispatcher ID to use for running the “head” actor, i.e. the Router.

    Definition Classes
    BroadcastRouterRouterConfig
  29. val supervisorStrategy : SupervisorStrategy

    SupervisorStrategy for the created Router actor.

    SupervisorStrategy for the created Router actor.

    Definition Classes
    BroadcastRouterRouterConfig
  30. def synchronized [T0] (arg0: ⇒ T0): T0

    Attributes
    final
    Definition Classes
    AnyRef
  31. def toAll (sender: ActorRef, routees: Iterable[ActorRef]): Iterable[Destination]

    Attributes
    protected
    Definition Classes
    RouterConfig
  32. def toString (): String

    Definition Classes
    BroadcastRouter → AnyRef → Any
  33. def wait (): Unit

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()
  34. def wait (arg0: Long, arg1: Int): Unit

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()
  35. def wait (arg0: Long): Unit

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()
  36. def withDispatcher (dispatcherId: String): BroadcastRouter

    Java API for setting routerDispatcher

  37. def withFallback (other: RouterConfig): RouterConfig

    Overridable merge strategy, by default completely prefers “this” (i.

    Overridable merge strategy, by default completely prefers “this” (i.e. no merge).

    Definition Classes
    RouterConfig
  38. def withSupervisorStrategy (strategy: SupervisorStrategy): BroadcastRouter

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

Deprecated Value Members

  1. def productElements : Iterator[Any]

    Definition Classes
    Product
    Annotations
    @deprecated
    Deprecated

    use productIterator instead

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from BroadcastLike

Inherited from RouterConfig

Inherited from AnyRef

Inherited from Any