akka.dispatch

Class BoundedControlAwareMailbox.MessageQueue

java.lang.Object

akka.dispatch.BoundedControlAwareMailbox.MessageQueue

All Implemented Interfaces:

BoundedControlAwareMessageQueueSemantics, BoundedMessageQueueSemantics, ControlAwareMessageQueueSemantics, MessageQueue, MultipleConsumerSemantics, QueueBasedMessageQueue

Enclosing class:

BoundedControlAwareMailbox

public static class BoundedControlAwareMailbox.MessageQueue
extends java.lang.Object
implements BoundedControlAwareMessageQueueSemantics

Constructor Summary

Constructors

Constructor and Description
MessageQueue(int capacity, scala.concurrent.duration.FiniteDuration pushTimeOut)

Method Summary

Modifier and Type	Method and Description
int	capacity()
java.util.concurrent.ConcurrentLinkedQueue<Envelope>	controlQueue()
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.FiniteDuration	pushTimeOut()
java.util.concurrent.ConcurrentLinkedQueue<Envelope>	queue()

Methods inherited from class java.lang.Object

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

Methods inherited from interface akka.dispatch.QueueBasedMessageQueue

cleanUp

Constructor Detail

MessageQueue

public MessageQueue(int capacity,
                    scala.concurrent.duration.FiniteDuration pushTimeOut)

Method Detail

capacity

public int capacity()

pushTimeOut

public scala.concurrent.duration.FiniteDuration pushTimeOut()

Specified by:

pushTimeOut in interface BoundedMessageQueueSemantics

controlQueue

public java.util.concurrent.ConcurrentLinkedQueue<Envelope> controlQueue()

Specified by:

controlQueue in interface ControlAwareMessageQueueSemantics

queue

public java.util.concurrent.ConcurrentLinkedQueue<Envelope> queue()

Specified by:

queue in interface ControlAwareMessageQueueSemantics

Specified by:

queue in interface QueueBasedMessageQueue

enqueue

public 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 ControlAwareMessageQueueSemantics

Specified by:

enqueue in interface MessageQueue

Parameters:

receiver - (undocumented)

handle - (undocumented)

numberOfMessages

public 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 ControlAwareMessageQueueSemantics

Specified by:

numberOfMessages in interface MessageQueue

Specified by:

numberOfMessages in interface QueueBasedMessageQueue

Returns:

(undocumented)

hasMessages

public boolean hasMessages()

Description copied from interface: MessageQueue

Indicates whether this queue is non-empty.

Specified by:

hasMessages in interface ControlAwareMessageQueueSemantics

Specified by:

hasMessages in interface MessageQueue

Specified by:

hasMessages in interface QueueBasedMessageQueue

Returns:

(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 ControlAwareMessageQueueSemantics

Specified by:

dequeue in interface MessageQueue

Returns:

(undocumented)