abstract class MessageDispatcher extends AbstractMessageDispatcher with BatchingExecutor with ExecutionContextExecutor
- Source
- AbstractDispatcher.scala
- Alphabetic
- By Inheritance
- MessageDispatcher
- ExecutionContextExecutor
- ExecutionContext
- BatchingExecutor
- Executor
- AbstractMessageDispatcher
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- All
Instance Constructors
- new MessageDispatcher(configurator: MessageDispatcherConfigurator)
Abstract Value Members
-
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[akka]
-
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[akka]
-
abstract
def
executeTask(invocation: TaskInvocation): Unit
INTERNAL API
INTERNAL API
- Attributes
- protected[akka]
-
abstract
def
id: String
Identifier of this dispatcher, corresponds to the full key of the dispatcher configuration.
-
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[akka]
-
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[akka]
-
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 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
- Attributes
- protected[akka]
-
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[akka]
-
abstract
def
throughput: Int
INTERNAL API
INTERNAL API
- Attributes
- protected[akka]
-
abstract
def
throughputDeadlineTime: Duration
INTERNAL API
INTERNAL API
- Attributes
- protected[akka]
Concrete Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
def
+(other: String): String
- Implicit
- This member is added by an implicit conversion from MessageDispatcher to any2stringadd[MessageDispatcher] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
-
def
->[B](y: B): (MessageDispatcher, B)
- Implicit
- This member is added by an implicit conversion from MessageDispatcher to ArrowAssoc[MessageDispatcher] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @inline()
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
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).
-
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
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
- val configurator: MessageDispatcherConfigurator
-
final
def
detach(actor: ActorCell): Unit
Detaches the specified actor instance from this dispatcher
-
def
ensuring(cond: (MessageDispatcher) ⇒ Boolean, msg: ⇒ Any): MessageDispatcher
- Implicit
- This member is added by an implicit conversion from MessageDispatcher to Ensuring[MessageDispatcher] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: (MessageDispatcher) ⇒ Boolean): MessageDispatcher
- Implicit
- This member is added by an implicit conversion from MessageDispatcher to Ensuring[MessageDispatcher] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: Boolean, msg: ⇒ Any): MessageDispatcher
- Implicit
- This member is added by an implicit conversion from MessageDispatcher to Ensuring[MessageDispatcher] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: Boolean): MessageDispatcher
- Implicit
- This member is added by an implicit conversion from MessageDispatcher to Ensuring[MessageDispatcher] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- val eventStream: EventStream
-
def
execute(runnable: Runnable): Unit
- Definition Classes
- BatchingExecutor → Executor
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
def
formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from MessageDispatcher to StringFormat[MessageDispatcher] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @inline()
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- final def inhabitants: Long
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
val
isThroughputDeadlineTimeDefined: Boolean
INTERNAL API
INTERNAL API
- Attributes
- protected[akka]
- val mailboxes: Mailboxes
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
-
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]
-
def
reportFailure(t: Throwable): Unit
- Definition Classes
- MessageDispatcher → ExecutionContext
-
final
def
resubmitOnBlock: Boolean
- Attributes
- protected
- Definition Classes
- MessageDispatcher → BatchingExecutor
-
def
resume(actor: ActorCell): Unit
- Attributes
- protected[akka]
-
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]
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
unbatchedExecute(r: Runnable): Unit
- Attributes
- protected
- Definition Classes
- MessageDispatcher → BatchingExecutor
-
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]
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
def
→[B](y: B): (MessageDispatcher, B)
- Implicit
- This member is added by an implicit conversion from MessageDispatcher to ArrowAssoc[MessageDispatcher] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
Deprecated Value Members
-
def
prepare(): ExecutionContext
- Definition Classes
- ExecutionContext
- Annotations
- @deprecated
- Deprecated
(Since version 2.12.0) preparation of ExecutionContexts will be removed
Inherited from ExecutionContext
Value Members
-
def
prepare(): ExecutionContext
- Definition Classes
- ExecutionContext
- Annotations
- @deprecated
- Deprecated
(Since version 2.12.0) preparation of ExecutionContexts will be removed
Inherited from BatchingExecutor
Inherited from AnyRef
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
Inherited from Any
Inherited by implicit conversion any2stringadd from MessageDispatcher to any2stringadd[MessageDispatcher]
Value Members
-
def
+(other: String): String
- Implicit
- This member is added by an implicit conversion from MessageDispatcher to any2stringadd[MessageDispatcher] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
Inherited by implicit conversion StringFormat from MessageDispatcher to StringFormat[MessageDispatcher]
Value Members
-
def
formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from MessageDispatcher to StringFormat[MessageDispatcher] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @inline()
Inherited by implicit conversion Ensuring from MessageDispatcher to Ensuring[MessageDispatcher]
Value Members
-
def
ensuring(cond: (MessageDispatcher) ⇒ Boolean, msg: ⇒ Any): MessageDispatcher
- Implicit
- This member is added by an implicit conversion from MessageDispatcher to Ensuring[MessageDispatcher] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: (MessageDispatcher) ⇒ Boolean): MessageDispatcher
- Implicit
- This member is added by an implicit conversion from MessageDispatcher to Ensuring[MessageDispatcher] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: Boolean, msg: ⇒ Any): MessageDispatcher
- Implicit
- This member is added by an implicit conversion from MessageDispatcher to Ensuring[MessageDispatcher] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: Boolean): MessageDispatcher
- Implicit
- This member is added by an implicit conversion from MessageDispatcher to Ensuring[MessageDispatcher] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
Inherited by implicit conversion ArrowAssoc from MessageDispatcher to ArrowAssoc[MessageDispatcher]
Value Members
-
def
->[B](y: B): (MessageDispatcher, B)
- Implicit
- This member is added by an implicit conversion from MessageDispatcher to ArrowAssoc[MessageDispatcher] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @inline()
-
def
→[B](y: B): (MessageDispatcher, B)
- Implicit
- This member is added by an implicit conversion from MessageDispatcher to ArrowAssoc[MessageDispatcher] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
Ungrouped
-
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[akka]
-
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[akka]
-
abstract
def
executeTask(invocation: TaskInvocation): Unit
INTERNAL API
INTERNAL API
- Attributes
- protected[akka]
-
abstract
def
id: String
Identifier of this dispatcher, corresponds to the full key of the dispatcher configuration.
-
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[akka]
-
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[akka]
-
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 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
- Attributes
- protected[akka]
-
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[akka]
-
abstract
def
throughput: Int
INTERNAL API
INTERNAL API
- Attributes
- protected[akka]
-
abstract
def
throughputDeadlineTime: Duration
INTERNAL API
INTERNAL API
- Attributes
- protected[akka]
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
def
+(other: String): String
- Implicit
- This member is added by an implicit conversion from MessageDispatcher to any2stringadd[MessageDispatcher] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
-
def
->[B](y: B): (MessageDispatcher, B)
- Implicit
- This member is added by an implicit conversion from MessageDispatcher to ArrowAssoc[MessageDispatcher] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @inline()
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
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).
-
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
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
- val configurator: MessageDispatcherConfigurator
-
final
def
detach(actor: ActorCell): Unit
Detaches the specified actor instance from this dispatcher
-
def
ensuring(cond: (MessageDispatcher) ⇒ Boolean, msg: ⇒ Any): MessageDispatcher
- Implicit
- This member is added by an implicit conversion from MessageDispatcher to Ensuring[MessageDispatcher] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: (MessageDispatcher) ⇒ Boolean): MessageDispatcher
- Implicit
- This member is added by an implicit conversion from MessageDispatcher to Ensuring[MessageDispatcher] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: Boolean, msg: ⇒ Any): MessageDispatcher
- Implicit
- This member is added by an implicit conversion from MessageDispatcher to Ensuring[MessageDispatcher] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: Boolean): MessageDispatcher
- Implicit
- This member is added by an implicit conversion from MessageDispatcher to Ensuring[MessageDispatcher] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- val eventStream: EventStream
-
def
execute(runnable: Runnable): Unit
- Definition Classes
- BatchingExecutor → Executor
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
def
formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from MessageDispatcher to StringFormat[MessageDispatcher] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @inline()
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- final def inhabitants: Long
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
val
isThroughputDeadlineTimeDefined: Boolean
INTERNAL API
INTERNAL API
- Attributes
- protected[akka]
- val mailboxes: Mailboxes
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
-
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]
-
def
reportFailure(t: Throwable): Unit
- Definition Classes
- MessageDispatcher → ExecutionContext
-
final
def
resubmitOnBlock: Boolean
- Attributes
- protected
- Definition Classes
- MessageDispatcher → BatchingExecutor
-
def
resume(actor: ActorCell): Unit
- Attributes
- protected[akka]
-
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]
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
unbatchedExecute(r: Runnable): Unit
- Attributes
- protected
- Definition Classes
- MessageDispatcher → BatchingExecutor
-
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]
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
def
→[B](y: B): (MessageDispatcher, B)
- Implicit
- This member is added by an implicit conversion from MessageDispatcher to ArrowAssoc[MessageDispatcher] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
-
def
prepare(): ExecutionContext
- Definition Classes
- ExecutionContext
- Annotations
- @deprecated
- Deprecated
(Since version 2.12.0) preparation of ExecutionContexts will be removed