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

Class NIOSequentialFile

java.lang.Object

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

org.apache.activemq.artemis.core.io.nio.NIOSequentialFile

All Implemented Interfaces:

SequentialFile

public class NIOSequentialFile
extends AbstractSequentialFile

Nested Class Summary

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

AbstractSequentialFile.LocalBufferObserver

Field Summary

Fields

Modifier and Type	Field	Description
protected FileChannel	channel
protected final int	maxIO
protected RandomAccessFile	rfile

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

directory, factory, file, fileSize, position, timedBuffer, timedBufferObserver

Constructor Summary

Constructors

Constructor	Description
NIOSequentialFile(SequentialFileFactory factory, File directory, String file, int maxIO, Executor writerExecutor)

Method Summary

Modifier and Type	Method	Description
void	blockingWriteDirect(ByteBuffer bytes, boolean sync, boolean releaseBuffer)	Write directly to the file without using any intermediate buffer and wait completion.
int	calculateBlockStart(int position)
static void	clearDebug()
SequentialFile	cloneFile()
void	close()
void	close(boolean waitSync, boolean blockOnPending)	When closing a file from a finalize block, you cant wait on syncs or anything like that.
void	copyTo(SequentialFile dstFile)
protected TimedBufferObserver	createTimedBufferObserver()
void	fill(int size)
static AtomicInteger	getDebugCounter(Exception location)
static AtomicInteger	getDebugCounter(String strLocation)
boolean	isOpen()
ByteBuffer	map(int position, long size)
void	open()	this.maxIO represents the default maxIO.
void	open(int maxIO, boolean useExecutor)	The maximum number of simultaneous writes accepted
void	position(long pos)
static void	printDebug()
int	read(ByteBuffer bytes)	Read the file.
int	read(ByteBuffer bytes, IOCallback callback)	Read the file.
long	size()
void	sync()
protected void	syncChannel(FileChannel syncChannel)
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)	Write directly to the file without using any buffer

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

delete, exists, fits, getFile, getFileName, getJavaFile, newBuffer, 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

afterComplete

Field Details

channel

protected volatile FileChannel channel

rfile

protected volatile RandomAccessFile rfile

maxIO

protected final int maxIO

Constructor Details

NIOSequentialFile

public NIOSequentialFile(SequentialFileFactory factory,
 File directory,
 String file,
 int maxIO,
 Executor writerExecutor)

Method Details

createTimedBufferObserver

protected TimedBufferObserver createTimedBufferObserver()

Overrides:

createTimedBufferObserver in class AbstractSequentialFile

calculateBlockStart

public int calculateBlockStart(int position)

isOpen

public boolean isOpen()

open

public void open()
          throws IOException

this.maxIO represents the default maxIO. Some operations while initializing files on the journal may require a different maxIO

Throws:

IOException

map

public ByteBuffer map(int position,
 long size)
               throws IOException

Throws:

IOException

clearDebug

public static void clearDebug()

printDebug

public static void printDebug()

getDebugCounter

public static AtomicInteger getDebugCounter(Exception location)

getDebugCounter

public static AtomicInteger getDebugCounter(String strLocation)

open

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

Description copied from interface: SequentialFile

The maximum number of simultaneous writes accepted

Throws:

IOException

fill

public void fill(int size)
          throws IOException

Throws:

IOException

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,
 boolean blockOnPending)
           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

read

public int read(ByteBuffer bytes)
         throws Exception

Description copied from interface: SequentialFile

Read the file.

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

read

public int read(ByteBuffer bytes,
 IOCallback callback)
         throws IOException,
ActiveMQIllegalStateException

Description copied from interface: SequentialFile

Read the file.

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:

IOException

ActiveMQIllegalStateException

sync

public void sync()
          throws IOException

Throws:

IOException

syncChannel

protected void syncChannel(FileChannel syncChannel)
                    throws IOException

Throws:

IOException

size

public long size()
          throws IOException

Throws:

IOException

position

public void position(long pos)
              throws IOException

Specified by:

position in interface SequentialFile

Overrides:

position in class AbstractSequentialFile

Throws:

IOException - only declare exception due to signature. Sub-class needs it.

toString

public String toString()

Overrides:

toString in class Object

cloneFile

public SequentialFile cloneFile()

writeDirect

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

Description copied from interface: SequentialFile

Write directly to the file without using 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).

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

copyTo

public void copyTo(SequentialFile dstFile)
            throws IOException

Specified by:

copyTo in interface SequentialFile

Overrides:

copyTo in class AbstractSequentialFile

Throws:

IOException