net.openhft.chronicle.queue

Interface ChronicleQueueBuilder<B extends ChronicleQueueBuilder,Q extends ChronicleQueue>

All Superinterfaces:

Cloneable, net.openhft.chronicle.wire.Marshallable, net.openhft.chronicle.wire.ReadMarshallable, net.openhft.chronicle.core.io.Resettable, net.openhft.chronicle.wire.WriteMarshallable, net.openhft.chronicle.wire.WriteValue

All Known Implementing Classes:

AbstractChronicleQueueBuilder, SingleChronicleQueueBuilder

public interface ChronicleQueueBuilder<B extends ChronicleQueueBuilder,Q extends ChronicleQueue>
extends Cloneable, net.openhft.chronicle.wire.Marshallable

Author:

Rob Austin.

Field Summary

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

EMPTY

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

DISCARD

Method Summary

Modifier and Type	Method and Description
long	blockSize()
B	blockSize(int blockSize) you should make sure that your largest message size is no larger than 1/4 of your block size
B	blockSize(long blockSize)
long	bufferCapacity()
B	bufferCapacity(long bufferCapacity)
boolean	buffered() Deprecated. Use writeBufferMode
B	buffered(boolean isBuffered) Deprecated. Use writeBufferMode
Q	build()
Object	clone()
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)
boolean	hasBlockSize()
boolean	hasPretouchIntervalMillis()
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()
B	path(File path)
default B	path(String path)
B	pauserSupplier(Supplier<net.openhft.chronicle.threads.TimingPauser> timedBusy)
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.
default B	setAllNullFields(ChronicleQueueBuilder parentBuilder) updates all the fields in this that are null, from the
static SingleChronicleQueueBuilder<SingleChronicleQueueBuilder,SingleChronicleQueue>	single()
static SingleChronicleQueueBuilder<SingleChronicleQueueBuilder,SingleChronicleQueue>	single(File basePath)
static SingleChronicleQueueBuilder<SingleChronicleQueueBuilder,SingleChronicleQueue>	single(String basePath)
static SingleChronicleQueueBuilder<SingleChronicleQueueBuilder,SingleChronicleQueue>	singleText(String basePath) Deprecated.
WireStoreFactory	storeFactory()
StoreFileListener	storeFileListener()
B	storeFileListener(StoreFileListener storeFileListener)
boolean	strongAppenders()
B	strongAppenders(boolean strongAppenders) Hold a strong reference to any appender instead of a weak one which prevents GC if the thread and queue exists.
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)

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

$equals, $fieldInfos, $hashCode, $toString, copyFrom, copyTo, deepCopy, fromFile, fromFile, fromFileAsMap, fromFileAsMap, fromHexString, fromString, fromString, fromString, getClassName, getField, mergeToMap, readMarshallable, reset, setField, streamFromFile, streamFromFile, writeMarshallable

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

writeValue

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

unexpectedField

Method Detail

single

static SingleChronicleQueueBuilder<SingleChronicleQueueBuilder,SingleChronicleQueue> single()

single

static SingleChronicleQueueBuilder<SingleChronicleQueueBuilder,SingleChronicleQueue> single(@NotNull
                                                                                            String basePath)

single

static SingleChronicleQueueBuilder<SingleChronicleQueueBuilder,SingleChronicleQueue> single(@NotNull
                                                                                            File basePath)

singleText

@Deprecated
static SingleChronicleQueueBuilder<SingleChronicleQueueBuilder,SingleChronicleQueue> singleText(@NotNull
                                                                                                            String basePath)

Deprecated.

build

@NotNull
Q 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)

you should make sure that your largest message size is no larger than 1/4 of your block size

Parameters:

blockSize - the size of the off heap memory mapping

Returns:

that

blockSize

B blockSize(long 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()

hasPretouchIntervalMillis

boolean hasPretouchIntervalMillis()

readOnly

boolean readOnly()

readOnly

B readOnly(boolean readOnly)

cycleCalculator

CycleCalculator cycleCalculator()

strongAppenders

B strongAppenders(boolean strongAppenders)

Hold a strong reference to any appender instead of a weak one which prevents GC if the thread and queue exists.

Parameters:

strongAppenders - use strong references if true, use weak references is false.

Returns:

this builder.

strongAppenders

boolean strongAppenders()

clone

Object clone()

pauserSupplier

B pauserSupplier(Supplier<net.openhft.chronicle.threads.TimingPauser> timedBusy)

path

default B path(String path)

path

B path(File path)

setAllNullFields

default B setAllNullFields(@Nullable
                           ChronicleQueueBuilder parentBuilder)

updates all the fields in this that are null, from the

Parameters:

parentBuilder - the parentBuilder Chronicle Queue Builder

Returns:

that

hasBlockSize

boolean hasBlockSize()

Returns:

true if the bockSize has been set, Hence is non null