final case class ScatterGatherFirstCompletedPool(nrOfInstances: Int, resizer: Option[Resizer] = None, within: FiniteDuration, supervisorStrategy: SupervisorStrategy = Pool.defaultSupervisorStrategy, routerDispatcher: String = Dispatchers.DefaultDispatcherId, usePoolDispatcher: Boolean = false) extends Pool with PoolOverrideUnsetConfig[ScatterGatherFirstCompletedPool] with Product with Serializable
A router pool that broadcasts the message to all routees, and replies with the first response.
The configuration parameter trumps the constructor arguments. This means that
if you provide nrOfInstances during instantiation they will be ignored if
the router is defined in the configuration file for the actor being used.
Supervision Setup
Any routees that are created by a router will be created as the router's children. The router is therefore also the children's supervisor.
The supervision strategy of the router actor can be configured with #withSupervisorStrategy. If no strategy is provided, routers default to a strategy of “always escalate”. This means that errors are passed up to the router's supervisor for handling.
The router's supervisor will treat the error as an error with the router itself. Therefore a directive to stop or restart will cause the router itself to stop or restart. The router, in turn, will cause its children to stop and restart.
- nrOfInstances
initial number of routees in the pool
- resizer
optional resizer that dynamically adjust the pool size
- within
expecting at least one reply within this duration, otherwise it will reply with akka.pattern.AskTimeoutException in a akka.actor.Status.Failure
- supervisorStrategy
strategy for supervising the routees, see 'Supervision Setup'
- routerDispatcher
dispatcher to use for the router head actor, which handles supervision, death watch and router management messages
- Annotations
- @SerialVersionUID()
- Source
- ScatterGatherFirstCompleted.scala
- Alphabetic
- By Inheritance
- ScatterGatherFirstCompletedPool
- Product
- Equals
- PoolOverrideUnsetConfig
- Pool
- RouterConfig
- Serializable
- Serializable
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- All
Instance Constructors
-
new
ScatterGatherFirstCompletedPool(nr: Int, within: FiniteDuration)
Java API
Java API
- nr
initial number of routees in the pool
- within
expecting at least one reply within this duration, otherwise it will reply with akka.pattern.AskTimeoutException in a akka.actor.Status.Failure
- new ScatterGatherFirstCompletedPool(config: Config)
-
new
ScatterGatherFirstCompletedPool(nrOfInstances: Int, resizer: Option[Resizer] = None, within: FiniteDuration, supervisorStrategy: SupervisorStrategy = Pool.defaultSupervisorStrategy, routerDispatcher: String = Dispatchers.DefaultDispatcherId, usePoolDispatcher: Boolean = false)
- nrOfInstances
initial number of routees in the pool
- resizer
optional resizer that dynamically adjust the pool size
- within
expecting at least one reply within this duration, otherwise it will reply with akka.pattern.AskTimeoutException in a akka.actor.Status.Failure
- supervisorStrategy
strategy for supervising the routees, see 'Supervision Setup'
- routerDispatcher
dispatcher to use for the router head actor, which handles supervision, death watch and 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 ScatterGatherFirstCompletedPool to any2stringadd[ScatterGatherFirstCompletedPool] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
-
def
->[B](y: B): (ScatterGatherFirstCompletedPool, B)
- Implicit
- This member is added by an implicit conversion from ScatterGatherFirstCompletedPool to ArrowAssoc[ScatterGatherFirstCompletedPool] 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
- @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
- ScatterGatherFirstCompletedPool → RouterConfig
-
def
ensuring(cond: (ScatterGatherFirstCompletedPool) ⇒ Boolean, msg: ⇒ Any): ScatterGatherFirstCompletedPool
- Implicit
- This member is added by an implicit conversion from ScatterGatherFirstCompletedPool to Ensuring[ScatterGatherFirstCompletedPool] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: (ScatterGatherFirstCompletedPool) ⇒ Boolean): ScatterGatherFirstCompletedPool
- Implicit
- This member is added by an implicit conversion from ScatterGatherFirstCompletedPool to Ensuring[ScatterGatherFirstCompletedPool] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: Boolean, msg: ⇒ Any): ScatterGatherFirstCompletedPool
- Implicit
- This member is added by an implicit conversion from ScatterGatherFirstCompletedPool to Ensuring[ScatterGatherFirstCompletedPool] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: Boolean): ScatterGatherFirstCompletedPool
- Implicit
- This member is added by an implicit conversion from ScatterGatherFirstCompletedPool to Ensuring[ScatterGatherFirstCompletedPool] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
def
formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from ScatterGatherFirstCompletedPool to StringFormat[ScatterGatherFirstCompletedPool] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @inline()
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
-
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
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
-
def
nrOfInstances(sys: ActorSystem): Int
Initial number of routee instances
Initial number of routee instances
- Definition Classes
- ScatterGatherFirstCompletedPool → Pool
-
val
nrOfInstances: Int
- Definition Classes
- ScatterGatherFirstCompletedPool → Pool
-
final
def
overrideUnsetConfig(other: RouterConfig): RouterConfig
- Definition Classes
- PoolOverrideUnsetConfig
-
def
props(routeeProps: Props): Props
akka.actor.Props for a pool router based on the settings defined by this instance and the supplied akka.actor.Props for the routees created by the router.
akka.actor.Props for a pool router based on the settings defined by this instance and the supplied akka.actor.Props for the routees created by the router.
- Definition Classes
- Pool
-
val
resizer: Option[Resizer]
- Definition Classes
- ScatterGatherFirstCompletedPool → Pool
-
val
routerDispatcher: String
- Definition Classes
- ScatterGatherFirstCompletedPool → 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
- Pool → RouterConfig
-
val
supervisorStrategy: SupervisorStrategy
- Definition Classes
- ScatterGatherFirstCompletedPool → Pool
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
val
usePoolDispatcher: Boolean
- Definition Classes
- ScatterGatherFirstCompletedPool → Pool
-
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(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
def
withDispatcher(dispatcherId: String): ScatterGatherFirstCompletedPool
Setting the dispatcher to be used for the router head actor, which handles supervision, death watch and router management messages.
-
def
withFallback(other: RouterConfig): RouterConfig
Uses the resizer and/or the supervisor strategy of the given RouterConfig if this RouterConfig doesn't have one, i.e.
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.
- Definition Classes
- ScatterGatherFirstCompletedPool → RouterConfig
-
def
withResizer(resizer: Resizer): ScatterGatherFirstCompletedPool
Setting the resizer to be used.
Setting the resizer to be used.
- Definition Classes
- ScatterGatherFirstCompletedPool → PoolOverrideUnsetConfig
-
def
withSupervisorStrategy(strategy: SupervisorStrategy): ScatterGatherFirstCompletedPool
Setting the supervisor strategy to be used for the “head” Router actor.
Setting the supervisor strategy to be used for the “head” Router actor.
- Definition Classes
- ScatterGatherFirstCompletedPool → PoolOverrideUnsetConfig
- val within: FiniteDuration
-
def
→[B](y: B): (ScatterGatherFirstCompletedPool, B)
- Implicit
- This member is added by an implicit conversion from ScatterGatherFirstCompletedPool to ArrowAssoc[ScatterGatherFirstCompletedPool] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc