reactor.io.queue

Class ChronicleQueuePersistor<T>

java.lang.Object

reactor.io.queue.ChronicleQueuePersistor<T>

All Implemented Interfaces:

Iterable<T>, QueuePersistor<T>

public class ChronicleQueuePersistor<T>
extends Object
implements QueuePersistor<T>

A QueuePersistor implementation that uses a Java Chronicle IndexedChronicle to persist items in the queue.

Author:

Jon Brisbin, Stephane Maldini

See Also:

Java Chronicle

Constructor Summary

Constructors

Constructor and Description
ChronicleQueuePersistor(String basePath) Create an ChronicleQueuePersistor based on the given base path.
ChronicleQueuePersistor(String basePath, Codec<Buffer,T,T> codec, boolean clearOnStart, boolean deleteOnExit, net.openhft.chronicle.ChronicleQueueBuilder config) Create an ChronicleQueuePersistor based on the given base path, encoder and decoder.

Method Summary

Modifier and Type	Method and Description
void	close() Close the underlying chronicles.
Codec<Buffer,T,T>	codec()
T	get(Long id) Return the item with the given id.
boolean	hasNext() Are there more items waiting to be returned?
Iterator<T>	iterator()
long	lastId() Get the value of the last item to have been persisted.
Long	offer(T t) Persist and return the last Long id of the item.
Long	offerAll(Collection<T> t) Persist N items in batch and return a Long id of the last item.
net.openhft.chronicle.ExcerptTailer	reader()
T	remove() Remove the oldest item from the persistence queue.
long	size() Get the number of items persisted right now.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

ChronicleQueuePersistor

public ChronicleQueuePersistor(@Nonnull
                               String basePath)
                        throws IOException

Create an ChronicleQueuePersistor based on the given base path.

Parameters:

basePath - Directory in which to create the Chronicle.

Throws:

IOException

ChronicleQueuePersistor

public ChronicleQueuePersistor(@Nonnull
                               String basePath,
                               @Nonnull
                               Codec<Buffer,T,T> codec,
                               boolean clearOnStart,
                               boolean deleteOnExit,
                               @Nonnull
                               net.openhft.chronicle.ChronicleQueueBuilder config)
                        throws IOException

Create an ChronicleQueuePersistor based on the given base path, encoder and decoder. Optionally, passing false to clearOnStart skips clearing the Chronicle on start for appending.

Parameters:

basePath - Directory in which to create the Chronicle.

codec - Codec to turn objects into Buffers and visa-versa.

clearOnStart - Whether or not to clear the Chronicle on start.

deleteOnExit - Whether or not to delete the Chronicle when the program exits.

config - ChronicleConfig to use.

Throws:

IOException

Method Detail

close

public void close()

Close the underlying chronicles.

Specified by:

close in interface QueuePersistor<T>

lastId

public long lastId()

Description copied from interface: QueuePersistor

Get the value of the last item to have been persisted.

Specified by:

lastId in interface QueuePersistor<T>

Returns:

last ID persisted

size

public long size()

Description copied from interface: QueuePersistor

Get the number of items persisted right now.

Specified by:

size in interface QueuePersistor<T>

Returns:

number of items persisted

hasNext

public boolean hasNext()

Description copied from interface: QueuePersistor

Are there more items waiting to be returned?

Specified by:

hasNext in interface QueuePersistor<T>

Returns:

true if items can be retrieved from this persistor, false otherwise

offer

public Long offer(@Nonnull
                  T t)

Description copied from interface: QueuePersistor

Persist and return the last Long id of the item.

Specified by:

offer in interface QueuePersistor<T>

Parameters:

t - element to persist

Returns:

id of the item just persisted

offerAll

public Long offerAll(@Nonnull
                     Collection<T> t)

Description copied from interface: QueuePersistor

Persist N items in batch and return a Long id of the last item.

Specified by:

offerAll in interface QueuePersistor<T>

Parameters:

t - element to persist

Returns:

id of the item just persisted

get

public T get(Long id)

Description copied from interface: QueuePersistor

Return the item with the given id.

Specified by:

get in interface QueuePersistor<T>

Parameters:

id - the given index to lookup

Returns:

item persisted under the given id

codec

public Codec<Buffer,T,T> codec()

reader

public net.openhft.chronicle.ExcerptTailer reader()

remove

public T remove()

Description copied from interface: QueuePersistor

Remove the oldest item from the persistence queue.

Specified by:

remove in interface QueuePersistor<T>

Returns:

the oldest item in the queue

iterator

public Iterator<T> iterator()

Specified by:

iterator in interface Iterable<T>