net.openhft.chronicle.queue.impl.single

Class SingleChronicleQueueStore

java.lang.Object

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

All Implemented Interfaces:

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

public class SingleChronicleQueueStore
extends Object
implements WireStore

Field Summary

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

DEMARSHALLABLES

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

EMPTY

Constructor Summary

Constructors

Constructor and Description
SingleChronicleQueueStore(RollCycle rollCycle, net.openhft.chronicle.wire.WireType wireType, net.openhft.chronicle.bytes.MappedBytes mappedBytes, long epoch, int indexCount, int indexSpacing, StoreRecovery recovery, int deltaCheckpointInterval)

Method Summary

Modifier and Type	Method and Description
net.openhft.chronicle.bytes.MappedBytes	bytes()
void	close()
int	deltaCheckpointInterval()
String	dump()
static String	dump(String directoryFilePath)
static void	dumpStore(net.openhft.chronicle.wire.Wire wire)
long	epoch()
File	file()
long	lastAcknowledgedIndexReplicated() when using replication to another host, this is the last index that has been confirmed to * have been read by the remote host.
void	lastAcknowledgedIndexReplicated(long newValue)
ScanResult	moveToIndexForRead(ExcerptContext ec, long index) Moves the position to the index
long	refCount()
void	release()
void	reserve()
long	sequenceForPosition(ExcerptContext ec, long position, boolean inclusive) Reverse look up an index for a position.
void	setPositionForSequenceNumber(ExcerptContext ec, long sequenceNumber, long position)
String	toString()
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)
void	writeMarshallable(net.openhft.chronicle.wire.WireOut wire)
long	writePosition()
WireStore	writePosition(long position)

Methods inherited from class java.lang.Object

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

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

release, releaseAll, tryReserve

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

closeQuietly, isClosed, notifyClosing

Constructor Detail

SingleChronicleQueueStore

public SingleChronicleQueueStore(@Nullable
                                 RollCycle rollCycle,
                                 @NotNull
                                 net.openhft.chronicle.wire.WireType wireType,
                                 @NotNull
                                 net.openhft.chronicle.bytes.MappedBytes mappedBytes,
                                 long epoch,
                                 int indexCount,
                                 int indexSpacing,
                                 StoreRecovery recovery,
                                 int deltaCheckpointInterval)

Parameters:

rollCycle - the current rollCycle

wireType - the wire type that is being used

mappedBytes - used to mapped the data store file

epoch - sets an epoch offset as the number of number of milliseconds since

indexCount - the number of entries in each index.

indexSpacing - the spacing between indexed entries.

recovery -

deltaCheckpointInterval -

Method Detail

dumpStore

public static void dumpStore(net.openhft.chronicle.wire.Wire wire)

dump

public static String dump(String directoryFilePath)

wireType

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

Specified by:

wireType in interface WireStore

Returns:

the type of wire used

file

public File file()

Specified by:

file in interface WireStore

Returns:

the file associated with this store.

lastAcknowledgedIndexReplicated

public long lastAcknowledgedIndexReplicated()

when using replication to another host, this is the last index that has been confirmed to * have been read by the remote host.

Specified by:

lastAcknowledgedIndexReplicated in interface WireStore

lastAcknowledgedIndexReplicated

public void lastAcknowledgedIndexReplicated(long newValue)

Specified by:

lastAcknowledgedIndexReplicated in interface WireStore

dump

public String dump()

Specified by:

dump 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

public 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

epoch

public long epoch()

Specified by:

epoch in interface WireStore

Returns:

an epoch offset as the number of number of milliseconds since January 1, 1970, 00:00:00 GMT

moveToIndexForRead

public ScanResult moveToIndexForRead(@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.

reserve

public void reserve()
             throws IllegalStateException

Specified by:

reserve in interface net.openhft.chronicle.core.ReferenceCounted

Throws:

IllegalStateException

release

public void release()
             throws IllegalStateException

Specified by:

release in interface net.openhft.chronicle.core.ReferenceCounted

Throws:

IllegalStateException

refCount

public long refCount()

Specified by:

refCount in interface net.openhft.chronicle.core.ReferenceCounted

close

public void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

bytes

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

Specified by:

bytes in interface WireStore

Returns:

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

sequenceForPosition

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

EOFException

net.openhft.chronicle.wire.UnrecoverableTimeoutException

StreamCorruptedException

toString

public String toString()

Overrides:

toString in class Object

writeMarshallable

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

Specified by:

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

setPositionForSequenceNumber

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

Specified by:

setPositionForSequenceNumber in interface WireStore

Throws:

net.openhft.chronicle.wire.UnrecoverableTimeoutException

StreamCorruptedException

writeHeader

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

Specified by:

writeHeader in interface WireStore

Throws:

EOFException

net.openhft.chronicle.wire.UnrecoverableTimeoutException

writeEOF

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

Specified by:

writeEOF in interface WireStore

Throws:

net.openhft.chronicle.wire.UnrecoverableTimeoutException

deltaCheckpointInterval

public int deltaCheckpointInterval()

Specified by:

deltaCheckpointInterval in interface WireStore