CallingThreadDispatcher

java.lang.Object
- akka.dispatch.MessageDispatcher
- - akka.testkit.CallingThreadDispatcher

All Implemented Interfaces:

BatchingExecutor, java.util.concurrent.Executor, scala.concurrent.ExecutionContext, scala.concurrent.ExecutionContextExecutor
```
public class CallingThreadDispatcher
extends MessageDispatcher
```
Dispatcher which runs invocations on the current thread only. This dispatcher does not create any new threads, but it can be used from different threads concurrently for the same actor. The dispatch strategy is to run on the current thread unless the target actor is either suspendSwitch or already running on the current thread (if it is running on a different thread, then this thread will block until that other invocation is finished); if the invocation is not run, it is queued in a thread-local queue to be executed once the active invocation further up the call stack finishes. This leads to completely deterministic execution order if only one thread is used.
Suspending and resuming are global actions for one actor, meaning they can affect different threads, which leads to complications. If messages are queued (thread-locally) during the suspendSwitch period, the only thread to run them upon resume is the thread actually calling the resume method. Hence, all thread-local queues which are not currently being drained (possible, since suspend-queue-resume might happen entirely during an invocation on a different thread) are scooped up into the current thread-local queue which is then executed. It is possible to suspend an actor from within its call stack.

Since:

1.1

Nested Class Summary
- Nested classes/interfaces inherited from interface scala.concurrent.ExecutionContext
  scala.concurrent.ExecutionContext.Implicits$

Constructor Summary

Constructors
Constructor and Description

CallingThreadDispatcher(MessageDispatcherConfigurator _configurator)

Constructors
Constructor and Description
`CallingThreadDispatcher(MessageDispatcherConfigurator _configurator)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected static void`	`akka$dispatch$BatchingExecutor$_setter_$akka$dispatch$BatchingExecutor$$_blockContext_$eq(java.lang.ThreadLocal<scala.concurrent.BlockContext> x$1)`
`protected static void`	`akka$dispatch$BatchingExecutor$_setter_$akka$dispatch$BatchingExecutor$$_tasksLocal_$eq(java.lang.ThreadLocal<BatchingExecutor.AbstractBatch> x$1)`
`static java.lang.ThreadLocal<scala.concurrent.BlockContext>`	`akka$dispatch$BatchingExecutor$$_blockContext()`
`static java.lang.ThreadLocal<BatchingExecutor.AbstractBatch>`	`akka$dispatch$BatchingExecutor$$_tasksLocal()`
`static void`	`attach(ActorCell actor)`
`static boolean`	`batchable(java.lang.Runnable runnable)`
`static MessageDispatcherConfigurator`	`configurator()`
`protected CallingThreadMailbox`	`createMailbox(Cell actor, MailboxType mailboxType)` Creates and returns a mailbox for the given actor.
`static void`	`detach(ActorCell actor)`
`protected void`	`dispatch(ActorCell receiver, Envelope handle)` Will be called when the dispatcher is to queue an invocation for execution
`static EventStream`	`eventStream()`
`static void`	`execute(java.lang.Runnable runnable)`
`protected void`	`executeTask(TaskInvocation invocation)` INTERNAL API
`java.lang.String`	`id()` Identifier of this dispatcher, corresponds to the full key of the dispatcher configuration.
`static java.lang.String`	`Id()`
`static long`	`inhabitants()`
`protected static boolean`	`isThroughputDeadlineTimeDefined()`
`LoggingAdapter`	`log()`
`static Mailboxes`	`mailboxes()`
`static scala.concurrent.ExecutionContext`	`prepare()`
`protected void`	`register(ActorCell actor)` If you override it, you must call it.
`protected boolean`	`registerForExecution(Mailbox mbox, boolean hasMessageHint, boolean hasSystemMessageHint)` Suggest to register the provided mailbox for execution
`static void`	`reportFailure(java.lang.Throwable t)`
`protected static boolean`	`resubmitOnBlock()`
`protected void`	`resume(ActorCell actor)`
`protected void`	`shutdown()` Called one time every time an actor is detached from this dispatcher and this dispatcher has no actors left attached Must be idempotent
`protected scala.concurrent.duration.FiniteDuration`	`shutdownTimeout()` 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
`protected void`	`suspend(ActorCell actor)` After the call to this method, the dispatcher mustn't begin any new message processing for the specified reference
`protected void`	`systemDispatch(ActorCell receiver, SystemMessage message)` Will be called when the dispatcher is to queue an invocation for execution
`protected int`	`throughput()` INTERNAL API
`protected scala.concurrent.duration.FiniteDuration`	`throughputDeadlineTime()` INTERNAL API
`protected static void`	`unbatchedExecute(java.lang.Runnable r)`
`protected void`	`unregister(ActorCell actor)` If you override it, you must call it.

Methods inherited from class akka.dispatch.MessageDispatcher
actors, attach, configurator, debug, detach, eventStream, inhabitants, isThroughputDeadlineTimeDefined, mailboxes, printActors, reportFailure, RESCHEDULED, resubmitOnBlock, SCHEDULED, unbatchedExecute, UNSCHEDULED

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface akka.dispatch.BatchingExecutor
batchable, execute

Methods inherited from interface scala.concurrent.ExecutionContext
$init$, defaultReporter, execute, fromExecutor, fromExecutor, fromExecutorService, fromExecutorService, global, prepare

- Constructor Detail
  - CallingThreadDispatcher
```
public CallingThreadDispatcher(MessageDispatcherConfigurator _configurator)
```
- Method Detail
  - Id
```
public static java.lang.String Id()
```
  - execute
```
public static void execute(java.lang.Runnable runnable)
```
  - batchable
```
public static boolean batchable(java.lang.Runnable runnable)
```
  - prepare
```
public static scala.concurrent.ExecutionContext prepare()
```
  - configurator
```
public static MessageDispatcherConfigurator configurator()
```
  - mailboxes
```
public static Mailboxes mailboxes()
```
  - eventStream
```
public static EventStream eventStream()
```
  - inhabitants
```
public static final long inhabitants()
```
  - attach
```
public static final void attach(ActorCell actor)
```
  - detach
```
public static final void detach(ActorCell actor)
```
  - resubmitOnBlock
```
protected static final boolean resubmitOnBlock()
```
  - unbatchedExecute
```
protected static final void unbatchedExecute(java.lang.Runnable r)
```
  - reportFailure
```
public static void reportFailure(java.lang.Throwable t)
```
  - isThroughputDeadlineTimeDefined
```
protected static final boolean isThroughputDeadlineTimeDefined()
```
  - akka$dispatch$BatchingExecutor$$_tasksLocal
```
public static java.lang.ThreadLocal<BatchingExecutor.AbstractBatch> akka$dispatch$BatchingExecutor$$_tasksLocal()
```
  - akka$dispatch$BatchingExecutor$$_blockContext
```
public static java.lang.ThreadLocal<scala.concurrent.BlockContext> akka$dispatch$BatchingExecutor$$_blockContext()
```
  - akka$dispatch$BatchingExecutor$_setter_$akka$dispatch$BatchingExecutor$$_tasksLocal_$eq
```
protected static final void akka$dispatch$BatchingExecutor$_setter_$akka$dispatch$BatchingExecutor$$_tasksLocal_$eq(java.lang.ThreadLocal<BatchingExecutor.AbstractBatch> x$1)
```
  - akka$dispatch$BatchingExecutor$_setter_$akka$dispatch$BatchingExecutor$$_blockContext_$eq
```
protected static final void akka$dispatch$BatchingExecutor$_setter_$akka$dispatch$BatchingExecutor$$_blockContext_$eq(java.lang.ThreadLocal<scala.concurrent.BlockContext> x$1)
```
  - log
```
public LoggingAdapter log()
```
  - id
```
public java.lang.String id()
```
    Description copied from class: MessageDispatcher
    
    Identifier of this dispatcher, corresponds to the full key of the dispatcher configuration.
    
    Specified by:
    
    id in class MessageDispatcher
    
    Returns:
    
    (undocumented)
  - createMailbox
```
protected CallingThreadMailbox createMailbox(Cell actor,
                                             MailboxType mailboxType)
```
    Description copied from class: MessageDispatcher
    
    Creates and returns a mailbox for the given actor.
    
    Specified by:
    
    createMailbox in class MessageDispatcher
    
    Parameters:
    
    actor - (undocumented)
    
    mailboxType - (undocumented)
    
    Returns:
    
    (undocumented)
  - shutdown
```
protected void shutdown()
```
    Description copied from class: MessageDispatcher
    
    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
    
    Specified by:
    
    shutdown in class MessageDispatcher
  - throughput
```
protected int throughput()
```
    Description copied from class: MessageDispatcher
    
    INTERNAL API
    
    Specified by:
    
    throughput in class MessageDispatcher
    
    Returns:
    
    (undocumented)
  - throughputDeadlineTime
```
protected scala.concurrent.duration.FiniteDuration throughputDeadlineTime()
```
    Description copied from class: MessageDispatcher
    
    INTERNAL API
    
    Specified by:
    
    throughputDeadlineTime in class MessageDispatcher
    
    Returns:
    
    (undocumented)
  - registerForExecution
```
protected boolean registerForExecution(Mailbox mbox,
                                       boolean hasMessageHint,
                                       boolean hasSystemMessageHint)
```
    Description copied from class: MessageDispatcher
    
    Suggest to register the provided mailbox for execution
    INTERNAL API
    
    Specified by:
    
    registerForExecution in class MessageDispatcher
    
    Parameters:
    
    mbox - (undocumented)
    
    hasMessageHint - (undocumented)
    
    hasSystemMessageHint - (undocumented)
    
    Returns:
    
    (undocumented)
  - shutdownTimeout
```
protected scala.concurrent.duration.FiniteDuration shutdownTimeout()
```
    Description copied from class: MessageDispatcher
    
    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
    
    Specified by:
    
    shutdownTimeout in class MessageDispatcher
    
    Returns:
    
    (undocumented)
  - register
```
protected void register(ActorCell actor)
```
    Description copied from class: MessageDispatcher
    
    If you override it, you must call it. But only ever once. See "attach" for only invocation.
    INTERNAL API
    
    Overrides:
    
    register in class MessageDispatcher
    
    Parameters:
    
    actor - (undocumented)
  - unregister
```
protected void unregister(ActorCell actor)
```
    Description copied from class: MessageDispatcher
    
    If you override it, you must call it. But only ever once. See "detach" for the only invocation
    INTERNAL API
    
    Overrides:
    
    unregister in class MessageDispatcher
    
    Parameters:
    
    actor - (undocumented)
  - suspend
```
protected void suspend(ActorCell actor)
```
    Description copied from class: MessageDispatcher
    
    After the call to this method, the dispatcher mustn't begin any new message processing for the specified reference
    
    Overrides:
    
    suspend in class MessageDispatcher
    
    Parameters:
    
    actor - (undocumented)
  - resume
```
protected void resume(ActorCell actor)
```
    Overrides:
    
    resume in class MessageDispatcher
  - systemDispatch
```
protected void systemDispatch(ActorCell receiver,
                              SystemMessage message)
```
    Description copied from class: MessageDispatcher
    
    Will be called when the dispatcher is to queue an invocation for execution
    INTERNAL API
    
    Specified by:
    
    systemDispatch in class MessageDispatcher
    
    Parameters:
    
    receiver - (undocumented)
    
    message - (undocumented)
  - dispatch
```
protected void dispatch(ActorCell receiver,
                        Envelope handle)
```
    Description copied from class: MessageDispatcher
    
    Will be called when the dispatcher is to queue an invocation for execution
    INTERNAL API
    
    Specified by:
    
    dispatch in class MessageDispatcher
    
    Parameters:
    
    receiver - (undocumented)
    
    handle - (undocumented)
  - executeTask
```
protected void executeTask(TaskInvocation invocation)
```
    Description copied from class: MessageDispatcher
    
    INTERNAL API
    
    Specified by:
    
    executeTask in class MessageDispatcher
    
    Parameters:
    
    invocation - (undocumented)

Class CallingThreadDispatcher

Nested Class Summary

Nested classes/interfaces inherited from interface scala.concurrent.ExecutionContext

Constructor Summary

Method Summary

Methods inherited from class akka.dispatch.MessageDispatcher

Methods inherited from class java.lang.Object

Methods inherited from interface akka.dispatch.BatchingExecutor

Methods inherited from interface scala.concurrent.ExecutionContext

Constructor Detail

CallingThreadDispatcher

Method Detail

Id

execute

batchable

prepare

configurator

mailboxes

eventStream

inhabitants

attach

detach

resubmitOnBlock

unbatchedExecute

reportFailure

isThroughputDeadlineTimeDefined

akka$dispatch$BatchingExecutor$$_tasksLocal

akka$dispatch$BatchingExecutor$$_blockContext

akka$dispatch$BatchingExecutor$_setter_$akka$dispatch$BatchingExecutor$$_tasksLocal_$eq

akka$dispatch$BatchingExecutor$_setter_$akka$dispatch$BatchingExecutor$$_blockContext_$eq

log

id

createMailbox

shutdown

throughput

throughputDeadlineTime

registerForExecution

shutdownTimeout

register

unregister

suspend

resume

systemDispatch

dispatch

executeTask