ralscha / xodus-queue Goto Github PK

This project provides a persistent java.util.Queue and java.util.concurrent.BlockingQueue implementation. It is using Xodus as the underlying storage engine. For persisting POJOs, it relies on Kryo.

xodus-queue is not a high-performance queue, and it only works within a single JVM. The primary motivation was to write a queue that survives a server restart and does not introduce a lot of external dependencies to my projects. Because I often use Xodus already in my projects, this library only adds Kryo as an additional dependency.

Any contributions are welcome if something is missing or could be implemented better, submit a pull request, or create an issue.

Create an instance of XodusQueue or XodusBlockingQueue and specify the database directory and the class of the entries you want to put into the queue. These can be either built-in Java types like String, Integer, Long, or a more complex POJO.

It is recommended to open the queue in an automatic resource management block because the underlying Xodus database should be closed when you no longer access the queue.

try (XodusQueue<String> queue = new XodusQueue<>("./test", String.class)) {

}

After the instantiation, you can call any of the methods from the java.util.Queue<E> and java.util.concurrent.BlockingQueue<E> interface. See the JavaDoc (Queue, BlockingQueue) for a list of all available methods.

Currently iterator() is not implemented. The underlying storage engine requires that read and write operations have to run inside transactions, and I don't know how to implement that in an iterator.

try (XodusQueue<String> queue = new XodusQueue<>("./queue", String.class)) {
  queue.add("one");

  String head = queue.poll(); // "one"
}

The blocking queue supports a capacity limit. The following example limits the number of elements in the queue to 3. put blocks the current thread when the queue is full and take blocks when the queue is empty.

try (XodusBlockingQueue<String> queue = new XodusBlockingQueue<>("./blocking_queue", String.class, 3)) {
  queue.put("one");
  queue.put("two");

  String head = queue.take(); // "one"
}

The library is hosted on the Central Maven Repository

  <dependency>
    <groupId>ch.rasc</groupId>
    <artifactId>xodus-queue</artifactId>
    <version>1.0.1</version>
  </dependency>

• Fix key management in XodusQueue
• Add java.util.concurrent.BlockingQueue implementation: XodusBlockingQueue

• Initial release

Code released under the Apache license.