final case class ClusterRouterPool(local: Pool, settings: ClusterRouterPoolSettings) extends Pool with ClusterRouterConfigBase with Product with Serializable
pekko.routing.RouterConfig implementation for deployment on cluster nodes. Delegates other duties to the local pekko.routing.RouterConfig, which makes it possible to mix this with the built-in routers such as pekko.routing.RoundRobinGroup or custom routers.
- Annotations
- @SerialVersionUID()
- Source
- ClusterRouterConfig.scala
- Alphabetic
- By Inheritance
- ClusterRouterPool
- Product
- Equals
- ClusterRouterConfigBase
- Pool
- RouterConfig
- Serializable
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new ClusterRouterPool(local: Pool, settings: ClusterRouterPoolSettings)
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 ClusterRouterPool toany2stringadd[ClusterRouterPool] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
- def ->[B](y: B): (ClusterRouterPool, B)
- Implicit
- This member is added by an implicit conversion from ClusterRouterPool toArrowAssoc[ClusterRouterPool] 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[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
- 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
- ClusterRouterConfigBase → RouterConfig
- def ensuring(cond: (ClusterRouterPool) => Boolean, msg: => Any): ClusterRouterPool
- Implicit
- This member is added by an implicit conversion from ClusterRouterPool toEnsuring[ClusterRouterPool] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: (ClusterRouterPool) => Boolean): ClusterRouterPool
- Implicit
- This member is added by an implicit conversion from ClusterRouterPool toEnsuring[ClusterRouterPool] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean, msg: => Any): ClusterRouterPool
- Implicit
- This member is added by an implicit conversion from ClusterRouterPool toEnsuring[ClusterRouterPool] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean): ClusterRouterPool
- Implicit
- This member is added by an implicit conversion from ClusterRouterPool toEnsuring[ClusterRouterPool] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- 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
- ClusterRouterConfigBase → RouterConfig
- val local: Pool
- Definition Classes
- ClusterRouterPool → ClusterRouterConfigBase
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- def nrOfInstances(sys: ActorSystem): Int
Initial number of routee instances
Initial number of routee instances
- Definition Classes
- ClusterRouterPool → Pool
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- 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
- def 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
- ClusterRouterPool → Pool
- def 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
- ClusterRouterConfigBase → 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
- ClusterRouterConfigBase → RouterConfig
- val settings: ClusterRouterPoolSettings
- Definition Classes
- ClusterRouterPool → ClusterRouterConfigBase
- 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 aresizeris used.- Definition Classes
- ClusterRouterConfigBase → RouterConfig
- def 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
- ClusterRouterPool → Pool
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- 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
- RouterConfig
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- 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
- ClusterRouterPool → RouterConfig
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
(Since version 9)
- def formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from ClusterRouterPool toStringFormat[ClusterRouterPool] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @deprecated @inline()
- Deprecated
(Since version 2.12.16) Use
formatString.format(value)instead ofvalue.formatted(formatString), or use thef""string interpolator. In Java 15 and later,formattedresolves to the new method in String which has reversed parameters.
- def →[B](y: B): (ClusterRouterPool, B)
- Implicit
- This member is added by an implicit conversion from ClusterRouterPool toArrowAssoc[ClusterRouterPool] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Use
->instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.