Package org.apache.pekko.cluster.routing

Interface ClusterRouterConfigBase

All Superinterfaces:

RouterConfig, Serializable

All Known Implementing Classes:

ClusterRouterGroup, ClusterRouterPool

public interface ClusterRouterConfigBase
extends RouterConfig

INTERNAL API

Method Summary

Modifier and Type	Method	Description
Router	createRouter(ActorSystem system)	Create the actual router, responsible for routing messages to routees.
boolean	isManagementMessage(Object msg)	Is the message handled by the router head actor or the RouterConfig.routingLogicController(org.apache.pekko.routing.RoutingLogic) actor.
RouterConfig	local()
String	routerDispatcher()	Dispatcher ID to use for running the “head” actor, which handles supervision, death watch and router management messages
scala.Option<Props>	routingLogicController(RoutingLogic routingLogic)	Possibility to define an actor for controlling the routing logic from external stimuli (e.g.
ClusterRouterSettingsBase	settings()
boolean	stopRouterWhenAllRouteesRemoved()	Specify that this router should stop itself when all routees have terminated (been removed).
boolean	super$isManagementMessage(Object msg)

Methods inherited from interface org.apache.pekko.routing.RouterConfig

createRouterActor, verifyConfig, withFallback

Method Details

createRouter

Router createRouter(ActorSystem system)

Description copied from interface: RouterConfig

Create the actual router, responsible for routing messages to routees.

Specified by:

createRouter in interface RouterConfig

Parameters:

system - the ActorSystem this router belongs to

isManagementMessage

boolean isManagementMessage(Object msg)

Description copied from interface: RouterConfig

Is the message handled by the router head actor or the RouterConfig.routingLogicController(org.apache.pekko.routing.RoutingLogic) actor.

Specified by:

isManagementMessage in interface RouterConfig

local

RouterConfig local()

routerDispatcher

String routerDispatcher()

Description copied from interface: RouterConfig

Dispatcher ID to use for running the “head” actor, which handles supervision, death watch and router management messages

Specified by:

routerDispatcher in interface RouterConfig

routingLogicController

scala.Option<Props> routingLogicController(RoutingLogic routingLogic)

Description copied from interface: RouterConfig

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.

Specified by:

routingLogicController in interface RouterConfig

settings

ClusterRouterSettingsBase settings()

stopRouterWhenAllRouteesRemoved

boolean stopRouterWhenAllRouteesRemoved()

Description copied from interface: RouterConfig

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

Specified by:

stopRouterWhenAllRouteesRemoved in interface RouterConfig

super$isManagementMessage

boolean super$isManagementMessage(Object msg)