akka.routing

SmallestMailboxRouter

case class SmallestMailboxRouter (nrOfInstances: Int, routees: Iterable[String], resizer: Option[Resizer], routerDispatcher: String, supervisorStrategy: SupervisorStrategy) extends RouterConfig with SmallestMailboxLike with Product with Serializable

A Router that tries to send to the non-suspended routee with fewest messages in mailbox. The selection is done in this order:


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(RoundRobinRouter(5))) val poolIndividuals = context.actorOf(Props[SomeActor].withRouter( RoundRobinRouter(5, supervisorStrategy = this.supervisorStrategy))) val specialChild = context.actorOf(Props[SomeActor].withRouter( RoundRobinRouter(5, supervisorStrategy = OneForOneStrategy() { ... }))) } }}}

routees

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

Linear Supertypes
Serializable, Serializable, Product, Equals, SmallestMailboxLike, RouterConfig, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Hide All
  2. Show all
  1. SmallestMailboxRouter
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. SmallestMailboxLike
  7. RouterConfig
  8. AnyRef
  9. Any
Visibility
  1. Public
  2. All

Instance Constructors

  1. new SmallestMailboxRouter (resizer: Resizer)

    Constructor that sets the resizer to be used.

    Constructor that sets the resizer to be used. Java API

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

    Constructor that sets the routees to be used.

    Constructor that sets the routees to be used. Java API

    routeePaths

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

  3. new SmallestMailboxRouter (nr: Int)

    Constructor that sets nrOfInstances to be created.

    Constructor that sets nrOfInstances to be created. Java API

  4. new SmallestMailboxRouter (nrOfInstances: Int, routees: Iterable[String], resizer: Option[Resizer], routerDispatcher: String, supervisorStrategy: SupervisorStrategy)

    routees

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

Value Members

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

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

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

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

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

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

    Attributes
    final
    Definition Classes
    Any
  7. def canEqual (arg0: Any): Boolean

    Definition Classes
    SmallestMailboxRouter → Equals
  8. def clone (): AnyRef

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

    Definition Classes
    RouterConfig
  10. def createRoute (props: Props, routeeProvider: RouteeProvider): Route

    Definition Classes
    SmallestMailboxLike
  11. def createRouteeProvider (context: ActorContext): RouteeProvider

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

    Attributes
    final
    Definition Classes
    AnyRef
  13. def equals (arg0: Any): Boolean

    Definition Classes
    SmallestMailboxRouter → Equals → AnyRef → Any
  14. def finalize (): Unit

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

    Attributes
    final
    Definition Classes
    AnyRef → Any
  16. def hasMessages (a: ActorRef): Boolean

    Returns true if the actor currently has any pending messages in the mailbox, i.

    Returns true if the actor currently has any pending messages in the mailbox, i.e. the mailbox is not empty. It will always return false for remote actors. Method is exposed to subclasses to be able to implement custom routers based on mailbox and actor internal state.

    Attributes
    protected
    Definition Classes
    SmallestMailboxLike
  17. def hashCode (): Int

    Definition Classes
    SmallestMailboxRouter → AnyRef → Any
  18. def isInstanceOf [T0] : Boolean

    Attributes
    final
    Definition Classes
    Any
  19. def isProcessingMessage (a: ActorRef): Boolean

    Returns true if the actor is currently processing a message.

    Returns true if the actor is currently processing a message. It will always return false for remote actors. Method is exposed to subclasses to be able to implement custom routers based on mailbox and actor internal state.

    Attributes
    protected
    Definition Classes
    SmallestMailboxLike
  20. def isSuspended (a: ActorRef): Boolean

    Returns true if the actor is currently suspended.

    Returns true if the actor is currently suspended. It will always return false for remote actors. Method is exposed to subclasses to be able to implement custom routers based on mailbox and actor internal state.

    Attributes
    protected
    Definition Classes
    SmallestMailboxLike
  21. def ne (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef
  22. def notify (): Unit

    Attributes
    final
    Definition Classes
    AnyRef
  23. def notifyAll (): Unit

    Attributes
    final
    Definition Classes
    AnyRef
  24. val nrOfInstances : Int

  25. def numberOfMessages (a: ActorRef): Int

    Returns the number of pending messages in the mailbox of the actor.

    Returns the number of pending messages in the mailbox of the actor. It will always return 0 for remote actors. Method is exposed to subclasses to be able to implement custom routers based on mailbox and actor internal state.

    Attributes
    protected
    Definition Classes
    SmallestMailboxLike
  26. def productArity : Int

    Definition Classes
    SmallestMailboxRouter → Product
  27. def productElement (arg0: Int): Any

    Definition Classes
    SmallestMailboxRouter → Product
  28. def productIterator : Iterator[Any]

    Definition Classes
    Product
  29. def productPrefix : String

    Definition Classes
    SmallestMailboxRouter → Product
  30. val resizer : Option[Resizer]

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

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

    Definition Classes
    SmallestMailboxRouterRouterConfig
  31. val routees : Iterable[String]

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

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

    Definition Classes
    SmallestMailboxRouterSmallestMailboxLike
  32. 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 Router.

    Definition Classes
    SmallestMailboxRouterRouterConfig
  33. val supervisorStrategy : SupervisorStrategy

    SupervisorStrategy for the created Router actor.

    SupervisorStrategy for the created Router actor.

    Definition Classes
    SmallestMailboxRouterRouterConfig
  34. def synchronized [T0] (arg0: ⇒ T0): T0

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

    Attributes
    protected
    Definition Classes
    RouterConfig
  36. def toString (): String

    Definition Classes
    SmallestMailboxRouter → AnyRef → Any
  37. def wait (): Unit

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()
  38. def wait (arg0: Long, arg1: Int): Unit

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()
  39. def wait (arg0: Long): Unit

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()
  40. def withDispatcher (dispatcherId: String): SmallestMailboxRouter

    Java API for setting routerDispatcher

  41. def withFallback (other: RouterConfig): RouterConfig

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

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

    Definition Classes
    RouterConfig
  42. def withSupervisorStrategy (strategy: SupervisorStrategy): SmallestMailboxRouter

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

Deprecated Value Members

  1. def productElements : Iterator[Any]

    Definition Classes
    Product
    Annotations
    @deprecated
    Deprecated

    use productIterator instead

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from SmallestMailboxLike

Inherited from RouterConfig

Inherited from AnyRef

Inherited from Any