Packages

c

org.apache.pekko.cluster.routing

ClusterRouterPool

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
Linear Supertypes
Product, Equals, ClusterRouterConfigBase, Pool, RouterConfig, Serializable, AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ClusterRouterPool
  2. Product
  3. Equals
  4. ClusterRouterConfigBase
  5. Pool
  6. RouterConfig
  7. Serializable
  8. AnyRef
  9. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new ClusterRouterPool(local: Pool, settings: ClusterRouterPoolSettings)

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. 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
  4. 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()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  8. 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
  9. 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
  10. 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
  11. 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
  12. 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
  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  15. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  16. 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
  17. val local: Pool
    Definition Classes
    ClusterRouterPool → ClusterRouterConfigBase
  18. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  20. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  21. def nrOfInstances(sys: ActorSystem): Int

    Initial number of routee instances

    Initial number of routee instances

    Definition Classes
    ClusterRouterPoolPool
  22. def productElementNames: Iterator[String]
    Definition Classes
    Product
  23. 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
  24. 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
    ClusterRouterPoolPool
  25. 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
  26. 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
  27. val settings: ClusterRouterPoolSettings
    Definition Classes
    ClusterRouterPool → ClusterRouterConfigBase
  28. 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
    ClusterRouterConfigBase → RouterConfig
  29. 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
    ClusterRouterPoolPool
  30. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  31. 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
  32. 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
  33. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  34. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  35. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  36. 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
    ClusterRouterPoolRouterConfig

Deprecated Value Members

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

    (Since version 9)

  2. 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 of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  3. 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.

Inherited from Product

Inherited from Equals

Inherited from ClusterRouterConfigBase

Inherited from Pool

Inherited from RouterConfig

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromClusterRouterPool to any2stringadd[ClusterRouterPool]

Inherited by implicit conversion StringFormat fromClusterRouterPool to StringFormat[ClusterRouterPool]

Inherited by implicit conversion Ensuring fromClusterRouterPool to Ensuring[ClusterRouterPool]

Inherited by implicit conversion ArrowAssoc fromClusterRouterPool to ArrowAssoc[ClusterRouterPool]

Ungrouped