net.openhft.chronicle.queue

Interface ExcerptTailer

All Superinterfaces:

ExcerptCommon

All Known Subinterfaces:

Excerpt

All Known Implementing Classes:

SingleTailer

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	index(long index) Randomly select an Excerpt.
boolean	index(long cycle, long index) Randomly select an Excerpt.
boolean	readDocument(net.openhft.chronicle.wire.ReadMarshallable reader)
ExcerptTailer	toEnd() Wind to the upper.
ExcerptTailer	toStart() Replay from the lower.

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

queue

Method Detail

readDocument

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

Parameters:

reader - user to read the document

Returns:

true if successful

Throws:

IOException - if not able to read the chronicle file

index

long index()

Returns:

the index just read

cycle

long cycle()

Returns:

the cycle this tailer is on

index

boolean index(long index)
       throws IOException

Randomly select an Excerpt.

Parameters:

index - index to look up

Returns:

true if this is a valid entries.

Throws:

IOException - if not able to read the chronicle file

index

boolean index(long cycle,
              long index)
       throws IOException

Randomly select an Excerpt.

Parameters:

cycle - cycle

index - index to look up

Returns:

true if this is a valid entries.

Throws:

IOException - if not able to read the chronicle file

toStart

@NotNull
ExcerptTailer toStart()
                        throws IOException

Replay from the lower.

Returns:

this Excerpt

Throws:

IOException - if not able to read the chronicle file

toEnd

@NotNull
ExcerptTailer toEnd()
                      throws IOException

Wind to the upper.

Returns:

this Excerpt

Throws:

IOException - if not able to read the chronicle file