akka.dispatch

BalancingDispatcher

class BalancingDispatcher extends Dispatcher

An executor based event driven dispatcher which will try to redistribute work from busy actors to idle actors. It is assumed that all actors using the same instance of this dispatcher can process all messages that have been sent to one of the actors. I.e. the actors belong to a pool of actors, and to the client there is no guarantee about which actor instance actually processes a given message.

Although the technique used in this implementation is commonly known as "work stealing", the actual implementation is probably best described as "work donating" because the actor of which work is being stolen takes the initiative.

The preferred way of creating dispatchers is to define configuration of it and use the the lookup method in akka.dispatch.Dispatchers.

Annotations
@deprecated
Deprecated

(Since version 2.3) Use BalancingPool instead of BalancingDispatcher

Source
BalancingDispatcher.scala
See also

akka.dispatch.Dispatchers

akka.dispatch.BalancingDispatcher

Linear Supertypes
Dispatcher, MessageDispatcher, ExecutionContextExecutor, ExecutionContext, BatchingExecutor, Executor, AbstractMessageDispatcher, AnyRef, Any
Type Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. BalancingDispatcher
  2. Dispatcher
  3. MessageDispatcher
  4. ExecutionContextExecutor
  5. ExecutionContext
  6. BatchingExecutor
  7. Executor
  8. AbstractMessageDispatcher
  9. AnyRef
  10. Any
Implicitly
  1. by any2stringadd
  2. by any2stringfmt
  3. by any2ArrowAssoc
  4. by any2Ensuring
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new BalancingDispatcher(_configurator: MessageDispatcherConfigurator, _id: String, throughput: Int, throughputDeadlineTime: Duration, _mailboxType: MailboxType, _executorServiceFactoryProvider: ExecutorServiceFactoryProvider, _shutdownTimeout: FiniteDuration, attemptTeamWork: Boolean)

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. def +(other: String): String

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

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

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

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

    Definition Classes
    Any
  9. final def attach(actor: ActorCell): Unit

    Attaches the specified actor instance to this dispatcher, which includes scheduling it to run for the first time (Create() is expected to have been enqueued by the ActorCell upon mailbox creation).

    Attaches the specified actor instance to this dispatcher, which includes scheduling it to run for the first time (Create() is expected to have been enqueued by the ActorCell upon mailbox creation).

    Definition Classes
    MessageDispatcher
  10. def batchable(runnable: Runnable): Boolean

    Override this to define which runnables will be batched.

    Override this to define which runnables will be batched.

    Definition Classes
    BatchingExecutor
  11. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  12. val configurator: MessageDispatcherConfigurator

    Definition Classes
    MessageDispatcher
  13. def createMailbox(actor: Cell, mailboxType: MailboxType): Mailbox

    INTERNAL API

    INTERNAL API

    Attributes
    protected[akka]
    Definition Classes
    BalancingDispatcherDispatcherMessageDispatcher
  14. final def detach(actor: ActorCell): Unit

    Detaches the specified actor instance from this dispatcher

    Detaches the specified actor instance from this dispatcher

    Definition Classes
    MessageDispatcher
  15. def dispatch(receiver: ActorCell, invocation: Envelope): Unit

    INTERNAL API

    INTERNAL API

    Attributes
    protected[akka]
    Definition Classes
    BalancingDispatcherDispatcherMessageDispatcher
  16. def ensuring(cond: (BalancingDispatcher) ⇒ Boolean, msg: ⇒ Any): BalancingDispatcher

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

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

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

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

    Definition Classes
    AnyRef
  21. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  22. val eventStream: EventStream

    Definition Classes
    MessageDispatcher
  23. def execute(runnable: Runnable): Unit

    Definition Classes
    BatchingExecutor → Executor
  24. def executeTask(invocation: TaskInvocation): Unit

    INTERNAL API

    INTERNAL API

    Attributes
    protected[akka]
    Definition Classes
    DispatcherMessageDispatcher
  25. final def executorService: ExecutorServiceDelegate

    Attributes
    protected
    Definition Classes
    Dispatcher
  26. def finalize(): Unit

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

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

    Definition Classes
    AnyRef → Any
  29. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  30. val id: String

    Identifier of this dispatcher, corresponds to the full key of the dispatcher configuration.

    Identifier of this dispatcher, corresponds to the full key of the dispatcher configuration.

    Definition Classes
    DispatcherMessageDispatcher
  31. final def inhabitants: Long

    Definition Classes
    MessageDispatcher
  32. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  33. final val isThroughputDeadlineTimeDefined: Boolean

    INTERNAL API

    INTERNAL API

    Attributes
    protected[akka]
    Definition Classes
    MessageDispatcher
  34. val mailboxes: Mailboxes

    Definition Classes
    MessageDispatcher
  35. final def ne(arg0: AnyRef): Boolean

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

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

    Definition Classes
    AnyRef
  38. def prepare(): ExecutionContext

    Definition Classes
    ExecutionContext
  39. def register(actor: ActorCell): Unit

    If you override it, you must call it.

    If you override it, you must call it. But only ever once. See "attach" for only invocation.

    INTERNAL API

    Attributes
    protected[akka]
    Definition Classes
    BalancingDispatcherMessageDispatcher
  40. def registerForExecution(mbox: Mailbox, hasMessageHint: Boolean, hasSystemMessageHint: Boolean): Boolean

    Returns if it was registered

    Returns if it was registered

    INTERNAL API

    Attributes
    protected[akka]
    Definition Classes
    DispatcherMessageDispatcher
  41. def reportFailure(t: Throwable): Unit

    Definition Classes
    MessageDispatcher → ExecutionContext
  42. def resume(actor: ActorCell): Unit

    Attributes
    protected[akka]
    Definition Classes
    MessageDispatcher
  43. def shutdown(): Unit

    INTERNAL API

    INTERNAL API

    Attributes
    protected[akka]
    Definition Classes
    DispatcherMessageDispatcher
  44. val shutdownTimeout: FiniteDuration

    When the dispatcher no longer has any actors registered, how long will it wait until it shuts itself down, defaulting to your akka configs "akka.

    When the dispatcher no longer has any actors registered, how long will it wait until it shuts itself down, defaulting to your akka configs "akka.actor.default-dispatcher.shutdown-timeout" or default specified in reference.conf

    INTERNAL API

    Definition Classes
    DispatcherMessageDispatcher
  45. def suspend(actor: ActorCell): Unit

    After the call to this method, the dispatcher mustn't begin any new message processing for the specified reference

    After the call to this method, the dispatcher mustn't begin any new message processing for the specified reference

    Attributes
    protected[akka]
    Definition Classes
    MessageDispatcher
  46. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  47. def systemDispatch(receiver: ActorCell, invocation: SystemMessage): Unit

    INTERNAL API

    INTERNAL API

    Attributes
    protected[akka]
    Definition Classes
    DispatcherMessageDispatcher
  48. def teamWork(): Unit

    Attributes
    protected
  49. val toString: String

    Definition Classes
    Dispatcher → AnyRef → Any
  50. final def unbatchedExecute(r: Runnable): Unit

    Attributes
    protected
    Definition Classes
    MessageDispatcher → BatchingExecutor
  51. def unregister(actor: ActorCell): Unit

    If you override it, you must call it.

    If you override it, you must call it. But only ever once. See "detach" for the only invocation

    INTERNAL API

    Attributes
    protected[akka]
    Definition Classes
    BalancingDispatcherMessageDispatcher
  52. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  55. def [B](y: B): (BalancingDispatcher, B)

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

Shadowed Implicit Value Members

  1. val self: Any

    Implicit information
    This member is added by an implicit conversion from BalancingDispatcher to StringAdd performed by method any2stringadd in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (balancingDispatcher: StringAdd).self
    Definition Classes
    StringAdd
  2. val self: Any

    Implicit information
    This member is added by an implicit conversion from BalancingDispatcher to StringFormat performed by method any2stringfmt in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (balancingDispatcher: StringFormat).self
    Definition Classes
    StringFormat

Deprecated Value Members

  1. def x: BalancingDispatcher

    Implicit information
    This member is added by an implicit conversion from BalancingDispatcher to ArrowAssoc[BalancingDispatcher] performed by method any2ArrowAssoc in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (balancingDispatcher: ArrowAssoc[BalancingDispatcher]).x
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use leftOfArrow instead

  2. def x: BalancingDispatcher

    Implicit information
    This member is added by an implicit conversion from BalancingDispatcher to Ensuring[BalancingDispatcher] performed by method any2Ensuring in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (balancingDispatcher: Ensuring[BalancingDispatcher]).x
    Definition Classes
    Ensuring
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use resultOfEnsuring instead

Inherited from Dispatcher

Inherited from MessageDispatcher

Inherited from ExecutionContextExecutor

Inherited from ExecutionContext

Inherited from BatchingExecutor

Inherited from Executor

Inherited from AbstractMessageDispatcher

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from BalancingDispatcher to StringAdd

Inherited by implicit conversion any2stringfmt from BalancingDispatcher to StringFormat

Inherited by implicit conversion any2ArrowAssoc from BalancingDispatcher to ArrowAssoc[BalancingDispatcher]

Inherited by implicit conversion any2Ensuring from BalancingDispatcher to Ensuring[BalancingDispatcher]

Ungrouped