net.openhft.chronicle.queue.impl.single

Interface InternalAppender

All Superinterfaces:

AutoCloseable, Closeable, net.openhft.chronicle.wire.DocumentWritten, ExcerptAppender, ExcerptCommon<ExcerptAppender>, net.openhft.chronicle.wire.MarshallableOut, net.openhft.chronicle.core.io.QueryCloseable, net.openhft.chronicle.wire.RollbackIfNotCompleteNotifier, net.openhft.chronicle.core.io.SingleThreadedChecked

public interface InternalAppender
extends ExcerptAppender

please don't use this interface as it's an internal implementation.

Field Summary

Fields inherited from interface net.openhft.chronicle.core.io.SingleThreadedChecked

DISABLE_SINGLE_THREADED_CHECK

Method Summary

Modifier and Type	Method and Description
void	unsafeWriteBytes(long index, net.openhft.chronicle.bytes.BytesStore bytes) Deprecated. Use writeBytes(long, BytesStore) instead
void	writeBytes(long index, net.openhft.chronicle.bytes.BytesStore bytes) Append an excerpt at the specified index, if the index is a valid next index for the queue.

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

cycle, lastIndexAppended, methodWriter, methodWriterBuilder, normaliseEOFs, pretouch, wire, writeBytes, writeBytes

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

currentFile, queue, sourceId, sync

Methods inherited from interface net.openhft.chronicle.core.io.Closeable

close, closeQuietly, closeQuietly

Methods inherited from interface net.openhft.chronicle.core.io.QueryCloseable

isClosed, isClosing

Methods inherited from interface net.openhft.chronicle.core.io.SingleThreadedChecked

singleThreadedCheckDisabled, singleThreadedCheckReset

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

acquireWritingDocument, builder, methodWriterBuilder, recordHistory, writeBytes, writeDocument, writeDocument, writeMap, writeMessage, writeMessage, writeText, writingDocument, writingDocument

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

rollbackIfNotComplete, writingIsComplete

Method Detail

writeBytes

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

Append an excerpt at the specified index, if the index is a valid next index for the queue.

If the index is:

Greater than the next valid indices for the queue

An IllegalIndexException is thrown

Less than or equal to the last index in the queue

The method returns without modifying the queue

Parameters:

index - index the index to append at

bytes - bytes the contents of the excerpt to write

Throws:

IllegalIndexException - if the index specified is larger than the valid next indices of the queue

unsafeWriteBytes

@Deprecated
void unsafeWriteBytes(long index,
                                  net.openhft.chronicle.bytes.BytesStore bytes)

Deprecated. Use writeBytes(long, BytesStore) instead

Append an excerpt at the specified index, if the index is a valid next index for the queue.

If the index is:

Greater than the next valid indices for the queue

An IllegalIndexException is thrown

Less than or equal to the last index in the queue

The method returns without modifying the queue

Note: This form of the method will do a faster, less reliable check to confirm the index specified is a valid next index for the state of the queue. This should only be used when we know that there have been no partial writes to the queue previously.

Parameters:

index - index the index to append at

bytes - bytes the contents of the excerpt to write

Throws:

IllegalIndexException - if the index specified is larger than the valid next indices of the queue