akka.actor.mailbox.filebased
Class FileBasedMessageQueue

java.lang.Object
  extended by akka.actor.mailbox.DurableMessageQueue
      extended by akka.actor.mailbox.filebased.FileBasedMessageQueue
All Implemented Interfaces:
DurableMessageSerialization, MessageQueue

public class FileBasedMessageQueue
extends DurableMessageQueue
implements DurableMessageSerialization


Constructor Summary
FileBasedMessageQueue(ActorRef _owner, ExtendedActorSystem _system, FileBasedMailboxSettings settings)
           
 
Method Summary
 CircuitBreaker breaker()
           
 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 envelope)
          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.
 boolean remove()
          Completely delete the queue.
 FileBasedMailboxSettings settings()
           
 
Methods inherited from class akka.actor.mailbox.DurableMessageQueue
name, owner, ownerPath, ownerPathString, system
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface akka.actor.mailbox.DurableMessageSerialization
deserialize, serialize
 

Constructor Detail

FileBasedMessageQueue

public FileBasedMessageQueue(ActorRef _owner,
                             ExtendedActorSystem _system,
                             FileBasedMailboxSettings settings)
Method Detail

settings

public FileBasedMailboxSettings settings()

breaker

public CircuitBreaker breaker()

enqueue

public void enqueue(ActorRef receiver,
                    Envelope envelope)
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)
envelope - (undocumented)

dequeue

public 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 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 boolean hasMessages()
Description copied from interface: MessageQueue
Indicates whether this queue is non-empty.

Specified by:
hasMessages in interface MessageQueue
Returns:
(undocumented)

remove

public boolean remove()
Completely delete the queue.

Returns:
(undocumented)

cleanUp

public 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()), “/deadletters” otherwise.

Specified by:
cleanUp in interface MessageQueue
Parameters:
owner - (undocumented)
deadLetters - (undocumented)