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
Type Hierarchy
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. Protected

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 !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from Dispatcher toany2stringadd[Dispatcher] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (Dispatcher, B)
    Implicit
    This member is added by an implicit conversion from Dispatcher toArrowAssoc[Dispatcher] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. 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
  8. 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
  9. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  10. val configurator: MessageDispatcherConfigurator
    Definition Classes
    MessageDispatcher
  11. def createMailbox(actor: Cell, mailboxType: MailboxType): Mailbox

    INTERNAL API

    INTERNAL API

    Attributes
    protected[akka]
    Definition Classes
    Dispatcher → MessageDispatcher
  12. 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
  13. def dispatch(receiver: ActorCell, invocation: Envelope): Unit

    INTERNAL API

    INTERNAL API

    Attributes
    protected[akka]
    Definition Classes
    Dispatcher → MessageDispatcher
  14. def ensuring(cond: (Dispatcher) => Boolean, msg: => Any): Dispatcher
    Implicit
    This member is added by an implicit conversion from Dispatcher toEnsuring[Dispatcher] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. def ensuring(cond: (Dispatcher) => Boolean): Dispatcher
    Implicit
    This member is added by an implicit conversion from Dispatcher toEnsuring[Dispatcher] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  16. def ensuring(cond: Boolean, msg: => Any): Dispatcher
    Implicit
    This member is added by an implicit conversion from Dispatcher toEnsuring[Dispatcher] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  17. def ensuring(cond: Boolean): Dispatcher
    Implicit
    This member is added by an implicit conversion from Dispatcher toEnsuring[Dispatcher] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  18. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  20. val eventStream: EventStream
    Definition Classes
    MessageDispatcher
  21. def execute(runnable: Runnable): Unit
    Definition Classes
    BatchingExecutor → Executor
  22. def executeTask(invocation: TaskInvocation): Unit

    INTERNAL API

    INTERNAL API

    Attributes
    protected[akka]
    Definition Classes
    Dispatcher → MessageDispatcher
  23. final def executorService: ExecutorServiceDelegate
    Attributes
    protected
  24. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  25. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  26. 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
  27. final def inhabitants: Long
    Definition Classes
    MessageDispatcher
  28. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  29. final val isThroughputDeadlineTimeDefined: Boolean

    INTERNAL API

    INTERNAL API

    Attributes
    protected[akka]
    Definition Classes
    MessageDispatcher
  30. val mailboxes: Mailboxes
    Definition Classes
    MessageDispatcher
  31. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  32. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  33. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  34. 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
    MessageDispatcher
  35. 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
    Dispatcher → MessageDispatcher
  36. def reportFailure(t: Throwable): Unit
    Definition Classes
    MessageDispatcher → ExecutionContext
  37. final def resubmitOnBlock: Boolean
    Attributes
    protected
    Definition Classes
    MessageDispatcher → BatchingExecutor
  38. def resume(actor: ActorCell): Unit
    Attributes
    protected[akka]
    Definition Classes
    MessageDispatcher
  39. def shutdown(): Unit

    INTERNAL API

    INTERNAL API

    Attributes
    protected[akka]
    Definition Classes
    Dispatcher → MessageDispatcher
  40. 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
  41. 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
  42. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  43. def systemDispatch(receiver: ActorCell, invocation: SystemMessage): Unit

    INTERNAL API

    INTERNAL API

    Attributes
    protected[akka]
    Definition Classes
    Dispatcher → MessageDispatcher
  44. val throughput: Int

    INTERNAL API

    INTERNAL API

    Definition Classes
    Dispatcher → MessageDispatcher
  45. val throughputDeadlineTime: Duration

    INTERNAL API

    INTERNAL API

    Definition Classes
    Dispatcher → MessageDispatcher
  46. val toString: String
    Definition Classes
    Dispatcher → AnyRef → Any
  47. final def unbatchedExecute(r: Runnable): Unit
    Attributes
    protected
    Definition Classes
    MessageDispatcher → BatchingExecutor
  48. 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
    MessageDispatcher
  49. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  50. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  51. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

  2. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from Dispatcher toStringFormat[Dispatcher] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

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

    (Since version 2.12.0) preparation of ExecutionContexts will be removed

  4. def →[B](y: B): (Dispatcher, B)
    Implicit
    This member is added by an implicit conversion from Dispatcher toArrowAssoc[Dispatcher] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

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 fromDispatcher to any2stringadd[Dispatcher]

Inherited by implicit conversion StringFormat fromDispatcher to StringFormat[Dispatcher]

Inherited by implicit conversion Ensuring fromDispatcher to Ensuring[Dispatcher]

Inherited by implicit conversion ArrowAssoc fromDispatcher to ArrowAssoc[Dispatcher]

Ungrouped