RemoteRouterConfig

org.apache.pekko.remote.routing.RemoteRouterConfig
final case class RemoteRouterConfig(local: Pool, nodes: Iterable[Address]) extends Pool

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

Attributes

Source
RemoteRouterConfig.scala
Graph
Supertypes
trait Product
trait Equals
trait Pool
trait RouterConfig
trait Serializable
class Object
trait Matchable
class Any
Show all

Members list

Value members

Constructors

def this(local: Pool, nodes: Iterable[Address])

Attributes

Source
RemoteRouterConfig.scala
def this(local: Pool, nodes: Array[Address])

Attributes

Source
RemoteRouterConfig.scala

Concrete methods

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

Value parameters

system

the ActorSystem this router belongs to

Attributes

Definition Classes
Source
RemoteRouterConfig.scala
override def createRouterActor(): RouterActor

INTERNAL API

INTERNAL API

Attributes

Definition Classes
Source
RemoteRouterConfig.scala
override def newRoutee(routeeProps: Props, context: ActorContext): Routee

INTERNAL API

INTERNAL API

Attributes

Definition Classes
Source
RemoteRouterConfig.scala
override def nrOfInstances(sys: ActorSystem): Int

Initial number of routee instances

Initial number of routee instances

Attributes

Definition Classes
Source
RemoteRouterConfig.scala
override def resizer: Option[Resizer]

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.

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.

Attributes

Definition Classes
Source
RemoteRouterConfig.scala
override 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

Attributes

Definition Classes
Source
RemoteRouterConfig.scala

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

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

Attributes

Definition Classes
Source
RemoteRouterConfig.scala
override def withFallback(other: RouterConfig): RouterConfig

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

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

Attributes

Definition Classes
Source
RemoteRouterConfig.scala

Inherited methods

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.

Attributes

Inherited from:
RouterConfig
Source
RouterConfig.scala

Attributes

Inherited from:
Product

Attributes

Inherited from:
Product

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.

Attributes

Inherited from:
Pool
Source
RouterConfig.scala

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.

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.

Attributes

Inherited from:
RouterConfig
Source
RouterConfig.scala

Specify that this router should stop itself when all routees have terminated (been removed). By Default it is true, unless a resizer is used.

Specify that this router should stop itself when all routees have terminated (been removed). By Default it is true, unless a resizer is used.

Attributes

Definition Classes
Inherited from:
Pool
Source
RouterConfig.scala

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.

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.

Attributes

Inherited from:
Pool
Source
RouterConfig.scala

Check that everything is there which is needed. Called in constructor of RoutedActorRef to fail early.

Check that everything is there which is needed. Called in constructor of RoutedActorRef to fail early.

Attributes

Inherited from:
RouterConfig
Source
RouterConfig.scala