Packages

c

org.apache.pekko.dispatch

MessageDispatcher

abstract class MessageDispatcher extends AbstractMessageDispatcher with BatchingExecutor with ExecutionContextExecutor

Source
AbstractDispatcher.scala
Linear Supertypes
ExecutionContextExecutor, ExecutionContext, BatchingExecutor, Executor, AbstractMessageDispatcher, AnyRef, Any
Known Subclasses
Dispatcher, PinnedDispatcher, CallingThreadDispatcher
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. MessageDispatcher
  2. ExecutionContextExecutor
  3. ExecutionContext
  4. BatchingExecutor
  5. Executor
  6. AbstractMessageDispatcher
  7. AnyRef
  8. 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 MessageDispatcher(configurator: MessageDispatcherConfigurator)

Abstract Value Members

  1. abstract def createMailbox(actor: Cell, mailboxType: MailboxType): Mailbox

    Creates and returns a mailbox for the given actor.

    Creates and returns a mailbox for the given actor.

    Attributes
    protected[pekko]
  2. abstract 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

    INTERNAL API

    Attributes
    protected[pekko]
  3. abstract def executeTask(invocation: TaskInvocation): Unit

    INTERNAL API

    INTERNAL API

    Attributes
    protected[pekko]
  4. abstract def id: String

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

  5. abstract def registerForExecution(mbox: Mailbox, hasMessageHint: Boolean, hasSystemMessageHint: Boolean): Boolean

    Suggest to register the provided mailbox for execution

    Suggest to register the provided mailbox for execution

    INTERNAL API

    Attributes
    protected[pekko]
  6. abstract 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

    INTERNAL API

    Attributes
    protected[pekko]
    Annotations
    @InternalStableApi()
  7. abstract def shutdownTimeout: FiniteDuration

    When the dispatcher no longer has any actors registered, how long will it wait until it shuts itself down, defaulting to your pekko configs "pekko.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 pekko configs "pekko.actor.default-dispatcher.shutdown-timeout" or default specified in reference.conf

    INTERNAL API

    Attributes
    protected[pekko]
  8. abstract 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

    INTERNAL API

    Attributes
    protected[pekko]
  9. abstract def throughput: Int

    INTERNAL API

    INTERNAL API

    Attributes
    protected[pekko]
  10. abstract def throughputDeadlineTime: Duration

    INTERNAL API

    INTERNAL API

    Attributes
    protected[pekko]

Concrete 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 MessageDispatcher toany2stringadd[MessageDispatcher] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (MessageDispatcher, B)
    Implicit
    This member is added by an implicit conversion from MessageDispatcher toArrowAssoc[MessageDispatcher] 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).

  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
  11. final def detach(actor: ActorCell): Unit

    Detaches the specified actor instance from this dispatcher

  12. def ensuring(cond: (MessageDispatcher) => Boolean, msg: => Any): MessageDispatcher
    Implicit
    This member is added by an implicit conversion from MessageDispatcher toEnsuring[MessageDispatcher] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: (MessageDispatcher) => Boolean): MessageDispatcher
    Implicit
    This member is added by an implicit conversion from MessageDispatcher toEnsuring[MessageDispatcher] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: Boolean, msg: => Any): MessageDispatcher
    Implicit
    This member is added by an implicit conversion from MessageDispatcher toEnsuring[MessageDispatcher] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. def ensuring(cond: Boolean): MessageDispatcher
    Implicit
    This member is added by an implicit conversion from MessageDispatcher toEnsuring[MessageDispatcher] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  16. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  18. val eventStream: EventStream
  19. def execute(runnable: Runnable): Unit
    Definition Classes
    BatchingExecutor → Executor
  20. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  21. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  22. final def inhabitants: Long
  23. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  24. final val isThroughputDeadlineTimeDefined: Boolean

    INTERNAL API

    INTERNAL API

    Attributes
    protected[pekko]
  25. val mailboxes: Mailboxes
  26. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  27. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  28. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  29. 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[pekko]
  30. def reportFailure(t: Throwable): Unit
    Definition Classes
    MessageDispatcher → ExecutionContext
  31. final def resubmitOnBlock: Boolean
    Attributes
    protected
    Definition Classes
    MessageDispatcher → BatchingExecutor
  32. def resume(actor: ActorCell): Unit

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

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

    Attributes
    protected[pekko]
  33. 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[pekko]
  34. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  35. def toString(): String
    Definition Classes
    AnyRef → Any
  36. final def unbatchedExecute(r: Runnable): Unit
    Attributes
    protected
    Definition Classes
    MessageDispatcher → BatchingExecutor
  37. 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[pekko]
  38. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  39. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  40. 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 MessageDispatcher toStringFormat[MessageDispatcher] 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): (MessageDispatcher, B)
    Implicit
    This member is added by an implicit conversion from MessageDispatcher toArrowAssoc[MessageDispatcher] 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 ExecutionContextExecutor

Inherited from ExecutionContext

Inherited from BatchingExecutor

Inherited from Executor

Inherited from AbstractMessageDispatcher

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromMessageDispatcher to any2stringadd[MessageDispatcher]

Inherited by implicit conversion StringFormat fromMessageDispatcher to StringFormat[MessageDispatcher]

Inherited by implicit conversion Ensuring fromMessageDispatcher to Ensuring[MessageDispatcher]

Inherited by implicit conversion ArrowAssoc fromMessageDispatcher to ArrowAssoc[MessageDispatcher]

Ungrouped