net.openhft.chronicle.queue.impl.single

Class SingleChronicleQueueStore

java.lang.Object

net.openhft.chronicle.core.io.AbstractCloseable

net.openhft.chronicle.queue.impl.single.SingleChronicleQueueStore

All Implemented Interfaces:

Closeable, AutoCloseable, net.openhft.chronicle.bytes.CommonMarshallable, net.openhft.chronicle.core.io.CloseableTracer, net.openhft.chronicle.core.io.ManagedCloseable, net.openhft.chronicle.core.io.QueryCloseable, net.openhft.chronicle.core.io.ReferenceOwner, CommonStore, WireStore, net.openhft.chronicle.wire.Demarshallable, net.openhft.chronicle.wire.WriteMarshallable, net.openhft.chronicle.wire.WriteValue

public class SingleChronicleQueueStore
extends net.openhft.chronicle.core.io.AbstractCloseable
implements WireStore

Field Summary

Fields inherited from class net.openhft.chronicle.core.io.AbstractCloseable

CHECK_THREAD_SAFETY, DISABLE_DISCARD_WARNING, DISABLE_THREAD_SAFETY, STRICT_DISCARD_WARNING, WARN_NS

Fields inherited from interface net.openhft.chronicle.wire.Demarshallable

DEMARSHALLABLES

Fields inherited from interface net.openhft.chronicle.wire.WriteMarshallable

EMPTY

Fields inherited from interface net.openhft.chronicle.core.io.ReferenceOwner

INIT

Constructor Summary

Constructors

Constructor and Description
SingleChronicleQueueStore(@NotNull RollCycle rollCycle, @NotNull net.openhft.chronicle.wire.WireType wireType, @NotNull net.openhft.chronicle.bytes.MappedBytes mappedBytes, int indexCount, int indexSpacing)

Method Summary

Modifier and Type	Method and Description
@NotNull net.openhft.chronicle.bytes.MappedBytes	bytes()
File	currentFile()
int	cycle()
SingleChronicleQueueStore	cycle(int cycle)
int	dataVersion()
@NotNull String	dump()
static @NotNull String	dump(@NotNull String directoryFilePath)
String	dumpHeader()
@NotNull File	file()
boolean	indexable(long index)
void	initIndex(@NotNull net.openhft.chronicle.wire.Wire wire)
long	lastSequenceNumber(@NotNull ExcerptContext ec)
ScanResult	linearScanTo(long index, long knownIndex, ExcerptContext ec, long knownAddress)
long	moveToEndForRead(@NotNull net.openhft.chronicle.wire.Wire w)
@Nullable ScanResult	moveToIndexForRead(@NotNull ExcerptContext ec, long index) Moves the position to the index
@Nullable ScanResult	moveToStartForRead(@NotNull ExcerptContext ec) Moves the position to the start
protected void	performClose()
long	sequenceForPosition(@NotNull ExcerptContext ec, long position, boolean inclusive) Reverse look up an index for a position.
void	setPositionForSequenceNumber(@NotNull ExcerptContext ec, long sequenceNumber, long position) Sets the position using the provided parameters.
@NotNull String	shortDump()
protected boolean	threadSafetyCheck(boolean isUsed)
@NotNull String	toString()
boolean	writeEOF(@NotNull net.openhft.chronicle.wire.Wire wire, long timeoutMS)
void	writeMarshallable(@NotNull net.openhft.chronicle.wire.WireOut wire)
long	writePosition()
@NotNull WireStore	writePosition(long position)

Methods inherited from class net.openhft.chronicle.core.io.AbstractCloseable

assertCloseablesClosed, clearUsedByThread, close, createdHere, disableCloseableTracing, enableCloseableTracing, isClosed, isClosing, isInUserThread, performCloseInBackground, referenceId, resetUsedByThread, shouldPerformCloseInBackground, shouldWaitForClosed, throwExceptionIfClosed, throwExceptionIfClosedInSetter, unmonitor, waitForCloseablesToClose, waitForClosed, warnAndCloseIfNotClosed

Methods inherited from class java.lang.Object

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

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

newInstance

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

writeValue

Methods inherited from interface net.openhft.chronicle.bytes.CommonMarshallable

usesSelfDescribingMessage

Methods inherited from interface java.io.Closeable

close

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

referenceName, temporary

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

closeQuietly, closeQuietly, notifyClosing

Constructor Detail

SingleChronicleQueueStore

public SingleChronicleQueueStore(@NotNull
                                 @NotNull RollCycle rollCycle,
                                 @NotNull
                                 @NotNull net.openhft.chronicle.wire.WireType wireType,
                                 @NotNull
                                 @NotNull net.openhft.chronicle.bytes.MappedBytes mappedBytes,
                                 int indexCount,
                                 int indexSpacing)

Parameters:

rollCycle - the current rollCycle

wireType - the wire type that is being used

mappedBytes - used to mapped the data store file

indexCount - the number of entries in each index.

indexSpacing - the spacing between indexed entries.

Method Detail

dump

@NotNull
public static @NotNull String dump(@NotNull
                                            @NotNull String directoryFilePath)

file

@NotNull
public @NotNull File file()

Specified by:

file in interface CommonStore

Returns:

the file associated with this store.

dump

@NotNull
public @NotNull String dump()

Specified by:

dump in interface CommonStore

shortDump

@NotNull
public @NotNull String shortDump()

Specified by:

shortDump in interface CommonStore

dumpHeader

public String dumpHeader()

Specified by:

dumpHeader in interface WireStore

writePosition

public long writePosition()

Specified by:

writePosition in interface WireStore

Returns:

the start of the last written excerpt to this cycle/store

writePosition

@NotNull
public @NotNull WireStore writePosition(long position)

Specified by:

writePosition in interface WireStore

Parameters:

position - the start of the last written excerpt to this cycle/store

Returns:

this store

moveToIndexForRead

@Nullable
public @Nullable ScanResult moveToIndexForRead(@NotNull
                                                         @NotNull ExcerptContext ec,
                                                         long index)

Moves the position to the index

Specified by:

moveToIndexForRead in interface WireStore

Parameters:

ec - the data structure we are navigating

index - the index we wish to move to

Returns:

whether the index was found for reading.

moveToStartForRead

@Nullable
public @Nullable ScanResult moveToStartForRead(@NotNull
                                                         @NotNull ExcerptContext ec)

Moves the position to the start

Specified by:

moveToStartForRead in interface WireStore

Parameters:

ec - the data structure we are navigating

Returns:

whether the index was found for reading.

threadSafetyCheck

protected boolean threadSafetyCheck(boolean isUsed)

Overrides:

threadSafetyCheck in class net.openhft.chronicle.core.io.AbstractCloseable

moveToEndForRead

public long moveToEndForRead(@NotNull
                             @NotNull net.openhft.chronicle.wire.Wire w)

Specified by:

moveToEndForRead in interface WireStore

performClose

protected void performClose()

Specified by:

performClose in class net.openhft.chronicle.core.io.AbstractCloseable

bytes

@NotNull
public @NotNull net.openhft.chronicle.bytes.MappedBytes bytes()

Specified by:

bytes in interface CommonStore

Returns:

creates a new instance of mapped bytes, because, for example the tailer and appender can be at different locations.

sequenceForPosition

public long sequenceForPosition(@NotNull
                                @NotNull ExcerptContext ec,
                                long position,
                                boolean inclusive)
                         throws StreamCorruptedException

Description copied from interface: WireStore

Reverse look up an index for a position.

Specified by:

sequenceForPosition in interface WireStore

Parameters:

ec - the wire of the bytes, to work with

position - of the start of the message

Returns:

index in this store.

Throws:

StreamCorruptedException

lastSequenceNumber

public long lastSequenceNumber(@NotNull
                               @NotNull ExcerptContext ec)
                        throws StreamCorruptedException

Specified by:

lastSequenceNumber in interface WireStore

Throws:

StreamCorruptedException

toString

@NotNull
public @NotNull String toString()

Overrides:

toString in class net.openhft.chronicle.core.io.AbstractCloseable

writeMarshallable

public void writeMarshallable(@NotNull
                              @NotNull net.openhft.chronicle.wire.WireOut wire)

Specified by:

writeMarshallable in interface net.openhft.chronicle.wire.WriteMarshallable

initIndex

public void initIndex(@NotNull
                      @NotNull net.openhft.chronicle.wire.Wire wire)

Specified by:

initIndex in interface WireStore

indexable

public boolean indexable(long index)

Specified by:

indexable in interface WireStore

setPositionForSequenceNumber

public void setPositionForSequenceNumber(@NotNull
                                         @NotNull ExcerptContext ec,
                                         long sequenceNumber,
                                         long position)
                                  throws StreamCorruptedException

Description copied from interface: WireStore

Sets the position using the provided parameters.

Specified by:

setPositionForSequenceNumber in interface WireStore

Parameters:

ec - the wire of the bytes, to work with

sequenceNumber - to use when setting position

position - of the start of the message

Throws:

StreamCorruptedException - if the stream is corrupted

linearScanTo

public ScanResult linearScanTo(long index,
                               long knownIndex,
                               ExcerptContext ec,
                               long knownAddress)

Specified by:

linearScanTo in interface WireStore

writeEOF

public boolean writeEOF(@NotNull
                        @NotNull net.openhft.chronicle.wire.Wire wire,
                        long timeoutMS)

Specified by:

writeEOF in interface WireStore

Returns:

true if EOF was written

dataVersion

public int dataVersion()

Specified by:

dataVersion in interface WireStore

cycle

public SingleChronicleQueueStore cycle(int cycle)

cycle

public int cycle()

currentFile

public File currentFile()