net.openhft.chronicle.queue

Interface ChronicleQueueBuilder<B extends ChronicleQueueBuilder>

All Superinterfaces:

Cloneable

All Known Implementing Classes:

AbstractChronicleQueueBuilder, SingleChronicleQueueBuilder

public interface ChronicleQueueBuilder<B extends ChronicleQueueBuilder>
extends Cloneable

Author:

Rob Austin.

Method Summary

Modifier and Type	Method and Description
long	blockSize()
B	blockSize(int blockSize)
long	bufferCapacity()
B	bufferCapacity(long bufferCapacity)
boolean	buffered() Deprecated. Use writeBufferMode
B	buffered(boolean isBuffered) Deprecated. Use writeBufferMode
ChronicleQueue	build()
CycleCalculator	cycleCalculator()
long	epoch()
B	epoch(long epoch) Deprecated.
net.openhft.chronicle.core.threads.EventLoop	eventLoop()
B	eventLoop(net.openhft.chronicle.core.threads.EventLoop eventLoop)
int	indexCount()
B	indexCount(int indexCount)
int	indexSpacing()
B	indexSpacing(int indexSpacing)
Consumer<net.openhft.chronicle.bytes.BytesRingBufferStats>	onRingBufferStats()
B	onRingBufferStats(Consumer<net.openhft.chronicle.bytes.BytesRingBufferStats> onRingBufferStats)
File	path()
boolean	progressOnContention()
B	progressOnContention(boolean progressOnContention) Setting this to true enables new functionality whereby opening the DocumentContext to write to a chronicle will make only one (very cheap) attempt to grab the header so as to lock the queue for appending.
BufferMode	readBufferMode()
B	readBufferMode(BufferMode readBufferMode)
boolean	readOnly()
B	readOnly(boolean readOnly)
RollCycle	rollCycle()
B	rollCycle(RollCycle rollCycle)
B	rollTime(LocalTime time, ZoneId zoneId) Resets the rollTime for the queue cycle to a new time.
static SingleChronicleQueueBuilder	single(File basePath)
static SingleChronicleQueueBuilder	single(String basePath)
static SingleChronicleQueueBuilder	singleText(String basePath) Deprecated.
WireStoreFactory	storeFactory()
StoreFileListener	storeFileListener()
B	storeFileListener(StoreFileListener storeFileListener)
default B	testBlockSize() THIS IS FOR TESTING ONLY.
net.openhft.chronicle.wire.WireType	wireType()
B	wireType(net.openhft.chronicle.wire.WireType wireType)
BufferMode	writeBufferMode()
B	writeBufferMode(BufferMode writeBufferMode)

Method Detail

single

static SingleChronicleQueueBuilder single(@NotNull
                                          String basePath)

single

static SingleChronicleQueueBuilder single(@NotNull
                                          File basePath)

singleText

@Deprecated
static SingleChronicleQueueBuilder singleText(@NotNull
                                                          String basePath)

Deprecated.

build

@NotNull
ChronicleQueue build()

onRingBufferStats

@NotNull
B onRingBufferStats(@NotNull
                             Consumer<net.openhft.chronicle.bytes.BytesRingBufferStats> onRingBufferStats)

onRingBufferStats

@NotNull
Consumer<net.openhft.chronicle.bytes.BytesRingBufferStats> onRingBufferStats()

path

@NotNull
File path()

blockSize

@NotNull
B blockSize(int blockSize)

testBlockSize

@NotNull
default B testBlockSize()

THIS IS FOR TESTING ONLY. This makes the block size small to speed up short tests and show up issues which occur when moving from one block to another.

Using this will be slower when you have many messages, and break when you have large messages.

Returns:

this

blockSize

long blockSize()

wireType

@NotNull
B wireType(@NotNull
                    net.openhft.chronicle.wire.WireType wireType)

wireType

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

rollCycle

@NotNull
B rollCycle(@NotNull
                     RollCycle rollCycle)

epoch

@NotNull
 @Deprecated
B epoch(long epoch)

Deprecated.

Resets the concept of 'epoch' from 1970-01-01T00:00:00 UTC to a new value (in UTC millis).

This method is deprecated and will be removed in a future release.

Please use the rollTime method, specifying the new epoch as a LocalTime that will be resolved against UTC.

Parameters:

epoch - a value in UTC millis that will be used when resolving roll cycle times.

Returns:

the builder

epoch

long epoch()

rollTime

B rollTime(@NotNull
           LocalTime time,
           ZoneId zoneId)

Resets the rollTime for the queue cycle to a new time.

E.g. builder.rollTime(LocalTime.of(21, 0), ZoneId.of("UTC")) will cause the queue to roll cycles at 21:00 UTC, rather than the default roll-time of midnight UTC.

Parameters:

time - the new value for the time of day when the cycle should roll

zoneId - the time-zone against which to base the roll-time

Returns:

the builder

rollCycle

@NotNull
RollCycle rollCycle()

buffered

@NotNull
 @Deprecated
B buffered(boolean isBuffered)

Deprecated. Use writeBufferMode

buffered

@Deprecated
boolean buffered()

Deprecated. Use writeBufferMode

bufferCapacity

@NotNull
B bufferCapacity(long bufferCapacity)

Parameters:

bufferCapacity - to use when buffering enabled.

Returns:

this

bufferCapacity

long bufferCapacity()

writeBufferMode

B writeBufferMode(BufferMode writeBufferMode)

Parameters:

writeBufferMode - to use for writes. Only None is available in OSS

Returns:

this

writeBufferMode

@NotNull
BufferMode writeBufferMode()

readBufferMode

B readBufferMode(BufferMode readBufferMode)

Parameters:

readBufferMode - to use for read. Only None is available in OSS

Returns:

this

readBufferMode

BufferMode readBufferMode()

eventLoop

@NotNull
B eventLoop(net.openhft.chronicle.core.threads.EventLoop eventLoop)

Parameters:

eventLoop - to use when asynchronous buffering is used.

Returns:

this

eventLoop

@Nullable
net.openhft.chronicle.core.threads.EventLoop eventLoop()

indexCount

B indexCount(int indexCount)

indexCount

int indexCount()

indexSpacing

B indexSpacing(int indexSpacing)

indexSpacing

int indexSpacing()

storeFactory

WireStoreFactory storeFactory()

storeFileListener

B storeFileListener(StoreFileListener storeFileListener)

storeFileListener

StoreFileListener storeFileListener()

readOnly

boolean readOnly()

readOnly

B readOnly(boolean readOnly)

progressOnContention

boolean progressOnContention()

progressOnContention

B progressOnContention(boolean progressOnContention)

Setting this to true enables new functionality whereby opening the DocumentContext to write to a chronicle will make only one (very cheap) attempt to grab the header so as to lock the queue for appending. If this attempt fails then the client code will be given a buffer to write into, and on close of the DocumentContext, we grab the header (skipping forward as necessary, and CASing the header), and then cheaply copy the contents of the buffer into the queue's Wire. Setting this will likely improve throughput if

• you have multiple concurrent appenders, writing relatively infrequently, and
• the appenders are holding the writingContext open for a long time (e.g. large objects that are slow to serialise)

Setting this true means that there is no longer a guarantee of ordering provided by the try block around the DocumentContext i.e. 2 concurrent appenders can race in the DocumentContext.close.

Parameters:

progressOnContention - leave false (default) for existing behaviour

Returns:

this

cycleCalculator

CycleCalculator cycleCalculator()