t

akka.routing

RouterConfig

trait 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’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 akka.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!

Annotations
@silent() @SerialVersionUID()
Source
RouterConfig.scala
Linear Supertypes
Serializable, Serializable, AnyRef, Any
Known Subclasses
AdaptiveLoadBalancingGroup, AdaptiveLoadBalancingPool, ClusterRouterGroup, ClusterRouterPool, RemoteRouterConfig, BalancingPool, BroadcastGroup, BroadcastPool, ConsistentHashingGroup, ConsistentHashingPool, CustomRouterConfig, FromConfig, FromConfig, Group, GroupBase, NoRouter, NoRouter, Pool, PoolBase, RandomGroup, RandomPool, RoundRobinGroup, RoundRobinPool, ScatterGatherFirstCompletedGroup, ScatterGatherFirstCompletedPool, SmallestMailboxPool, TailChoppingGroup, TailChoppingPool
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. RouterConfig
  2. Serializable
  3. Serializable
  4. AnyRef
  5. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def createRouter(system: ActorSystem): Router

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

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

    system

    the ActorSystem this router belongs to

  2. abstract def routerDispatcher: String

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

Concrete Value Members

  1. def isManagementMessage(msg: Any): Boolean

    Is the message handled by the router head actor or the #routingLogicController actor.

  2. def routingLogicController(routingLogic: RoutingLogic): Option[Props]

    Possibility to define an actor for controlling the routing logic from external stimuli (e.g.

    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.

  3. def stopRouterWhenAllRouteesRemoved: Boolean
  4. def verifyConfig(path: ActorPath): Unit

    Check that everything is there which is needed.

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

  5. def withFallback(other: RouterConfig): RouterConfig

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

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