net.openhft.chronicle.queue.impl.single

Class SingleChronicleQueueExcerpts.StoreTailer

java.lang.Object

net.openhft.chronicle.wire.ReadDocumentContext

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

All Implemented Interfaces:

Closeable, AutoCloseable, ExcerptCommon, ExcerptTailer, net.openhft.chronicle.wire.DocumentContext

Enclosing class:

SingleChronicleQueueExcerpts

public static class SingleChronicleQueueExcerpts.StoreTailer
extends net.openhft.chronicle.wire.ReadDocumentContext
implements ExcerptTailer

Tailer

Field Summary

Fields inherited from class net.openhft.chronicle.wire.ReadDocumentContext

present, wire

Constructor Summary

Constructors

Constructor and Description
StoreTailer(SingleChronicleQueue queue)

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
void	close()
int	cycle()
TailerDirection	direction()
ExcerptTailer	direction(TailerDirection direction) Set the direction of movement.
long	index()
long	lastIndex(int cycle)
boolean	moveToIndex(long index) Randomly select an Excerpt.
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(boolean includeMetaData)
String	readText() Read the next message as a String
boolean	readText(StringBuilder sb) Read the next message as string
int	sourceId()
ExcerptTailer	toEnd() Wind to the last entry int eh last entry
ExcerptTailer	toStart() Replay from the first entry in the first cycle.
String	toString()

Methods inherited from class net.openhft.chronicle.wire.ReadDocumentContext

closeReadLimit, closeReadPosition, isMetaData, isPresent, metaData, start, wire

Methods inherited from class java.lang.Object

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

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

methodReader, readingDocument, readMap

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

isData

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

closeQuietly, notifyClosing

Constructor Detail

StoreTailer

public StoreTailer(@NotNull
                   SingleChronicleQueue queue)

Method Detail

sourceId

public int sourceId()

Specified by:

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

Overrides:

sourceId in class net.openhft.chronicle.wire.ReadDocumentContext

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(boolean includeMetaData)

Specified by:

readingDocument in interface ExcerptTailer

readText

public String readText()

Description copied from interface: ExcerptTailer

Read the next message as a String

Specified by:

readText in interface ExcerptTailer

Returns:

the String or null if there is none.

readText

@Nullable
public boolean readText(StringBuilder sb)

Description copied from interface: ExcerptTailer

Read the next message as string

Specified by:

readText in interface ExcerptTailer

Parameters:

sb - to copy the text into

Returns:

true if there was a message, or false if not.

close

public void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class net.openhft.chronicle.wire.ReadDocumentContext

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

Specified by:

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

Overrides:

index in class net.openhft.chronicle.wire.ReadDocumentContext

Returns:

provides an index that includes the cycle number

cycle

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

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.

Throws:

TimeoutException

toStart

@NotNull
public final ExcerptTailer toStart()

Description copied from interface: ExcerptTailer

Replay from the first entry in the first cycle.

Specified by:

toStart in interface ExcerptTailer

Returns:

this Excerpt

toEnd

@NotNull
public ExcerptTailer toEnd()

Description copied from interface: ExcerptTailer

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.

Specified by:

toEnd in interface ExcerptTailer

Returns:

this Excerpt

direction

public TailerDirection direction()

Specified by:

direction in interface ExcerptTailer

Returns:

the direction of movement after reading an entry.

direction

public ExcerptTailer direction(TailerDirection direction)

Description copied from interface: ExcerptTailer

Set the direction of movement.

Specified by:

direction in interface ExcerptTailer

Parameters:

direction - NONE, FORWARD, BACKWARD

Returns:

this

queue

public RollingChronicleQueue queue()

lastIndex

public long lastIndex(int cycle)

afterLastWritten

public ExcerptTailer afterLastWritten(ChronicleQueue queue)

Description copied from interface: ExcerptTailer

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

Specified by:

afterLastWritten in interface ExcerptTailer

Parameters:

queue - which was written to.

Returns:

this ExcerptTailer