net.openhft.chronicle.queue.impl

Class AbstractChronicleQueueBuilder<B extends ChronicleQueueBuilder>

java.lang.Object

net.openhft.chronicle.queue.impl.AbstractChronicleQueueBuilder<B>

All Implemented Interfaces:

Cloneable, ChronicleQueueBuilder<B>

Direct Known Subclasses:

SingleChronicleQueueBuilder

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

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

Method Summary

Modifier and Type	Method and Description
long	blockSize()
B	blockSize(int blockSize)
long	bufferCapacity()
B	bufferCapacity(long bufferCapacity)
boolean	buffered() Deprecated.
B	buffered(boolean isBuffered) Deprecated.
AbstractChronicleQueueBuilder	decryptSupplier(java.util.function.Supplier<Cipher> decryptSupplier)
AbstractChronicleQueueBuilder	encryptSupplier(java.util.function.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)
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
File	path()
java.util.function.Supplier<net.openhft.chronicle.threads.Pauser>	pauserSupplier()
B	pauserSupplier(java.util.function.Supplier<net.openhft.chronicle.threads.Pauser> pauser)
BufferMode	readBufferMode()
B	readBufferMode(BufferMode readBufferMode)
boolean	readOnly()
B	readOnly(boolean readOnly)
StoreRecoveryFactory	recoverySupplier()
B	recoverySupplier(StoreRecoveryFactory recoverySupplier)
RollCycle	rollCycle()
B	rollCycle(RollCycle rollCycle)
int	sourceId()
B	sourceId(int sourceId)
WireStoreFactory	storeFactory()
void	storeFactory(WireStoreFactory storeFactory)
StoreFileListener	storeFileListener()
B	storeFileListener(StoreFileListener storeFileListener)
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

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<B extends ChronicleQueueBuilder>

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<B extends ChronicleQueueBuilder>

path

@NotNull
public File path()

Specified by:

path in interface ChronicleQueueBuilder<B extends ChronicleQueueBuilder>

blockSize

@NotNull
public B blockSize(int blockSize)

Specified by:

blockSize in interface ChronicleQueueBuilder<B extends ChronicleQueueBuilder>

blockSize

public long blockSize()

Specified by:

blockSize in interface ChronicleQueueBuilder<B extends ChronicleQueueBuilder>

wireType

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

Specified by:

wireType in interface ChronicleQueueBuilder<B extends ChronicleQueueBuilder>

wireType

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

Specified by:

wireType in interface ChronicleQueueBuilder<B extends ChronicleQueueBuilder>

rollCycle

@NotNull
public B rollCycle(@NotNull
                            RollCycle rollCycle)

Specified by:

rollCycle in interface ChronicleQueueBuilder<B extends ChronicleQueueBuilder>

bufferCapacity

public long bufferCapacity()

Specified by:

bufferCapacity in interface ChronicleQueueBuilder<B extends ChronicleQueueBuilder>

Returns:

ringBufferCapacity in bytes

bufferCapacity

@NotNull
public B bufferCapacity(long bufferCapacity)

Specified by:

bufferCapacity in interface ChronicleQueueBuilder<B extends 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<B extends 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<B extends 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<B extends 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<B extends ChronicleQueueBuilder>

Parameters:

isBuffered - true if the append is buffered

Returns:

this

buffered

@Deprecated
public boolean buffered()

Deprecated.

Specified by:

buffered in interface ChronicleQueueBuilder<B extends ChronicleQueueBuilder>

Returns:

if we uses a ring buffer to buffer the appends, the Excerts are written to the Chronicle Queue using a background thread

writeBufferMode

public BufferMode writeBufferMode()

Specified by:

writeBufferMode in interface ChronicleQueueBuilder<B extends 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<B extends 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<B extends 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<B extends 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<B extends ChronicleQueueBuilder>

eventLoop

@NotNull
public B eventLoop(net.openhft.chronicle.core.threads.EventLoop eventLoop)

Specified by:

eventLoop in interface ChronicleQueueBuilder<B extends ChronicleQueueBuilder>

Parameters:

eventLoop - to use when asynchronous buffering is used.

Returns:

this

indexCount

public B indexCount(int indexCount)

Specified by:

indexCount in interface ChronicleQueueBuilder<B extends ChronicleQueueBuilder>

indexCount

public int indexCount()

Specified by:

indexCount in interface ChronicleQueueBuilder<B extends ChronicleQueueBuilder>

indexSpacing

public B indexSpacing(int indexSpacing)

Specified by:

indexSpacing in interface ChronicleQueueBuilder<B extends ChronicleQueueBuilder>

indexSpacing

public int indexSpacing()

Specified by:

indexSpacing in interface ChronicleQueueBuilder<B extends ChronicleQueueBuilder>

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(WireStoreFactory storeFactory)

storeFactory

public WireStoreFactory storeFactory()

Specified by:

storeFactory in interface ChronicleQueueBuilder<B extends ChronicleQueueBuilder>

storeFileListener

public B storeFileListener(StoreFileListener storeFileListener)

Specified by:

storeFileListener in interface ChronicleQueueBuilder<B extends ChronicleQueueBuilder>

storeFileListener

public StoreFileListener storeFileListener()

Specified by:

storeFileListener in interface ChronicleQueueBuilder<B extends 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<B extends ChronicleQueueBuilder>

readOnly

public B readOnly(boolean readOnly)

Specified by:

readOnly in interface ChronicleQueueBuilder<B extends ChronicleQueueBuilder>

encryptSupplier

public AbstractChronicleQueueBuilder encryptSupplier(java.util.function.Supplier<Cipher> encryptSupplier)

decryptSupplier

public AbstractChronicleQueueBuilder decryptSupplier(java.util.function.Supplier<Cipher> decryptSupplier)