SingleChronicleQueueBuilder (OpenHFT/Chronicle-Queue 5.16.0 API)

java.lang.Object
- net.openhft.chronicle.queue.impl.AbstractChronicleQueueBuilder<SingleChronicleQueueBuilder<S>>
- - net.openhft.chronicle.queue.impl.single.SingleChronicleQueueBuilder<S>

All Implemented Interfaces:: Cloneable, ChronicleQueueBuilder<SingleChronicleQueueBuilder<S>>

public class SingleChronicleQueueBuilder<S extends SingleChronicleQueueBuilder>
extends AbstractChronicleQueueBuilder<SingleChronicleQueueBuilder<S>>

Field Summary
- Fields inherited from class net.openhft.chronicle.queue.impl.AbstractChronicleQueueBuilder
  blockSize, cycleCalculator, epoch, eventLoop, path, readBufferMode, rollCycle, wireType, writeBufferMode

Constructor Summary

Constructors
Constructor and Description

SingleChronicleQueueBuilder(File path)
Deprecated.

SingleChronicleQueueBuilder(String path)
Deprecated.

Constructors
Constructor and Description
`SingleChronicleQueueBuilder(File path)` Deprecated.
`SingleChronicleQueueBuilder(String path)` Deprecated.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
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)`
`SingleChronicleQueueBuilder<S>`	`blockSize(int blockSize)` you should make sure that your largest message size is no larger than 1/4 of your block size
`SingleChronicleQueueBuilder<S>`	`bufferCapacity(long bufferCapacity)`
`SingleChronicleQueueBuilder<S>`	`buffered(boolean isBuffered)` when set to `true`.
`SingleChronicleQueue`	`build()`
`static SingleChronicleQueueBuilder`	`builder(File file, net.openhft.chronicle.wire.WireType wireType)`
`static <S extends SingleChronicleQueueBuilder<S>> SingleChronicleQueueBuilder<S>`	`builder(Path path, net.openhft.chronicle.wire.WireType wireType)`
`SingleChronicleQueueBuilder<S>`	`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)`
`Supplier<BiConsumer<net.openhft.chronicle.bytes.BytesStore,net.openhft.chronicle.bytes.Bytes>>`	`encodingSupplier()`
`SingleChronicleQueueBuilder<S>`	`epoch(long epoch)` sets epoch offset in milliseconds
`SingleChronicleQueueBuilder<S>`	`eventLoop(net.openhft.chronicle.core.threads.EventLoop eventLoop)`
`static SingleChronicleQueueBuilder`	`fieldlessBinary(File name)`
`SingleChronicleQueueBuilder<S>`	`indexCount(int indexCount)`
`SingleChronicleQueueBuilder<S>`	`indexSpacing(int indexSpacing)`
`static void`	`init()`
`SingleChronicleQueueBuilder<S>`	`pauserSupplier(Supplier<net.openhft.chronicle.threads.Pauser> pauser)`
`protected QueueLock`	`queueLock()`
`SingleChronicleQueueBuilder<S>`	`readBufferMode(BufferMode readBufferMode)`
`SingleChronicleQueueBuilder<S>`	`readOnly(boolean readOnly)`
`SingleChronicleQueueBuilder<S>`	`recoverySupplier(StoreRecoveryFactory recoverySupplier)`
`SingleChronicleQueueBuilder<S>`	`rollCycle(RollCycle rollCycle)`
`SingleChronicleQueueBuilder<S>`	`rollTime(LocalTime time, ZoneId zoneId)` Resets the rollTime for the queue cycle to a new time.
`SingleChronicleQueueBuilder<S>`	`sourceId(int sourceId)`
`SingleChronicleQueueBuilder<S>`	`storeFileListener(StoreFileListener storeFileListener)`
`SingleChronicleQueueBuilder<S>`	`testBlockSize()` THIS IS FOR TESTING ONLY.
`static SingleChronicleQueueBuilder`	`text(File name)` Deprecated.
`SingleChronicleQueueBuilder<S>`	`timeoutMS(long timeoutMS)`
`SingleChronicleQueueBuilder<S>`	`timeProvider(net.openhft.chronicle.core.time.TimeProvider timeProvider)`
`SingleChronicleQueueBuilder<S>`	`wireType(net.openhft.chronicle.wire.WireType wireType)`
`SingleChronicleQueueBuilder<S>`	`writeBufferMode(BufferMode writeBufferMode)`
`protected WriteLock`	`writeLock()`

Methods inherited from class net.openhft.chronicle.queue.impl.AbstractChronicleQueueBuilder
blockSize, bufferCapacity, buffered, cycleCalculator, decryptSupplier, encryptSupplier, epoch, eventLoop, getLogger, indexCount, indexSpacing, onRingBufferStats, onRingBufferStats, path, pauserSupplier, preBuild, readBufferMode, readOnly, recoverySupplier, rollCycle, sourceId, storeFactory, storeFactory, storeFileListener, strongAppenders, strongAppenders, timeoutMS, timeProvider, wireType, 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.queue.ChronicleQueueBuilder
single, single, singleText

- Constructor Detail
  - SingleChronicleQueueBuilder
```
@Deprecated
public SingleChronicleQueueBuilder(@NotNull
                                               String path)
```
    Deprecated.
  - SingleChronicleQueueBuilder
```
@Deprecated
public SingleChronicleQueueBuilder(@NotNull
                                               File path)
```
    Deprecated.
- Method Detail
  - addAliases
```
public static void addAliases()
```
  - init
```
public static void init()
```
  - builder
```
@NotNull
public static <S extends SingleChronicleQueueBuilder<S>> SingleChronicleQueueBuilder<S> 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)
```
  - binary
```
@NotNull
public static SingleChronicleQueueBuilder binary(@NotNull
                                                          Path path)
```
  - binary
```
@NotNull
public static SingleChronicleQueueBuilder binary(@NotNull
                                                          String basePath)
```
  - binary
```
@NotNull
public static SingleChronicleQueueBuilder binary(@NotNull
                                                          File basePathFile)
```
  - fieldlessBinary
```
@NotNull
public static SingleChronicleQueueBuilder fieldlessBinary(@NotNull
                                                                   File name)
```
  - defaultZeroBinary
```
@NotNull
public static SingleChronicleQueueBuilder defaultZeroBinary(@NotNull
                                                                     File basePathFile)
```
  - deltaBinary
```
@NotNull
public static SingleChronicleQueueBuilder deltaBinary(@NotNull
                                                               File basePathFile)
```
  - text
```
@Deprecated
 @NotNull
public static SingleChronicleQueueBuilder text(@NotNull
                                                                     File name)
```
    Deprecated.
  - build
```
@NotNull
public SingleChronicleQueue build()
```
  - clone
```
@NotNull
public SingleChronicleQueueBuilder<S> clone()
```
    Overrides:
    
    clone in class Object
  - encodingSupplier
```
@Nullable
public Supplier<BiConsumer<net.openhft.chronicle.bytes.BytesStore,net.openhft.chronicle.bytes.Bytes>> encodingSupplier()
```
  - decodingSupplier
```
@Nullable
public Supplier<BiConsumer<net.openhft.chronicle.bytes.BytesStore,net.openhft.chronicle.bytes.Bytes>> decodingSupplier()
```
  - aesEncryption
```
@NotNull
public SingleChronicleQueueBuilder aesEncryption(@Nullable
                                                          byte[] keyBytes)
```
  - codingSuppliers
```
@NotNull
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)
```
  - testBlockSize
```
@NotNull
public SingleChronicleQueueBuilder<S> testBlockSize()
```
    Description copied from interface: ChronicleQueueBuilder
    
    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
  - sourceId
```
public SingleChronicleQueueBuilder<S> sourceId(int sourceId)
```
    Overrides:
    
    sourceId in class AbstractChronicleQueueBuilder<SingleChronicleQueueBuilder<S extends SingleChronicleQueueBuilder>>
  - blockSize
```
@NotNull
public SingleChronicleQueueBuilder<S> 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<SingleChronicleQueueBuilder<S extends SingleChronicleQueueBuilder>>
    
    Overrides:
    
    blockSize in class AbstractChronicleQueueBuilder<SingleChronicleQueueBuilder<S extends SingleChronicleQueueBuilder>>
    
    Parameters:
    
    blockSize - the size of the off heap memory mapping
    
    Returns:
    
    that
  - wireType
```
@NotNull
public SingleChronicleQueueBuilder<S> wireType(@NotNull
                                                        net.openhft.chronicle.wire.WireType wireType)
```
    Specified by:
    
    wireType in interface ChronicleQueueBuilder<SingleChronicleQueueBuilder<S extends SingleChronicleQueueBuilder>>
    
    Overrides:
    
    wireType in class AbstractChronicleQueueBuilder<SingleChronicleQueueBuilder<S extends SingleChronicleQueueBuilder>>
  - rollCycle
```
@NotNull
public SingleChronicleQueueBuilder<S> rollCycle(@NotNull
                                                         RollCycle rollCycle)
```
    Specified by:
    
    rollCycle in interface ChronicleQueueBuilder<SingleChronicleQueueBuilder<S extends SingleChronicleQueueBuilder>>
    
    Overrides:
    
    rollCycle in class AbstractChronicleQueueBuilder<SingleChronicleQueueBuilder<S extends SingleChronicleQueueBuilder>>
  - bufferCapacity
```
@NotNull
public SingleChronicleQueueBuilder<S> bufferCapacity(long bufferCapacity)
```
    Specified by:
    
    bufferCapacity in interface ChronicleQueueBuilder<SingleChronicleQueueBuilder<S extends SingleChronicleQueueBuilder>>
    
    Overrides:
    
    bufferCapacity in class AbstractChronicleQueueBuilder<SingleChronicleQueueBuilder<S extends SingleChronicleQueueBuilder>>
    
    Parameters:
    
    bufferCapacity - sets the ring buffer capacity in bytes
    
    Returns:
    
    this
  - epoch
```
@NotNull
public SingleChronicleQueueBuilder<S> epoch(long epoch)
```
    Description copied from class: AbstractChronicleQueueBuilder
    
    sets epoch offset in milliseconds
    
    Specified by:
    
    epoch in interface ChronicleQueueBuilder<SingleChronicleQueueBuilder<S extends SingleChronicleQueueBuilder>>
    
    Overrides:
    
    epoch in class AbstractChronicleQueueBuilder<SingleChronicleQueueBuilder<S extends SingleChronicleQueueBuilder>>
    
    Parameters:
    
    epoch - sets an epoch offset as the number of number of milliseconds since January 1, 1970, 00:00:00 GMT
    
    Returns:
    
    this
  - buffered
```
@NotNull
public SingleChronicleQueueBuilder<S> buffered(boolean isBuffered)
```
    Description copied from class: AbstractChronicleQueueBuilder
    
    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<SingleChronicleQueueBuilder<S extends SingleChronicleQueueBuilder>>
    
    Overrides:
    
    buffered in class AbstractChronicleQueueBuilder<SingleChronicleQueueBuilder<S extends SingleChronicleQueueBuilder>>
    
    Parameters:
    
    isBuffered - true if the append is buffered
    
    Returns:
    
    this
  - writeBufferMode
```
public SingleChronicleQueueBuilder<S> writeBufferMode(BufferMode writeBufferMode)
```
    Specified by:
    
    writeBufferMode in interface ChronicleQueueBuilder<SingleChronicleQueueBuilder<S extends SingleChronicleQueueBuilder>>
    
    Overrides:
    
    writeBufferMode in class AbstractChronicleQueueBuilder<SingleChronicleQueueBuilder<S extends SingleChronicleQueueBuilder>>
    
    Parameters:
    
    writeBufferMode - to use for writes. Only None is available in OSS
    
    Returns:
    
    this
  - readBufferMode
```
public SingleChronicleQueueBuilder<S> readBufferMode(BufferMode readBufferMode)
```
    Specified by:
    
    readBufferMode in interface ChronicleQueueBuilder<SingleChronicleQueueBuilder<S extends SingleChronicleQueueBuilder>>
    
    Overrides:
    
    readBufferMode in class AbstractChronicleQueueBuilder<SingleChronicleQueueBuilder<S extends SingleChronicleQueueBuilder>>
    
    Parameters:
    
    readBufferMode - to use for read. Only None is available in OSS
    
    Returns:
    
    this
  - eventLoop
```
@NotNull
public SingleChronicleQueueBuilder<S> eventLoop(net.openhft.chronicle.core.threads.EventLoop eventLoop)
```
    Specified by:
    
    eventLoop in interface ChronicleQueueBuilder<SingleChronicleQueueBuilder<S extends SingleChronicleQueueBuilder>>
    
    Overrides:
    
    eventLoop in class AbstractChronicleQueueBuilder<SingleChronicleQueueBuilder<S extends SingleChronicleQueueBuilder>>
    
    Parameters:
    
    eventLoop - to use when asynchronous buffering is used.
    
    Returns:
    
    this
  - indexCount
```
public SingleChronicleQueueBuilder<S> indexCount(int indexCount)
```
    Specified by:
    
    indexCount in interface ChronicleQueueBuilder<SingleChronicleQueueBuilder<S extends SingleChronicleQueueBuilder>>
    
    Overrides:
    
    indexCount in class AbstractChronicleQueueBuilder<SingleChronicleQueueBuilder<S extends SingleChronicleQueueBuilder>>
  - indexSpacing
```
public SingleChronicleQueueBuilder<S> indexSpacing(int indexSpacing)
```
    Specified by:
    
    indexSpacing in interface ChronicleQueueBuilder<SingleChronicleQueueBuilder<S extends SingleChronicleQueueBuilder>>
    
    Overrides:
    
    indexSpacing in class AbstractChronicleQueueBuilder<SingleChronicleQueueBuilder<S extends SingleChronicleQueueBuilder>>
  - timeProvider
```
public SingleChronicleQueueBuilder<S> timeProvider(net.openhft.chronicle.core.time.TimeProvider timeProvider)
```
    Overrides:
    
    timeProvider in class AbstractChronicleQueueBuilder<SingleChronicleQueueBuilder<S extends SingleChronicleQueueBuilder>>
  - pauserSupplier
```
public SingleChronicleQueueBuilder<S> pauserSupplier(Supplier<net.openhft.chronicle.threads.Pauser> pauser)
```
    Overrides:
    
    pauserSupplier in class AbstractChronicleQueueBuilder<SingleChronicleQueueBuilder<S extends SingleChronicleQueueBuilder>>
  - timeoutMS
```
public SingleChronicleQueueBuilder<S> timeoutMS(long timeoutMS)
```
    Overrides:
    
    timeoutMS in class AbstractChronicleQueueBuilder<SingleChronicleQueueBuilder<S extends SingleChronicleQueueBuilder>>
  - readOnly
```
public SingleChronicleQueueBuilder<S> readOnly(boolean readOnly)
```
    Specified by:
    
    readOnly in interface ChronicleQueueBuilder<SingleChronicleQueueBuilder<S extends SingleChronicleQueueBuilder>>
    
    Overrides:
    
    readOnly in class AbstractChronicleQueueBuilder<SingleChronicleQueueBuilder<S extends SingleChronicleQueueBuilder>>
  - storeFileListener
```
public SingleChronicleQueueBuilder<S> storeFileListener(StoreFileListener storeFileListener)
```
    Specified by:
    
    storeFileListener in interface ChronicleQueueBuilder<SingleChronicleQueueBuilder<S extends SingleChronicleQueueBuilder>>
    
    Overrides:
    
    storeFileListener in class AbstractChronicleQueueBuilder<SingleChronicleQueueBuilder<S extends SingleChronicleQueueBuilder>>
  - recoverySupplier
```
public SingleChronicleQueueBuilder<S> recoverySupplier(StoreRecoveryFactory recoverySupplier)
```
    Overrides:
    
    recoverySupplier in class AbstractChronicleQueueBuilder<SingleChronicleQueueBuilder<S extends SingleChronicleQueueBuilder>>
  - rollTime
```
public SingleChronicleQueueBuilder<S> 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<SingleChronicleQueueBuilder<S extends SingleChronicleQueueBuilder>>
    
    Overrides:
    
    rollTime in class AbstractChronicleQueueBuilder<SingleChronicleQueueBuilder<S extends SingleChronicleQueueBuilder>>
    
    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
  - queueLock
```
@NotNull
protected QueueLock queueLock()
```
  - writeLock
```
@NotNull
protected WriteLock writeLock()
```

Class SingleChronicleQueueBuilder<S extends SingleChronicleQueueBuilder>

Field Summary

Fields inherited from class net.openhft.chronicle.queue.impl.AbstractChronicleQueueBuilder

Constructor Summary

Method Summary

Methods inherited from class net.openhft.chronicle.queue.impl.AbstractChronicleQueueBuilder

Methods inherited from class java.lang.Object

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

Constructor Detail

SingleChronicleQueueBuilder

SingleChronicleQueueBuilder

Method Detail

addAliases

init

builder

builder

binary

binary

binary

fieldlessBinary

defaultZeroBinary

deltaBinary

text

build

clone

encodingSupplier

decodingSupplier

aesEncryption

codingSuppliers

testBlockSize

sourceId

blockSize

wireType

rollCycle

bufferCapacity

epoch

buffered

writeBufferMode

readBufferMode

eventLoop

indexCount

indexSpacing

timeProvider

pauserSupplier

timeoutMS

readOnly

storeFileListener

recoverySupplier

rollTime

queueLock

writeLock