net.openhft.chronicle.queue

Interface ExcerptAppender

All Superinterfaces:

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

All Known Implementing Classes:

SingleChronicleQueueExcerpts.StoreAppender

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()
void	writeBytes(net.openhft.chronicle.bytes.Bytes<?> bytes)
default void	writeBytes(long index, net.openhft.chronicle.bytes.Bytes<?> bytes) Write an entry at a given index.

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

lazyIndexing, lazyIndexing, 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.Bytes<?> 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.

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