net.openhft.chronicle.queue.impl.single

Class SingleChronicleQueueBuilder

java.lang.Object

net.openhft.chronicle.queue.impl.single.SingleChronicleQueueBuilder

All Implemented Interfaces:

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

public class SingleChronicleQueueBuilder
extends Object
implements Cloneable, net.openhft.chronicle.wire.Marshallable

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_ROLL_CYCLE_PROPERTY
BufferMode	readBufferMode
BufferMode	writeBufferMode

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

EMPTY

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

DISCARD

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SingleChronicleQueueBuilder()

Method Summary

Modifier and Type	Method and Description
static void	addAliases()
SingleChronicleQueueBuilder	aesEncryption(byte[] keyBytes)
static SingleChronicleQueueBuilder	binary(File basePathFile)
static SingleChronicleQueueBuilder	binary(Path path)
static SingleChronicleQueueBuilder	binary(String basePath)
long	blockSize()
SingleChronicleQueueBuilder	blockSize(int blockSize)
SingleChronicleQueueBuilder	blockSize(long blockSize)
net.openhft.chronicle.core.util.ThrowingBiFunction<Long,Integer,net.openhft.chronicle.bytes.BytesStore,Exception>	bufferBytesStoreCreator() Creator for BytesStore for underlying ring buffer.
SingleChronicleQueueBuilder	bufferBytesStoreCreator(net.openhft.chronicle.core.util.ThrowingBiFunction<Long,Integer,net.openhft.chronicle.bytes.BytesStore,Exception> bufferBytesStoreCreator)
long	bufferCapacity()
SingleChronicleQueueBuilder	bufferCapacity(long bufferCapacity)
boolean	buffered() Deprecated.
SingleChronicleQueueBuilder	buffered(boolean isBuffered) Deprecated.
SingleChronicleQueue	build()
static SingleChronicleQueueBuilder	builder()
static SingleChronicleQueueBuilder	builder(File file, net.openhft.chronicle.wire.WireType wireType)
static SingleChronicleQueueBuilder	builder(Path path, net.openhft.chronicle.wire.WireType wireType)
boolean	checkInterrupts()
SingleChronicleQueueBuilder	checkInterrupts(boolean checkInterrupts)
SingleChronicleQueueBuilder	clone()
SingleChronicleQueueBuilder	codingSuppliers(Supplier<BiConsumer<net.openhft.chronicle.bytes.BytesStore,net.openhft.chronicle.bytes.Bytes>> encodingSupplier, Supplier<BiConsumer<net.openhft.chronicle.bytes.BytesStore,net.openhft.chronicle.bytes.Bytes>> decodingSupplier)
Supplier<BiConsumer<net.openhft.chronicle.bytes.BytesStore,net.openhft.chronicle.bytes.Bytes>>	decodingSupplier()
static SingleChronicleQueueBuilder	defaultZeroBinary(File basePathFile)
static SingleChronicleQueueBuilder	deltaBinary(File basePathFile)
static SingleChronicleQueueBuilder	deltaBinary(File name, byte deltaIntervalShift)
int	deltaCheckpointInterval()
SingleChronicleQueueBuilder	enablePreloader(long pretouchIntervalMillis) Enable out-of-process pretoucher (AKA preloader) (Queue Enterprise feature)
boolean	enableRingBufferMonitoring()
SingleChronicleQueueBuilder	enableRingBufferMonitoring(boolean enableRingBufferMonitoring)
Supplier<BiConsumer<net.openhft.chronicle.bytes.BytesStore,net.openhft.chronicle.bytes.Bytes>>	encodingSupplier()
long	epoch()
SingleChronicleQueueBuilder	epoch(long epoch) sets epoch offset in milliseconds
net.openhft.chronicle.core.threads.EventLoop	eventLoop()
SingleChronicleQueueBuilder	eventLoop(net.openhft.chronicle.core.threads.EventLoop eventLoop)
static SingleChronicleQueueBuilder	fieldlessBinary(File name)
boolean	hasPretouchIntervalMillis()
int	indexCount()
SingleChronicleQueueBuilder	indexCount(int indexCount)
int	indexSpacing()
SingleChronicleQueueBuilder	indexSpacing(int indexSpacing)
protected void	initializeMetadata()
SecretKeySpec	key()
int	maxTailers() maxTailers
SingleChronicleQueueBuilder	maxTailers(int maxTailers) RingBuffer tailers need to be preallocated.
SingleChronicleQueueBuilder	messageHeader(net.openhft.chronicle.core.util.Updater<net.openhft.chronicle.bytes.Bytes> messageInitializer, Consumer<net.openhft.chronicle.bytes.Bytes> messageHeaderReader)
Consumer<net.openhft.chronicle.bytes.Bytes>	messageHeaderReader()
net.openhft.chronicle.core.util.Updater<net.openhft.chronicle.bytes.Bytes>	messageInitializer()
Consumer<net.openhft.chronicle.bytes.BytesRingBufferStats>	onRingBufferStats()
SingleChronicleQueueBuilder	onRingBufferStats(Consumer<net.openhft.chronicle.bytes.BytesRingBufferStats> onRingBufferStats) consumer will be called every second, also as there is data to report
File	path()
SingleChronicleQueueBuilder	path(File path)
SingleChronicleQueueBuilder	path(Path path)
SingleChronicleQueueBuilder	path(String path)
Supplier<net.openhft.chronicle.threads.TimingPauser>	pauserSupplier()
SingleChronicleQueueBuilder	pauserSupplier(Supplier<net.openhft.chronicle.threads.TimingPauser> pauser)
protected void	preBuild()
long	pretouchIntervalMillis() Interval in ms to invoke out of process pretoucher.
QueueOffsetSpec	queueOffsetSpec()
BufferMode	readBufferMode()
SingleChronicleQueueBuilder	readBufferMode(BufferMode readBufferMode)
boolean	readOnly()
SingleChronicleQueueBuilder	readOnly(boolean readOnly)
RollCycle	rollCycle()
SingleChronicleQueueBuilder	rollCycle(RollCycle rollCycle)
SingleChronicleQueueBuilder	rollTime(LocalTime rollTime)
SingleChronicleQueueBuilder	rollTime(LocalTime rollTime, ZoneId zoneId)
ZoneId	rollTimeZone()
SingleChronicleQueueBuilder	rollTimeZone(ZoneId rollTimeZone)
SingleChronicleQueueBuilder	setAllNullFields(SingleChronicleQueueBuilder parentBuilder) updates all the fields in this that are null, from the
static SingleChronicleQueueBuilder	single()
static SingleChronicleQueueBuilder	single(File basePath)
static SingleChronicleQueueBuilder	single(String basePath)
int	sourceId()
SingleChronicleQueueBuilder	sourceId(int sourceId)
WireStoreFactory	storeFactory()
StoreFileListener	storeFileListener()
SingleChronicleQueueBuilder	storeFileListener(StoreFileListener storeFileListener)
boolean	strongAppenders()
SingleChronicleQueueBuilder	strongAppenders(boolean strongAppenders)
SingleChronicleQueueBuilder	testBlockSize() THIS IS FOR TESTING ONLY.
long	timeoutMS()
SingleChronicleQueueBuilder	timeoutMS(long timeoutMS)
net.openhft.chronicle.core.time.TimeProvider	timeProvider()
SingleChronicleQueueBuilder	timeProvider(net.openhft.chronicle.core.time.TimeProvider timeProvider)
net.openhft.chronicle.wire.WireType	wireType()
SingleChronicleQueueBuilder	wireType(net.openhft.chronicle.wire.WireType wireType)
BufferMode	writeBufferMode()
SingleChronicleQueueBuilder	writeBufferMode(BufferMode writeBufferMode)

Methods inherited from class java.lang.Object

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

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

Field Detail

DEFAULT_ROLL_CYCLE_PROPERTY

public static final String DEFAULT_ROLL_CYCLE_PROPERTY

See Also:

Constant Field Values

writeBufferMode

public BufferMode writeBufferMode

readBufferMode

public BufferMode readBufferMode

Constructor Detail

SingleChronicleQueueBuilder

protected SingleChronicleQueueBuilder()

Method Detail

addAliases

public static void addAliases()

builder

public static SingleChronicleQueueBuilder builder()

Returns:

an empty builder

builder

@NotNull
public static SingleChronicleQueueBuilder builder(@NotNull
                                                           Path path,
                                                           @NotNull
                                                           net.openhft.chronicle.wire.WireType wireType)

builder

@NotNull
public static SingleChronicleQueueBuilder builder(@NotNull
                                                           File file,
                                                           @NotNull
                                                           net.openhft.chronicle.wire.WireType wireType)

single

public static SingleChronicleQueueBuilder single()

single

public static SingleChronicleQueueBuilder single(@NotNull
                                                 String basePath)

single

public static SingleChronicleQueueBuilder single(@NotNull
                                                 File basePath)

binary

public static SingleChronicleQueueBuilder binary(@NotNull
                                                 Path path)

binary

public static SingleChronicleQueueBuilder binary(@NotNull
                                                 String basePath)

binary

public static SingleChronicleQueueBuilder binary(@NotNull
                                                 File basePathFile)

fieldlessBinary

public static SingleChronicleQueueBuilder fieldlessBinary(@NotNull
                                                          File name)

defaultZeroBinary

public static SingleChronicleQueueBuilder defaultZeroBinary(@NotNull
                                                            File basePathFile)

deltaBinary

public static SingleChronicleQueueBuilder deltaBinary(@NotNull
                                                      File basePathFile)

deltaBinary

public static SingleChronicleQueueBuilder deltaBinary(@NotNull
                                                      File name,
                                                      byte deltaIntervalShift)

Parameters:

name - the file name

deltaIntervalShift - default value of 6, the shift for deltaInterval, the should be a number between 0-63 ( inclusive ), default the delta messaging is check pointed every 64 messages, so the default deltaIntervalShift == 6, as 1 << 6 == 64

Returns:

the SingleChronicleQueueBuilder

storeFactory

public WireStoreFactory storeFactory()

build

@NotNull
public SingleChronicleQueue build()

aesEncryption

public SingleChronicleQueueBuilder aesEncryption(@Nullable
                                                 byte[] keyBytes)

messageInitializer

public net.openhft.chronicle.core.util.Updater<net.openhft.chronicle.bytes.Bytes> messageInitializer()

messageHeaderReader

public Consumer<net.openhft.chronicle.bytes.Bytes> messageHeaderReader()

messageHeader

public SingleChronicleQueueBuilder messageHeader(net.openhft.chronicle.core.util.Updater<net.openhft.chronicle.bytes.Bytes> messageInitializer,
                                                 Consumer<net.openhft.chronicle.bytes.Bytes> messageHeaderReader)

rollTime

public SingleChronicleQueueBuilder rollTime(LocalTime rollTime)

rollTimeZone

public ZoneId rollTimeZone()

rollTimeZone

public SingleChronicleQueueBuilder rollTimeZone(ZoneId rollTimeZone)

rollTime

public SingleChronicleQueueBuilder rollTime(@NotNull
                                            LocalTime rollTime,
                                            ZoneId zoneId)

initializeMetadata

protected void initializeMetadata()

deltaCheckpointInterval

public int deltaCheckpointInterval()

queueOffsetSpec

public QueueOffsetSpec queueOffsetSpec()

maxTailers

public SingleChronicleQueueBuilder maxTailers(int maxTailers)

RingBuffer tailers need to be preallocated. Only set this if using readBufferMode=Asynchronous. By default 1 tailer will be created for the user.

Parameters:

maxTailers - number of tailers that will be required from this queue, not including the draining tailer

Returns:

this

maxTailers

public int maxTailers()

maxTailers

Returns:

number of tailers that will be required from this queue, not including the draining tailer

bufferBytesStoreCreator

public SingleChronicleQueueBuilder bufferBytesStoreCreator(net.openhft.chronicle.core.util.ThrowingBiFunction<Long,Integer,net.openhft.chronicle.bytes.BytesStore,Exception> bufferBytesStoreCreator)

bufferBytesStoreCreator

@Nullable
public net.openhft.chronicle.core.util.ThrowingBiFunction<Long,Integer,net.openhft.chronicle.bytes.BytesStore,Exception> bufferBytesStoreCreator()

Creator for BytesStore for underlying ring buffer. Allows visibility of RB's data to be controlled. See also RB_BYTES_STORE_CREATOR_NATIVE, RB_BYTES_STORE_CREATOR_MAPPED_FILE

Returns:

enablePreloader

public SingleChronicleQueueBuilder enablePreloader(long pretouchIntervalMillis)

Enable out-of-process pretoucher (AKA preloader) (Queue Enterprise feature)

Parameters:

pretouchIntervalMillis -

Returns:

pretouchIntervalMillis

public long pretouchIntervalMillis()

Interval in ms to invoke out of process pretoucher. Default is not to turn on

Returns:

interval ms

hasPretouchIntervalMillis

public boolean hasPretouchIntervalMillis()

path

public SingleChronicleQueueBuilder path(String path)

path

public SingleChronicleQueueBuilder path(File path)

path

public SingleChronicleQueueBuilder path(Path path)

onRingBufferStats

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

consumer will be called every second, also as there is data to report

Parameters:

onRingBufferStats - a consumer of the BytesRingBufferStats

Returns:

this

onRingBufferStats

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

path

@NotNull
public File path()

blockSize

public SingleChronicleQueueBuilder blockSize(long blockSize)

blockSize

public SingleChronicleQueueBuilder blockSize(int blockSize)

blockSize

public long blockSize()

testBlockSize

public SingleChronicleQueueBuilder 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

wireType

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

wireType

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

rollCycle

@NotNull
public SingleChronicleQueueBuilder rollCycle(@NotNull
                                                      RollCycle rollCycle)

rollCycle

@NotNull
public RollCycle rollCycle()

bufferCapacity

public long bufferCapacity()

Returns:

ringBufferCapacity in bytes

bufferCapacity

@NotNull
public SingleChronicleQueueBuilder bufferCapacity(long bufferCapacity)

Parameters:

bufferCapacity - sets the ring buffer capacity in bytes

Returns:

this

epoch

@NotNull
public SingleChronicleQueueBuilder epoch(long epoch)

sets epoch offset in milliseconds

Parameters:

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

Returns:

this

epoch

public long epoch()

Returns:

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

buffered

@NotNull
 @Deprecated
public SingleChronicleQueueBuilder buffered(boolean isBuffered)

Deprecated.

when set to true. uses a ring buffer to buffer appends, excerpts are written to the Chronicle Queue using a background thread

Parameters:

isBuffered - true if the append is buffered

Returns:

this

buffered

@Deprecated
public boolean buffered()

Deprecated.

Returns:

if we uses a ring buffer to buffer the appends, the Excerpts are written to the Chronicle Queue using a background thread

writeBufferMode

@NotNull
public BufferMode writeBufferMode()

Returns:

BufferMode to use for writes. Only None is available is the OSS

writeBufferMode

public SingleChronicleQueueBuilder writeBufferMode(BufferMode writeBufferMode)

readBufferMode

public BufferMode readBufferMode()

Returns:

BufferMode to use for reads. Only None is available is the OSS

readBufferMode

public SingleChronicleQueueBuilder readBufferMode(BufferMode readBufferMode)

eventLoop

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

Returns:

a new event loop instance if none has been set, otherwise the eventLoop that was set

eventLoop

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

enableRingBufferMonitoring

public boolean enableRingBufferMonitoring()

Returns:

if the ring buffer's monitoring capability is turned on. Not available in OSS

enableRingBufferMonitoring

public SingleChronicleQueueBuilder enableRingBufferMonitoring(boolean enableRingBufferMonitoring)

indexCount

public SingleChronicleQueueBuilder indexCount(int indexCount)

indexCount

public int indexCount()

indexSpacing

public SingleChronicleQueueBuilder indexSpacing(int indexSpacing)

indexSpacing

public int indexSpacing()

timeProvider

public net.openhft.chronicle.core.time.TimeProvider timeProvider()

timeProvider

public SingleChronicleQueueBuilder timeProvider(net.openhft.chronicle.core.time.TimeProvider timeProvider)

pauserSupplier

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

pauserSupplier

public SingleChronicleQueueBuilder pauserSupplier(Supplier<net.openhft.chronicle.threads.TimingPauser> pauser)

timeoutMS

public SingleChronicleQueueBuilder timeoutMS(long timeoutMS)

timeoutMS

public long timeoutMS()

storeFileListener

public SingleChronicleQueueBuilder storeFileListener(StoreFileListener storeFileListener)

storeFileListener

public StoreFileListener storeFileListener()

sourceId

public SingleChronicleQueueBuilder sourceId(int sourceId)

sourceId

public int sourceId()

readOnly

public boolean readOnly()

readOnly

public SingleChronicleQueueBuilder readOnly(boolean readOnly)

encodingSupplier

public Supplier<BiConsumer<net.openhft.chronicle.bytes.BytesStore,net.openhft.chronicle.bytes.Bytes>> encodingSupplier()

decodingSupplier

public Supplier<BiConsumer<net.openhft.chronicle.bytes.BytesStore,net.openhft.chronicle.bytes.Bytes>> decodingSupplier()

codingSuppliers

public SingleChronicleQueueBuilder codingSuppliers(@Nullable
                                                   Supplier<BiConsumer<net.openhft.chronicle.bytes.BytesStore,net.openhft.chronicle.bytes.Bytes>> encodingSupplier,
                                                   @Nullable
                                                   Supplier<BiConsumer<net.openhft.chronicle.bytes.BytesStore,net.openhft.chronicle.bytes.Bytes>> decodingSupplier)

key

public SecretKeySpec key()

preBuild

protected void preBuild()

strongAppenders

public SingleChronicleQueueBuilder strongAppenders(boolean strongAppenders)

strongAppenders

public boolean strongAppenders()

checkInterrupts

public boolean checkInterrupts()

checkInterrupts

public SingleChronicleQueueBuilder checkInterrupts(boolean checkInterrupts)

clone

public SingleChronicleQueueBuilder clone()

Overrides:

clone in class Object

setAllNullFields

public SingleChronicleQueueBuilder setAllNullFields(@Nullable
                                                    SingleChronicleQueueBuilder parentBuilder)

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

Parameters:

parentBuilder - the parentBuilder Chronicle Queue Builder

Returns:

that