net.openhft.chronicle

Class VanillaChronicle

java.lang.Object

net.openhft.chronicle.VanillaChronicle

All Implemented Interfaces:

Closeable, AutoCloseable, Chronicle

public class VanillaChronicle
extends Object
implements Chronicle

Created by peter

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	VanillaChronicle.Cycle
static interface	VanillaChronicle.VanillaAppender
static interface	VanillaChronicle.VanillaExcerptCommon
static interface	VanillaChronicle.VanillaTailer

Field Summary

Fields

Modifier and Type	Field and Description
static int	INDEX_DATA_OFFSET_BITS Number of least-significant bits used to hold the data offset info in index entries.
static long	INDEX_DATA_OFFSET_MASK Mask used to extract the data offset info from an index entry.
static long	MIN_CYCLE_LENGTH
static int	THREAD_ID_BITS Number of most-significant bits used to hold the thread id in index entries.
static long	THREAD_ID_MASK Mask used to validate that the thread id does not exceed the allocated number of bits.

Method Summary

Modifier and Type	Method and Description
void	checkCounts(int min, int max)
void	clear()
void	close()
VanillaChronicle.VanillaAppender	createAppender()
Excerpt	createExcerpt()
ExcerptTailer	createTailer()
int	getEntriesForCycleBits()
boolean	isClosed()
long	lastIndex() This method returns the very last index in the chronicle.
long	lastWrittenIndex()
String	name()
long	size()

Methods inherited from class java.lang.Object

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

Field Detail

MIN_CYCLE_LENGTH

public static final long MIN_CYCLE_LENGTH

THREAD_ID_BITS

public static final int THREAD_ID_BITS

Number of most-significant bits used to hold the thread id in index entries. The remaining least-significant bits of the index entry are used for the data offset info.

THREAD_ID_MASK

public static final long THREAD_ID_MASK

Mask used to validate that the thread id does not exceed the allocated number of bits.

INDEX_DATA_OFFSET_BITS

public static final int INDEX_DATA_OFFSET_BITS

Number of least-significant bits used to hold the data offset info in index entries.

INDEX_DATA_OFFSET_MASK

public static final long INDEX_DATA_OFFSET_MASK

Mask used to extract the data offset info from an index entry.

Method Detail

isClosed

public boolean isClosed()

Specified by:

isClosed in interface Chronicle

name

public String name()

Specified by:

name in interface Chronicle

getEntriesForCycleBits

public int getEntriesForCycleBits()

createTailer

@NotNull
public ExcerptTailer createTailer()
                                    throws IOException

Specified by:

createTailer in interface Chronicle

Throws:

IOException

createAppender

@NotNull
public VanillaChronicle.VanillaAppender createAppender()
                                                         throws IOException

Specified by:

createAppender in interface Chronicle

Throws:

IOException

createExcerpt

@NotNull
public Excerpt createExcerpt()
                               throws IOException

Specified by:

createExcerpt in interface Chronicle

Throws:

IOException

lastWrittenIndex

public long lastWrittenIndex()

Specified by:

lastWrittenIndex in interface Chronicle

lastIndex

public long lastIndex()

This method returns the very last index in the chronicle. Not to be confused with lastWrittenIndex(), this method returns the actual last index by scanning the underlying data even the appender has not been activated.

Specified by:

lastIndex in interface Chronicle

Returns:

The last index in the file

size

public long size()

Specified by:

size in interface Chronicle

close

public void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

clear

public void clear()

Specified by:

clear in interface Chronicle

checkCounts

public void checkCounts(int min,
                        int max)