Packages

c

akka.remote.routing

RemoteRouterConfig

final case class RemoteRouterConfig(local: Pool, nodes: Iterable[Address]) extends Pool with Product with Serializable

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

Annotations
@SerialVersionUID()
Source
RemoteRouterConfig.scala
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. RemoteRouterConfig
  2. Product
  3. Equals
  4. Pool
  5. RouterConfig
  6. Serializable
  7. AnyRef
  8. 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 RemoteRouterConfig(local: Pool, nodes: Array[Address])
  2. new RemoteRouterConfig(local: Pool, nodes: Iterable[Address])
  3. new RemoteRouterConfig(local: Pool, nodes: Iterable[Address])

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 RemoteRouterConfig toany2stringadd[RemoteRouterConfig] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (RemoteRouterConfig, B)
    Implicit
    This member is added by an implicit conversion from RemoteRouterConfig toArrowAssoc[RemoteRouterConfig] 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]) @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
    RemoteRouterConfigRouterConfig
  9. def createRouterActor(): RouterActor

    INTERNAL API

    INTERNAL API

    Definition Classes
    RemoteRouterConfigPoolRouterConfig
  10. def ensuring(cond: (RemoteRouterConfig) => Boolean, msg: => Any): RemoteRouterConfig
    Implicit
    This member is added by an implicit conversion from RemoteRouterConfig toEnsuring[RemoteRouterConfig] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: (RemoteRouterConfig) => Boolean): RemoteRouterConfig
    Implicit
    This member is added by an implicit conversion from RemoteRouterConfig toEnsuring[RemoteRouterConfig] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean, msg: => Any): RemoteRouterConfig
    Implicit
    This member is added by an implicit conversion from RemoteRouterConfig toEnsuring[RemoteRouterConfig] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: Boolean): RemoteRouterConfig
    Implicit
    This member is added by an implicit conversion from RemoteRouterConfig toEnsuring[RemoteRouterConfig] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  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
    RouterConfig
  18. val local: Pool
  19. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. def newRoutee(routeeProps: Props, context: ActorContext): Routee

    INTERNAL API

    INTERNAL API

    Definition Classes
    RemoteRouterConfigPool
  21. val nodes: Iterable[Address]
  22. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  23. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  24. def nrOfInstances(sys: ActorSystem): Int

    Initial number of routee instances

    Initial number of routee instances

    Definition Classes
    RemoteRouterConfigPool
  25. def productElementNames: Iterator[String]
    Definition Classes
    Product
  26. 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
  27. def resizer: Option[Resizer]

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

    Pool with dynamically resizable number of routees return the akka.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
    RemoteRouterConfigPool
  28. 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
    RemoteRouterConfigRouterConfig
  29. 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
  30. def stopRouterWhenAllRouteesRemoved: Boolean
    Definition Classes
    PoolRouterConfig
  31. 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
    RemoteRouterConfigPool
  32. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  33. 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
  34. 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
  35. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  36. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  37. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  38. 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
    RemoteRouterConfigRouterConfig

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated
  2. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from RemoteRouterConfig toStringFormat[RemoteRouterConfig] 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): (RemoteRouterConfig, B)
    Implicit
    This member is added by an implicit conversion from RemoteRouterConfig toArrowAssoc[RemoteRouterConfig] 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 Pool

Inherited from RouterConfig

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromRemoteRouterConfig to any2stringadd[RemoteRouterConfig]

Inherited by implicit conversion StringFormat fromRemoteRouterConfig to StringFormat[RemoteRouterConfig]

Inherited by implicit conversion Ensuring fromRemoteRouterConfig to Ensuring[RemoteRouterConfig]

Inherited by implicit conversion ArrowAssoc fromRemoteRouterConfig to ArrowAssoc[RemoteRouterConfig]

Ungrouped