Packages

c

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 akka.dispatch.Dispatchers.

Source
Dispatcher.scala
Linear Supertypes
MessageDispatcher, ExecutionContextExecutor, ExecutionContext, BatchingExecutor, Executor, AbstractMessageDispatcher, AnyRef, Any
Known Subclasses
PinnedDispatcher
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Dispatcher
  2. MessageDispatcher
  3. ExecutionContextExecutor
  4. ExecutionContext
  5. BatchingExecutor
  6. Executor
  7. AbstractMessageDispatcher
  8. AnyRef
  9. 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 Dispatcher(_configurator: MessageDispatcherConfigurator, id: String, throughput: Int, throughputDeadlineTime: Duration, executorServiceFactoryProvider: ExecutorServiceFactoryProvider, shutdownTimeout: FiniteDuration)

    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. 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
  2. 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
  3. val configurator: MessageDispatcherConfigurator
    Definition Classes
    MessageDispatcher
  4. 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
  5. val eventStream: EventStream
    Definition Classes
    MessageDispatcher
  6. def execute(runnable: Runnable): Unit
    Definition Classes
    BatchingExecutor → Executor
  7. 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
    Dispatcher → MessageDispatcher
  8. final def inhabitants: Long
    Definition Classes
    MessageDispatcher
  9. val mailboxes: Mailboxes
    Definition Classes
    MessageDispatcher
  10. def reportFailure(t: Throwable): Unit
    Definition Classes
    MessageDispatcher → ExecutionContext
  11. 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.actor.default-dispatcher.shutdown-timeout" or default specified in reference.conf

    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
    Dispatcher → MessageDispatcher
  12. val throughput: Int

    INTERNAL API

    INTERNAL API

    Definition Classes
    Dispatcher → MessageDispatcher
  13. val throughputDeadlineTime: Duration

    INTERNAL API

    INTERNAL API

    Definition Classes
    Dispatcher → MessageDispatcher
  14. val toString: String
    Definition Classes
    Dispatcher → AnyRef → Any

Deprecated Value Members

  1. def prepare(): ExecutionContext
    Definition Classes
    ExecutionContext
    Annotations
    @deprecated
    Deprecated

    (Since version 2.12.0) preparation of ExecutionContexts will be removed