#3437 - Adding rst documentation for the MPSC mailbox

This commit is contained in:
Viktor Klang 2013-06-28 00:59:16 +02:00
parent 1cca2b85e3
commit 709a568aa1
2 changed files with 40 additions and 2 deletions

View file

@ -92,9 +92,10 @@ fall-back to the default mailbox configuration section.
Builtin Mailbox Implementations
===============================
Akka comes shipped with a number of default mailbox implementations:
Akka comes shipped with a number of mailbox implementations:
* UnboundedMailbox
- The default mailbox
- Backed by a ``java.util.concurrent.ConcurrentLinkedQueue``
@ -102,6 +103,18 @@ Akka comes shipped with a number of default mailbox implementations:
- Bounded: No
- Configuration name: "unbounded" or "akka.dispatch.UnboundedMailbox"
* SingleConsumerOnlyUnboundedMailbox
- Backed by a very efficient Multiple Producer Single Consumer queue, cannot be used with BalancingDispatcher
- Blocking: No
- Bounded: No
- Configuration name: "akka.dispatch.SingleConsumerOnlyUnboundedMailbox"
* BoundedMailbox
- Backed by a ``java.util.concurrent.LinkedBlockingQueue``
@ -110,6 +123,8 @@ Akka comes shipped with a number of default mailbox implementations:
- Bounded: Yes
- Configuration name: "bounded" or "akka.dispatch.BoundedMailbox"
* UnboundedPriorityMailbox
- Backed by a ``java.util.concurrent.PriorityBlockingQueue``
@ -118,6 +133,8 @@ Akka comes shipped with a number of default mailbox implementations:
- Bounded: No
- Configuration name: "akka.dispatch.UnboundedPriorityMailbox"
* BoundedPriorityMailbox
- Backed by a ``java.util.PriorityBlockingQueue`` wrapped in an ``akka.util.BoundedBlockingQueue``
@ -126,6 +143,8 @@ Akka comes shipped with a number of default mailbox implementations:
- Bounded: Yes
- Configuration name: "akka.dispatch.BoundedPriorityMailbox"
* Durable mailboxes, see :ref:`durable-mailboxes-java`.
Mailbox configuration examples