net.openhft.chronicle.queue.impl.single

Class SingleChronicleQueueBuilder

java.lang.Object

net.openhft.chronicle.wire.AbstractCommonMarshallable

net.openhft.chronicle.wire.SelfDescribingMarshallable

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

All Implemented Interfaces:

Cloneable, net.openhft.chronicle.bytes.BytesMarshallable, net.openhft.chronicle.bytes.CommonMarshallable, net.openhft.chronicle.bytes.ReadBytesMarshallable, net.openhft.chronicle.bytes.WriteBytesMarshallable, 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 net.openhft.chronicle.wire.SelfDescribingMarshallable
implements Cloneable

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_ROLL_CYCLE_PROPERTY

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(@Nullable byte[] keyBytes)
WriteLock	appendLock()
static SingleChronicleQueueBuilder	binary(@NotNull File basePathFile)
static SingleChronicleQueueBuilder	binary(@NotNull Path path)
static SingleChronicleQueueBuilder	binary(@NotNull String basePath)
long	blockSize()
SingleChronicleQueueBuilder	blockSize(int blockSize)
SingleChronicleQueueBuilder	blockSize(long blockSize)
@Nullable 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()
@NotNull SingleChronicleQueueBuilder	bufferCapacity(long bufferCapacity)
boolean	buffered() Deprecated.
@NotNull SingleChronicleQueueBuilder	buffered(boolean isBuffered) Deprecated.
@NotNull SingleChronicleQueue	build()
static SingleChronicleQueueBuilder	builder()
static @NotNull SingleChronicleQueueBuilder	builder(@NotNull File file, @NotNull net.openhft.chronicle.wire.WireType wireType)
static @NotNull SingleChronicleQueueBuilder	builder(@NotNull Path path, @NotNull net.openhft.chronicle.wire.WireType wireType)
boolean	checkInterrupts()
SingleChronicleQueueBuilder	checkInterrupts(boolean checkInterrupts)
SingleChronicleQueueBuilder	clone()
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)
Supplier<BiConsumer<net.openhft.chronicle.bytes.BytesStore,net.openhft.chronicle.bytes.Bytes>>	decodingSupplier()
static SingleChronicleQueueBuilder	defaultZeroBinary(@NotNull File basePathFile)
static SingleChronicleQueueBuilder	deltaBinary(@NotNull File basePathFile)
static SingleChronicleQueueBuilder	deltaBinary(@NotNull File name, byte deltaIntervalShift)
int	deltaCheckpointInterval()
boolean	doubleBuffer()
SingleChronicleQueueBuilder	doubleBuffer(boolean doubleBuffer) Enables double-buffered writes on contention.
net.openhft.chronicle.core.threads.HandlerPriority	drainerPriority() Priority for ring buffer's drainer handler
SingleChronicleQueueBuilder	drainerPriority(net.openhft.chronicle.core.threads.HandlerPriority drainerPriority)
int	drainerTimeoutMS()
SingleChronicleQueueBuilder	drainerTimeoutMS(int timeout)
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()
@NotNull SingleChronicleQueueBuilder	epoch(long epoch) sets epoch offset in milliseconds
@NotNull net.openhft.chronicle.core.threads.EventLoop	eventLoop()
@NotNull SingleChronicleQueueBuilder	eventLoop(net.openhft.chronicle.core.threads.EventLoop eventLoop)
static SingleChronicleQueueBuilder	fieldlessBinary(@NotNull 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(@NotNull Consumer<net.openhft.chronicle.bytes.BytesRingBufferStats> onRingBufferStats) consumer will be called every second, also as there is data to report
@NotNull 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) When readBufferMode is set to Asynchronous, reads from the ring buffer.
boolean	readOnly()
SingleChronicleQueueBuilder	readOnly(boolean readOnly)
boolean	ringBufferForceCreateReader()
SingleChronicleQueueBuilder	ringBufferForceCreateReader(boolean ringBufferForceCreateReader)
SingleChronicleQueueBuilder	ringBufferPauser(net.openhft.chronicle.threads.Pauser ringBufferPauser) Deprecated.
Supplier<net.openhft.chronicle.threads.Pauser>	ringBufferPauserSupplier() Pauser supplier for the pauser to be used by ring buffer when waiting
SingleChronicleQueueBuilder	ringBufferPauserSupplier(Supplier<net.openhft.chronicle.threads.Pauser> ringBufferPauserSupplier)
boolean	ringBufferReaderCanDrain()
SingleChronicleQueueBuilder	ringBufferReaderCanDrain(boolean ringBufferReaderCanDrain)
boolean	ringBufferReopenReader()
SingleChronicleQueueBuilder	ringBufferReopenReader(boolean ringBufferReopenReader)
@NotNull RollCycle	rollCycle()
@NotNull SingleChronicleQueueBuilder	rollCycle(@NotNull RollCycle rollCycle)
SingleChronicleQueueBuilder	rollTime(LocalTime rollTime)
SingleChronicleQueueBuilder	rollTime(@NotNull LocalTime rollTime, ZoneId zoneId)
ZoneId	rollTimeZone()
SingleChronicleQueueBuilder	rollTimeZone(ZoneId rollTimeZone)
SingleChronicleQueueBuilder	setAllNullFields(@Nullable SingleChronicleQueueBuilder parentBuilder) updates all the fields in this that are null, from the parentBuilder
static SingleChronicleQueueBuilder	single()
static SingleChronicleQueueBuilder	single(@NotNull File basePath)
static SingleChronicleQueueBuilder	single(@NotNull 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)
@NotNull net.openhft.chronicle.wire.WireType	wireType()
@NotNull SingleChronicleQueueBuilder	wireType(@NotNull net.openhft.chronicle.wire.WireType wireType)
@NotNull BufferMode	writeBufferMode()
SingleChronicleQueueBuilder	writeBufferMode(BufferMode writeBufferMode) When writeBufferMode is set to Asynchronous, uses a ring buffer to buffer appends, excerpts are written to the Chronicle Queue using a background thread.

Methods inherited from class net.openhft.chronicle.wire.SelfDescribingMarshallable

usesSelfDescribingMessage

Methods inherited from class net.openhft.chronicle.wire.AbstractCommonMarshallable

equals, hashCode, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

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

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

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

writeValue

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

unexpectedField

Methods inherited from interface net.openhft.chronicle.bytes.BytesMarshallable

$toString, readMarshallable, writeMarshallable

Field Detail

DEFAULT_ROLL_CYCLE_PROPERTY

public static final String DEFAULT_ROLL_CYCLE_PROPERTY

See Also:

Constant Field Values

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 @NotNull SingleChronicleQueueBuilder builder(@NotNull
                                                                    @NotNull Path path,
                                                                    @NotNull
                                                                    @NotNull net.openhft.chronicle.wire.WireType wireType)

builder

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

single

public static SingleChronicleQueueBuilder single()

single

public static SingleChronicleQueueBuilder single(@NotNull
                                                 @NotNull String basePath)

single

public static SingleChronicleQueueBuilder single(@NotNull
                                                 @NotNull File basePath)

binary

public static SingleChronicleQueueBuilder binary(@NotNull
                                                 @NotNull Path path)

binary

public static SingleChronicleQueueBuilder binary(@NotNull
                                                 @NotNull String basePath)

binary

public static SingleChronicleQueueBuilder binary(@NotNull
                                                 @NotNull File basePathFile)

fieldlessBinary

public static SingleChronicleQueueBuilder fieldlessBinary(@NotNull
                                                          @NotNull File name)

defaultZeroBinary

public static SingleChronicleQueueBuilder defaultZeroBinary(@NotNull
                                                            @NotNull File basePathFile)

deltaBinary

public static SingleChronicleQueueBuilder deltaBinary(@NotNull
                                                      @NotNull File basePathFile)

deltaBinary

public static SingleChronicleQueueBuilder deltaBinary(@NotNull
                                                      @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 @NotNull SingleChronicleQueue build()

aesEncryption

public SingleChronicleQueueBuilder aesEncryption(@Nullable
                                                 @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
                                            @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 @Nullable 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 EnterpriseSingleChronicleQueue.RB_BYTES_STORE_CREATOR_NATIVE, EnterpriseSingleChronicleQueue.RB_BYTES_STORE_CREATOR_MAPPED_FILE

Returns:

bufferBytesStoreCreator

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
                                                     @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

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

path

@NotNull
public @NotNull File path()

blockSize

public SingleChronicleQueueBuilder blockSize(long blockSize)

blockSize

public SingleChronicleQueueBuilder blockSize(int blockSize)

blockSize

public long blockSize()

Returns:

- this is the size of a memory mapping chunk, a queue is read/written by using a number of blocks, you should avoid changing this unnecessarily.

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 @NotNull SingleChronicleQueueBuilder wireType(@NotNull
                                                              @NotNull net.openhft.chronicle.wire.WireType wireType)

wireType

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

rollCycle

@NotNull
public @NotNull SingleChronicleQueueBuilder rollCycle(@NotNull
                                                               @NotNull RollCycle rollCycle)

rollCycle

@NotNull
public @NotNull RollCycle rollCycle()

bufferCapacity

public long bufferCapacity()

Returns:

ring buffer capacity in bytes [ Chronicle-Ring is an enterprise product ]

bufferCapacity

@NotNull
public @NotNull SingleChronicleQueueBuilder bufferCapacity(long bufferCapacity)

Parameters:

bufferCapacity - sets the ring buffer capacity in bytes

Returns:

this

epoch

@NotNull
public @NotNull 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 @NotNull 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. See also writeBufferMode()

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 @NotNull BufferMode writeBufferMode()

Returns:

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

writeBufferMode

public SingleChronicleQueueBuilder writeBufferMode(BufferMode writeBufferMode)

When writeBufferMode is set to Asynchronous, uses a ring buffer to buffer appends, excerpts are written to the Chronicle Queue using a background thread. See also bufferCapacity() See also bufferBytesStoreCreator() See also software.chronicle.enterprise.ring.EnterpriseRingBuffer

Parameters:

writeBufferMode - bufferMode for writing

Returns:

this

readBufferMode

public BufferMode readBufferMode()

Returns:

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

readBufferMode

public SingleChronicleQueueBuilder readBufferMode(BufferMode readBufferMode)

When readBufferMode is set to Asynchronous, reads from the ring buffer. This requires that writeBufferMode() is also set to Asynchronous. See also bufferCapacity() See also bufferBytesStoreCreator() See also software.chronicle.enterprise.ring.EnterpriseRingBuffer

Parameters:

readBufferMode - BufferMode for read

Returns:

this

eventLoop

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

ringBufferReaderCanDrain

public boolean ringBufferReaderCanDrain()

Returns:

if ring buffer reader processes can invoke the CQ drainer, otherwise only writer processes can

ringBufferReaderCanDrain

public SingleChronicleQueueBuilder ringBufferReaderCanDrain(boolean ringBufferReaderCanDrain)

ringBufferForceCreateReader

public boolean ringBufferForceCreateReader()

Returns:

whether to force creating a reader (to recover from crash)

ringBufferForceCreateReader

public SingleChronicleQueueBuilder ringBufferForceCreateReader(boolean ringBufferForceCreateReader)

ringBufferReopenReader

public boolean ringBufferReopenReader()

Returns:

if ring buffer readers are not reset on close. If true then re-opening a reader puts you back at the same place. If true, your reader can block writers if the reader is not open

ringBufferReopenReader

public SingleChronicleQueueBuilder ringBufferReopenReader(boolean ringBufferReopenReader)

drainerPriority

public net.openhft.chronicle.core.threads.HandlerPriority drainerPriority()

Priority for ring buffer's drainer handler

Returns:

drainerPriority

drainerPriority

public SingleChronicleQueueBuilder drainerPriority(net.openhft.chronicle.core.threads.HandlerPriority drainerPriority)

drainerTimeoutMS

public int drainerTimeoutMS()

drainerTimeoutMS

public SingleChronicleQueueBuilder drainerTimeoutMS(int timeout)

ringBufferPauserSupplier

public Supplier<net.openhft.chronicle.threads.Pauser> ringBufferPauserSupplier()

Pauser supplier for the pauser to be used by ring buffer when waiting

ringBufferPauser

@Deprecated
public SingleChronicleQueueBuilder ringBufferPauser(net.openhft.chronicle.threads.Pauser ringBufferPauser)

Deprecated.

ringBufferPauserSupplier

public SingleChronicleQueueBuilder ringBufferPauserSupplier(Supplier<net.openhft.chronicle.threads.Pauser> ringBufferPauserSupplier)

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)

doubleBuffer

public boolean doubleBuffer()

doubleBuffer

public SingleChronicleQueueBuilder doubleBuffer(boolean doubleBuffer)

Enables double-buffered writes on contention.

Normally, all writes to the queue will be serialized based on the write lock acquisition. Each time MarshallableOut.writingDocument() is called, appender tries to acquire the write lock on the queue, and if it fails to do so it blocks until write lock is unlocked, and in turn locks the queue for itself.

When double-buffering is enabled, if appender sees that the write lock is acquired upon MarshallableOut.writingDocument() call, it returns immediately with a context pointing to the secondary buffer, and essentially defers lock acquisition until the context.close() is called (normally with try-with-resources pattern it is at the end of the try block), allowing user to go ahead writing data, and then essentially doing memcpy on the serialized data (thus reducing cost of serialization).

This is only useful if (majority of) the objects being written to the queue are big enough AND their marshalling is not straight-forward (e.g. BytesMarshallable's marshalling is very efficient and quick and hence double-buffering will only slow things down), and if there's a heavy contention on writes (e.g. 2 or more threads writing a lot of data to the queue at a very high rate).

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
                                                   @Nullable Supplier<BiConsumer<net.openhft.chronicle.bytes.BytesStore,net.openhft.chronicle.bytes.Bytes>> encodingSupplier,
                                                   @Nullable
                                                   @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)

Parameters:

strongAppenders - by default, we create the appenders as a weak reference, these can get garbage collected. To avoid them becoming unnecessarily garbage collected, set this to true

Returns:

that

strongAppenders

public boolean strongAppenders()

Returns:

true if we are using strong appender, by default, we create the appenders in a thread-local, weak reference, these can get garbage collected. * Setting them to strong will ensure they are created using a strong reference.

checkInterrupts

public boolean checkInterrupts()

checkInterrupts

public SingleChronicleQueueBuilder checkInterrupts(boolean checkInterrupts)

clone

public SingleChronicleQueueBuilder clone()

Overrides:

clone in class Object

setAllNullFields

public SingleChronicleQueueBuilder setAllNullFields(@Nullable
                                                    @Nullable SingleChronicleQueueBuilder parentBuilder)

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

Parameters:

parentBuilder - the parentBuilder Chronicle Queue Builder

Returns:

that

appendLock

public WriteLock appendLock()