akka.cluster.routing
Interface ClusterRouterConfigBase

All Superinterfaces:
RouterConfig, java.io.Serializable
All Known Implementing Classes:
ClusterRouterConfig, ClusterRouterGroup, ClusterRouterPool

public interface ClusterRouterConfigBase
extends RouterConfig

INTERNAL API


Method Summary
 Router createRouter(ActorSystem system)
          Create the actual router, responsible for routing messages to routees.
 boolean isManagementMessage(java.lang.Object msg)
          Is the message handled by the router head actor or the RouterConfig.routingLogicController(akka.routing.RoutingLogic) actor.
 RouterConfig local()
           
 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.
 ClusterRouterSettingsBase settings()
           
 boolean stopRouterWhenAllRouteesRemoved()
           
 
Methods inherited from interface akka.routing.RouterConfig
createRouterActor, verifyConfig, withFallback
 

Method Detail

local

RouterConfig local()

settings

ClusterRouterSettingsBase settings()

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
Returns:
(undocumented)

routerDispatcher

java.lang.String routerDispatcher()
Description copied from interface: RouterConfig
Dispatcher ID to use for running the &ldquo;head&rdquo; actor, which handles supervision, death watch and router management messages

Specified by:
routerDispatcher in interface RouterConfig
Returns:
(undocumented)

stopRouterWhenAllRouteesRemoved

boolean stopRouterWhenAllRouteesRemoved()
Specified by:
stopRouterWhenAllRouteesRemoved 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. Managment messages not handled by the "head" actor are delegated to this controller actor.

Specified by:
routingLogicController in interface RouterConfig
Parameters:
routingLogic - (undocumented)
Returns:
(undocumented)

isManagementMessage

boolean isManagementMessage(java.lang.Object msg)
Description copied from interface: RouterConfig
Is the message handled by the router head actor or the RouterConfig.routingLogicController(akka.routing.RoutingLogic) actor.

Specified by:
isManagementMessage in interface RouterConfig
Parameters:
msg - (undocumented)
Returns:
(undocumented)