akka.actor.mailbox.filebased.filequeue
Class QueueCollection

java.lang.Object
  extended by akka.actor.mailbox.filebased.filequeue.QueueCollection

public class QueueCollection
extends java.lang.Object


Constructor Summary
QueueCollection(java.lang.String queueFolder, FileBasedMailboxSettings settings, LoggingAdapter log)
           
 
Method Summary
 boolean add(java.lang.String key, byte[] item)
           
 boolean add(java.lang.String key, byte[] item, int expiry)
          Add an item to a named queue.
 void confirmRemove(java.lang.String key, int xid)
           
 long currentBytes()
           
 long currentItems()
           
 void delete(java.lang.String name)
           
 java.lang.String[] dumpConfig(java.lang.String key)
           
 void flush(java.lang.String key)
           
 int flushAllExpired()
           
 int flushExpired(java.lang.String name)
           
 void loadQueues()
           
 scala.Option<PersistentQueue> queue(java.lang.String name)
          Get a named queue, creating it if necessary.
 Counter queueHits()
           
 Counter queueMisses()
           
 scala.collection.immutable.List<java.lang.String> queueNames()
           
 scala.Option<byte[]> receive(java.lang.String key)
           
 void remove(java.lang.String key, int timeout, boolean transaction, boolean peek, scala.Function1<scala.Option<QItem>,scala.runtime.BoxedUnit> f)
          Retrieve an item from a queue and pass it to a continuation.
 void shutdown()
          Shutdown this queue collection.
 scala.Tuple2<java.lang.String,java.lang.String>[] stats(java.lang.String key)
           
 Counter totalAdded()
           
 void unremove(java.lang.String key, int xid)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

QueueCollection

public QueueCollection(java.lang.String queueFolder,
                       FileBasedMailboxSettings settings,
                       LoggingAdapter log)
Method Detail

totalAdded

public Counter totalAdded()

queueHits

public Counter queueHits()

queueMisses

public Counter queueMisses()

loadQueues

public void loadQueues()

queueNames

public scala.collection.immutable.List<java.lang.String> queueNames()

currentItems

public long currentItems()

currentBytes

public long currentBytes()

queue

public scala.Option<PersistentQueue> queue(java.lang.String name)
Get a named queue, creating it if necessary. Exposed only to unit tests.

Parameters:
name - (undocumented)
Returns:
(undocumented)

add

public boolean add(java.lang.String key,
                   byte[] item,
                   int expiry)
Add an item to a named queue. Will not return until the item has been synchronously added and written to the queue journal file.

Parameters:
key - (undocumented)
item - (undocumented)
expiry - (undocumented)
Returns:
true if the item was added; false if the server is shutting down

add

public boolean add(java.lang.String key,
                   byte[] item)

remove

public void remove(java.lang.String key,
                   int timeout,
                   boolean transaction,
                   boolean peek,
                   scala.Function1<scala.Option<QItem>,scala.runtime.BoxedUnit> f)
Retrieve an item from a queue and pass it to a continuation. If no item is available within the requested time, or the server is shutting down, None is passed.

Parameters:
key - (undocumented)
timeout - (undocumented)
transaction - (undocumented)
peek - (undocumented)
f - (undocumented)

receive

public scala.Option<byte[]> receive(java.lang.String key)

unremove

public void unremove(java.lang.String key,
                     int xid)

confirmRemove

public void confirmRemove(java.lang.String key,
                          int xid)

flush

public void flush(java.lang.String key)

delete

public void delete(java.lang.String name)

flushExpired

public int flushExpired(java.lang.String name)

flushAllExpired

public int flushAllExpired()

stats

public scala.Tuple2<java.lang.String,java.lang.String>[] stats(java.lang.String key)

dumpConfig

public java.lang.String[] dumpConfig(java.lang.String key)

shutdown

public void shutdown()
Shutdown this queue collection. All actors are asked to exit, and any future queue requests will fail.