object FromConfig extends FromConfig with Product with Serializable
Wraps a akka.actor.Props to mark the actor as externally configurable to be used with a router. If a akka.actor.Props is not wrapped with FromConfig then the actor will ignore the router part of the deployment section in the configuration.
- Source
- RouterConfig.scala
- Alphabetic
- By Inheritance
- FromConfig
- Product
- Equals
- FromConfig
- Pool
- RouterConfig
- Serializable
- Serializable
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
apply(resizer: Option[Resizer] = None, supervisorStrategy: SupervisorStrategy = Pool.defaultSupervisorStrategy, routerDispatcher: String = Dispatchers.DefaultDispatcherId): FromConfig
- Annotations
- @inline()
-
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
- FromConfig → RouterConfig
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
-
def
getInstance: FromConfig.type
Java API: get the singleton instance
-
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
- FromConfig → Pool
-
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
- FromConfig
-
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
- FromConfig → Pool
-
val
routerDispatcher: String
- Definition Classes
- FromConfig → 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
- FromConfig → Pool
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
final
def
unapply(fc: FromConfig): Option[String]
- Annotations
- @inline()
-
def
usePoolDispatcher: Boolean
Use a dedicated dispatcher for the routees of the pool.
Use a dedicated dispatcher for the routees of the pool. The dispatcher is defined in 'pool-dispatcher' configuration property in the deployment section of the router.
- Definition Classes
- 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
- FromConfig → 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): FromConfig
Setting the dispatcher to be used for the router head actor, which handles supervision, death watch and router management messages.
Setting the dispatcher to be used for the router head actor, which handles supervision, death watch and router management messages.
- Definition Classes
- FromConfig
-
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
withResizer(resizer: Resizer): FromConfig
Setting the resizer to be used.
Setting the resizer to be used.
- Definition Classes
- FromConfig
-
def
withSupervisorStrategy(strategy: SupervisorStrategy): FromConfig
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
- FromConfig