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

=act #17425 Document NonBlockingBoundedMailbox to be single-consumer

Browse source
This commit is contained in:
Patrik Nordwall 2015-09-11 09:00:03 +02:00
parent a22b3be9da
commit 876b8045a1
4 changed files with 12 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

9
akka-actor/src/main/scala/akka/dispatch/Mailbox.scala
View file

@ -386,7 +386,10 @@ class NodeMessageQueue extends AbstractNodeQueue[Envelope] with MessageQueue wit
}
}
//Discards overflowing messages into DeadLetters
/**
* Lock-free bounded non-blocking multiple-producer single-consumer queue.
* Discards overflowing messages into DeadLetters.
*/
class BoundedNodeMessageQueue(capacity: Int) extends AbstractBoundedNodeQueue[Envelope](capacity)
with MessageQueue with BoundedMessageQueueSemantics with MultipleConsumerSemantics {
final def pushTimeOut: Duration = Duration.Undefined
@ -627,9 +630,11 @@ final case class SingleConsumerOnlyUnboundedMailbox() extends MailboxType with P
}
/**
* NonBlockingBoundedMailbox is a high-performance, multiple producer—multiple consumer, bounded MailboxType,
* NonBlockingBoundedMailbox is a high-performance, multiple-producer single-consumer, bounded MailboxType,
* Noteworthy is that it discards overflow as DeadLetters.
*
* It can't have multiple consumers, which rules out using it with BalancingPool (BalancingDispatcher) for instance.
*
* NOTE: NonBlockingBoundedMailbox does not use `mailbox-push-timeout-time` as it is non-blocking.
*/
case class NonBlockingBoundedMailbox(val capacity: Int) extends MailboxType with ProducesMessageQueue[BoundedNodeMessageQueue] {