akka.dispatch

Dispatcher

class Dispatcher extends MessageDispatcher

The event-based Dispatcher binds a set of Actors to a thread pool backed up by a BlockingQueue.

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

Linear Supertypes
MessageDispatcher, ExecutionContext, Executor, AbstractMessageDispatcher, AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Hide All
  2. Show all
  1. Dispatcher
  2. MessageDispatcher
  3. ExecutionContext
  4. Executor
  5. AbstractMessageDispatcher
  6. AnyRef
  7. Any
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Dispatcher (_prerequisites: DispatcherPrerequisites, id: String, throughput: Int, throughputDeadlineTime: Duration, mailboxType: MailboxType, executorServiceFactoryProvider: ExecutorServiceFactoryProvider, shutdownTimeout: Duration)

    throughput

    positive integer indicates the dispatcher will only process so much messages at a time from the mailbox, without checking the mailboxes of other actors. Zero or negative means the dispatcher always continues until the mailbox is empty. Larger values (or zero or negative) increase throughput, smaller values increase fairness

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 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).

    Attributes
    final
    Definition Classes
    MessageDispatcher
  8. def clone (): AnyRef

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  9. def createMailbox (actor: ActorCell): Mailbox

    Creates and returns a mailbox for the given actor.

    Creates and returns a mailbox for the given actor.

    Attributes
    protected[akka]
    Definition Classes
    DispatcherMessageDispatcher
  10. def detach (actor: ActorCell): Unit

    Detaches the specified actor instance from this dispatcher

    Detaches the specified actor instance from this dispatcher

    Attributes
    final
    Definition Classes
    MessageDispatcher
  11. def dispatch (receiver: ActorCell, invocation: Envelope): Unit

    Will be called when the dispatcher is to queue an invocation for execution

    Will be called when the dispatcher is to queue an invocation for execution

    Attributes
    protected[akka]
    Definition Classes
    DispatcherMessageDispatcher
  12. def eq (arg0: AnyRef): Boolean

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

    Definition Classes
    AnyRef → Any
  14. def execute (runnable: Runnable): Unit

    Submits the runnable for execution

    Submits the runnable for execution

    Attributes
    final
    Definition Classes
    MessageDispatcherExecutionContext → Executor
  15. def executeTask (invocation: TaskInvocation): Unit

    Attributes
    protected[akka]
    Definition Classes
    DispatcherMessageDispatcher
  16. val executorService : AtomicReference[ExecutorServiceDelegate]

    Attributes
    protected
  17. val executorServiceFactory : ExecutorServiceFactory

    Attributes
    protected
  18. def finalize (): Unit

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

    Attributes
    final
    Definition Classes
    AnyRef → Any
  20. def hashCode (): Int

    Definition Classes
    AnyRef → Any
  21. 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
  22. def inhabitants : Long

    Definition Classes
    MessageDispatcher
  23. def isInstanceOf [T0] : Boolean

    Attributes
    final
    Definition Classes
    Any
  24. val isThroughputDeadlineTimeDefined : Boolean

    Attributes
    protected[akka] final
    Definition Classes
    MessageDispatcher
  25. val mailboxType : MailboxType

  26. def ne (arg0: AnyRef): Boolean

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

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

    Attributes
    final
    Definition Classes
    AnyRef
  29. val prerequisites : DispatcherPrerequisites

    Definition Classes
    MessageDispatcher
  30. 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.

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

    Returns if it was registered

    Returns if it was registered

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

    Failed tasks should call reportFailure to let the ExecutionContext log the problem or whatever is appropriate for the implementation.

    Failed tasks should call reportFailure to let the ExecutionContext log the problem or whatever is appropriate for the implementation.

    Definition Classes
    MessageDispatcherExecutionContext
  33. def resume (actor: ActorCell): Unit

    Definition Classes
    MessageDispatcher
  34. def shutdown (): Unit

    Called one time every time an actor is detached from this dispatcher and this dispatcher has no actors left attached Must be idempotent

    Called one time every time an actor is detached from this dispatcher and this dispatcher has no actors left attached Must be idempotent

    Attributes
    protected[akka]
    Definition Classes
    DispatcherMessageDispatcher
  35. val shutdownTimeout : Duration

    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

    Definition Classes
    DispatcherMessageDispatcher
  36. 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

    Definition Classes
    MessageDispatcher
  37. def synchronized [T0] (arg0: ⇒ T0): T0

    Attributes
    final
    Definition Classes
    AnyRef
  38. def systemDispatch (receiver: ActorCell, invocation: SystemMessage): Unit

    Will be called when the dispatcher is to queue an invocation for execution

    Will be called when the dispatcher is to queue an invocation for execution

    Attributes
    protected[akka]
    Definition Classes
    DispatcherMessageDispatcher
  39. val throughput : Int

    positive integer indicates the dispatcher will only process so much messages at a time from the mailbox, without checking the mailboxes of other actors.

    positive integer indicates the dispatcher will only process so much messages at a time from the mailbox, without checking the mailboxes of other actors. Zero or negative means the dispatcher always continues until the mailbox is empty. Larger values (or zero or negative) increase throughput, smaller values increase fairness

    Definition Classes
    DispatcherMessageDispatcher
  40. val throughputDeadlineTime : Duration

    Definition Classes
    DispatcherMessageDispatcher
  41. val toString : String

    Definition Classes
    Dispatcher → AnyRef → Any
  42. 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

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

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

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

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()

Inherited from MessageDispatcher

Inherited from ExecutionContext

Inherited from Executor

Inherited from AbstractMessageDispatcher

Inherited from AnyRef

Inherited from Any