case object FromConfig extends FromConfig with Product with Serializable

Wraps a pekko.actor.Props to mark the actor as externally configurable to be used with a router. If a pekko.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
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. FromConfig
  2. Product
  3. Equals
  4. FromConfig
  5. Pool
  6. RouterConfig
  7. Serializable
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def apply(resizer: Option[Resizer] = None, supervisorStrategy: SupervisorStrategy = Pool.defaultSupervisorStrategy, routerDispatcher: String = Dispatchers.DefaultDispatcherId): FromConfig
    Annotations
    @inline()
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  7. 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
    FromConfigRouterConfig
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  10. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  11. def getInstance: FromConfig

    Java API: get the singleton instance

  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. 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
  14. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  16. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  17. def nrOfInstances(sys: ActorSystem): Int

    Initial number of routee instances

    Initial number of routee instances

    Definition Classes
    FromConfigPool
  18. def productElementName(n: Int): String
    Definition Classes
    Product
  19. def productElementNames: Iterator[String]
    Definition Classes
    Product
  20. def props(): Props

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

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

    Definition Classes
    FromConfig
  21. def props(routeeProps: Props): Props

    pekko.actor.Props for a pool router based on the settings defined by this instance and the supplied pekko.actor.Props for the routees created by the router.

    pekko.actor.Props for a pool router based on the settings defined by this instance and the supplied pekko.actor.Props for the routees created by the router.

    Definition Classes
    Pool
  22. val resizer: Option[Resizer]

    Pool with dynamically resizable number of routees return the pekko.routing.Resizer to use.

    Pool with dynamically resizable number of routees return the pekko.routing.Resizer to use. The resizer is invoked once when the router is created, before any messages can be sent to it. Resize is also triggered when messages are sent to the routees, and the resizer is invoked asynchronously, i.e. not necessarily before the message has been sent.

    Definition Classes
    FromConfigPool
  23. 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
    FromConfigRouterConfig
  24. 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
  25. def stopRouterWhenAllRouteesRemoved: Boolean

    Specify that this router should stop itself when all routees have terminated (been removed).

    Specify that this router should stop itself when all routees have terminated (been removed). By Default it is true, unless a resizer is used.

    Definition Classes
    PoolRouterConfig
  26. val supervisorStrategy: SupervisorStrategy

    SupervisorStrategy for the head actor, i.e.

    SupervisorStrategy for the head actor, i.e. for supervising the routees of the pool.

    Definition Classes
    FromConfigPool
  27. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  28. final def unapply(fc: FromConfig): Option[String]
    Annotations
    @inline()
  29. 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
  30. 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
    FromConfigRouterConfig
  31. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  32. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  33. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  34. 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
  35. 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
  36. def withResizer(resizer: Resizer): FromConfig

    Setting the resizer to be used.

    Setting the resizer to be used.

    Definition Classes
    FromConfig
  37. 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

Deprecated Value Members

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

    (Since version 9)

Inherited from Product

Inherited from Equals

Inherited from FromConfig

Inherited from Pool

Inherited from RouterConfig

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped