net.openhft.chronicle.queue

Interface ExcerptAppender

All Superinterfaces:

ExcerptCommon

All Known Implementing Classes:

Excerpts.BufferedAppender, Excerpts.DefaultAppender, Excerpts.StoreAppender

public interface ExcerptAppender
extends ExcerptCommon

The component that facilitates sequentially writing data to a ChronicleQueue.

Author:

peter.lawrey

Method Summary

Modifier and Type	Method and Description
long	cycle()
long	index()
long	writeBytes(net.openhft.chronicle.bytes.Bytes<?> bytes)
long	writeBytes(net.openhft.chronicle.bytes.WriteBytesMarshallable marshallable)
long	writeDocument(net.openhft.chronicle.wire.WriteMarshallable writer)

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

prefetch, queue

Method Detail

writeDocument

long writeDocument(@NotNull
                   net.openhft.chronicle.wire.WriteMarshallable writer)
            throws IOException

Parameters:

writer - to write to excerpt.

Returns:

the index last written or -1 if a buffered appender is being used

Throws:

IOException

writeBytes

long writeBytes(@NotNull
                net.openhft.chronicle.bytes.WriteBytesMarshallable marshallable)
         throws IOException

Parameters:

marshallable - to write to excerpt.

Returns:

the index last written or -1 if a buffered appender is being used

Throws:

IOException

writeBytes

long writeBytes(@NotNull
                net.openhft.chronicle.bytes.Bytes<?> bytes)
         throws IOException

Parameters:

bytes - to write to excerpt.

Returns:

the index last written -1 if a buffered appender is being used

Throws:

IOException

index

long index()

Returns:

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

Throws:

IllegalStateException - if no index is available

cycle

long cycle()

Returns:

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