net.openhft.chronicle.queue.impl.single

Class Pretoucher

java.lang.Object

net.openhft.chronicle.core.io.AbstractCloseable

net.openhft.chronicle.queue.impl.single.Pretoucher

All Implemented Interfaces:

Closeable, AutoCloseable, net.openhft.chronicle.core.io.ManagedCloseable, net.openhft.chronicle.core.io.QueryCloseable, net.openhft.chronicle.core.io.ReferenceOwner

public final class Pretoucher
extends net.openhft.chronicle.core.io.AbstractCloseable

A class designed to be called from a long-lived thread.

Upon invocation of the execute() method, this object will pre-touch pages in the supplied queue's underlying store file, attempting to keep ahead of any appenders to the queue.

Resources held by this object will be released when the underlying queue is closed.

Alternatively, the shutdown() method can be called to close the supplied queue and release any other resources. Invocation of the execute() method after shutdown() has been called will cause an IllegalStateException to be thrown.

Field Summary

Fields inherited from class net.openhft.chronicle.core.io.AbstractCloseable

CHECK_THREAD_SAFETY, DISABLE_DISCARD_WARNING, DISABLE_THREAD_SAFETY, STRICT_DISCARD_WARNING, WARN_NS

Fields inherited from interface net.openhft.chronicle.core.io.ReferenceOwner

INIT

Constructor Summary

Constructors

Constructor and Description
Pretoucher(SingleChronicleQueue queue)
Pretoucher(SingleChronicleQueue queue, net.openhft.chronicle.bytes.NewChunkListener chunkListener, IntConsumer cycleChangedListener, boolean earlyAcquireNextCycle, boolean canWrite)

Method Summary

Modifier and Type	Method and Description
void	execute()
protected void	performClose()
void	shutdown()

Methods inherited from class net.openhft.chronicle.core.io.AbstractCloseable

assertCloseablesClosed, clearUsedByThread, close, createdHere, disableCloseableTracing, disableThreadSafetyCheck, disableThreadSafetyCheck, enableCloseableTracing, isClosed, isClosing, isInUserThread, referenceId, resetUsedByThread, shouldPerformCloseInBackground, shouldWaitForClosed, threadSafetyCheck, throwExceptionIfClosed, throwExceptionIfClosedInSetter, toString, unmonitor, waitForCloseablesToClose, waitForClosed, warnAndCloseIfNotClosed

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.openhft.chronicle.core.io.ReferenceOwner

referenceName, temporary

Methods inherited from interface net.openhft.chronicle.core.io.Closeable

closeQuietly, closeQuietly

Constructor Detail

Pretoucher

public Pretoucher(SingleChronicleQueue queue)

Pretoucher

public Pretoucher(SingleChronicleQueue queue,
                  net.openhft.chronicle.bytes.NewChunkListener chunkListener,
                  IntConsumer cycleChangedListener,
                  boolean earlyAcquireNextCycle,
                  boolean canWrite)

Method Detail

execute

public void execute()
             throws net.openhft.chronicle.core.threads.InvalidEventHandlerException

Throws:

net.openhft.chronicle.core.threads.InvalidEventHandlerException

shutdown

public void shutdown()

performClose

protected void performClose()

Specified by:

performClose in class net.openhft.chronicle.core.io.AbstractCloseable