org.apache.activemq.artemis.core.io.mapped

Class MappedSequentialFileFactory

java.lang.Object

org.apache.activemq.artemis.core.io.mapped.MappedSequentialFileFactory

All Implemented Interfaces:

SequentialFileFactory

public final class MappedSequentialFileFactory
extends Object
implements SequentialFileFactory

Constructor Summary

Constructors

Constructor and Description
MappedSequentialFileFactory(File directory)
MappedSequentialFileFactory(File directory, IOCriticalErrorListener criticalErrorListener)

Method Summary

Modifier and Type	Method and Description
void	activateBuffer(SequentialFile file)
ByteBuffer	allocateDirectBuffer(int size) used for cases where you need direct buffer outside of the journal context.
int	calculateBlockSize(int bytes)
long	chunkBytes()
MappedSequentialFileFactory	chunkBytes(long chunkBytes)
void	clearBuffer(ByteBuffer buffer)
void	createDirs() Creates the directory if it does not exist yet.
SequentialFile	createSequentialFile(String fileName)
void	deactivateBuffer()
void	flush()
int	getAlignment()
File	getDirectory()
int	getMaxIO()
boolean	isDatasync()
boolean	isSupportsCallbacks()
List<String>	listFiles(String extension) Lists files that end with the given extension.
ByteBuffer	newBuffer(int size) Note: You need to release the buffer if is used for reading operations.
void	onIOError(Exception exception, String message, SequentialFile file) The SequentialFile will call this method when a disk IO Error happens during the live phase.
long	overlapBytes()
MappedSequentialFileFactory	overlapBytes(long overlapBytes)
void	releaseBuffer(ByteBuffer buffer)
void	releaseDirectBuffer(ByteBuffer buffer) used for cases where you need direct buffer outside of the journal context.
SequentialFileFactory	setAlignment(int alignment)
SequentialFileFactory	setDatasync(boolean enabled)
void	start()
void	stop()
ByteBuffer	wrapBuffer(byte[] bytes)

Methods inherited from class java.lang.Object

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

Constructor Detail

MappedSequentialFileFactory

public MappedSequentialFileFactory(File directory,
                                   IOCriticalErrorListener criticalErrorListener)

MappedSequentialFileFactory

public MappedSequentialFileFactory(File directory)

Method Detail

chunkBytes

public long chunkBytes()

chunkBytes

public MappedSequentialFileFactory chunkBytes(long chunkBytes)

overlapBytes

public long overlapBytes()

overlapBytes

public MappedSequentialFileFactory overlapBytes(long overlapBytes)

createSequentialFile

public SequentialFile createSequentialFile(String fileName)

Specified by:

createSequentialFile 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

getMaxIO

public int getMaxIO()

Specified by:

getMaxIO in interface SequentialFileFactory

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

isSupportsCallbacks

public boolean isSupportsCallbacks()

Specified by:

isSupportsCallbacks in interface SequentialFileFactory

onIOError

public void onIOError(Exception exception,
                      String message,
                      SequentialFile 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

allocateDirectBuffer

public ByteBuffer allocateDirectBuffer(int size)

Description copied from interface: SequentialFileFactory

used for cases where you need direct buffer outside of the journal context. This is because the native layer has a method that can be reused in certain cases like paging

Specified by:

allocateDirectBuffer in interface SequentialFileFactory

releaseDirectBuffer

public void releaseDirectBuffer(ByteBuffer buffer)

Description copied from interface: SequentialFileFactory

used for cases where you need direct buffer outside of the journal context. This is because the native layer has a method that can be reused in certain cases like paging

Specified by:

releaseDirectBuffer in interface SequentialFileFactory

newBuffer

public ByteBuffer newBuffer(int size)

Description copied from interface: SequentialFileFactory

Note: You need to release the buffer if is used for reading operations. You don't need to do it if using writing operations (AIO Buffer Lister will take of writing operations)

Specified by:

newBuffer in interface SequentialFileFactory

Returns:

the allocated ByteBuffer

releaseBuffer

public void releaseBuffer(ByteBuffer buffer)

Specified by:

releaseBuffer in interface SequentialFileFactory

activateBuffer

public void activateBuffer(SequentialFile file)

Specified by:

activateBuffer in interface SequentialFileFactory

deactivateBuffer

public void deactivateBuffer()

Specified by:

deactivateBuffer in interface SequentialFileFactory

wrapBuffer

public ByteBuffer wrapBuffer(byte[] bytes)

Specified by:

wrapBuffer in interface SequentialFileFactory

getAlignment

public int getAlignment()

Specified by:

getAlignment in interface SequentialFileFactory

setAlignment

public SequentialFileFactory setAlignment(int alignment)

Specified by:

setAlignment in interface SequentialFileFactory

calculateBlockSize

public int calculateBlockSize(int bytes)

Specified by:

calculateBlockSize in interface SequentialFileFactory

getDirectory

public File getDirectory()

Specified by:

getDirectory in interface SequentialFileFactory

clearBuffer

public void clearBuffer(ByteBuffer buffer)

Specified by:

clearBuffer in interface SequentialFileFactory

start

public void start()

Specified by:

start in interface SequentialFileFactory

stop

public void stop()

Specified by:

stop in interface SequentialFileFactory

createDirs

public void createDirs()
                throws Exception

Description copied from interface: SequentialFileFactory

Creates the directory if it does not exist yet.

Specified by:

createDirs in interface SequentialFileFactory

Throws:

Exception

flush

public void flush()

Specified by:

flush in interface SequentialFileFactory