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 rollEpoc, int indexCount, int indexSpacing)

Method Summary

Modifier and Type	Method and Description
boolean	appendRollMeta(net.openhft.chronicle.wire.Wire wire, long cycle, long timeoutMS)
String	dump()
static void	dumpStore(net.openhft.chronicle.wire.Wire wire)
long	epoch()
long	indexForPosition(net.openhft.chronicle.wire.Wire wire, long position, long timeoutMS) Reverse look up an index for a position.
long	lastEntryIndexed(net.openhft.chronicle.wire.Wire wire, long timeoutMS)
net.openhft.chronicle.bytes.MappedBytes	mappedBytes()
ScanResult	moveToIndex(net.openhft.chronicle.wire.Wire wire, long index, long timeoutMS) Moves the position to the index
long	refCount()
void	release()
void	reserve()
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, toString, wait, wait, wait

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

close, release, releaseAll, tryReserve

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

closeQuietly, notifyClosing

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

newInstance

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

writeValue

Constructor Detail

SingleChronicleQueueStore

public SingleChronicleQueueStore(@Nullable
                                 RollCycle rollCycle,
                                 @NotNull
                                 net.openhft.chronicle.wire.WireType wireType,
                                 @NotNull
                                 net.openhft.chronicle.bytes.MappedBytes mappedBytes,
                                 long rollEpoc,
                                 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

rollEpoc - 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.

Method Detail

dumpStore

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

dump

public String dump()

Specified by:

dump in interface WireStore

writePosition

public long writePosition()

Specified by:

writePosition in interface WireStore

Returns:

the next writable position, Will be or-ed with ROLLED_BIT if it has rolled.

writePosition

public WireStore writePosition(long position)

Specified by:

writePosition in interface WireStore

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

lastEntryIndexed

public long lastEntryIndexed(net.openhft.chronicle.wire.Wire wire,
                             long timeoutMS)

Specified by:

lastEntryIndexed in interface WireStore

Returns:

the last index available on the file system

appendRollMeta

public boolean appendRollMeta(@NotNull
                              net.openhft.chronicle.wire.Wire wire,
                              long cycle,
                              long timeoutMS)
                       throws TimeoutException

Specified by:

appendRollMeta in interface WireStore

Throws:

TimeoutException

moveToIndex

public ScanResult moveToIndex(@NotNull
                              net.openhft.chronicle.wire.Wire wire,
                              long index,
                              long timeoutMS)
                       throws TimeoutException

Moves the position to the index

Specified by:

moveToIndex in interface WireStore

Parameters:

wire - the data structure we are navigating

index - the index we wish to move to

timeoutMS -

Returns:

whether the index was found for reading.

Throws:

TimeoutException

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

mappedBytes

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

Specified by:

mappedBytes in interface WireStore

Returns:

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

indexForPosition

public long indexForPosition(net.openhft.chronicle.wire.Wire wire,
                             long position,
                             long timeoutMS)
                      throws EOFException,
                             TimeoutException

Description copied from interface: WireStore

Reverse look up an index for a position.

Specified by:

indexForPosition in interface WireStore

position - of the start of the message

Returns:

index in this store.

Throws:

EOFException

TimeoutException

writeMarshallable

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

Specified by:

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