net.openhft.chronicle.queue.impl

Interface WireStore

All Superinterfaces:

AutoCloseable, Closeable, net.openhft.chronicle.wire.Demarshallable, net.openhft.chronicle.core.ReferenceCounted, net.openhft.chronicle.wire.WriteMarshallable, net.openhft.chronicle.wire.WriteValue

All Known Implementing Classes:

SingleChronicleQueueStore

public interface WireStore
extends net.openhft.chronicle.core.ReferenceCounted, net.openhft.chronicle.wire.Demarshallable, net.openhft.chronicle.wire.WriteMarshallable, net.openhft.chronicle.core.io.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
net.openhft.chronicle.bytes.MappedBytes	bytes()
int	deltaCheckpointInterval()
String	dump()
long	epoch()
File	file()
boolean	indexable(long index)
long	lastAcknowledgedIndexReplicated()
void	lastAcknowledgedIndexReplicated(long lastAcknowledgedIndexReplicated)
long	lastSequenceNumber(ExcerptContext ec)
ScanResult	moveToIndexForRead(ExcerptContext ec, long index)
long	sequenceForPosition(ExcerptContext ec, long position, boolean inclusive) Reverse look up an index for a position.
void	setPositionForSequenceNumber(ExcerptContext ec, long sequenceNumber, long position)
net.openhft.chronicle.wire.WireType	wireType()
void	writeEOF(net.openhft.chronicle.wire.Wire wire, long timeoutMS)
long	writeHeader(net.openhft.chronicle.wire.Wire wire, int length, long timeoutMS)
long	writePosition()
WireStore	writePosition(long position)

Methods inherited from interface net.openhft.chronicle.core.ReferenceCounted

refCount, release, release, releaseAll, reserve, tryReserve

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.core.io.Closeable

close, closeQuietly, isClosed, notifyClosing

Method Detail

file

File file()

Returns:

the file associated with this store.

writePosition

WireStore writePosition(long position)

Parameters:

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

Returns:

this store

epoch

long epoch()

Returns:

an epoch offset as the number of number of milliseconds since January 1, 1970, 00:00:00 GMT, if you set the epoch to the current time, then the cycle will be ZERO

writePosition

long writePosition()

Returns:

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

moveToIndexForRead

ScanResult moveToIndexForRead(@NotNull
                              ExcerptContext ec,
                              long index)

bytes

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

sequenceForPosition

long sequenceForPosition(ExcerptContext ec,
                         long position,
                         boolean inclusive)
                  throws net.openhft.chronicle.wire.UnrecoverableTimeoutException,
                         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

StreamCorruptedException

lastSequenceNumber

long lastSequenceNumber(ExcerptContext ec)
                 throws StreamCorruptedException

Throws:

StreamCorruptedException

dump

String dump()

lastAcknowledgedIndexReplicated

void lastAcknowledgedIndexReplicated(long lastAcknowledgedIndexReplicated)

lastAcknowledgedIndexReplicated

long lastAcknowledgedIndexReplicated()

setPositionForSequenceNumber

void setPositionForSequenceNumber(ExcerptContext ec,
                                  long sequenceNumber,
                                  long position)
                           throws net.openhft.chronicle.wire.UnrecoverableTimeoutException,
                                  StreamCorruptedException

Throws:

net.openhft.chronicle.wire.UnrecoverableTimeoutException

StreamCorruptedException

writeHeader

long writeHeader(net.openhft.chronicle.wire.Wire wire,
                 int length,
                 long timeoutMS)
          throws EOFException,
                 net.openhft.chronicle.wire.UnrecoverableTimeoutException

Throws:

EOFException

net.openhft.chronicle.wire.UnrecoverableTimeoutException

writeEOF

void writeEOF(net.openhft.chronicle.wire.Wire wire,
              long timeoutMS)
       throws TimeoutException

Throws:

TimeoutException

deltaCheckpointInterval

int deltaCheckpointInterval()

wireType

net.openhft.chronicle.wire.WireType wireType()

Returns:

the type of wire used

indexable

boolean indexable(long index)