net.openhft.chronicle.queue

Interface ExcerptAppender

All Superinterfaces:

ExcerptCommon

All Known Implementing Classes:

SingleChronicleQueueExcerpts.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
int	cycle()
long	lastIndexAppended()
default <T> T	methodWriter(Class<T> tClass, Class... additional) Proxy an interface so each message called is written to a file for replay.
default <T> MethodWriterBuilder<T>	methodWriterBuilder(Class<T> tClass)
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.
void	writeBytes(net.openhft.chronicle.bytes.WriteBytesMarshallable marshallable)
void	writeDocument(net.openhft.chronicle.wire.WriteMarshallable writer)
default void	writeMap(Map<String,?> map) Write a Map as a marshallable
default void	writeText(CharSequence text)
net.openhft.chronicle.wire.DocumentContext	writingDocument() Start a document which is completed when DocumentContext.close() is called.

Method Detail

writingDocument

net.openhft.chronicle.wire.DocumentContext writingDocument()

Start a document which is completed when DocumentContext.close() is called. You can use a

 try(DocumentContext context = appender.writingDocument()) {
      context.wire().write("message").text("Hello World");
 }
 

Returns:

the DocumentContext

writeDocument

void writeDocument(@NotNull
                   net.openhft.chronicle.wire.WriteMarshallable writer)

Parameters:

writer - to write to excerpt.

writeBytes

void writeBytes(@NotNull
                net.openhft.chronicle.bytes.WriteBytesMarshallable marshallable)

Parameters:

marshallable - to write to excerpt.

writeBytes

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

Parameters:

bytes - to write to excerpt.

writeText

default void writeText(CharSequence text)

Parameters:

text - to write a message

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

methodWriter

default <T> T methodWriter(Class<T> tClass,
                           Class... additional)

Proxy an interface so each message called is written to a file for replay.

Parameters:

tClass - primary interface

additional - any additional interfaces

Returns:

a proxy which implements the primary interface (additional interfaces have to be cast)

methodWriterBuilder

default <T> MethodWriterBuilder<T> methodWriterBuilder(Class<T> tClass)

writeMap

default void writeMap(Map<String,?> map)

Write a Map as a marshallable