Package akka.routing

Interface RouterConfig

All Superinterfaces:

java.io.Serializable, scala.Serializable

All Known Subinterfaces:

ClusterRouterConfigBase, Group, Pool, PoolOverrideUnsetConfig<T>

All Known Implementing Classes:

AdaptiveLoadBalancingGroup, AdaptiveLoadBalancingPool, BalancingPool, BroadcastGroup, BroadcastPool, ClusterRouterGroup, ClusterRouterPool, ConsistentHashingGroup, ConsistentHashingPool, CustomRouterConfig, FromConfig, FromConfig$, GroupBase, NoRouter, NoRouter$, PoolBase, RandomGroup, RandomPool, RemoteRouterConfig, RoundRobinGroup, RoundRobinPool, ScatterGatherFirstCompletedGroup, ScatterGatherFirstCompletedPool, SmallestMailboxPool, TailChoppingGroup, TailChoppingPool

public interface RouterConfig
extends scala.Serializable

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

param: system the ActorSystem this router belongs to

Method Summary

Modifier and Type	Method	Description
Router	createRouter(ActorSystem system)	Create the actual router, responsible for routing messages to routees.
RouterActor	createRouterActor()	INTERNAL API The router "head" actor.
boolean	isManagementMessage(java.lang.Object msg)	Is the message handled by the router head actor or the routingLogicController(akka.routing.RoutingLogic) actor.
java.lang.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.
boolean	stopRouterWhenAllRouteesRemoved()
void	verifyConfig(ActorPath path)	Check that everything is there which is needed.
RouterConfig	withFallback(RouterConfig other)	Overridable merge strategy, by default completely prefers this (i.e.

Method Detail

createRouter

Router createRouter(ActorSystem system)

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

Parameters:

system - the ActorSystem this router belongs to

Returns:

(undocumented)

createRouterActor

RouterActor createRouterActor()

INTERNAL API The router "head" actor.

Returns:

(undocumented)

isManagementMessage

boolean isManagementMessage(java.lang.Object msg)

Is the message handled by the router head actor or the routingLogicController(akka.routing.RoutingLogic) actor.

Parameters:

msg - (undocumented)

Returns:

(undocumented)

routerDispatcher

java.lang.String routerDispatcher()

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

Returns:

(undocumented)

routingLogicController

scala.Option<Props> routingLogicController(RoutingLogic routingLogic)

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.

Parameters:

routingLogic - (undocumented)

Returns:

(undocumented)

stopRouterWhenAllRouteesRemoved

boolean stopRouterWhenAllRouteesRemoved()

verifyConfig

void verifyConfig(ActorPath path)

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

Parameters:

path - (undocumented)

withFallback

RouterConfig withFallback(RouterConfig other)

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

Parameters:

other - (undocumented)

Returns:

(undocumented)