net.openhft.chronicle.queue.impl.single

Class SingleChronicleQueueExcerpts.StoreAppender

java.lang.Object

net.openhft.chronicle.queue.impl.single.SingleChronicleQueueExcerpts.StoreAppender

All Implemented Interfaces:

Closeable, AutoCloseable, ExcerptAppender, ExcerptCommon, net.openhft.chronicle.wire.DocumentContext, net.openhft.chronicle.wire.MarshallableOut

Enclosing class:

SingleChronicleQueueExcerpts

public static class SingleChronicleQueueExcerpts.StoreAppender
extends Object
implements ExcerptAppender, net.openhft.chronicle.wire.DocumentContext

StoreAppender

Constructor Summary

Constructors

Constructor and Description
StoreAppender(SingleChronicleQueue queue)

Method Summary

Modifier and Type	Method and Description
void	close()
int	cycle()
long	index()
boolean	isMetaData()
boolean	isNotComplete()
boolean	isPresent()
long	lastIndexAppended()
void	metaData(boolean metaData)
SingleChronicleQueue	queue()
boolean	recordHistory()
int	sourceId()
net.openhft.chronicle.wire.Wire	wire()
void	writeBytes(net.openhft.chronicle.bytes.Bytes bytes)
void	writeBytes(long index, net.openhft.chronicle.bytes.Bytes<?> bytes) Write an entry at a given index.
net.openhft.chronicle.wire.DocumentContext	writingDocument()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

methodWriter, methodWriterBuilder, writeBytes, writeDocument, writeDocument, writeMap, writeMessage, writeText

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

closeQuietly, isClosed, notifyClosing

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

isData

Constructor Detail

StoreAppender

public StoreAppender(@NotNull
                     SingleChronicleQueue queue)

Method Detail

recordHistory

public boolean recordHistory()

Specified by:

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

sourceId

public int sourceId()

Specified by:

sourceId in interface ExcerptCommon

Specified by:

sourceId in interface net.openhft.chronicle.wire.DocumentContext

Returns:

the sourceId for the queue which created this.

index

public long index()

Specified by:

index in interface net.openhft.chronicle.wire.DocumentContext

isNotComplete

public boolean isNotComplete()

Specified by:

isNotComplete in interface net.openhft.chronicle.wire.DocumentContext

isPresent

public boolean isPresent()

Specified by:

isPresent in interface net.openhft.chronicle.wire.DocumentContext

wire

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

Specified by:

wire in interface net.openhft.chronicle.wire.DocumentContext

writingDocument

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

Specified by:

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

isMetaData

public boolean isMetaData()

Specified by:

isMetaData in interface net.openhft.chronicle.wire.DocumentContext

metaData

public void metaData(boolean metaData)

Specified by:

metaData in interface net.openhft.chronicle.wire.DocumentContext

close

public void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

writeBytes

public void writeBytes(@NotNull
                       net.openhft.chronicle.bytes.Bytes bytes)

Specified by:

writeBytes in interface ExcerptAppender

Parameters:

bytes - to write to excerpt.

writeBytes

public void writeBytes(long index,
                       net.openhft.chronicle.bytes.Bytes<?> bytes)
                throws StreamCorruptedException

Description copied from interface: ExcerptAppender

Write an entry at a given index. This can use used for rebuilding a queue, or replication.

Specified by:

writeBytes in interface ExcerptAppender

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

public long lastIndexAppended()

Specified by:

lastIndexAppended in interface ExcerptAppender

Returns:

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

cycle

public int cycle()

Specified by:

cycle in interface ExcerptAppender

Returns:

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

queue

public SingleChronicleQueue queue()