net.openhft.chronicle.queue.impl.single

Class SingleChronicleQueueBuilder

java.lang.Object

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

All Implemented Interfaces:

Cloneable, ChronicleQueueBuilder, SingleChronicleQueueFields

public class SingleChronicleQueueBuilder
extends Object
implements ChronicleQueueBuilder, SingleChronicleQueueFields

Constructor Summary

Constructors

Modifier	Constructor and Description
	SingleChronicleQueueBuilder(File path)
protected	SingleChronicleQueueBuilder(File path, ExcerptFactory<SingleChronicleQueue> excerptFactory)
	SingleChronicleQueueBuilder(String path)
protected	SingleChronicleQueueBuilder(String path, ExcerptFactory<SingleChronicleQueue> excerptFactory)

Method Summary

Modifier and Type	Method and Description
static SingleChronicleQueueBuilder	binary(File name)
long	blockSize()
SingleChronicleQueueBuilder	blockSize(int blockSize)
long	bufferCapacity()
SingleChronicleQueueBuilder	bufferCapacity(int bufferCapacity) setting the bufferCapacity also sets buffered to true
SingleChronicleQueueBuilder	bufferCapacity(long ringBufferSize)
boolean	buffered()
SingleChronicleQueueBuilder	buffered(boolean isBuffered) when set to true.
ChronicleQueue	build()
SingleChronicleQueueBuilder	clone()
long	epoch()
SingleChronicleQueueBuilder	epoch(long epoch) sets epoch offset in milliseconds
net.openhft.chronicle.threads.api.EventLoop	eventLoop()
SingleChronicleQueueBuilder	eventLoop(net.openhft.chronicle.threads.api.EventLoop eventLoop)
ExcerptFactory<SingleChronicleQueue>	excertpFactory()
SingleChronicleQueueBuilder	excertpFactory(ExcerptFactory<SingleChronicleQueue> excerptFactory)
java.util.function.Consumer<net.openhft.chronicle.bytes.BytesRingBufferStats>	onRingBufferStats()
SingleChronicleQueueBuilder	onRingBufferStats(java.util.function.Consumer<net.openhft.chronicle.bytes.BytesRingBufferStats> onRingBufferStats) consumer will be called every second, also as there is data to report
SingleChronicleQueueBuilder	onThrowable(java.util.function.Consumer<Throwable> onThrowable) use this to trap exceptions that came from the other threads
File	path()
static SingleChronicleQueueBuilder	raw(File name)
RollCycle	rollCycle()
SingleChronicleQueueBuilder	rollCycle(RollCycle rollCycle)
static SingleChronicleQueueBuilder	text(File name)
net.openhft.chronicle.wire.WireType	wireType()
SingleChronicleQueueBuilder	wireType(net.openhft.chronicle.wire.WireType wireType)

Methods inherited from class java.lang.Object

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

Constructor Detail

SingleChronicleQueueBuilder

public SingleChronicleQueueBuilder(@NotNull
                                   String path)

SingleChronicleQueueBuilder

protected SingleChronicleQueueBuilder(@NotNull
                                      String path,
                                      @NotNull
                                      ExcerptFactory<SingleChronicleQueue> excerptFactory)

SingleChronicleQueueBuilder

public SingleChronicleQueueBuilder(@NotNull
                                   File path)

SingleChronicleQueueBuilder

protected SingleChronicleQueueBuilder(@NotNull
                                      File path,
                                      @NotNull
                                      ExcerptFactory<SingleChronicleQueue> excerptFactory)

Method Detail

binary

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

text

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

raw

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

onRingBufferStats

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

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 SingleChronicleQueueFields

path

@NotNull
public File path()

Specified by:

path in interface SingleChronicleQueueFields

blockSize

@NotNull
public SingleChronicleQueueBuilder blockSize(int blockSize)

blockSize

public long blockSize()

Specified by:

blockSize in interface SingleChronicleQueueFields

wireType

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

wireType

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

Specified by:

wireType in interface SingleChronicleQueueFields

rollCycle

@NotNull
public SingleChronicleQueueBuilder rollCycle(@NotNull
                                                      RollCycle rollCycle)

bufferCapacity

public long bufferCapacity()

Specified by:

bufferCapacity in interface SingleChronicleQueueFields

Returns:

ringBufferCapacity in bytes

bufferCapacity

@NotNull
public SingleChronicleQueueBuilder bufferCapacity(long ringBufferSize)

Parameters:

ringBufferSize - 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()

Specified by:

epoch in interface SingleChronicleQueueFields

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 SingleChronicleQueueFields

excertpFactory

@NotNull
public SingleChronicleQueueBuilder excertpFactory(@NotNull
                                                           ExcerptFactory<SingleChronicleQueue> excerptFactory)

excertpFactory

public ExcerptFactory<SingleChronicleQueue> excertpFactory()

build

@NotNull
public ChronicleQueue build()

Specified by:

build in interface ChronicleQueueBuilder

clone

@NotNull
public SingleChronicleQueueBuilder clone()

Overrides:

clone in class Object

onThrowable

@NotNull
public SingleChronicleQueueBuilder onThrowable(@NotNull
                                                        java.util.function.Consumer<Throwable> onThrowable)

use this to trap exceptions that came from the other threads

Parameters:

onThrowable - your exception handler

Returns:

this

buffered

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

Parameters:

isBuffered - true if the append is buffered

Returns:

this

buffered

public boolean buffered()

Specified by:

buffered in interface SingleChronicleQueueFields

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.threads.api.EventLoop eventLoop()

Specified by:

eventLoop in interface SingleChronicleQueueFields

eventLoop

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

bufferCapacity

@NotNull
public SingleChronicleQueueBuilder bufferCapacity(int bufferCapacity)

setting the bufferCapacity also sets buffered to true

Parameters:

bufferCapacity - the capacity of the ring buffer

Returns:

this