net.openhft.chronicle.queue

Interface ExcerptAppender

All Superinterfaces:

ExcerptCommon<ExcerptAppender>, net.openhft.chronicle.wire.MarshallableOut

public interface ExcerptAppender
extends ExcerptCommon<ExcerptAppender>, net.openhft.chronicle.wire.MarshallableOut

The component that facilitates sequentially writing data to a ChronicleQueue.

Author:

peter.lawrey

Method Summary

Modifier and Type	Method and Description
int	cycle()
long	lastIndexAppended()
boolean	padToCacheAlign()
void	padToCacheAlign(boolean padToCacheAlign) Enable padding if near the end of a cache line, pad it so a following 4-byte int value will not split a cache line.
default void	pretouch() Asynchronous call to load a block before it needed to reduce latency.
void	writeBytes(net.openhft.chronicle.bytes.Bytes<?> bytes)
default void	writeBytes(long index, net.openhft.chronicle.bytes.BytesStore bytes) Write an entry at a given index.
void	writeEndOfCycleIfRequired() Write an EOF marker on the current cycle if it is about to roll.
default net.openhft.chronicle.wire.DocumentContext	writingDocument(long index) Write an entry at a given index.

Methods inherited from interface net.openhft.chronicle.queue.ExcerptCommon

lazyIndexing, lazyIndexing, queue, sourceId

Methods inherited from interface net.openhft.chronicle.wire.MarshallableOut

methodWriter, methodWriterBuilder, recordHistory, writeBytes, writeDocument, writeDocument, writeMap, writeMessage, writeText, writingDocument

Method Detail

writeBytes

void writeBytes(@NotNull
                net.openhft.chronicle.bytes.Bytes<?> bytes)
         throws net.openhft.chronicle.wire.UnrecoverableTimeoutException

Parameters:

bytes - to write to excerpt.

Throws:

net.openhft.chronicle.wire.UnrecoverableTimeoutException

writeBytes

default void writeBytes(long index,
                        net.openhft.chronicle.bytes.BytesStore bytes)
                 throws StreamCorruptedException

Write an entry at a given index. This can use used for rebuilding a queue, or replication.

Parameters:

index - to write the byte to or fail.

bytes - to write.

Throws:

StreamCorruptedException - the write failed is was unable to write the data at the given index.

writingDocument

default net.openhft.chronicle.wire.DocumentContext writingDocument(long index)

Write an entry at a given index. This can use used for rebuilding a queue, or replication.

Parameters:

index - to write the byte to or fail.

Returns:

DocumentContext to write to.

Throws:

StreamCorruptedException - the write failed is was unable to write the data at the given index.

lastIndexAppended

long lastIndexAppended()

Returns:

the index last written, this index includes the cycle and the sequence number

Throws:

IllegalStateException - if no index is available

cycle

int cycle()

Returns:

the cycle this tailer is on, usually with chronicle-queue each cycle will have its own unique data file to store the excerpt

pretouch

default void pretouch()

Asynchronous call to load a block before it needed to reduce latency.

padToCacheAlign

void padToCacheAlign(boolean padToCacheAlign)

Enable padding if near the end of a cache line, pad it so a following 4-byte int value will not split a cache line.

padToCacheAlign

boolean padToCacheAlign()

writeEndOfCycleIfRequired

void writeEndOfCycleIfRequired()

Write an EOF marker on the current cycle if it is about to roll. It would do this any way if a new message wis written, but this doesn't create a new cycle or add a message.