net.openhft.chronicle.queue.impl.single.work.in.progress

Class IndexedSingleChronicleQueue

java.lang.Object

net.openhft.chronicle.queue.impl.single.work.in.progress.AbstractChronicle

net.openhft.chronicle.queue.impl.single.work.in.progress.IndexedSingleChronicleQueue

All Implemented Interfaces:

Closeable, AutoCloseable, ChronicleQueue

public class IndexedSingleChronicleQueue
extends AbstractChronicle

SingleChronicle implements Chronicle over a single streaming file

Created by peter.lawrey on 30/01/15.

Constructor Summary

Constructors

Constructor and Description
IndexedSingleChronicleQueue(String filename, long blockSize, net.openhft.chronicle.wire.WireType wireType)

Method Summary

Modifier and Type	Method and Description
long	appendDocument(net.openhft.chronicle.bytes.Bytes buffer)
net.openhft.chronicle.bytes.Bytes	bytes()
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.
long	firstAvailableIndex()
long	firstBytes()
boolean	index(long index, net.openhft.chronicle.bytes.VanillaBytes bytes)
long	indexToIndex()
long	lastIndex()
long	lastWrittenIndex()
String	name()
long	newIndex() Creates a new Excerpt containing and index which will be 1L << 17L bytes long, This method is used for creating both the primary and secondary indexes.
boolean	readDocument(AtomicLong offset, net.openhft.chronicle.bytes.Bytes buffer)
boolean	readDocument(long offset, net.openhft.chronicle.wire.ReadMarshallable buffer)
long	size()
protected net.openhft.chronicle.wire.Wire	wire()
Class<? extends net.openhft.chronicle.wire.Wire>	wireType()

Methods inherited from class java.lang.Object

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

Constructor Detail

IndexedSingleChronicleQueue

public IndexedSingleChronicleQueue(@NotNull
                                   String filename,
                                   long blockSize,
                                   @NotNull
                                   net.openhft.chronicle.wire.WireType wireType)
                            throws IOException

Throws:

IOException

Method Detail

name

public String name()

Returns:

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

createExcerpt

@NotNull
public Excerpt createExcerpt()
                               throws IOException

Description copied from interface: ChronicleQueue

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

Returns:

Excerpt

Throws:

IOException - if an IO problem occurs

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.

Returns:

ExcerptTailer

Throws:

IOException - if an IO problem occurs

createAppender

@NotNull
public ExcerptAppender createAppender()
                                        throws IOException

Description copied from interface: ChronicleQueue

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

Returns:

ExcerptAppender

Throws:

IOException - if an IO problem occurs

size

public long size()

Returns:

The current estimated number of entries.

clear

public void clear()

Description copied from interface: ChronicleQueue

Remove all the entries in the queue.

firstAvailableIndex

public long firstAvailableIndex()

Returns:

the lowest valid index available.

lastWrittenIndex

public long lastWrittenIndex()

Returns:

the highest valid index immediately available.

wire

protected net.openhft.chronicle.wire.Wire wire()

Specified by:

wire in class AbstractChronicle

wireType

public Class<? extends net.openhft.chronicle.wire.Wire> wireType()

Specified by:

wireType in class AbstractChronicle

indexToIndex

public long indexToIndex()

Specified by:

indexToIndex in class AbstractChronicle

Returns:

gets the index2index, or creates it, if it does not exist.

newIndex

public long newIndex()

Creates a new Excerpt containing and index which will be 1L << 17L bytes long, This method is used for creating both the primary and secondary indexes. Chronicle Queue uses a root primary index ( each entry in the primary index points to a unique a secondary index. The secondary index only records the address of every 64th except, the except are linearly scanned from there on.

Specified by:

newIndex in class AbstractChronicle

Returns:

the address of the Excerpt containing the usable index, just after the header

close

public void close()

appendDocument

public long appendDocument(@NotNull
                           net.openhft.chronicle.bytes.Bytes buffer)

readDocument

public boolean readDocument(long offset,
                            net.openhft.chronicle.wire.ReadMarshallable buffer)

readDocument

public boolean readDocument(@NotNull
                            AtomicLong offset,
                            @NotNull
                            net.openhft.chronicle.bytes.Bytes buffer)

bytes

@NotNull
public net.openhft.chronicle.bytes.Bytes bytes()

lastIndex

public long lastIndex()

index

public boolean index(long index,
                     @NotNull
                     net.openhft.chronicle.bytes.VanillaBytes bytes)

firstBytes

public long firstBytes()