org.apache.activemq.artemis.core.io.aio

Class AIOSequentialFile

java.lang.Object

org.apache.activemq.artemis.core.io.AbstractSequentialFile

org.apache.activemq.artemis.core.io.aio.AIOSequentialFile

All Implemented Interfaces:

SequentialFile

public class AIOSequentialFile
extends AbstractSequentialFile

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.activemq.artemis.core.io.AbstractSequentialFile

AbstractSequentialFile.LocalBufferObserver

Field Summary

Fields inherited from class org.apache.activemq.artemis.core.io.AbstractSequentialFile

directory, factory, fileSize, position, timedBuffer, timedBufferObserver

Constructor Summary

Constructors

Constructor and Description
AIOSequentialFile(AIOSequentialFileFactory factory, int bufferSize, long bufferTimeoutMilliseconds, File directory, String fileName, Executor writerExecutor)

Method Summary

Modifier and Type	Method and Description
void	blockingWriteDirect(ByteBuffer bytes, boolean sync, boolean releaseBuffer) Write directly to the file without using any intermediate buffer and wait completion. If releaseBuffer is true the provided bytes should be released through SequentialFileFactory.releaseBuffer(ByteBuffer), if supported.
int	calculateBlockStart(int position)
SequentialFile	cloneFile()
void	close()
void	close(boolean waitSync) When closing a file from a finalize block, you cant wait on syncs or anything like that.
void	fill(int size)
boolean	isOpen()
protected ByteBuffer	newBuffer(int size, int limit)
void	open()
void	open(int maxIO, boolean useExecutor) The maximum number of simultaneous writes accepted
int	read(ByteBuffer bytes)
int	read(ByteBuffer bytes, IOCallback callback)
long	size()
void	sync()
String	toString()
void	writeDirect(ByteBuffer bytes, boolean sync) Write directly to the file without using intermediate any buffer
void	writeDirect(ByteBuffer bytes, boolean sync, IOCallback callback) Note: Parameter sync is not used on AIO

Methods inherited from class org.apache.activemq.artemis.core.io.AbstractSequentialFile

copyTo, createTimedBufferObserver, delete, exists, fits, getFile, getFileName, getJavaFile, position, position, renameTo, setTimedBuffer, write, write, write, write

Methods inherited from class java.lang.Object

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

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

appendTo

Constructor Detail

AIOSequentialFile

public AIOSequentialFile(AIOSequentialFileFactory factory,
                         int bufferSize,
                         long bufferTimeoutMilliseconds,
                         File directory,
                         String fileName,
                         Executor writerExecutor)

Method Detail

isOpen

public boolean isOpen()

calculateBlockStart

public int calculateBlockStart(int position)

cloneFile

public SequentialFile cloneFile()

close

public void close()
           throws IOException,
                  InterruptedException,
                  ActiveMQException

Specified by:

close in interface SequentialFile

Overrides:

close in class AbstractSequentialFile

Throws:

IOException - we declare throwing IOException because sub-classes need to do it

InterruptedException

ActiveMQException

close

public void close(boolean waitSync)
           throws IOException,
                  InterruptedException,
                  ActiveMQException

Description copied from interface: SequentialFile

When closing a file from a finalize block, you cant wait on syncs or anything like that. otherwise the VM may hung. Especially on the testsuite.

Throws:

IOException

InterruptedException

ActiveMQException

fill

public void fill(int size)
          throws Exception

Throws:

Exception

open

public void open()
          throws Exception

Throws:

Exception

open

public void open(int maxIO,
                 boolean useExecutor)
          throws ActiveMQException

Description copied from interface: SequentialFile

The maximum number of simultaneous writes accepted

Throws:

ActiveMQException

read

public int read(ByteBuffer bytes,
                IOCallback callback)
         throws ActiveMQException

Parameters:

bytes - the ByteBuffer must be compatible with the SequentialFile implementation (AIO or NIO). To be safe, use a buffer from the corresponding SequentialFileFactory.newBuffer(int).

Throws:

ActiveMQException

read

public int read(ByteBuffer bytes)
         throws Exception

Parameters:

bytes - the ByteBuffer must be compatible with the SequentialFile implementation (AIO or NIO). To be safe, use a buffer from the corresponding SequentialFileFactory.newBuffer(int).

Throws:

Exception

writeDirect

public void writeDirect(ByteBuffer bytes,
                        boolean sync)
                 throws Exception

Description copied from interface: SequentialFile

Write directly to the file without using intermediate any buffer

Parameters:

bytes - the ByteBuffer must be compatible with the SequentialFile implementation (AIO or NIO). To be safe, use a buffer from the corresponding SequentialFileFactory.newBuffer(int).

Throws:

Exception

blockingWriteDirect

public void blockingWriteDirect(ByteBuffer bytes,
                                boolean sync,
                                boolean releaseBuffer)
                         throws Exception

Description copied from interface: SequentialFile

Write directly to the file without using any intermediate buffer and wait completion.
If releaseBuffer is true the provided bytes should be released through SequentialFileFactory.releaseBuffer(ByteBuffer), if supported.

Parameters:

bytes - the ByteBuffer must be compatible with the SequentialFile implementation (AIO or NIO). If releaseBuffer is true use a buffer from SequentialFileFactory.newBuffer(int), SequentialFileFactory.allocateDirectBuffer(int) otherwise.

sync - if true will durable flush the written data on the file, false otherwise

releaseBuffer - if true will release the buffer, false otherwise

Throws:

Exception

writeDirect

public void writeDirect(ByteBuffer bytes,
                        boolean sync,
                        IOCallback callback)

Note: Parameter sync is not used on AIO

Parameters:

bytes - the ByteBuffer must be compatible with the SequentialFile implementation (AIO or NIO). To be safe, use a buffer from the corresponding SequentialFileFactory.newBuffer(int).

sync

public void sync()

size

public long size()
          throws Exception

Throws:

Exception

toString

public String toString()

Overrides:

toString in class Object

newBuffer

protected ByteBuffer newBuffer(int size,
                               int limit)

Overrides:

newBuffer in class AbstractSequentialFile