c

akka.routing

BroadcastGroup

final case class BroadcastGroup(paths: Iterable[String], routerDispatcher: String = Dispatchers.DefaultDispatcherId) extends Group with Product with 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.

paths

string representation of the actor paths of the routees, messages are sent with akka.actor.ActorSelection to these paths

routerDispatcher

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

Annotations
@SerialVersionUID()
Source
Broadcast.scala
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. BroadcastGroup
  2. Product
  3. Equals
  4. Group
  5. RouterConfig
  6. Serializable
  7. Serializable
  8. AnyRef
  9. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new BroadcastGroup(routeePaths: Iterable[String])

    Java API

    Java API

    routeePaths

    string representation of the actor paths of the routees, messages are sent with akka.actor.ActorSelection to these paths

  2. new BroadcastGroup(config: Config)
  3. new BroadcastGroup(paths: Iterable[String], routerDispatcher: String = Dispatchers.DefaultDispatcherId)

    paths

    string representation of the actor paths of the routees, messages are sent with akka.actor.ActorSelection to these paths

    routerDispatcher

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

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from BroadcastGroup to any2stringadd[BroadcastGroup] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (BroadcastGroup, B)
    Implicit
    This member is added by an implicit conversion from BroadcastGroup to ArrowAssoc[BroadcastGroup] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  8. def createRouter(system: ActorSystem): Router

    Create the actual router, responsible for routing messages to routees.

    Create the actual router, responsible for routing messages to routees.

    system

    the ActorSystem this router belongs to

    Definition Classes
    BroadcastGroupRouterConfig
  9. def ensuring(cond: (BroadcastGroup) ⇒ Boolean, msg: ⇒ Any): BroadcastGroup
    Implicit
    This member is added by an implicit conversion from BroadcastGroup to Ensuring[BroadcastGroup] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: (BroadcastGroup) ⇒ Boolean): BroadcastGroup
    Implicit
    This member is added by an implicit conversion from BroadcastGroup to Ensuring[BroadcastGroup] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean, msg: ⇒ Any): BroadcastGroup
    Implicit
    This member is added by an implicit conversion from BroadcastGroup to Ensuring[BroadcastGroup] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean): BroadcastGroup
    Implicit
    This member is added by an implicit conversion from BroadcastGroup to Ensuring[BroadcastGroup] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from BroadcastGroup to StringFormat[BroadcastGroup] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  15. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  16. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  17. def isManagementMessage(msg: Any): Boolean

    Is the message handled by the router head actor or the #routingLogicController actor.

    Is the message handled by the router head actor or the #routingLogicController actor.

    Definition Classes
    RouterConfig
  18. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  20. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  21. def paths(system: ActorSystem): Iterable[String]
    Definition Classes
    BroadcastGroupGroup
  22. val paths: Iterable[String]
  23. def props(): Props

    akka.actor.Props for a group router based on the settings defined by this instance.

    akka.actor.Props for a group router based on the settings defined by this instance.

    Definition Classes
    Group
  24. val routerDispatcher: String

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

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

    Definition Classes
    BroadcastGroupRouterConfig
  25. def routingLogicController(routingLogic: RoutingLogic): Option[Props]

    Possibility to define an actor for controlling the routing logic from external stimuli (e.g.

    Possibility to define an actor for controlling the routing logic from external stimuli (e.g. monitoring metrics). This actor will be a child of the router "head" actor. Management messages not handled by the "head" actor are delegated to this controller actor.

    Definition Classes
    RouterConfig
  26. def stopRouterWhenAllRouteesRemoved: Boolean
    Definition Classes
    RouterConfig
  27. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  28. def verifyConfig(path: ActorPath): Unit

    Check that everything is there which is needed.

    Check that everything is there which is needed. Called in constructor of RoutedActorRef to fail early.

    Definition Classes
    RouterConfig
  29. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  30. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  31. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  32. def withDispatcher(dispatcherId: String): BroadcastGroup

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

  33. def withFallback(other: RouterConfig): RouterConfig

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

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

    Definition Classes
    RouterConfig
  34. def [B](y: B): (BroadcastGroup, B)
    Implicit
    This member is added by an implicit conversion from BroadcastGroup to ArrowAssoc[BroadcastGroup] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated @deprecated
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

Inherited from Product

Inherited from Equals

Inherited from Group

Inherited from RouterConfig

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from BroadcastGroup to any2stringadd[BroadcastGroup]

Inherited by implicit conversion StringFormat from BroadcastGroup to StringFormat[BroadcastGroup]

Inherited by implicit conversion Ensuring from BroadcastGroup to Ensuring[BroadcastGroup]

Inherited by implicit conversion ArrowAssoc from BroadcastGroup to ArrowAssoc[BroadcastGroup]

Ungrouped