Package org.apache.pekko.routing

Interface RouterConfig

All Superinterfaces:
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 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 pekko.routing.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 Details

    • createRouter

      Router createRouter(ActorSystem system)
      Create the actual router, responsible for routing messages to routees.

      Parameters:
      system - the ActorSystem this router belongs to

    • createRouterActor

      org.apache.pekko.routing.RouterActor createRouterActor()
      INTERNAL API The router "head" actor.

    • isManagementMessage

      boolean isManagementMessage(Object msg)
      Is the message handled by the router head actor or the routingLogicController(org.apache.pekko.routing.RoutingLogic) actor.

    • routerDispatcher

      String routerDispatcher()
      Dispatcher ID to use for running the &ldquo;head&rdquo; actor, which handles supervision, death watch and router management messages

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

    • stopRouterWhenAllRouteesRemoved

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

    • verifyConfig

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

    • withFallback

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