Class

akka.routing

SmallestMailboxPool

Related Doc: package routing

Permalink

final case class SmallestMailboxPool(nrOfInstances: Int, resizer: Option[Resizer] = None, supervisorStrategy: SupervisorStrategy = Pool.defaultSupervisorStrategy, routerDispatcher: String = Dispatchers.DefaultDispatcherId, usePoolDispatcher: Boolean = false) extends Pool with PoolOverrideUnsetConfig[SmallestMailboxPool] with Product with Serializable

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

The configuration parameter trumps the constructor arguments. This means that if you provide nrOfInstances during instantiation they will be ignored if the router is defined in the configuration file for the actor being used.

Supervision Setup

Any routees that are created by a router will be created as the router's children. The router is therefore also the children's supervisor.

The supervision strategy of the router actor can be configured with #withSupervisorStrategy. If no strategy is provided, routers default to a strategy of “always escalate”. This means that errors are passed up to the router's supervisor for handling.

The router's supervisor will treat the error as an error with the router itself. Therefore a directive to stop or restart will cause the router itself to stop or restart. The router, in turn, will cause its children to stop and restart.

nrOfInstances

initial number of routees in the pool

resizer

optional resizer that dynamically adjust the pool size

supervisorStrategy

strategy for supervising the routees, see 'Supervision Setup'

routerDispatcher

dispatcher to use for the router head actor, which handles supervision, death watch and router management messages

Annotations
@silent() @SerialVersionUID()
Source
SmallestMailbox.scala
Linear Supertypes
Product, Equals, PoolOverrideUnsetConfig[SmallestMailboxPool], Pool, RouterConfig, Serializable, Serializable, AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SmallestMailboxPool
  2. Product
  3. Equals
  4. PoolOverrideUnsetConfig
  5. Pool
  6. RouterConfig
  7. Serializable
  8. Serializable
  9. AnyRef
  10. 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

Instance Constructors

  1. new SmallestMailboxPool(nr: Int)

    Permalink

    Java API

    Java API

    nr

    initial number of routees in the pool

  2. new SmallestMailboxPool(config: Config)

    Permalink
  3. new SmallestMailboxPool(nrOfInstances: Int, resizer: Option[Resizer] = None, supervisorStrategy: SupervisorStrategy = Pool.defaultSupervisorStrategy, routerDispatcher: String = Dispatchers.DefaultDispatcherId, usePoolDispatcher: Boolean = false)

    Permalink

    nrOfInstances

    initial number of routees in the pool

    resizer

    optional resizer that dynamically adjust the pool size

    supervisorStrategy

    strategy for supervising the routees, see 'Supervision Setup'

    routerDispatcher

    dispatcher to use for the router head actor, which handles supervision, death watch and router management messages

Value Members

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

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from SmallestMailboxPool to any2stringadd[SmallestMailboxPool] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (SmallestMailboxPool, B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from SmallestMailboxPool to ArrowAssoc[SmallestMailboxPool] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean

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

    Permalink
    Definition Classes
    Any
  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. def createRouter(system: ActorSystem): Router

    Permalink

    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

    Definition Classes
    SmallestMailboxPoolRouterConfig
  9. def ensuring(cond: (SmallestMailboxPool) ⇒ Boolean, msg: ⇒ Any): SmallestMailboxPool

    Permalink
    Implicit information
    This member is added by an implicit conversion from SmallestMailboxPool to Ensuring[SmallestMailboxPool] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: (SmallestMailboxPool) ⇒ Boolean): SmallestMailboxPool

    Permalink
    Implicit information
    This member is added by an implicit conversion from SmallestMailboxPool to Ensuring[SmallestMailboxPool] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean, msg: ⇒ Any): SmallestMailboxPool

    Permalink
    Implicit information
    This member is added by an implicit conversion from SmallestMailboxPool to Ensuring[SmallestMailboxPool] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean): SmallestMailboxPool

    Permalink
    Implicit information
    This member is added by an implicit conversion from SmallestMailboxPool to Ensuring[SmallestMailboxPool] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  14. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  15. def formatted(fmtstr: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from SmallestMailboxPool to StringFormat[SmallestMailboxPool] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  16. final def getClass(): Class[_]

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

    Permalink
    Definition Classes
    Any
  18. def isManagementMessage(msg: Any): Boolean

    Permalink

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

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

    Definition Classes
    RouterConfig
  19. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  20. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  21. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  22. def nrOfInstances(sys: ActorSystem): Int

    Permalink

    Initial number of routee instances

    Initial number of routee instances

    Definition Classes
    SmallestMailboxPoolPool
  23. val nrOfInstances: Int

    Permalink

    initial number of routees in the pool

  24. final def overrideUnsetConfig(other: RouterConfig): RouterConfig

    Permalink
    Definition Classes
    PoolOverrideUnsetConfig
  25. def props(routeeProps: Props): Props

    Permalink

    akka.actor.Props for a pool router based on the settings defined by this instance and the supplied akka.actor.Props for the routees created by the router.

    akka.actor.Props for a pool router based on the settings defined by this instance and the supplied akka.actor.Props for the routees created by the router.

    Definition Classes
    Pool
  26. val resizer: Option[Resizer]

    Permalink

    optional resizer that dynamically adjust the pool size

    optional resizer that dynamically adjust the pool size

    Definition Classes
    SmallestMailboxPoolPool
  27. val routerDispatcher: String

    Permalink

    dispatcher to use for the router head actor, which handles supervision, death watch and router management messages

    dispatcher to use for the router head actor, which handles supervision, death watch and router management messages

    Definition Classes
    SmallestMailboxPoolRouterConfig
  28. def routingLogicController(routingLogic: RoutingLogic): Option[Props]

    Permalink

    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.

    Definition Classes
    RouterConfig
  29. def stopRouterWhenAllRouteesRemoved: Boolean

    Permalink
    Definition Classes
    PoolRouterConfig
  30. val supervisorStrategy: SupervisorStrategy

    Permalink

    strategy for supervising the routees, see 'Supervision Setup'

    strategy for supervising the routees, see 'Supervision Setup'

    Definition Classes
    SmallestMailboxPoolPool
  31. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  32. val usePoolDispatcher: Boolean

    Permalink

    Use a dedicated dispatcher for the routees of the pool.

    Use a dedicated dispatcher for the routees of the pool. The dispatcher is defined in 'pool-dispatcher' configuration property in the deployment section of the router.

    Definition Classes
    SmallestMailboxPoolPool
  33. def verifyConfig(path: ActorPath): Unit

    Permalink

    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
  34. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  37. def withDispatcher(dispatcherId: String): SmallestMailboxPool

    Permalink

    Setting the dispatcher to be used for the router head actor, which handles supervision, death watch and router management messages.

  38. def withFallback(other: RouterConfig): RouterConfig

    Permalink

    Uses the resizer and/or the supervisor strategy of the given RouterConfig if this RouterConfig doesn't have one, i.e.

    Uses the resizer and/or the supervisor strategy 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
    SmallestMailboxPoolRouterConfig
  39. def withResizer(resizer: Resizer): SmallestMailboxPool

    Permalink

    Setting the resizer to be used.

    Setting the resizer to be used.

    Definition Classes
    SmallestMailboxPool → PoolOverrideUnsetConfig
  40. def withSupervisorStrategy(strategy: SupervisorStrategy): SmallestMailboxPool

    Permalink

    Setting the supervisor strategy to be used for the “head” Router actor.

    Setting the supervisor strategy to be used for the “head” Router actor.

    Definition Classes
    SmallestMailboxPool → PoolOverrideUnsetConfig
  41. def [B](y: B): (SmallestMailboxPool, B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from SmallestMailboxPool to ArrowAssoc[SmallestMailboxPool] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from Product

Inherited from Equals

Inherited from PoolOverrideUnsetConfig[SmallestMailboxPool]

Inherited from Pool

Inherited from RouterConfig

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

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

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

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

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

Ungrouped