net.openhft.chronicle.queue.impl.single

Interface Indexing

public interface Indexing

Provides internal-only indexing functionality for SingleChronicleQueue. This interface will be expanded over time to clarify the API contract of SCQIndexing.

Method Summary

Modifier and Type	Method and Description
boolean	indexable(long index)
int	indexCount()
int	indexSpacing()
long	lastSequenceNumber(ExcerptContext ex) Get the sequence number of the last entry present in the cycle.
default long	lastSequenceNumber(ExcerptContext ec, boolean approximate) Deprecated. Use lastSequenceNumber(ExcerptContext) instead
int	linearScanByPositionCount()
int	linearScanCount()
long	nextEntryToBeIndexed()

Method Detail

indexCount

int indexCount()

indexSpacing

int indexSpacing()

nextEntryToBeIndexed

long nextEntryToBeIndexed()

indexable

boolean indexable(long index)

lastSequenceNumber

@Deprecated
default long lastSequenceNumber(ExcerptContext ec,
                                            boolean approximate)
                                     throws StreamCorruptedException

Deprecated. Use lastSequenceNumber(ExcerptContext) instead

Throws:

StreamCorruptedException

lastSequenceNumber

long lastSequenceNumber(ExcerptContext ex)
                 throws StreamCorruptedException

Get the sequence number of the last entry present in the cycle.

Note: If you're not holding the write lock when you call this and there are concurrent writers, the value may be stale by the time it's returned. If you're holding the write lock it is guaranteed to be accurate.

Parameters:

ex - An ExcerptContext used to scan the roll cycle if necssary

Returns:

the sequence of the last excerpt in the cycle

Throws:

StreamCorruptedException

linearScanCount

int linearScanCount()

linearScanByPositionCount

int linearScanByPositionCount()