raboof/pekko
1
0
Fork 0
Code Issues Pull requests Projects Releases 6 Packages Wiki Activity Actions 10

Deemphasize CallingThreadDispatcher in the docs (#27387)

Browse source
This commit is contained in:
Arnout Engelen 2019-07-23 10:09:59 +02:00
parent 69fd98a39d
commit df57d42782
No known key found for this signature in database
GPG key ID: BB8C0F854A1E2105
2 changed files with 5 additions and 15 deletions
Download patch file Download diff file Expand all files Collapse all files

2
akka-docs/src/main/paradox/dispatchers.md
View file

@ -152,7 +152,7 @@ There are 3 different types of message dispatchers:
* Sharability: Unlimited
* Mailboxes: Any, creates one per Actor per Thread (on demand)
* Use cases: Testing
* Use cases: Debugging and testing
* Driven by: The calling thread (duh)
### More dispatcher configuration examples

18
akka-docs/src/main/paradox/testing.md
View file

@ -580,7 +580,7 @@ responsible for the Actor creation, but @scala[the]@java[using `TestProbe` or ha
## CallingThreadDispatcher
The `CallingThreadDispatcher` serves good purposes in unit testing, as
It is possible to use the `CallingThreadDispatcher` in unit testing, as
described above, but originally it was conceived in order to allow contiguous
stack traces to be generated in case of an error. As this special dispatcher
runs everything which would normally be queued directly on the current thread,
@ -660,22 +660,12 @@ the second line and never reach the fourth line, which would unblock it on a
normal dispatcher.
Thus, keep in mind that the `CallingThreadDispatcher` is not a
general-purpose replacement for the normal dispatchers. On the other hand it
may be quite useful to run your actor network on it for testing, because if it
runs without dead-locking chances are very high that it will not dead-lock in
production.
@@@ warning
The above sentence is unfortunately not a strong guarantee, because your
code might directly or indirectly change its behavior when running on a
different dispatcher. If you are looking for a tool to help you debug
dead-locks, the `CallingThreadDispatcher` may help with certain error
general-purpose replacement for the normal dispatchers. If you are looking
for a tool to help you debug dead-locks,
the `CallingThreadDispatcher` may help with certain error
scenarios, but keep in mind that it has may give false negatives as well as
false positives.
@@@
### Thread Interruptions
If the CallingThreadDispatcher sees that the current thread has its