class Dispatcher extends MessageDispatcher
The event-based
binds a set of Actors to a thread pool backed up by a
Dispatcher
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
- Alphabetic
- By Inheritance
- Dispatcher
- 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
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
-
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 Dispatcher to any2stringadd[Dispatcher] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
-
def
->[B](y: B): (Dispatcher, B)
- Implicit
- This member is added by an implicit conversion from Dispatcher to ArrowAssoc[Dispatcher] 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).
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
-
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
- @native() @HotSpotIntrinsicCandidate() @throws( ... )
-
val
configurator: MessageDispatcherConfigurator
- Definition Classes
- MessageDispatcher
-
def
createMailbox(actor: Cell, mailboxType: MailboxType): Mailbox
INTERNAL API
INTERNAL API
- Attributes
- protected[akka]
- Definition Classes
- Dispatcher → MessageDispatcher
-
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
-
def
dispatch(receiver: ActorCell, invocation: Envelope): Unit
INTERNAL API
INTERNAL API
- Attributes
- protected[akka]
- Definition Classes
- Dispatcher → MessageDispatcher
-
def
ensuring(cond: (Dispatcher) ⇒ Boolean, msg: ⇒ Any): Dispatcher
- Implicit
- This member is added by an implicit conversion from Dispatcher to Ensuring[Dispatcher] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: (Dispatcher) ⇒ Boolean): Dispatcher
- Implicit
- This member is added by an implicit conversion from Dispatcher to Ensuring[Dispatcher] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: Boolean, msg: ⇒ Any): Dispatcher
- Implicit
- This member is added by an implicit conversion from Dispatcher to Ensuring[Dispatcher] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: Boolean): Dispatcher
- Implicit
- This member is added by an implicit conversion from Dispatcher to Ensuring[Dispatcher] 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
- Definition Classes
- MessageDispatcher
-
def
execute(runnable: Runnable): Unit
- Definition Classes
- BatchingExecutor → Executor
-
def
executeTask(invocation: TaskInvocation): Unit
INTERNAL API
INTERNAL API
- Attributes
- protected[akka]
- Definition Classes
- Dispatcher → MessageDispatcher
-
final
def
executorService: ExecutorServiceDelegate
- Attributes
- protected
-
def
formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from Dispatcher to StringFormat[Dispatcher] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @inline()
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
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
-
final
def
inhabitants: Long
- Definition Classes
- MessageDispatcher
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
val
isThroughputDeadlineTimeDefined: Boolean
INTERNAL API
INTERNAL API
- Attributes
- protected[akka]
- Definition Classes
- MessageDispatcher
-
val
mailboxes: Mailboxes
- Definition Classes
- MessageDispatcher
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
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
-
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
-
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]
- Definition Classes
- MessageDispatcher
-
def
shutdown(): Unit
INTERNAL API
INTERNAL API
- Attributes
- protected[akka]
- Definition Classes
- Dispatcher → MessageDispatcher
-
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
-
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
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
systemDispatch(receiver: ActorCell, invocation: SystemMessage): Unit
INTERNAL API
INTERNAL API
- Attributes
- protected[akka]
- Definition Classes
- Dispatcher → MessageDispatcher
-
val
throughput: Int
INTERNAL API
INTERNAL API
- Definition Classes
- Dispatcher → MessageDispatcher
-
val
throughputDeadlineTime: Duration
INTERNAL API
INTERNAL API
- Definition Classes
- Dispatcher → MessageDispatcher
-
val
toString: String
- Definition Classes
- Dispatcher → 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]
- Definition Classes
- MessageDispatcher
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
def
→[B](y: B): (Dispatcher, B)
- Implicit
- This member is added by an implicit conversion from Dispatcher to ArrowAssoc[Dispatcher] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
Deprecated Value Members
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @Deprecated @deprecated @throws( classOf[java.lang.Throwable] )
- Deprecated
(Since version ) see corresponding Javadoc for more information.
-
def
prepare(): ExecutionContext
- Definition Classes
- ExecutionContext
- Annotations
- @deprecated
- Deprecated
(Since version 2.12.0) preparation of ExecutionContexts will be removed