net.openhft.chronicle.queue.impl.single

Class SingleChronicleQueue

java.lang.Object

net.openhft.chronicle.queue.impl.AbstractChronicleQueue

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

All Implemented Interfaces:

Closeable, AutoCloseable, ChronicleQueue, SingleChronicleQueueFields

public class SingleChronicleQueue
extends AbstractChronicleQueue
implements SingleChronicleQueueFields

Field Summary

Fields

Modifier and Type	Field and Description
static String	MESSAGE
static int	TIMEOUT

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

MINUS_1_40BIT

Method Summary

Modifier and Type	Method and Description
long	blockSize()
long	bufferCapacity()
boolean	buffered()
void	close()
ExcerptAppender	createAppender() An Appender can be used to writeBytes new excerpts sequentially to the upper.
ExcerptTailer	createTailer() A Tailer can be used to read sequentially from the lower of a given position.
protected long	cycle()
long	epoch()
net.openhft.chronicle.threads.api.EventLoop	eventLoop()
long	firstIndex()
long	lastIndex()
java.util.function.Consumer<net.openhft.chronicle.bytes.BytesRingBufferStats>	onRingBufferStats()
File	path()
protected void	release(WireStore store)
RollCycle	rollCycle()
protected WireStore	storeForCycle(long cycle, long epoch)
net.openhft.chronicle.wire.WireType	wireType()

Methods inherited from class net.openhft.chronicle.queue.impl.AbstractChronicleQueue

clear, createExcerpt, name, size

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.ChronicleQueue

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

epoch

public long epoch()

Specified by:

epoch in interface SingleChronicleQueueFields

Specified by:

epoch in class AbstractChronicleQueue

rollCycle

@NotNull
public RollCycle rollCycle()

Specified by:

rollCycle in interface SingleChronicleQueueFields

buffered

public boolean buffered()

Specified by:

buffered in interface SingleChronicleQueueFields

Returns:

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

eventLoop

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

Specified by:

eventLoop in interface SingleChronicleQueueFields

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

Overrides:

createAppender in class AbstractChronicleQueue

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

Overrides:

createTailer in class AbstractChronicleQueue

Returns:

ExcerptTailer

Throws:

IOException - if an IO problem occurs

storeForCycle

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

Specified by:

storeForCycle in class AbstractChronicleQueue

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

Overrides:

close in class AbstractChronicleQueue

Throws:

IOException

release

protected final void release(@NotNull
                             WireStore store)

Specified by:

release in class AbstractChronicleQueue

Parameters:

store - the store to release

cycle

protected final long cycle()

Specified by:

cycle in class AbstractChronicleQueue

Returns:

the current cycle

firstIndex

public long firstIndex()

Specified by:

firstIndex in interface ChronicleQueue

Overrides:

firstIndex in class AbstractChronicleQueue

Returns:

the lowest valid index available, or sequenceNumber=0 if none are found

lastIndex

public long lastIndex()

Specified by:

lastIndex in interface ChronicleQueue

Overrides:

lastIndex in class AbstractChronicleQueue

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

Specified by:

onRingBufferStats in interface SingleChronicleQueueFields

path

@NotNull
public File path()

Specified by:

path in interface SingleChronicleQueueFields

blockSize

public long blockSize()

Specified by:

blockSize in interface SingleChronicleQueueFields

wireType

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

Specified by:

wireType in interface ChronicleQueue

Specified by:

wireType in interface SingleChronicleQueueFields

Overrides:

wireType in class AbstractChronicleQueue

Returns:

the type of wire used, for example TEXT_WIRE or BINARY WIRE

bufferCapacity

public long bufferCapacity()

Specified by:

bufferCapacity in interface SingleChronicleQueueFields