org.elasticsearch.index.seqno

Class LocalCheckpointTracker

java.lang.Object

org.elasticsearch.index.seqno.LocalCheckpointTracker

public class LocalCheckpointTracker
extends java.lang.Object

This class generates sequences numbers and keeps track of the so-called "local checkpoint" which is the highest number for which all previous sequence numbers have been processed (inclusive).

Constructor Summary

Constructors

Constructor and Description
LocalCheckpointTracker(long maxSeqNo, long localCheckpoint) Initialize the local checkpoint service.

Method Summary

Modifier and Type	Method and Description
long	getCheckpoint() The current checkpoint which can be advanced by markSeqNoAsCompleted(long).
void	markSeqNoAsCompleted(long seqNo) Marks the processing of the provided sequence number as completed as updates the checkpoint if possible.

Methods inherited from class java.lang.Object

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

Constructor Detail

LocalCheckpointTracker

public LocalCheckpointTracker(long maxSeqNo,
                              long localCheckpoint)

Initialize the local checkpoint service. The maxSeqNo should be set to the last sequence number assigned, or SequenceNumbers.NO_OPS_PERFORMED and localCheckpoint should be set to the last known local checkpoint, or SequenceNumbers.NO_OPS_PERFORMED.

Parameters:

maxSeqNo - the last sequence number assigned, or SequenceNumbers.NO_OPS_PERFORMED

localCheckpoint - the last known local checkpoint, or SequenceNumbers.NO_OPS_PERFORMED

Method Detail

markSeqNoAsCompleted

public void markSeqNoAsCompleted(long seqNo)

Marks the processing of the provided sequence number as completed as updates the checkpoint if possible.

Parameters:

seqNo - the sequence number to mark as completed

getCheckpoint

public long getCheckpoint()

The current checkpoint which can be advanced by markSeqNoAsCompleted(long).

Returns:

the current checkpoint