Packages

c

akka.cluster.routing

ClusterRouterGroup

final case class ClusterRouterGroup(local: Group, settings: ClusterRouterGroupSettings) extends Group with ClusterRouterConfigBase with Product with Serializable

akka.routing.RouterConfig implementation for deployment on cluster nodes. Delegates other duties to the local akka.routing.RouterConfig, which makes it possible to mix this with the built-in routers such as akka.routing.RoundRobinGroup or custom routers.

Annotations
@SerialVersionUID()
Source
ClusterRouterConfig.scala
Linear Supertypes
Product, Equals, ClusterRouterConfigBase, Group, RouterConfig, Serializable, AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ClusterRouterGroup
  2. Product
  3. Equals
  4. ClusterRouterConfigBase
  5. Group
  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. All

Instance Constructors

  1. new ClusterRouterGroup(local: Group, settings: ClusterRouterGroupSettings)

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 ClusterRouterGroup toany2stringadd[ClusterRouterGroup] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (ClusterRouterGroup, B)
    Implicit
    This member is added by an implicit conversion from ClusterRouterGroup toArrowAssoc[ClusterRouterGroup] 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[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  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: (ClusterRouterGroup) => Boolean, msg: => Any): ClusterRouterGroup
    Implicit
    This member is added by an implicit conversion from ClusterRouterGroup toEnsuring[ClusterRouterGroup] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: (ClusterRouterGroup) => Boolean): ClusterRouterGroup
    Implicit
    This member is added by an implicit conversion from ClusterRouterGroup toEnsuring[ClusterRouterGroup] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean, msg: => Any): ClusterRouterGroup
    Implicit
    This member is added by an implicit conversion from ClusterRouterGroup toEnsuring[ClusterRouterGroup] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean): ClusterRouterGroup
    Implicit
    This member is added by an implicit conversion from ClusterRouterGroup toEnsuring[ClusterRouterGroup] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from ClusterRouterGroup toStringFormat[ClusterRouterGroup] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  15. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  16. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  17. 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
  18. val local: Group
    Definition Classes
    ClusterRouterGroup → ClusterRouterConfigBase
  19. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  21. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  22. def paths(system: ActorSystem): Iterable[String]
    Definition Classes
    ClusterRouterGroupGroup
  23. def productElementNames: Iterator[String]
    Definition Classes
    Product
  24. 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
    Group
  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: ClusterRouterGroupSettings
    Definition Classes
    ClusterRouterGroup → ClusterRouterConfigBase
  28. def stopRouterWhenAllRouteesRemoved: Boolean
    Definition Classes
    ClusterRouterConfigBase → RouterConfig
  29. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  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
    RouterConfig
  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 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
    ClusterRouterGroupRouterConfig

Deprecated Value Members

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

    (Since version ) see corresponding Javadoc for more information.

  2. def [B](y: B): (ClusterRouterGroup, B)
    Implicit
    This member is added by an implicit conversion from ClusterRouterGroup toArrowAssoc[ClusterRouterGroup] 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 Group

Inherited from RouterConfig

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromClusterRouterGroup to any2stringadd[ClusterRouterGroup]

Inherited by implicit conversion StringFormat fromClusterRouterGroup to StringFormat[ClusterRouterGroup]

Inherited by implicit conversion Ensuring fromClusterRouterGroup to Ensuring[ClusterRouterGroup]

Inherited by implicit conversion ArrowAssoc fromClusterRouterGroup to ArrowAssoc[ClusterRouterGroup]

Ungrouped