net.openhft.chronicle.queue

Interface ExcerptTailer

All Superinterfaces:

ExcerptCommon

All Known Subinterfaces:

Excerpt

All Known Implementing Classes:

SingleChronicleQueueExcerpts.StoreTailer

public interface ExcerptTailer
extends ExcerptCommon

The component that facilitates sequentially reading data from a ChronicleQueue.

Author:

peter.lawrey

Method Summary

Modifier and Type	Method and Description
long	cycle()
long	index()
boolean	moveToIndex(long index) Randomly select an Excerpt.
boolean	readBytes(net.openhft.chronicle.bytes.Bytes using)
boolean	readBytes(net.openhft.chronicle.bytes.ReadBytesMarshallable marshallable)
boolean	readDocument(net.openhft.chronicle.wire.ReadMarshallable reader)
net.openhft.chronicle.wire.DocumentContext	readingDocument() equivalent to readDocument(ReadMarshallable) but with out the use of a lambda expression.
ExcerptTailer	toEnd() Wind to the upper.
ExcerptTailer	toStart() Replay from the lower.

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

prefetch

Method Detail

readDocument

boolean readDocument(@NotNull
                     net.openhft.chronicle.wire.ReadMarshallable reader)

Parameters:

reader - user to read the document

Returns:

true if successful

readBytes

boolean readBytes(@NotNull
                  net.openhft.chronicle.bytes.ReadBytesMarshallable marshallable)

Parameters:

marshallable - used to read the document

Returns:

true if successful

readBytes

boolean readBytes(@NotNull
                  net.openhft.chronicle.bytes.Bytes using)

Parameters:

using - used to read the document

Returns:

true if successful

readingDocument

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

equivalent to readDocument(ReadMarshallable) but with out the use of a lambda expression. This method is the ExcerptTailer equivalent of WireIn.readingDocument()

Returns:

the document context

index

long index()

Returns:

the index just read , this include the cycle and the sequence number from with this cycle

cycle

long cycle()

Returns:

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

moveToIndex

boolean moveToIndex(long index)

Randomly select an Excerpt.

Parameters:

index - index to look up, the index includes the cycle number and a sequence number from with this cycle

Returns:

true if this is a valid entries.

toStart

@NotNull
ExcerptTailer toStart()

Replay from the lower.

Returns:

this Excerpt

toEnd

@NotNull
ExcerptTailer toEnd()

Wind to the upper.

Returns:

this Excerpt