net.openhft.chronicle.queue.impl.single

Class SingleChronicleQueue

java.lang.Object

net.openhft.chronicle.queue.impl.single.SingleChronicleQueue

All Implemented Interfaces:

Closeable, AutoCloseable, ChronicleQueue, RollingChronicleQueue

public class SingleChronicleQueue
extends Object
implements RollingChronicleQueue

Field Summary

Fields

Modifier and Type	Field and Description
protected ThreadLocal<ExcerptAppender>	excerptAppenderThreadLocal
protected int	sourceId
static String	SUFFIX

Fields inherited from interface net.openhft.chronicle.queue.ChronicleQueue

TEST_BLOCK_SIZE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SingleChronicleQueue(SingleChronicleQueueBuilder builder)

Method Summary

Modifier and Type	Method and Description
ExcerptAppender	acquireAppender() An Appender can be used to writeBytes new excerpts sequentially to the upper.
void	addCloseListener(Runnable closer)
long	blockSize()
long	bufferCapacity()
boolean	buffered()
void	clear() Remove all the entries in the queue.
void	close()
long	countExcerpts(long lowerIndex, long upperIndex) The number of excerpts between the indexes, index1 inclusive, index2 exclusive.
ExcerptTailer	createTailer()
int	cycle()
String	dump() Dump a Queue in YAML format.
void	dump(Writer writer, long fromIndex, long toIndex) Dump a range of entries to a Writer
long	epoch()
net.openhft.chronicle.core.threads.EventLoop	eventLoop()
File	file()
int	firstCycle()
long	firstIndex()
int	indexCount()
int	indexSpacing()
boolean	isClosed()
int	lastCycle()
protected ExcerptAppender	newAppender()
int	nextCycle(int cycle, TailerDirection direction) the next available cycle, no cycle will be created by this method, this method is typically used by a tailer to jump to the next cycle when the cycles are not adjacent.
java.util.function.Consumer<net.openhft.chronicle.bytes.BytesRingBufferStats>	onRingBufferStats()
StoreRecoveryFactory	recoverySupplier()
void	release(WireStore store)
RollCycle	rollCycle()
int	sourceId()
WireStore	storeForCycle(int cycle, long epoch, boolean createIfAbsent)
String	toString()
net.openhft.chronicle.wire.WireType	wireType()

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.openhft.chronicle.queue.ChronicleQueue

createAppender, dump

Methods inherited from interface net.openhft.chronicle.core.io.Closeable

closeQuietly, notifyClosing

Field Detail

SUFFIX

public static final String SUFFIX

See Also:

Constant Field Values

excerptAppenderThreadLocal

protected final ThreadLocal<ExcerptAppender> excerptAppenderThreadLocal

sourceId

protected final int sourceId

Constructor Detail

SingleChronicleQueue

protected SingleChronicleQueue(@NotNull
                               SingleChronicleQueueBuilder builder)

Method Detail

sourceId

public int sourceId()

Specified by:

sourceId in interface ChronicleQueue

clear

public void clear()

Description copied from interface: ChronicleQueue

Remove all the entries in the queue.

Specified by:

clear in interface ChronicleQueue

file

@NotNull
public File file()

Specified by:

file in interface ChronicleQueue

Returns:

the base path where ChronicleQueue stores its data.

dump

public String dump()

Description copied from interface: ChronicleQueue

Dump a Queue in YAML format.

Specified by:

dump in interface ChronicleQueue

Returns:

the contents of the Queue as YAML.

dump

public void dump(Writer writer,
                 long fromIndex,
                 long toIndex)

Description copied from interface: ChronicleQueue

Dump a range of entries to a Writer

Specified by:

dump in interface ChronicleQueue

Parameters:

writer - to write to

fromIndex - first index to include

toIndex - last index to include.

indexCount

public int indexCount()

Specified by:

indexCount in interface RollingChronicleQueue

Returns:

the number of entries in an index meta data entry

indexSpacing

public int indexSpacing()

Specified by:

indexSpacing in interface RollingChronicleQueue

Returns:

the spacing between indexed entries. If 1 then every entry is indexed.

epoch

public long epoch()

Specified by:

epoch in interface RollingChronicleQueue

rollCycle

@NotNull
public RollCycle rollCycle()

Specified by:

rollCycle in interface RollingChronicleQueue

recoverySupplier

public StoreRecoveryFactory recoverySupplier()

Specified by:

recoverySupplier in interface RollingChronicleQueue

buffered

public boolean buffered()

Returns:

if we uses a ring buffer to buffer the appends, the Excerpts are written to the Chronicle Queue using a background thread

eventLoop

@Nullable
public net.openhft.chronicle.core.threads.EventLoop eventLoop()

newAppender

protected ExcerptAppender newAppender()

acquireAppender

@NotNull
public ExcerptAppender acquireAppender()

Description copied from interface: ChronicleQueue

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

Specified by:

acquireAppender in interface ChronicleQueue

Returns:

A thread local Appender for writing new entries to the end.

createTailer

@NotNull
public ExcerptTailer createTailer()

Specified by:

createTailer in interface ChronicleQueue

Returns:

a new ExcerptTailer to read sequentially.

storeForCycle

@Nullable
public final WireStore storeForCycle(int cycle,
                                               long epoch,
                                               boolean createIfAbsent)

Specified by:

storeForCycle in interface RollingChronicleQueue

Parameters:

cycle - the cycle

epoch - an epoch offset as the number of number of milliseconds since January 1, 1970, 00:00:00 GMT

createIfAbsent - create missing stores if true, or return null if missing

Returns:

the WireStore associated with this cycle, or null if !createIfAbsent is false and absent

nextCycle

public int nextCycle(int cycle,
                     @NotNull
                     TailerDirection direction)
              throws ParseException

Description copied from interface: RollingChronicleQueue

the next available cycle, no cycle will be created by this method, this method is typically used by a tailer to jump to the next cycle when the cycles are not adjacent.

Specified by:

nextCycle in interface RollingChronicleQueue

Parameters:

cycle - the current cycle

direction - the direction

Returns:

the next available cycle from the current cycle, or -1 if there is no next cycle

Throws:

ParseException

countExcerpts

public long countExcerpts(long lowerIndex,
                          long upperIndex)
                   throws IllegalStateException

Description copied from interface: RollingChronicleQueue

The number of excerpts between the indexes, index1 inclusive, index2 exclusive. When index1 and index2 are in different cycles which are not adjacent, this operation can be expensive, as the index count for each intermediate cycle has to be found and calculated. As such, and in this situation, it's not recommended to call this method regularly in latency sensitive systems.

Specified by:

countExcerpts in interface RollingChronicleQueue

Parameters:

lowerIndex - from index, the index provided must exist. To improve performance no checking is
 carried out to validate if an excerpt exists at this index.

upperIndex - to index, the index provided must exist. To improve performance no checking is carried out to validate if an excerpt exists at this index.

Returns:

the number of excerpts between the indexes, index1 inclusive, index2 exclusive.

Throws:

IllegalStateException - if the cycle of index1 or index2 can not be ascertained

addCloseListener

public void addCloseListener(Runnable closer)

isClosed

public boolean isClosed()

close

public void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

release

public final void release(@NotNull
                          WireStore store)

Specified by:

release in interface RollingChronicleQueue

Parameters:

store - the store to release

cycle

public final int cycle()

Specified by:

cycle in interface RollingChronicleQueue

Returns:

the current cycle

firstIndex

public long firstIndex()

Specified by:

firstIndex in interface ChronicleQueue

Returns:

the lowest valid index available, or Long.MAX_VALUE if none are found

firstCycle

public int firstCycle()

Specified by:

firstCycle in interface RollingChronicleQueue

Returns:

the first cycle number found, or Integer.MAX_VALUE is none found.

lastCycle

public int lastCycle()

Specified by:

lastCycle in interface RollingChronicleQueue

Returns:

the lastCycle available or Integer.MIN_VALUE if none is found.

onRingBufferStats

public java.util.function.Consumer<net.openhft.chronicle.bytes.BytesRingBufferStats> onRingBufferStats()

blockSize

public long blockSize()

wireType

@NotNull
public net.openhft.chronicle.wire.WireType wireType()

Specified by:

wireType in interface ChronicleQueue

Returns:

the type of wire used, for example WireTypes.TEXT or WireTypes.BINARY

bufferCapacity

public long bufferCapacity()

toString

public String toString()

Overrides:

toString in class Object