net.openhft.chronicle.queue.impl

Class AbstractChronicleQueue

java.lang.Object

net.openhft.chronicle.queue.impl.AbstractChronicleQueue

All Implemented Interfaces:

Closeable, AutoCloseable, ChronicleQueue

public abstract class AbstractChronicleQueue
extends Object
implements ChronicleQueue

Constructor Summary

Constructors

Constructor and Description
AbstractChronicleQueue()

Method Summary

Modifier and Type	Method and Description
void	clear() Remove all the entries in the queue.
void	close()
ExcerptAppender	createAppender() An Appender can be used to write new excerpts sequentially to the upper.
Excerpt	createExcerpt() An Excerpt can be used access entries randomly and optionally change them.
ExcerptTailer	createTailer() A Tailer can be used to read sequentially from the lower of a given position.
protected abstract long	cycle()
long	firstAvailableIndex()
protected abstract long	firstCycle()
abstract long	indexToIndex()
protected abstract long	lastCycle()
long	lastWrittenIndex()
String	name()
abstract long	newIndex()
protected abstract void	release(WireStore store)
long	size()
protected abstract WireStore	storeForCycle(long cycle)
abstract net.openhft.chronicle.wire.Wire	wire()
abstract net.openhft.chronicle.wire.WireType	wireType()

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractChronicleQueue

public AbstractChronicleQueue()

Method Detail

name

public String name()

Specified by:

name in interface ChronicleQueue

Returns:

A descriptive name for this queue which can be used for logging.

createAppender

public ExcerptAppender createAppender()
                               throws IOException

Description copied from interface: ChronicleQueue

An Appender can be used to write new excerpts sequentially to the upper.

Specified by:

createAppender in interface ChronicleQueue

Returns:

ExcerptAppender

Throws:

IOException - if an IO problem occurs

createTailer

public ExcerptTailer createTailer()
                           throws IOException

Description copied from interface: ChronicleQueue

A Tailer can be used to read sequentially from the lower of a given position.

Specified by:

createTailer in interface ChronicleQueue

Returns:

ExcerptTailer

Throws:

IOException - if an IO problem occurs

createExcerpt

@NotNull
public Excerpt createExcerpt()
                               throws IOException

Description copied from interface: ChronicleQueue

An Excerpt can be used access entries randomly and optionally change them.

Specified by:

createExcerpt in interface ChronicleQueue

Returns:

Excerpt

Throws:

IOException - if an IO problem occurs

size

public long size()

Specified by:

size in interface ChronicleQueue

Returns:

The current estimated number of entries.

clear

public void clear()

Description copied from interface: ChronicleQueue

Remove all the entries in the queue.

Specified by:

clear in interface ChronicleQueue

firstAvailableIndex

public long firstAvailableIndex()

Specified by:

firstAvailableIndex in interface ChronicleQueue

Returns:

the lowest valid index available.

lastWrittenIndex

public long lastWrittenIndex()

Specified by:

lastWrittenIndex in interface ChronicleQueue

Returns:

the highest valid index immediately available.

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

storeForCycle

protected abstract WireStore storeForCycle(long cycle)
                                    throws IOException

Parameters:

cycle -

Returns:

Throws:

IOException

release

protected abstract void release(WireStore store)

Parameters:

store -

cycle

protected abstract long cycle()

Returns:

firstCycle

protected abstract long firstCycle()

Returns:

lastCycle

protected abstract long lastCycle()

Returns:

wireType

public abstract net.openhft.chronicle.wire.WireType wireType()

indexToIndex

public abstract long indexToIndex()

wire

public abstract net.openhft.chronicle.wire.Wire wire()

newIndex

public abstract long newIndex()