akka.routing

RandomRouter

case class RandomRouter(nrOfInstances: Int = 0, routees: Iterable[String] = immutable.this.Nil, resizer: Option[Resizer] = scala.None, routerDispatcher: String = ..., supervisorStrategy: SupervisorStrategy = Router.defaultSupervisorStrategy) extends RouterConfig with RandomLike with Product with Serializable

A Router that randomly selects one of the target connections to send a message to.
Please note that providing both 'nrOfInstances' and 'routees' does not make logical sense as this means that the router should both create new actors and use the 'routees' actor(s). In this case the 'nrOfInstances' will be ignored and the 'routees' will be used.
The configuration parameter trumps the constructor arguments. This means that if you provide either 'nrOfInstances' or 'routees' during instantiation they will be ignored if the router is defined in the configuration file for the actor being used. = Supervision Setup = The router creates a “head” actor which supervises and/or monitors the routees. Instances are created as children of this actor, hence the children are not supervised by the parent of the router. Common choices are to always escalate (meaning that fault handling is always applied to all children simultaneously; this is the default) or use the parent’s strategy, which will result in routed children being treated individually, but it is possible as well to use Routers to give different supervisor strategies to different groups of children. {{{ class MyActor extends Actor { override val supervisorStrategy = ... val poolAsAWhole = context.actorOf(Props[SomeActor].withRouter(RandomRouter(5))) val poolIndividuals = context.actorOf(Props[SomeActor].withRouter( RandomRouter(5, supervisorStrategy = this.supervisorStrategy))) val specialChild = context.actorOf(Props[SomeActor].withRouter( RandomRouter(5, supervisorStrategy = OneForOneStrategy() { ... }))) } }}}

routees

string representation of the actor paths of the routees that will be looked up using actorFor in akka.actor.ActorRefProvider

Annotations
@SerialVersionUID( 1L )
Linear Supertypes
Serializable, Serializable, Product, Equals, RandomLike, RouterConfig, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. RandomRouter
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. RandomLike
  7. RouterConfig
  8. AnyRef
  9. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new RandomRouter(resizer: Resizer)

    Java API: Constructor that sets the resizer to be used.

  2. new RandomRouter(routeePaths: Iterable[String])

    Java API: Constructor that sets the routees to be used.

    Java API: Constructor that sets the routees to be used.

    routeePaths

    string representation of the actor paths of the routees that will be looked up using actorFor in akka.actor.ActorRefProvider

  3. new RandomRouter(nr: Int)

    Java API: Constructor that sets nrOfInstances to be created.

  4. new RandomRouter(nrOfInstances: Int = 0, routees: Iterable[String] = immutable.this.Nil, resizer: Option[Resizer] = scala.None, routerDispatcher: String = ..., supervisorStrategy: SupervisorStrategy = Router.defaultSupervisorStrategy)

    routees

    string representation of the actor paths of the routees that will be looked up using actorFor in akka.actor.ActorRefProvider

Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  6. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  7. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  8. def createActor(): Router

    The router "head" actor.

    The router "head" actor.

    Definition Classes
    RouterConfig
  9. def createRoute(routeeProvider: RouteeProvider): Route

    Definition Classes
    RandomLike
  10. def createRouteeProvider(context: ActorContext, routeeProps: Props): RouteeProvider

    The RouteeProvider responsible for creating or looking up routees.

    The RouteeProvider responsible for creating or looking up routees. It's used in createRoute to register routees, and also from akka.routing.Resizer.

    Definition Classes
    RouterConfig
  11. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  12. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  13. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  14. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  15. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  16. final def notify(): Unit

    Definition Classes
    AnyRef
  17. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  18. val nrOfInstances: Int

    Definition Classes
    RandomRouterRandomLike
  19. val resizer: Option[Resizer]

    Routers with dynamically resizable number of routees return the akka.routing.Resizer to use.

    Routers with dynamically resizable number of routees return the akka.routing.Resizer to use.

    Definition Classes
    RandomRouterRouterConfig
  20. val routees: Iterable[String]

    string representation of the actor paths of the routees that will be looked up using actorFor in akka.actor.ActorRefProvider

    string representation of the actor paths of the routees that will be looked up using actorFor in akka.actor.ActorRefProvider

    Definition Classes
    RandomRouterRandomLike
  21. val routerDispatcher: String

    Dispatcher ID to use for running the “head” actor, i.

    Dispatcher ID to use for running the “head” actor, i.e. the akka.routing.Router.

    Definition Classes
    RandomRouterRouterConfig
  22. val supervisorStrategy: SupervisorStrategy

    SupervisorStrategy for the created Router actor.

    SupervisorStrategy for the created Router actor.

    Definition Classes
    RandomRouterRouterConfig
  23. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  24. def toAll(sender: ActorRef, routees: Iterable[ActorRef]): Iterable[Destination]

    Attributes
    protected
    Definition Classes
    RouterConfig
  25. def verifyConfig(): 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.

    Definition Classes
    RouterConfig
  26. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws()
  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
    @throws()
  29. def withDispatcher(dispatcherId: String): RandomRouter

    Java API for setting routerDispatcher

  30. def withFallback(other: RouterConfig): RouterConfig

    Uses the resizer of the given Routerconfig if this RouterConfig doesn't have one, i.

    Uses the resizer of the given Routerconfig if this RouterConfig doesn't have one, i.e. the resizer defined in code is used if resizer was not defined in config.

    Definition Classes
    RandomRouterRouterConfig
  31. def withSupervisorStrategy(strategy: SupervisorStrategy): RandomRouter

    Java API for setting the supervisor strategy to be used for the “head” Router actor.

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from RandomLike

Inherited from RouterConfig

Inherited from AnyRef

Inherited from Any

Ungrouped