AbstractChronicleQueueBuilder (OpenHFT/Chronicle-Queue 4.16.5 API)

java.lang.Object
- net.openhft.chronicle.queue.impl.AbstractChronicleQueueBuilder

All Implemented Interfaces:: Cloneable, ChronicleQueueBuilder

Direct Known Subclasses:: SingleChronicleQueueBuilder

public abstract class AbstractChronicleQueueBuilder<B extends ChronicleQueueBuilder>
extends Object
implements ChronicleQueueBuilder<B>

Field Summary

Fields
Modifier and Type	Field and Description
`protected long`	`blockSize`
`protected CycleCalculator`	`cycleCalculator`
`protected long`	`epoch`
`protected net.openhft.chronicle.core.threads.EventLoop`	`eventLoop`
`protected File`	`path`
`protected BufferMode`	`readBufferMode`
`protected RollCycle`	`rollCycle`
`protected net.openhft.chronicle.wire.WireType`	`wireType`
`protected BufferMode`	`writeBufferMode`

Constructor Summary

Constructors
Constructor and Description

AbstractChronicleQueueBuilder(File path)

Constructors
Constructor and Description
`AbstractChronicleQueueBuilder(File path)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
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
`long`	`bufferCapacity()`
`B`	`bufferCapacity(long bufferCapacity)`
`boolean`	`buffered()` Deprecated.
`B`	`buffered(boolean isBuffered)` Deprecated.
`CycleCalculator`	`cycleCalculator()`
`AbstractChronicleQueueBuilder`	`decryptSupplier(Supplier<Cipher> decryptSupplier)`
`AbstractChronicleQueueBuilder`	`encryptSupplier(Supplier<Cipher> encryptSupplier)`
`long`	`epoch()`
`B`	`epoch(long epoch)` sets epoch offset in milliseconds
`net.openhft.chronicle.core.threads.EventLoop`	`eventLoop()`
`B`	`eventLoop(net.openhft.chronicle.core.threads.EventLoop eventLoop)`
`protected org.slf4j.Logger`	`getLogger()`
`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)` consumer will be called every second, also as there is data to report
`File`	`path()`
`Supplier<net.openhft.chronicle.threads.Pauser>`	`pauserSupplier()`
`B`	`pauserSupplier(Supplier<net.openhft.chronicle.threads.Pauser> pauser)`
`protected void`	`preBuild()`
`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)`
`StoreRecoveryFactory`	`recoverySupplier()`
`B`	`recoverySupplier(StoreRecoveryFactory recoverySupplier)`
`RollCycle`	`rollCycle()`
`B`	`rollCycle(RollCycle rollCycle)`
`B`	`rollTime(LocalTime time, ZoneId zoneId)` Resets the rollTime for the queue cycle to a new time.
`int`	`sourceId()`
`B`	`sourceId(int sourceId)`
`WireStoreFactory`	`storeFactory()`
`void`	`storeFactory(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.
`long`	`timeoutMS()`
`B`	`timeoutMS(long timeoutMS)`
`net.openhft.chronicle.core.time.TimeProvider`	`timeProvider()`
`B`	`timeProvider(net.openhft.chronicle.core.time.TimeProvider timeProvider)`
`net.openhft.chronicle.wire.WireType`	`wireType()`
`B`	`wireType(net.openhft.chronicle.wire.WireType wireType)`
`BufferMode`	`writeBufferMode()`
`B`	`writeBufferMode(BufferMode writeBufferMode)`

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.queue.ChronicleQueueBuilder
build, single, single, singleText, testBlockSize

- Field Detail
 - path
```
protected final File path
```
 - blockSize
```
protected long blockSize
```
 - wireType
```
@NotNull
protected net.openhft.chronicle.wire.WireType wireType
```
 - rollCycle
```
@NotNull
protected RollCycle rollCycle
```
 - epoch
```
protected long epoch
```
 - writeBufferMode
```
protected BufferMode writeBufferMode
```
 - readBufferMode
```
protected BufferMode readBufferMode
```
 - eventLoop
```
@Nullable
protected net.openhft.chronicle.core.threads.EventLoop eventLoop
```
 - cycleCalculator
```
@NotNull
protected CycleCalculator cycleCalculator
```
- Constructor Detail
 - AbstractChronicleQueueBuilder
```
public AbstractChronicleQueueBuilder(File path)
```
- Method Detail
 - getLogger
```
protected org.slf4j.Logger getLogger()
```
 - cycleCalculator
```
@NotNull
public CycleCalculator cycleCalculator()
```
 Specified by:
 
 cycleCalculator in interface ChronicleQueueBuilder
 - rollTime
```
public B rollTime(@NotNull
 LocalTime time,
 ZoneId zoneId)
```
 Description copied from interface: ChronicleQueueBuilder
 
 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.
 
 Specified by:
 
 rollTime in interface ChronicleQueueBuilder
 
 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
 - onRingBufferStats
```
@NotNull
public B onRingBufferStats(@NotNull
 Consumer<net.openhft.chronicle.bytes.BytesRingBufferStats> onRingBufferStats)
```
 consumer will be called every second, also as there is data to report
 
 Specified by:
 
 onRingBufferStats in interface ChronicleQueueBuilder
 
 Parameters:
 
 onRingBufferStats - a consumer of the BytesRingBufferStats
 
 Returns:
 
 this
 - onRingBufferStats
```
@NotNull
public Consumer<net.openhft.chronicle.bytes.BytesRingBufferStats> onRingBufferStats()
```
 Specified by:
 
 onRingBufferStats in interface ChronicleQueueBuilder
 - path
```
@NotNull
public File path()
```
 Specified by:
 
 path in interface ChronicleQueueBuilder
 - blockSize
```
@NotNull
public B blockSize(int blockSize)
```
 Description copied from interface: ChronicleQueueBuilder
 
 you should make sure that your largest message size is no larger than 1/4 of your block size
 
 Specified by:
 
 blockSize in interface ChronicleQueueBuilder
 
 Parameters:
 
 blockSize - the size of the off heap memory mapping
 
 Returns:
 
 that
 - blockSize
```
public long blockSize()
```
 Specified by:
 
 blockSize in interface ChronicleQueueBuilder
 - wireType
```
@NotNull
public B wireType(@NotNull
 net.openhft.chronicle.wire.WireType wireType)
```
 Specified by:
 
 wireType in interface ChronicleQueueBuilder
 - wireType
```
@NotNull
public net.openhft.chronicle.wire.WireType wireType()
```
 Specified by:
 
 wireType in interface ChronicleQueueBuilder
 - rollCycle
```
@NotNull
public B rollCycle(@NotNull
 RollCycle rollCycle)
```
 Specified by:
 
 rollCycle in interface ChronicleQueueBuilder
 - bufferCapacity
```
public long bufferCapacity()
```
 Specified by:
 
 bufferCapacity in interface ChronicleQueueBuilder
 
 Returns:
 
 ringBufferCapacity in bytes
 - bufferCapacity
```
@NotNull
public B bufferCapacity(long bufferCapacity)
```
 Specified by:
 
 bufferCapacity in interface ChronicleQueueBuilder
 
 Parameters:
 
 bufferCapacity - sets the ring buffer capacity in bytes
 
 Returns:
 
 this
 - epoch
```
@NotNull
public B epoch(long epoch)
```
 sets epoch offset in milliseconds
 
 Specified by:
 
 epoch in interface ChronicleQueueBuilder
 
 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()
```
 Specified by:
 
 epoch in interface ChronicleQueueBuilder
 
 Returns:
 
 epoch offset as the number of number of milliseconds since January 1, 1970, 00:00:00 GMT
 - rollCycle
```
@NotNull
public RollCycle rollCycle()
```
 Specified by:
 
 rollCycle in interface ChronicleQueueBuilder
 - buffered
```
@NotNull
 @Deprecated
public B 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
 
 Specified by:
 
 buffered in interface ChronicleQueueBuilder
 
 Parameters:
 
 isBuffered - true if the append is buffered
 
 Returns:
 
 this
 - buffered
```
@Deprecated
public boolean buffered()
```
 Deprecated.
 
 Specified by:
 
 buffered in interface ChronicleQueueBuilder
 
 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()
```
 Specified by:
 
 writeBufferMode in interface ChronicleQueueBuilder
 
 Returns:
 
 BufferMode to use for writes. Only None is available is the OSS
 - writeBufferMode
```
public B writeBufferMode(BufferMode writeBufferMode)
```
 Specified by:
 
 writeBufferMode in interface ChronicleQueueBuilder
 
 Parameters:
 
 writeBufferMode - to use for writes. Only None is available in OSS
 
 Returns:
 
 this
 - readBufferMode
```
public BufferMode readBufferMode()
```
 Specified by:
 
 readBufferMode in interface ChronicleQueueBuilder
 
 Returns:
 
 BufferMode to use for reads. Only None is available is the OSS
 - readBufferMode
```
public B readBufferMode(BufferMode readBufferMode)
```
 Specified by:
 
 readBufferMode in interface ChronicleQueueBuilder
 
 Parameters:
 
 readBufferMode - to use for read. Only None is available in OSS
 
 Returns:
 
 this
 - eventLoop
```
@Nullable
public net.openhft.chronicle.core.threads.EventLoop eventLoop()
```
 Specified by:
 
 eventLoop in interface ChronicleQueueBuilder
 - eventLoop
```
@NotNull
public B eventLoop(net.openhft.chronicle.core.threads.EventLoop eventLoop)
```
 Specified by:
 
 eventLoop in interface ChronicleQueueBuilder
 
 Parameters:
 
 eventLoop - to use when asynchronous buffering is used.
 
 Returns:
 
 this
 - indexCount
```
public B indexCount(int indexCount)
```
 Specified by:
 
 indexCount in interface ChronicleQueueBuilder
 - indexCount
```
public int indexCount()
```
 Specified by:
 
 indexCount in interface ChronicleQueueBuilder
 - indexSpacing
```
public B indexSpacing(int indexSpacing)
```
 Specified by:
 
 indexSpacing in interface ChronicleQueueBuilder
 - indexSpacing
```
public int indexSpacing()
```
 Specified by:
 
 indexSpacing in interface ChronicleQueueBuilder
 - timeProvider
```
public net.openhft.chronicle.core.time.TimeProvider timeProvider()
```
 - timeProvider
```
public B timeProvider(net.openhft.chronicle.core.time.TimeProvider timeProvider)
```
 - pauserSupplier
```
public Supplier<net.openhft.chronicle.threads.Pauser> pauserSupplier()
```
 - pauserSupplier
```
public B pauserSupplier(Supplier<net.openhft.chronicle.threads.Pauser> pauser)
```
 - timeoutMS
```
public B timeoutMS(long timeoutMS)
```
 - timeoutMS
```
public long timeoutMS()
```
 - storeFactory
```
public void storeFactory(WireStoreFactory storeFactory)
```
 - storeFactory
```
public WireStoreFactory storeFactory()
```
 Specified by:
 
 storeFactory in interface ChronicleQueueBuilder
 - storeFileListener
```
public B storeFileListener(StoreFileListener storeFileListener)
```
 Specified by:
 
 storeFileListener in interface ChronicleQueueBuilder
 - storeFileListener
```
public StoreFileListener storeFileListener()
```
 Specified by:
 
 storeFileListener in interface ChronicleQueueBuilder
 - sourceId
```
public B sourceId(int sourceId)
```
 - sourceId
```
public int sourceId()
```
 - recoverySupplier
```
public StoreRecoveryFactory recoverySupplier()
```
 - recoverySupplier
```
public B recoverySupplier(StoreRecoveryFactory recoverySupplier)
```
 - readOnly
```
public boolean readOnly()
```
 Specified by:
 
 readOnly in interface ChronicleQueueBuilder
 - readOnly
```
public B readOnly(boolean readOnly)
```
 Specified by:
 
 readOnly in interface ChronicleQueueBuilder
 - progressOnContention
```
public boolean progressOnContention()
```
 Specified by:
 
 progressOnContention in interface ChronicleQueueBuilder
 - progressOnContention
```
public B progressOnContention(boolean progressOnContention)
```
 Description copied from interface: ChronicleQueueBuilder
 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.
 Specified by:
 
 progressOnContention in interface ChronicleQueueBuilder
 
 Parameters:
 
 progressOnContention - leave false (default) for existing behaviour
 
 Returns:
 
 this
 - encryptSupplier
```
@NotNull
public AbstractChronicleQueueBuilder encryptSupplier(Supplier<Cipher> encryptSupplier)
```
 - decryptSupplier
```
@NotNull
public AbstractChronicleQueueBuilder decryptSupplier(Supplier<Cipher> decryptSupplier)
```
 - preBuild
```
protected void preBuild()
```
 - strongAppenders
```
public B strongAppenders(boolean strongAppenders)
```
 Description copied from interface: ChronicleQueueBuilder
 
 Hold a strong reference to any appender instead of a weak one which prevents GC if the thread and queue exists.
 
 Specified by:
 
 strongAppenders in interface ChronicleQueueBuilder
 
 Parameters:
 
 strongAppenders - use strong references if true, use weak references is false.
 
 Returns:
 
 this builder.
 - strongAppenders
```
public boolean strongAppenders()
```
 Specified by:
 
 strongAppenders in interface ChronicleQueueBuilder

Class AbstractChronicleQueueBuilder<B extends ChronicleQueueBuilder>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface net.openhft.chronicle.queue.ChronicleQueueBuilder

Field Detail

path

blockSize

wireType

rollCycle

epoch

writeBufferMode

readBufferMode

eventLoop

cycleCalculator

Constructor Detail

AbstractChronicleQueueBuilder

Method Detail

getLogger

cycleCalculator

rollTime

onRingBufferStats

onRingBufferStats

path

blockSize

blockSize

wireType

wireType

rollCycle

bufferCapacity

bufferCapacity

epoch

epoch

rollCycle

buffered

buffered

writeBufferMode

writeBufferMode

readBufferMode

readBufferMode

eventLoop

eventLoop

indexCount

indexCount

indexSpacing

indexSpacing

timeProvider

timeProvider

pauserSupplier

pauserSupplier

timeoutMS

timeoutMS

storeFactory

storeFactory

storeFileListener

storeFileListener

sourceId

sourceId

recoverySupplier

recoverySupplier

readOnly

readOnly

progressOnContention

progressOnContention

encryptSupplier

decryptSupplier

preBuild

strongAppenders

strongAppenders