net.openhft.chronicle.queue.impl.single

Class SingleChronicleQueueExcerpts.StoreTailer

java.lang.Object

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

All Implemented Interfaces:

ExcerptCommon, ExcerptTailer

Enclosing class:

SingleChronicleQueueExcerpts

public static class SingleChronicleQueueExcerpts.StoreTailer
extends Object
implements ExcerptTailer

Tailer

Constructor Summary

Constructors

Constructor and Description
StoreTailer(SingleChronicleQueue queue)

Method Summary

Modifier and Type	Method and Description
long	cycle()
long	index()
boolean	moveToIndex(long index) Randomly select an Excerpt.
void	prefetch() Hint to the underlying store to get the next page(s)
RollingChronicleQueue	queue()
boolean	readBytes(net.openhft.chronicle.bytes.Bytes using)
boolean	readBytes(net.openhft.chronicle.bytes.ReadBytesMarshallable using)
boolean	readDocument(net.openhft.chronicle.wire.ReadMarshallable marshaller)
net.openhft.chronicle.wire.DocumentContext	readingDocument() equivalent to ExcerptTailer.readDocument(ReadMarshallable) but with out the use of a lambda expression.
ExcerptTailer	toEnd() Wind to the upper.
ExcerptTailer	toStart() Replay from the lower.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

StoreTailer

public StoreTailer(@NotNull
                   SingleChronicleQueue queue)

Method Detail

toString

public String toString()

Overrides:

toString in class Object

readDocument

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

Specified by:

readDocument in interface ExcerptTailer

Parameters:

marshaller - user to read the document

Returns:

true if successful

readBytes

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

Specified by:

readBytes in interface ExcerptTailer

Parameters:

using - used to read the document

Returns:

true if successful

readingDocument

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

Description copied from interface: ExcerptTailer

equivalent to ExcerptTailer.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 ExcerptTailer

Returns:

the document context

readBytes

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

Specified by:

readBytes in interface ExcerptTailer

Parameters:

using - used to read the document

Returns:

true if successful

index

public long index()

Specified by:

index in interface ExcerptTailer

Returns:

provides an index that includes the cycle number

cycle

public long cycle()

Specified by:

cycle in interface ExcerptTailer

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

public boolean moveToIndex(long index)

Description copied from interface: ExcerptTailer

Randomly select an Excerpt.

Specified by:

moveToIndex in interface ExcerptTailer

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
public final ExcerptTailer toStart()

Description copied from interface: ExcerptTailer

Replay from the lower.

Specified by:

toStart in interface ExcerptTailer

Returns:

this Excerpt

toEnd

@NotNull
public ExcerptTailer toEnd()

Description copied from interface: ExcerptTailer

Wind to the upper.

Specified by:

toEnd in interface ExcerptTailer

Returns:

this Excerpt

prefetch

public void prefetch()

Description copied from interface: ExcerptCommon

Hint to the underlying store to get the next page(s)

Specified by:

prefetch in interface ExcerptCommon

queue

public RollingChronicleQueue queue()