akka.dispatch

Class BoundedNodeMessageQueue

java.lang.Object

akka.dispatch.AbstractBoundedNodeQueue<Envelope>

akka.dispatch.BoundedNodeMessageQueue

All Implemented Interfaces:

BoundedMessageQueueSemantics, MessageQueue, MultipleConsumerSemantics

public class BoundedNodeMessageQueue
extends AbstractBoundedNodeQueue<Envelope>
implements MessageQueue, BoundedMessageQueueSemantics, MultipleConsumerSemantics

Lock-free bounded non-blocking multiple-producer single-consumer queue. Discards overflowing messages into DeadLetters.

Nested Class Summary

Nested classes/interfaces inherited from class akka.dispatch.AbstractBoundedNodeQueue

AbstractBoundedNodeQueue.Node<T>

Constructor Summary

Constructors

Constructor and Description
BoundedNodeMessageQueue(int capacity)

Method Summary

Modifier and Type	Method and Description
void	cleanUp(ActorRef owner, MessageQueue deadLetters) Called when the mailbox this queue belongs to is disposed of.
Envelope	dequeue() Try to dequeue the next message from this queue, return null failing that.
void	enqueue(ActorRef receiver, Envelope handle) Try to enqueue the message to this queue, or throw an exception.
boolean	hasMessages() Indicates whether this queue is non-empty.
int	numberOfMessages() Should return the current number of messages held in this queue; may always return 0 if no other value is available efficiently.
scala.concurrent.duration.Duration	pushTimeOut()

Methods inherited from class akka.dispatch.AbstractBoundedNodeQueue

add, addNode, capacity, isEmpty, peek, peekNode, poll, pollNode, size

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BoundedNodeMessageQueue

public BoundedNodeMessageQueue(int capacity)

Method Detail

pushTimeOut

public final scala.concurrent.duration.Duration pushTimeOut()

Specified by:

pushTimeOut in interface BoundedMessageQueueSemantics

enqueue

public final void enqueue(ActorRef receiver,
                          Envelope handle)

Description copied from interface: MessageQueue

Try to enqueue the message to this queue, or throw an exception.

Specified by:

enqueue in interface MessageQueue

Parameters:

receiver - (undocumented)

handle - (undocumented)

dequeue

public final Envelope dequeue()

Description copied from interface: MessageQueue

Try to dequeue the next message from this queue, return null failing that.

Specified by:

dequeue in interface MessageQueue

Returns:

(undocumented)

numberOfMessages

public final int numberOfMessages()

Description copied from interface: MessageQueue

Should return the current number of messages held in this queue; may always return 0 if no other value is available efficiently. Do not use this for testing for presence of messages, use hasMessages instead.

Specified by:

numberOfMessages in interface MessageQueue

Returns:

(undocumented)

hasMessages

public final boolean hasMessages()

Description copied from interface: MessageQueue

Indicates whether this queue is non-empty.

Specified by:

hasMessages in interface MessageQueue

Returns:

(undocumented)

cleanUp

public final void cleanUp(ActorRef owner,
                          MessageQueue deadLetters)

Description copied from interface: MessageQueue

Called when the mailbox this queue belongs to is disposed of. Normally it is expected to transfer all remaining messages into the dead letter queue which is passed in. The owner of this MessageQueue is passed in if available (e.g. for creating DeadLetters()), &ldquo;/deadletters&rdquo; otherwise.

Specified by:

cleanUp in interface MessageQueue

Parameters:

owner - (undocumented)

deadLetters - (undocumented)