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>, ExcerptTailer, ExcerptContext, net.openhft.chronicle.wire.MarshallableIn, net.openhft.chronicle.wire.SourceContext

Enclosing class:

SingleChronicleQueueExcerpts

public static class SingleChronicleQueueExcerpts.StoreTailer
extends Object
implements ExcerptTailer, net.openhft.chronicle.wire.SourceContext, ExcerptContext

Tailer

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
int	cycle()
TailerDirection	direction()
ExcerptTailer	direction(TailerDirection direction) Set the direction of movement.
long	index()
void	lastAcknowledgedIndexReplicated(long acknowledgeIndex)
boolean	lazyIndexing()
ExcerptTailer	lazyIndexing(boolean lazyIndexing)
boolean	moveToIndex(long index) Randomly select an Excerpt.
RollingChronicleQueue	queue()
boolean	readAfterReplicaAcknowledged()
void	readAfterReplicaAcknowledged(boolean readAfterReplicaAcknowledged)
net.openhft.chronicle.wire.DocumentContext	readingDocument(boolean includeMetaData)
int	sourceId()
TailerState	state()
long	timeoutMS()
ExcerptTailer	toEnd() Wind to the last entry int eh last entry
ExcerptTailer	toStart() Replay from the first entry in the first cycle.
String	toString()
net.openhft.chronicle.wire.Wire	wire()
net.openhft.chronicle.wire.Wire	wireForIndex()

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

readingDocument

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

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

Methods inherited from interface net.openhft.chronicle.queue.impl.ExcerptContext

pauserReset

Constructor Detail

StoreTailer

public StoreTailer(@NotNull
                   SingleChronicleQueue queue)

Method Detail

wire

public net.openhft.chronicle.wire.Wire wire()

Specified by:

wire in interface ExcerptContext

wireForIndex

public net.openhft.chronicle.wire.Wire wireForIndex()

Specified by:

wireForIndex in interface ExcerptContext

timeoutMS

public long timeoutMS()

Specified by:

timeoutMS in interface ExcerptContext

lazyIndexing

public ExcerptTailer lazyIndexing(boolean lazyIndexing)

Specified by:

lazyIndexing in interface ExcerptCommon<ExcerptTailer>

lazyIndexing

public boolean lazyIndexing()

Specified by:

lazyIndexing in interface ExcerptCommon<ExcerptTailer>

sourceId

public int sourceId()

Specified by:

sourceId in interface ExcerptCommon<ExcerptTailer>

Specified by:

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

Returns:

the sourceId for the queue which created this.

toString

public String toString()

Overrides:

toString in class Object

readingDocument

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

Specified by:

readingDocument in interface ExcerptTailer

index

public long index()

Specified by:

index in interface ExcerptTailer

Specified by:

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

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)

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

Specified by:

queue in interface ExcerptCommon<ExcerptTailer>

readAfterReplicaAcknowledged

public void readAfterReplicaAcknowledged(boolean readAfterReplicaAcknowledged)

Specified by:

readAfterReplicaAcknowledged in interface ExcerptTailer

readAfterReplicaAcknowledged

public boolean readAfterReplicaAcknowledged()

Specified by:

readAfterReplicaAcknowledged in interface ExcerptTailer

state

public TailerState state()

Specified by:

state in interface ExcerptTailer

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

lastAcknowledgedIndexReplicated

@UsedViaReflection
public void lastAcknowledgedIndexReplicated(long acknowledgeIndex)