Package org.apache.activemq.artemis.core.io

Class AbstractSequentialFileFactory

java.lang.Object

org.apache.activemq.artemis.core.io.AbstractSequentialFileFactory

All Implemented Interfaces:

SequentialFileFactory

Direct Known Subclasses:

AIOSequentialFileFactory, MappedSequentialFileFactory, NIOSequentialFileFactory

public abstract class AbstractSequentialFileFactory
extends Object
implements SequentialFileFactory

An abstract SequentialFileFactory containing basic functionality for both AIO and NIO SequentialFactories

Field Summary

Fields

Modifier and Type	Field	Description
protected int	alignment
protected int	bufferSize
protected long	bufferTimeout
protected IOCriticalErrorListener	critialErrorListener
protected CriticalAnalyzer	criticalAnalyzer
protected boolean	dataSync
protected static int	EXECUTOR_TIMEOUT
protected File	journalDir
protected int	maxIO
protected TimedBuffer	timedBuffer
protected ExecutorService	writeExecutor	Asynchronous writes need to be done at another executor.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractSequentialFileFactory(File journalDir, boolean buffered, int bufferSize, int bufferTimeout, int maxIO, boolean logRates, IOCriticalErrorListener criticalErrorListener, CriticalAnalyzer criticalAnalyzer)

Method Summary

Modifier and Type	Method	Description
void	activateBuffer(SequentialFile file)
void	createDirs()	Create the directory if it doesn't exist yet
void	deactivateBuffer()
void	flush()
int	getAlignment()
long	getBufferSize()
CriticalAnalyzer	getCriticalAnalyzer()
IOCriticalErrorListener	getCriticalErrorListener()
File	getDirectory()
int	getMaxIO()
boolean	isDatasync()
List<String>	listFiles(String extension)	Lists files that end with the given extension.
void	onIOError(Throwable exception, String message, String file)	The SequentialFile will call this method when a disk IO Error happens during the live phase.
void	releaseBuffer(ByteBuffer buffer)
AbstractSequentialFileFactory	setAlignment(int alignment)
void	setCriticalErrorListener(IOCriticalErrorListener listener)
SequentialFileFactory	setDatasync(boolean enabled)
void	start()
void	stop()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.activemq.artemis.core.io.SequentialFileFactory

allocateDirectBuffer, calculateBlockSize, clearBuffer, createSequentialFile, createSequentialFile, isSupportsCallbacks, newBuffer, newBuffer, onIOError, onIOError, releaseDirectBuffer, wrapBuffer

Field Detail

EXECUTOR_TIMEOUT

protected static final int EXECUTOR_TIMEOUT

See Also:

Constant Field Values

journalDir

protected final File journalDir

timedBuffer

protected final TimedBuffer timedBuffer

bufferSize

protected final int bufferSize

bufferTimeout

protected final long bufferTimeout

maxIO

protected final int maxIO

dataSync

protected boolean dataSync

alignment

protected volatile int alignment

critialErrorListener

protected IOCriticalErrorListener critialErrorListener

criticalAnalyzer

protected final CriticalAnalyzer criticalAnalyzer

writeExecutor

protected ExecutorService writeExecutor

Asynchronous writes need to be done at another executor. This needs to be done at NIO, or else we would have the callers thread blocking for the return. At AIO this is necessary as context switches on writes would fire flushes at the kernel.

Constructor Detail

AbstractSequentialFileFactory

protected AbstractSequentialFileFactory(File journalDir,
                                        boolean buffered,
                                        int bufferSize,
                                        int bufferTimeout,
                                        int maxIO,
                                        boolean logRates,
                                        IOCriticalErrorListener criticalErrorListener,
                                        CriticalAnalyzer criticalAnalyzer)

Method Detail

getCriticalErrorListener

public IOCriticalErrorListener getCriticalErrorListener()

Specified by:

getCriticalErrorListener in interface SequentialFileFactory

setCriticalErrorListener

public void setCriticalErrorListener(IOCriticalErrorListener listener)

Specified by:

setCriticalErrorListener in interface SequentialFileFactory

getCriticalAnalyzer

public CriticalAnalyzer getCriticalAnalyzer()

Specified by:

getCriticalAnalyzer in interface SequentialFileFactory

getBufferSize

public long getBufferSize()

Specified by:

getBufferSize in interface SequentialFileFactory

getAlignment

public int getAlignment()

Specified by:

getAlignment in interface SequentialFileFactory

setAlignment

public AbstractSequentialFileFactory setAlignment(int alignment)

Specified by:

setAlignment in interface SequentialFileFactory

setDatasync

public SequentialFileFactory setDatasync(boolean enabled)

Specified by:

setDatasync in interface SequentialFileFactory

isDatasync

public boolean isDatasync()

Specified by:

isDatasync in interface SequentialFileFactory

stop

public void stop()

Specified by:

stop in interface SequentialFileFactory

getDirectory

public File getDirectory()

Specified by:

getDirectory in interface SequentialFileFactory

start

public void start()

Specified by:

start in interface SequentialFileFactory

getMaxIO

public int getMaxIO()

Specified by:

getMaxIO in interface SequentialFileFactory

onIOError

public void onIOError(Throwable exception,
                      String message,
                      String file)

Description copied from interface: SequentialFileFactory

The SequentialFile will call this method when a disk IO Error happens during the live phase.

Specified by:

onIOError in interface SequentialFileFactory

activateBuffer

public void activateBuffer(SequentialFile file)

Specified by:

activateBuffer in interface SequentialFileFactory

flush

public void flush()

Specified by:

flush in interface SequentialFileFactory

deactivateBuffer

public void deactivateBuffer()

Specified by:

deactivateBuffer in interface SequentialFileFactory

releaseBuffer

public void releaseBuffer(ByteBuffer buffer)

Specified by:

releaseBuffer in interface SequentialFileFactory

createDirs

public void createDirs()
                throws Exception

Create the directory if it doesn't exist yet

Specified by:

createDirs in interface SequentialFileFactory

Throws:

Exception

listFiles

public List<String> listFiles(String extension)
                       throws Exception

Description copied from interface: SequentialFileFactory

Lists files that end with the given extension.

This method inserts a ".' before the extension.

Specified by:

listFiles in interface SequentialFileFactory

Returns:

Throws:

Exception