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.RoundRobinRouter or custom routers.

Annotations
@SerialVersionUID( 1L )
Source
RemoteRouterConfig.scala
Linear Supertypes
Type Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. RemoteRouterConfig
  2. Product
  3. Equals
  4. Pool
  5. RouterConfig
  6. Serializable
  7. Serializable
  8. AnyRef
  9. Any
Implicitly
  1. by any2stringadd
  2. by any2stringfmt
  3. by any2ArrowAssoc
  4. by any2Ensuring
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

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: AnyRef): Boolean

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. def +(other: String): String

    Implicit information
    This member is added by an implicit conversion from RemoteRouterConfig to StringAdd performed by method any2stringadd in scala.Predef.
    Definition Classes
    StringAdd
  5. def ->[B](y: B): (RemoteRouterConfig, B)

    Implicit information
    This member is added by an implicit conversion from RemoteRouterConfig to ArrowAssoc[RemoteRouterConfig] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  6. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  7. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  8. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  9. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  10. 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
  11. def createRouterActor(): RouterActor

    INTERNAL API

    INTERNAL API

    Definition Classes
    RemoteRouterConfigPoolRouterConfig
  12. def ensuring(cond: (RemoteRouterConfig) ⇒ Boolean, msg: ⇒ Any): RemoteRouterConfig

    Implicit information
    This member is added by an implicit conversion from RemoteRouterConfig to Ensuring[RemoteRouterConfig] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: (RemoteRouterConfig) ⇒ Boolean): RemoteRouterConfig

    Implicit information
    This member is added by an implicit conversion from RemoteRouterConfig to Ensuring[RemoteRouterConfig] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: Boolean, msg: ⇒ Any): RemoteRouterConfig

    Implicit information
    This member is added by an implicit conversion from RemoteRouterConfig to Ensuring[RemoteRouterConfig] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. def ensuring(cond: Boolean): RemoteRouterConfig

    Implicit information
    This member is added by an implicit conversion from RemoteRouterConfig to Ensuring[RemoteRouterConfig] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  16. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  17. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  18. def formatted(fmtstr: String): String

    Implicit information
    This member is added by an implicit conversion from RemoteRouterConfig to StringFormat performed by method any2stringfmt in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  19. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  20. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  21. 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
  22. val local: Pool

  23. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  24. def newRoutee(routeeProps: Props, context: ActorContext): Routee

    INTERNAL API

    INTERNAL API

    Definition Classes
    RemoteRouterConfigPool
  25. val nodes: Iterable[Address]

  26. final def notify(): Unit

    Definition Classes
    AnyRef
  27. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  28. def nrOfInstances: Int

    Initial number of routee instances

    Initial number of routee instances

    Definition Classes
    RemoteRouterConfigPool
  29. 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
  30. 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
  31. 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
  32. def routingLogicController(routingLogic: RoutingLogic): Option[Props]

    Possibility to define an actor for controlling the routing logic from external stimuli (e.

    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. Managment messages not handled by the "head" actor are delegated to this controller actor.

    Definition Classes
    RouterConfig
  33. def stopRouterWhenAllRouteesRemoved: Boolean

    Definition Classes
    PoolRouterConfig
  34. def supervisorStrategy: SupervisorStrategy

    SupervisorStrategy for the head actor, i.

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

    Definition Classes
    RemoteRouterConfigPool
  35. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  36. 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
  37. 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
  38. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  39. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  40. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  41. def withFallback(other: RouterConfig): RouterConfig

    Overridable merge strategy, by default completely prefers this (i.

    Overridable merge strategy, by default completely prefers this (i.e. no merge).

    Definition Classes
    RemoteRouterConfigRouterConfig
  42. def [B](y: B): (RemoteRouterConfig, B)

    Implicit information
    This member is added by an implicit conversion from RemoteRouterConfig to ArrowAssoc[RemoteRouterConfig] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Shadowed Implicit Value Members

  1. val self: Any

    Implicit information
    This member is added by an implicit conversion from RemoteRouterConfig to StringAdd performed by method any2stringadd in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (remoteRouterConfig: StringAdd).self
    Definition Classes
    StringAdd
  2. val self: Any

    Implicit information
    This member is added by an implicit conversion from RemoteRouterConfig to StringFormat performed by method any2stringfmt in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (remoteRouterConfig: StringFormat).self
    Definition Classes
    StringFormat

Deprecated Value Members

  1. def x: RemoteRouterConfig

    Implicit information
    This member is added by an implicit conversion from RemoteRouterConfig to ArrowAssoc[RemoteRouterConfig] performed by method any2ArrowAssoc in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (remoteRouterConfig: ArrowAssoc[RemoteRouterConfig]).x
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use leftOfArrow instead

  2. def x: RemoteRouterConfig

    Implicit information
    This member is added by an implicit conversion from RemoteRouterConfig to Ensuring[RemoteRouterConfig] performed by method any2Ensuring in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (remoteRouterConfig: Ensuring[RemoteRouterConfig]).x
    Definition Classes
    Ensuring
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use resultOfEnsuring instead

Inherited from Product

Inherited from Equals

Inherited from Pool

Inherited from RouterConfig

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from RemoteRouterConfig to StringAdd

Inherited by implicit conversion any2stringfmt from RemoteRouterConfig to StringFormat

Inherited by implicit conversion any2ArrowAssoc from RemoteRouterConfig to ArrowAssoc[RemoteRouterConfig]

Inherited by implicit conversion any2Ensuring from RemoteRouterConfig to Ensuring[RemoteRouterConfig]

Ungrouped