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.

NOTE: Appenders are NOT thread-safe, sharing the Appender between threads will lead to errors and unpredictable behaviour.

Author:

peter.lawrey

Nested Class Summary

Nested classes/interfaces inherited from interface net.openhft.chronicle.wire.MarshallableOut

net.openhft.chronicle.wire.MarshallableOut.Padding

Method Summary

Modifier and Type	Method and Description
int	cycle()
default Runnable	getCloserJob() A task that will be run if a WeakReference referring this appender is registered with a clean-up task.
long	lastIndexAppended()
default <T> T	methodWriter(Class<T> tClass, Class... additional)
default <T> net.openhft.chronicle.wire.VanillaMethodWriterBuilder<T>	methodWriterBuilder(Class<T> tClass)
void	padToCacheAlign(net.openhft.chronicle.wire.MarshallableOut.Padding 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.
net.openhft.chronicle.wire.MarshallableOut.Padding	padToCacheAlignMode()
default void	pretouch() We suggest this code is called from a background thread [ not you main business thread ], it must be called from the same thread that created it, as the call to pretouch() is not thread safe.
net.openhft.chronicle.wire.Wire	wire() Obtain the raw wire for low level direct access.
default void	writeBytes(net.openhft.chronicle.bytes.Bytes bytes)
void	writeBytes(net.openhft.chronicle.bytes.BytesStore bytes)
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

queue, sourceId

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

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

Method Detail

writeBytes

void writeBytes(@NotNull
                net.openhft.chronicle.bytes.BytesStore bytes)
         throws net.openhft.chronicle.wire.UnrecoverableTimeoutException

Parameters:

bytes - to write to excerpt.

Throws:

net.openhft.chronicle.wire.UnrecoverableTimeoutException

writeBytes

default void writeBytes(@NotNull
                        net.openhft.chronicle.bytes.Bytes bytes)
                 throws net.openhft.chronicle.wire.UnrecoverableTimeoutException

Throws:

net.openhft.chronicle.wire.UnrecoverableTimeoutException

writingDocument

@NotNull
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.

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()

We suggest this code is called from a background thread [ not you main business thread ], it must be called from the same thread that created it, as the call to pretouch() is not thread safe. For example :

newSingleThreadScheduledExecutor().scheduleAtFixedRate(() -> queue.acquireAppender().pretouch(), 0, 1, TimeUnit.SECONDS);

padToCacheAlign

void padToCacheAlign(net.openhft.chronicle.wire.MarshallableOut.Padding 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.

padToCacheAlignMode

@NotNull
net.openhft.chronicle.wire.MarshallableOut.Padding padToCacheAlignMode()

Specified by:

padToCacheAlignMode in interface net.openhft.chronicle.wire.MarshallableOut

getCloserJob

default Runnable getCloserJob()

A task that will be run if a WeakReference referring this appender is registered with a clean-up task.

Returns:

Task to release any associated resources

methodWriter

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

Specified by:

methodWriter in interface net.openhft.chronicle.wire.MarshallableOut

methodWriterBuilder

@NotNull
default <T> net.openhft.chronicle.wire.VanillaMethodWriterBuilder<T> methodWriterBuilder(@NotNull
                                                                                                  Class<T> tClass)

Specified by:

methodWriterBuilder in interface net.openhft.chronicle.wire.MarshallableOut

wire

net.openhft.chronicle.wire.Wire wire()

Obtain the raw wire for low level direct access.

Returns:

the raw wire.