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
- Alphabetic
- By Inheritance
- BroadcastGroup
- Product
- Equals
- Group
- RouterConfig
- Serializable
- Serializable
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- All
Instance Constructors
-
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
- new BroadcastGroup(config: Config)
-
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
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
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
-
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()
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate() @throws( ... )
-
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
- BroadcastGroup → RouterConfig
-
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
-
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
-
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
-
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
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
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()
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
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
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
def
paths(system: ActorSystem): Iterable[String]
- Definition Classes
- BroadcastGroup → Group
- val paths: Iterable[String]
-
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
-
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
- BroadcastGroup → RouterConfig
-
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
-
def
stopRouterWhenAllRouteesRemoved: Boolean
- Definition Classes
- RouterConfig
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
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
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
def
withDispatcher(dispatcherId: String): BroadcastGroup
Setting the dispatcher to be used for the router head actor, which handles router management messages
-
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
-
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