net.openhft.chronicle

Interface ExcerptAppender

All Superinterfaces:

Appendable, AutoCloseable, net.openhft.lang.io.Bytes, net.openhft.lang.io.BytesCommon, net.openhft.lang.io.serialization.BytesMarshallable, net.openhft.lang.io.ByteStringAppender, net.openhft.lang.io.ByteStringParser, CharSequence, DataInput, DataOutput, ExcerptCommon, ObjectInput, ObjectOutput, RandomAccess, net.openhft.lang.io.RandomDataInput, net.openhft.lang.io.RandomDataOutput, net.openhft.lang.io.RandomDataUpdate

All Known Implementing Classes:

NativeExcerptAppender, WrappedExcerpt

public interface ExcerptAppender
extends ExcerptCommon

Author:

peter.lawrey

Method Summary

Methods

Modifier and Type	Method and Description
void	addPaddedEntry() Add a padded entry to keep the index in sync with a master source.
boolean	nextSynchronous() The default value is ChronicleConfig.synchronousMode()
void	nextSynchronous(boolean nextSynchronous)
void	startExcerpt() Start an excerpt with the default message capacity of 128K (can be configured) This can waste up to 0.1% of disk space, unless you have sparse file support like Linux, when you will waste far less.
void	startExcerpt(long capacity) Ensure there is enough capacity for a new entry of up to the size given.
ExcerptAppender	toEnd() Skip to the last index.

Methods inherited from interface net.openhft.chronicle.ExcerptCommon

chronicle, finish, index, lastWrittenIndex, size, wasPadding

Methods inherited from interface net.openhft.lang.io.RandomDataInput

available, close, read, read, read, read, readBoolean, readBoolean, readByte, readByte, readChar, readChar, readCompactDouble, readCompactInt, readCompactLong, readCompactShort, readCompactUnsignedInt, readCompactUnsignedShort, readDouble, readDouble, readEnum, readFloat, readFloat, readFully, readFully, readInt, readInt, readInt24, readInt24, readInt48, readInt48, readLine, readList, readLong, readLong, readMap, readObject, readObject, readObject, readShort, readShort, readStopBit, readUnsignedByte, readUnsignedByte, readUnsignedInt, readUnsignedInt, readUnsignedShort, readUnsignedShort, readUTF, readUTFΔ, readUTFΔ, readUTFΔ, readVolatileDouble, readVolatileFloat, readVolatileInt, readVolatileInt, readVolatileLong, readVolatileLong, skip, skipBytes

Methods inherited from interface net.openhft.lang.io.RandomDataOutput

addAndGetInt, close, compareAndSwapInt, compareAndSwapLong, flush, getAndAdd, write, write, write, write, write, writeBoolean, writeBoolean, writeByte, writeByte, writeBytes, writeChar, writeChar, writeChars, writeCompactDouble, writeCompactInt, writeCompactLong, writeCompactShort, writeCompactUnsignedInt, writeCompactUnsignedShort, writeDouble, writeDouble, writeEnum, writeFloat, writeFloat, writeInt, writeInt, writeInt24, writeInt24, writeInt48, writeInt48, writeList, writeLong, writeLong, writeMap, writeObject, writeObject, writeOrderedDouble, writeOrderedFloat, writeOrderedInt, writeOrderedInt, writeOrderedLong, writeOrderedLong, writeShort, writeShort, writeStartToPosition, writeStopBit, writeUnsignedByte, writeUnsignedByte, writeUnsignedInt, writeUnsignedInt, writeUnsignedShort, writeUnsignedShort, writeUTF, writeUTFΔ, writeUTFΔ

Methods inherited from interface net.openhft.lang.io.RandomDataUpdate

addAtomicDouble, addAtomicFloat, addAtomicInt, addAtomicLong, addByte, addDouble, addFloat, addInt, addLong, addShort, addUnsignedByte, addUnsignedInt, addUnsignedShort, busyLockInt, busyLockLong, tryLockInt, tryLockLong, tryLockNanosInt, tryLockNanosLong, unlockInt, unlockLong

Methods inherited from interface net.openhft.lang.io.ByteStringAppender

append, append, append, append, append, append, append, append, append, append, append, append, appendDateMillis, appendDateTimeMillis, appendTimeMillis

Methods inherited from interface net.openhft.lang.io.ByteStringParser

parseBoolean, parseDecimal, parseDouble, parseEnum, parseLong, parseLong, parseUTF, parseUTF, skipTo, stepBackAndSkipTo

Methods inherited from interface net.openhft.lang.io.BytesCommon

byteOrder, bytesMarshallerFactory, capacity, checkEndOfBuffer, inputStream, isFinished, outputStream, position, position, remaining, reset, write

Methods inherited from interface java.lang.CharSequence

charAt, length, subSequence, toString

Methods inherited from interface net.openhft.lang.io.serialization.BytesMarshallable

readMarshallable, writeMarshallable

Method Detail

startExcerpt

void startExcerpt()

Start an excerpt with the default message capacity of 128K (can be configured) This can waste up to 0.1% of disk space, unless you have sparse file support like Linux, when you will waste far less.

startExcerpt

void startExcerpt(long capacity)

Ensure there is enough capacity for a new entry of up to the size given. If there is not enough space left in the chunk of memory mapped file, a padded entry is added and a new entry at the start of a new chunk is commenced. The capacity can be more than you need as finish() will shrink wrap the entry. It is onl a waste if you trigger a padded entry when none was required.

Parameters:

capacity - to allow for, but not exceed.

toEnd

@NotNull
ExcerptAppender toEnd()

Skip to the last index.

Specified by:

toEnd in interface ExcerptCommon

Returns:

this Excerpt

addPaddedEntry

void addPaddedEntry()

Add a padded entry to keep the index in sync with a master source.

nextSynchronous

boolean nextSynchronous()

The default value is ChronicleConfig.synchronousMode()

Returns:

will the next write be synchronous

nextSynchronous

void nextSynchronous(boolean nextSynchronous)

Parameters:

nextSynchronous - make the next write synchronous or not.