akka.routing
Interface RouterConfig

All Superinterfaces:
java.io.Serializable
All Known Subinterfaces:
ClusterRouterConfigBase, DeprecatedRouterConfig, Group, Pool, PoolOverrideUnsetConfig<T>
All Known Implementing Classes:
AdaptiveLoadBalancingGroup, AdaptiveLoadBalancingPool, AdaptiveLoadBalancingRouter, BalancingPool, BroadcastGroup, BroadcastPool, BroadcastRouter, ClusterRouterConfig, ClusterRouterGroup, ClusterRouterPool, ConsistentHashingGroup, ConsistentHashingPool, ConsistentHashingRouter, CustomRouterConfig, FromConfig, FromConfig$, GroupBase, NoRouter, NoRouter$, PoolBase, RandomGroup, RandomPool, RandomRouter, RemoteRouterConfig, RoundRobinGroup, RoundRobinPool, RoundRobinRouter, ScatterGatherFirstCompletedGroup, ScatterGatherFirstCompletedPool, ScatterGatherFirstCompletedRouter, SmallestMailboxPool, SmallestMailboxRouter, TailChoppingGroup, TailChoppingPool

public interface RouterConfig
extends scala.Serializable

This trait represents a router factory: it produces the actual router actor and creates the routing table (a function which determines the recipients for each message which is to be dispatched). The resulting RoutedActorRef optimizes the sending of the message so that it does NOT go through the router&rsquo;s mailbox unless the route returns an empty recipient set.

'''Caution:''' This means that the route function is evaluated concurrently without protection by the RoutedActorRef: either provide a reentrant (i.e. pure) implementation or do the locking yourself!

'''Caution:''' Please note that the Router which needs to be returned by createActor() should not send a message to itself in its constructor or preStart() or publish its self reference from there: if someone tries sending a message to that reference before the constructor of RoutedActorRef has returned, there will be a NullPointerException!


Method Summary
 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 &ldquo;head&rdquo; 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)

routerDispatcher

java.lang.String routerDispatcher()
Dispatcher ID to use for running the &ldquo;head&rdquo; 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. Managment messages not handled by the "head" actor are delegated to this controller actor.

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

stopRouterWhenAllRouteesRemoved

boolean stopRouterWhenAllRouteesRemoved()

withFallback

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

Parameters:
other - (undocumented)
Returns:
(undocumented)

verifyConfig

void verifyConfig(ActorPath path)
Check that everything is there which is needed. Called in constructor of RoutedActorRef to fail early.

Parameters:
path - (undocumented)

createRouterActor

RouterActor createRouterActor()
INTERNAL API The router "head" actor.

Returns:
(undocumented)