net.openhft.chronicle.queue

Interface ExcerptTailer

All Superinterfaces:

ExcerptCommon, net.openhft.chronicle.wire.MarshallableIn, net.openhft.chronicle.wire.SourceContext

All Known Subinterfaces:

Excerpt

All Known Implementing Classes:

SingleChronicleQueueExcerpts.StoreTailer

public interface ExcerptTailer
extends ExcerptCommon, net.openhft.chronicle.wire.MarshallableIn, net.openhft.chronicle.wire.SourceContext

The component that facilitates sequentially reading data from a ChronicleQueue.

Author:

peter.lawrey

Method Summary

Modifier and Type	Method and Description
ExcerptTailer	afterLastWritten(ChronicleQueue queue) Wind this tailer to after the last entry which wrote an entry to the queue
int	cycle()
TailerDirection	direction()
ExcerptTailer	direction(TailerDirection direction) Set the direction of movement.
long	index()
boolean	moveToIndex(long index) Randomly select an Excerpt.
default net.openhft.chronicle.wire.DocumentContext	readingDocument() equivalent to MarshallableIn.readDocument(ReadMarshallable) but with out the use of a lambda expression.
net.openhft.chronicle.wire.DocumentContext	readingDocument(boolean includeMetaData)
ExcerptTailer	toEnd() Wind to the last entry int eh last entry
ExcerptTailer	toStart() Replay from the first entry in the first cycle.

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

sourceId

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

methodReader, readBytes, readBytes, readDocument, readMap, readText, readText

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

sourceId

Method Detail

readingDocument

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

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

Specified by:

readingDocument in interface net.openhft.chronicle.wire.MarshallableIn

Returns:

the document context

readingDocument

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

index

long index()

Specified by:

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

Returns:

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

cycle

int 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)
             throws TimeoutException

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.

Throws:

TimeoutException

toStart

@NotNull
ExcerptTailer toStart()

Replay from the first entry in the first cycle.

Returns:

this Excerpt

toEnd

@NotNull
ExcerptTailer toEnd()

Wind to the last entry int eh last entry

If the direction() == FORWARD, this will be 1 more than the last entry.
Otherwise the index will be the last entry.

Returns:

this Excerpt

direction

TailerDirection direction()

Returns:

the direction of movement after reading an entry.

direction

ExcerptTailer direction(TailerDirection direction)

Set the direction of movement.

Parameters:

direction - NONE, FORWARD, BACKWARD

Returns:

this

afterLastWritten

ExcerptTailer afterLastWritten(ChronicleQueue queue)
                        throws net.openhft.chronicle.core.io.IORuntimeException

Wind this tailer to after the last entry which wrote an entry to the queue

Parameters:

queue - which was written to.

Returns:

this ExcerptTailer

Throws:

net.openhft.chronicle.core.io.IORuntimeException - if the queue couldn't be wound to the last index.