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
static String	MESSAGE
static int	TIMEOUT

Fields inherited from interface net.openhft.chronicle.queue.impl.RollingChronicleQueue

MINUS_1_40BIT

Method Summary

Modifier and Type	Method and Description
long	blockSize()
long	bufferCapacity()
boolean	buffered()
void	clear() Remove all the entries in the queue.
void	close()
ExcerptAppender	createAppender() An Appender can be used to writeBytes 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.
long	cycle()
long	epoch()
net.openhft.chronicle.core.threads.EventLoop	eventLoop()
long	firstIndex()
long	lastIndex()
java.util.function.Consumer<net.openhft.chronicle.bytes.BytesRingBufferStats>	onRingBufferStats()
File	path()
void	release(WireStore store)
RollCycle	rollCycle()
WireStore	storeForCycle(long cycle, long epoch)
net.openhft.chronicle.wire.WireType	wireType()

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.openhft.chronicle.queue.impl.RollingChronicleQueue

index, toCycle, toSequenceNumber

Field Detail

TIMEOUT

public static final int TIMEOUT

See Also:

Constant Field Values

MESSAGE

public static final String MESSAGE

See Also:

Constant Field Values

Method Detail

clear

public void clear()

Description copied from interface: ChronicleQueue

Remove all the entries in the queue.

Specified by:

clear in interface ChronicleQueue

path

@NotNull
public File path()

Specified by:

path in interface ChronicleQueue

Returns:

the base path where ChronicleQueue stores its data.

epoch

public long epoch()

Specified by:

epoch in interface RollingChronicleQueue

rollCycle

@NotNull
public RollCycle rollCycle()

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()

createExcerpt

@NotNull
public Excerpt createExcerpt()

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

createAppender

@NotNull
public ExcerptAppender createAppender()

Description copied from interface: ChronicleQueue

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

Specified by:

createAppender in interface ChronicleQueue

Returns:

ExcerptAppender

createTailer

@NotNull
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

storeForCycle

@NotNull
public final WireStore storeForCycle(long cycle,
                                              long epoch)

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

Returns:

the WireStore associated with this cycle

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

release

public final void release(@NotNull
                          WireStore store)

Specified by:

release in interface RollingChronicleQueue

Parameters:

store - the store to release

cycle

public final long 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 sequenceNumber=0 if none are found

lastIndex

public long lastIndex()

Specified by:

lastIndex in interface ChronicleQueue

Returns:

the highest valid index immediately available. Or -1 if none available. The lowest 40bits of the index refer to the sequence number with the cycle, giving a maximum of 1099511627776 excerpt per cycle. Each cycle has its own file. Each file holds its own index. You can discard the old files ( if they are no longer used ). The other highest 24 bits
 of the index are used for the cycle number (this equates to the filename), giving a maximum
 of 16777216 cycles ( aka files )

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 TEXT_WIRE or BINARY WIRE

bufferCapacity

public long bufferCapacity()