AbstractChronicleQueueBuilder (OpenHFT/Chronicle-Queue 4.4.0 API)

java.lang.Object
- net.openhft.chronicle.queue.impl.AbstractChronicleQueueBuilder<B,Q>

All Implemented Interfaces:: Cloneable, ChronicleQueueBuilder<B,Q>

Direct Known Subclasses:: SingleChronicleQueueBuilder

public abstract class AbstractChronicleQueueBuilder<B extends ChronicleQueueBuilder<B,Q>,Q extends ChronicleQueue>
extends Object
implements ChronicleQueueBuilder<B,Q>

Created by peter on 05/03/2016.

Field Summary

Fields
Modifier and Type	Field and Description
`protected long`	`blockSize`
`protected long`	`epoch`
`protected net.openhft.chronicle.core.threads.EventLoop`	`eventLoop`
`protected boolean`	`isBuffered`
`protected java.util.function.Consumer<Throwable>`	`onThrowable`
`protected File`	`path`
`protected RollCycle`	`rollCycle`
`protected net.openhft.chronicle.wire.WireType`	`wireType`

Constructor Summary

Constructors
Constructor and Description

AbstractChronicleQueueBuilder(File path)

Constructors
Constructor and Description
`AbstractChronicleQueueBuilder(File path)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`long`	`blockSize()`
`B`	`blockSize(int blockSize)`
`long`	`bufferCapacity()`
`B`	`bufferCapacity(int bufferCapacity)` setting the `bufferCapacity` also sets `buffered` to `true`
`B`	`bufferCapacity(long ringBufferSize)`
`boolean`	`buffered()`
`B`	`buffered(boolean isBuffered)` when set to `true`.
`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)`
`java.util.function.Consumer<net.openhft.chronicle.bytes.BytesRingBufferStats>`	`onRingBufferStats()`
`B`	`onRingBufferStats(java.util.function.Consumer<net.openhft.chronicle.bytes.BytesRingBufferStats> onRingBufferStats)` consumer will be called every second, also as there is data to report
`B`	`onThrowable(java.util.function.Consumer<Throwable> onThrowable)` use this to trap exceptions that came from the other threads
`File`	`path()`
`java.util.function.Supplier<net.openhft.chronicle.threads.Pauser>`	`pauserSupplier()`
`B`	`pauserSupplier(java.util.function.Supplier<net.openhft.chronicle.threads.Pauser> pauser)`
`RollCycle`	`rollCycle()`
`B`	`rollCycle(RollCycle rollCycle)`
`int`	`sourceId()`
`B`	`sourceId(int sourceId)`
`java.util.function.BiFunction<RollingChronicleQueue,net.openhft.chronicle.wire.Wire,WireStore>`	`storeFactory()`
`void`	`storeFactory(java.util.function.BiFunction<RollingChronicleQueue,net.openhft.chronicle.wire.Wire,WireStore> storeFactory)`
`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)`

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, singleText

- 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
```
 - isBuffered
```
protected boolean isBuffered
```
 - onThrowable
```
protected java.util.function.Consumer<Throwable> onThrowable
```
 - eventLoop
```
@Nullable
protected net.openhft.chronicle.core.threads.EventLoop eventLoop
```
- Constructor Detail
 - AbstractChronicleQueueBuilder
```
public AbstractChronicleQueueBuilder(File path)
```
- Method Detail
 - getLogger
```
protected org.slf4j.Logger getLogger()
```
 - onRingBufferStats
```
@NotNull
public B onRingBufferStats(@NotNull
 java.util.function.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,Q extends ChronicleQueue>
 
 Parameters:
 
 onRingBufferStats - a consumer of the BytesRingBufferStats
 
 Returns:
 
 this
 - onRingBufferStats
```
public java.util.function.Consumer<net.openhft.chronicle.bytes.BytesRingBufferStats> onRingBufferStats()
```
 Specified by:
 
 onRingBufferStats in interface ChronicleQueueBuilder,Q extends ChronicleQueue>
 - path
```
@NotNull
public File path()
```
 Specified by:
 
 path in interface ChronicleQueueBuilder,Q extends ChronicleQueue>
 - blockSize
```
@NotNull
public B blockSize(int blockSize)
```
 Specified by:
 
 blockSize in interface ChronicleQueueBuilder,Q extends ChronicleQueue>
 - blockSize
```
public long blockSize()
```
 Specified by:
 
 blockSize in interface ChronicleQueueBuilder,Q extends ChronicleQueue>
 - wireType
```
@NotNull
public B wireType(@NotNull
 net.openhft.chronicle.wire.WireType wireType)
```
 Specified by:
 
 wireType in interface ChronicleQueueBuilder,Q extends ChronicleQueue>
 - wireType
```
@NotNull
public net.openhft.chronicle.wire.WireType wireType()
```
 Specified by:
 
 wireType in interface ChronicleQueueBuilder,Q extends ChronicleQueue>
 - rollCycle
```
@NotNull
public B rollCycle(@NotNull
 RollCycle rollCycle)
```
 Specified by:
 
 rollCycle in interface ChronicleQueueBuilder,Q extends ChronicleQueue>
 - bufferCapacity
```
public long bufferCapacity()
```
 Specified by:
 
 bufferCapacity in interface ChronicleQueueBuilder,Q extends ChronicleQueue>
 
 Returns:
 
 ringBufferCapacity in bytes
 - bufferCapacity
```
@NotNull
public B bufferCapacity(long ringBufferSize)
```
 Specified by:
 
 bufferCapacity in interface ChronicleQueueBuilder,Q extends ChronicleQueue>
 
 Parameters:
 
 ringBufferSize - 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,Q extends ChronicleQueue>
 
 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,Q extends ChronicleQueue>
 
 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,Q extends ChronicleQueue>
 - onThrowable
```
@NotNull
public B onThrowable(@NotNull
 java.util.function.Consumer<Throwable> onThrowable)
```
 use this to trap exceptions that came from the other threads
 
 Specified by:
 
 onThrowable in interface ChronicleQueueBuilder,Q extends ChronicleQueue>
 
 Parameters:
 
 onThrowable - your exception handler
 
 Returns:
 
 this
 - buffered
```
@NotNull
public B buffered(boolean isBuffered)
```
 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,Q extends ChronicleQueue>
 
 Parameters:
 
 isBuffered - true if the append is buffered
 
 Returns:
 
 this
 - buffered
```
public boolean buffered()
```
 Specified by:
 
 buffered in interface ChronicleQueueBuilder,Q extends ChronicleQueue>
 
 Returns:
 
 if we uses a ring buffer to buffer the appends, the Excerts are written to the Chronicle Queue using a background thread
 - eventLoop
```
@Nullable
public net.openhft.chronicle.core.threads.EventLoop eventLoop()
```
 Specified by:
 
 eventLoop in interface ChronicleQueueBuilder,Q extends ChronicleQueue>
 - eventLoop
```
@NotNull
public B eventLoop(net.openhft.chronicle.core.threads.EventLoop eventLoop)
```
 Specified by:
 
 eventLoop in interface ChronicleQueueBuilder,Q extends ChronicleQueue>
 - bufferCapacity
```
@NotNull
public B bufferCapacity(int bufferCapacity)
```
 setting the bufferCapacity also sets buffered to true
 
 Specified by:
 
 bufferCapacity in interface ChronicleQueueBuilder,Q extends ChronicleQueue>
 
 Parameters:
 
 bufferCapacity - the capacity of the ring buffer
 
 Returns:
 
 this
 - indexCount
```
public B indexCount(int indexCount)
```
 Specified by:
 
 indexCount in interface ChronicleQueueBuilder,Q extends ChronicleQueue>
 - indexCount
```
public int indexCount()
```
 Specified by:
 
 indexCount in interface ChronicleQueueBuilder,Q extends ChronicleQueue>
 - indexSpacing
```
public B indexSpacing(int indexSpacing)
```
 Specified by:
 
 indexSpacing in interface ChronicleQueueBuilder,Q extends ChronicleQueue>
 - indexSpacing
```
public int indexSpacing()
```
 Specified by:
 
 indexSpacing in interface ChronicleQueueBuilder,Q extends ChronicleQueue>
 - timeProvider
```
public net.openhft.chronicle.core.time.TimeProvider timeProvider()
```
 - timeProvider
```
public B timeProvider(net.openhft.chronicle.core.time.TimeProvider timeProvider)
```
 - pauserSupplier
```
public java.util.function.Supplier<net.openhft.chronicle.threads.Pauser> pauserSupplier()
```
 - pauserSupplier
```
public B pauserSupplier(java.util.function.Supplier<net.openhft.chronicle.threads.Pauser> pauser)
```
 - timeoutMS
```
public B timeoutMS(long timeoutMS)
```
 - timeoutMS
```
public long timeoutMS()
```
 - storeFactory
```
public void storeFactory(java.util.function.BiFunction<RollingChronicleQueue,net.openhft.chronicle.wire.Wire,WireStore> storeFactory)
```
 - storeFactory
```
public java.util.function.BiFunction<RollingChronicleQueue,net.openhft.chronicle.wire.Wire,WireStore> storeFactory()
```
 Specified by:
 
 storeFactory in interface ChronicleQueueBuilder,Q extends ChronicleQueue>
 - sourceId
```
public B sourceId(int sourceId)
```
 - sourceId
```
public int sourceId()
```

Class AbstractChronicleQueueBuilder<B extends ChronicleQueueBuilder<B,Q>,Q extends ChronicleQueue>

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

isBuffered

onThrowable

eventLoop

Constructor Detail

AbstractChronicleQueueBuilder

Method Detail

getLogger

onRingBufferStats

onRingBufferStats

path

blockSize

blockSize

wireType

wireType

rollCycle

bufferCapacity

bufferCapacity

epoch

epoch

rollCycle

onThrowable

buffered

buffered

eventLoop

eventLoop

bufferCapacity

indexCount

indexCount

indexSpacing

indexSpacing

timeProvider

timeProvider

pauserSupplier

pauserSupplier

timeoutMS

timeoutMS

storeFactory

storeFactory

sourceId

sourceId