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

Merge pull request #18688 from akka/wip-18636-doc-blocking-mailboxes-patriknw

Browse source 
=doc #18636 Correction of mailbox documentation
This commit is contained in:
Konrad Malawski 2015-10-19 17:34:35 +02:00
commit ace389b1f4
2 changed files with 67 additions and 62 deletions
Download patch file Download diff file Expand all files Collapse all files

68
akka-docs/rst/java/mailboxes.rst
View file

@ -154,42 +154,17 @@ Akka comes shipped with a number of mailbox implementations:
- Configuration name: "akka.dispatch.UnboundedControlAwareMailbox"
Aditional implementations exist which can be potencially blocking on pushing into the queue,
however they can be configured using
* **BoundedMailbox**
- Backed by a ``java.util.concurrent.LinkedBlockingQueue``
- Blocking: Yes
- Bounded: Yes
- Configuration name: "bounded" or "akka.dispatch.BoundedMailbox"
* **UnboundedPriorityMailbox**
- Backed by a ``java.util.concurrent.PriorityBlockingQueue``
- Delivery order for messages of equal priority is undefined - contrast with the UnboundedStablePriorityMailbox
- Blocking: Yes
- Blocking: No
- Bounded: No
- Configuration name: ``"akka.dispatch.UnboundedPriorityMailbox"``
* **BoundedPriorityMailbox**
- Backed by a ``java.util.PriorityQueue`` wrapped in an ``akka.util.BoundedBlockingQueue``
- Delivery order for messages of equal priority is undefined - contrast with the ``BoundedStablePriorityMailbox``
- Blocking: Yes
- Bounded: Yes
- Configuration name: ``"akka.dispatch.BoundedPriorityMailbox"``
- Configuration name: "akka.dispatch.UnboundedPriorityMailbox"
* **UnboundedStablePriorityMailbox**
@ -197,11 +172,38 @@ however they can be configured using
- FIFO order is preserved for messages of equal priority - contrast with the UnboundedPriorityMailbox
- Blocking: Yes
- Blocking: No
- Bounded: No
- Configuration name: ``"akka.dispatch.UnboundedStablePriorityMailbox"``
- Configuration name: "akka.dispatch.UnboundedStablePriorityMailbox"
Other bounded mailbox implementations which will block the sender if the capacity is reached and
configured with non-zero ``mailbox-push-timeout-time``.
.. note:: The following mailboxes should only be used with zero ``mailbox-push-timeout-time``.
* **BoundedMailbox**
- Backed by a ``java.util.concurrent.LinkedBlockingQueue``
- Blocking: Yes if used with non-zero ``mailbox-push-timeout-time``, otherwise No
- Bounded: Yes
- Configuration name: "bounded" or "akka.dispatch.BoundedMailbox"
* **BoundedPriorityMailbox**
- Backed by a ``java.util.PriorityQueue`` wrapped in an ``akka.util.BoundedBlockingQueue``
- Delivery order for messages of equal priority is undefined - contrast with the ``BoundedStablePriorityMailbox``
- Blocking: Yes if used with non-zero ``mailbox-push-timeout-time``, otherwise No
- Bounded: Yes
- Configuration name: ``"akka.dispatch.BoundedPriorityMailbox"``
* **BoundedStablePriorityMailbox**
@ -209,11 +211,11 @@ however they can be configured using
- FIFO order is preserved for messages of equal priority - contrast with the BoundedPriorityMailbox
- Blocking: Yes
- Blocking: Yes if used with non-zero ``mailbox-push-timeout-time``, otherwise No
- Bounded: Yes
- Configuration name: ``"akka.dispatch.BoundedStablePriorityMailbox"``
- Configuration name: "akka.dispatch.BoundedStablePriorityMailbox"
* **BoundedControlAwareMailbox**
@ -221,11 +223,11 @@ however they can be configured using
- Backed by two ``java.util.concurrent.ConcurrentLinkedQueue`` and blocking on enqueue if capacity has been reached
- Blocking: Yes
- Blocking: Yes if used with non-zero ``mailbox-push-timeout-time``, otherwise No
- Bounded: Yes
- Configuration name: ``"akka.dispatch.BoundedControlAwareMailbox"``
- Configuration name: "akka.dispatch.BoundedControlAwareMailbox"
Mailbox configuration examples
==============================

59
akka-docs/rst/scala/mailboxes.rst
View file

@ -154,61 +154,64 @@ Akka comes shipped with a number of mailbox implementations:
- Configuration name: "akka.dispatch.UnboundedControlAwareMailbox"
Previously available mailbox implementations which were deprecated because they might block:
* **BoundedMailbox**
- Backed by a ``java.util.concurrent.LinkedBlockingQueue``
- Blocking: Yes
- Bounded: Yes
- Configuration name: "bounded" or "akka.dispatch.BoundedMailbox"
* **UnboundedPriorityMailbox**
- Backed by a ``java.util.concurrent.PriorityBlockingQueue``
- Delivery order for messages of equal priority is undefined - contrast with the UnboundedStablePriorityMailbox
- Blocking: Yes
- Blocking: No
- Bounded: No
- Configuration name: "akka.dispatch.UnboundedPriorityMailbox"
* **BoundedPriorityMailbox**
- Backed by a ``java.util.PriorityQueue`` wrapped in an ``akka.util.BoundedBlockingQueue``
- Delivery order for messages of equal priority is undefined - contrast with the ``BoundedStablePriorityMailbox``
- Blocking: Yes
- Bounded: Yes
- Configuration name: ``"akka.dispatch.BoundedPriorityMailbox"``
* **UnboundedStablePriorityMailbox**
- Backed by a ``java.util.concurrent.PriorityBlockingQueue`` wrapped in an ``akka.util.PriorityQueueStabilizer``
- FIFO order is preserved for messages of equal priority - contrast with the UnboundedPriorityMailbox
- Blocking: Yes
- Blocking: No
- Bounded: No
- Configuration name: "akka.dispatch.UnboundedStablePriorityMailbox"
Other bounded mailbox implementations which will block the sender if the capacity is reached and
configured with non-zero ``mailbox-push-timeout-time``.
.. note:: The following mailboxes should only be used with zero ``mailbox-push-timeout-time``.
* **BoundedMailbox**
- Backed by a ``java.util.concurrent.LinkedBlockingQueue``
- Blocking: Yes if used with non-zero ``mailbox-push-timeout-time``, otherwise No
- Bounded: Yes
- Configuration name: "bounded" or "akka.dispatch.BoundedMailbox"
* **BoundedPriorityMailbox**
- Backed by a ``java.util.PriorityQueue`` wrapped in an ``akka.util.BoundedBlockingQueue``
- Delivery order for messages of equal priority is undefined - contrast with the ``BoundedStablePriorityMailbox``
- Blocking: Yes if used with non-zero ``mailbox-push-timeout-time``, otherwise No
- Bounded: Yes
- Configuration name: ``"akka.dispatch.BoundedPriorityMailbox"``
* **BoundedStablePriorityMailbox**
- Backed by a ``java.util.PriorityQueue`` wrapped in an ``akka.util.PriorityQueueStabilizer`` and an ``akka.util.BoundedBlockingQueue``
- FIFO order is preserved for messages of equal priority - contrast with the BoundedPriorityMailbox
- Blocking: Yes
- Blocking: Yes if used with non-zero ``mailbox-push-timeout-time``, otherwise No
- Bounded: Yes
@ -220,7 +223,7 @@ Previously available mailbox implementations which were deprecated because they
- Backed by two ``java.util.concurrent.ConcurrentLinkedQueue`` and blocking on enqueue if capacity has been reached
- Blocking: Yes
- Blocking: Yes if used with non-zero ``mailbox-push-timeout-time``, otherwise No
- Bounded: Yes