net.openhft.chronicle.queue.impl

Interface WireStore

All Superinterfaces:

AutoCloseable, Closeable, net.openhft.chronicle.bytes.CommonMarshallable, CommonStore, net.openhft.chronicle.wire.Demarshallable, net.openhft.chronicle.wire.WriteMarshallable, net.openhft.chronicle.wire.WriteValue

All Known Implementing Classes:

SingleChronicleQueueStore

public interface WireStore
extends CommonStore, Closeable

Field Summary

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

DEMARSHALLABLES

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

EMPTY

Method Summary

Modifier and Type	Method and Description
int	dataVersion()
String	dumpHeader()
boolean	indexable(long index)
void	initIndex(net.openhft.chronicle.wire.Wire wire)
long	lastSequenceNumber(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)
@Nullable ScanResult	moveToStartForRead(@NotNull ExcerptContext ec)
long	sequenceForPosition(ExcerptContext ec, long position, boolean inclusive) Reverse look up an index for a position.
void	setPositionForSequenceNumber(ExcerptContext ec, long sequenceNumber, long position) Sets the position using the provided parameters.
boolean	writeEOF(net.openhft.chronicle.wire.Wire wire, long timeoutMS)
long	writePosition()
@NotNull WireStore	writePosition(long position)

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

bytes, dump, file, shortDump

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

newInstance

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

writeMarshallable, writeValue

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

usesSelfDescribingMessage

Methods inherited from interface java.io.Closeable

close

Method Detail

writePosition

@NotNull
@NotNull WireStore writePosition(long position)

Parameters:

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

Returns:

this store

writePosition

long writePosition()

Returns:

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

moveToIndexForRead

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

moveToStartForRead

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

sequenceForPosition

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

Reverse look up an index for a position.

Parameters:

ec - the wire of the bytes, to work with

position - of the start of the message

Returns:

index in this store.

Throws:

net.openhft.chronicle.wire.UnrecoverableTimeoutException - if the operation times out

StreamCorruptedException

lastSequenceNumber

long lastSequenceNumber(ExcerptContext ec)
                 throws StreamCorruptedException

Throws:

StreamCorruptedException

setPositionForSequenceNumber

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

Sets the position using the provided parameters.

Parameters:

ec - the wire of the bytes, to work with

sequenceNumber - to use when setting position

position - of the start of the message

Throws:

net.openhft.chronicle.wire.UnrecoverableTimeoutException - if the operation times out

StreamCorruptedException - if the stream is corrupted

writeEOF

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

Returns:

true if EOF was written

indexable

boolean indexable(long index)

linearScanTo

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

moveToEndForRead

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

initIndex

void initIndex(net.openhft.chronicle.wire.Wire wire)

dumpHeader

String dumpHeader()

dataVersion

int dataVersion()