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. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from RouterConfig to any2stringadd[RouterConfig] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (RouterConfig, B)
    Implicit
    This member is added by an implicit conversion from RouterConfig to ArrowAssoc[RouterConfig] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate() @throws( ... )
  8. def ensuring(cond: (RouterConfig) ⇒ Boolean, msg: ⇒ Any): RouterConfig
    Implicit
    This member is added by an implicit conversion from RouterConfig to Ensuring[RouterConfig] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (RouterConfig) ⇒ Boolean): RouterConfig
    Implicit
    This member is added by an implicit conversion from RouterConfig to Ensuring[RouterConfig] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: ⇒ Any): RouterConfig
    Implicit
    This member is added by an implicit conversion from RouterConfig to Ensuring[RouterConfig] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): RouterConfig
    Implicit
    This member is added by an implicit conversion from RouterConfig to Ensuring[RouterConfig] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  14. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from RouterConfig to StringFormat[RouterConfig] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  15. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  16. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. def isManagementMessage(msg: Any): Boolean

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

  19. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  21. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  22. 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.

  23. def stopRouterWhenAllRouteesRemoved: Boolean
  24. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  25. def toString(): String
    Definition Classes
    AnyRef → Any
  26. 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.

  27. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  28. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  29. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  30. 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).

  31. def →[B](y: B): (RouterConfig, B)
    Implicit
    This member is added by an implicit conversion from RouterConfig to ArrowAssoc[RouterConfig] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @Deprecated @deprecated @throws( classOf[java.lang.Throwable] )
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from RouterConfig to any2stringadd[RouterConfig]

Inherited by implicit conversion StringFormat from RouterConfig to StringFormat[RouterConfig]

Inherited by implicit conversion Ensuring from RouterConfig to Ensuring[RouterConfig]

Inherited by implicit conversion ArrowAssoc from RouterConfig to ArrowAssoc[RouterConfig]

Ungrouped