org.hornetq.core.journal

Interface SequentialFile

All Known Implementing Classes:

AbstractSequentialFile, AIOSequentialFile, NIOSequentialFile

public interface SequentialFile

A SequentialFile

Author:

Tim Fox, Clebert Suconic

Method Summary

Methods

Modifier and Type	Method and Description
int	calculateBlockStart(int position)
SequentialFile	cloneFile()
void	close()
void	copyTo(SequentialFile newFileName)
void	delete()
boolean	exists()
void	fill(int position, int size, byte fillCharacter)
boolean	fits(int size)
int	getAlignment()
String	getFileName()
File	getJavaFile() Returns a native File of the file underlying this sequential file.
boolean	isOpen()
void	open()
void	open(int maxIO, boolean useExecutor) The maximum number of simultaneous writes accepted
long	position()
void	position(long pos)
int	read(ByteBuffer bytes)
int	read(ByteBuffer bytes, IOAsyncTask callback)
void	renameTo(String newFileName)
void	setTimedBuffer(TimedBuffer buffer)
long	size()
void	sync()
void	waitForClose()
void	write(EncodingSupport bytes, boolean sync)
void	write(EncodingSupport bytes, boolean sync, IOAsyncTask callback)
void	write(HornetQBuffer bytes, boolean sync)
void	write(HornetQBuffer bytes, boolean sync, IOAsyncTask callback)
void	writeDirect(ByteBuffer bytes, boolean sync) Write directly to the file without using any buffer
void	writeDirect(ByteBuffer bytes, boolean sync, IOAsyncTask callback) Write directly to the file without using any buffer
void	writeInternal(ByteBuffer bytes) Write directly to the file.

Method Detail

open

void open()
          throws Exception

Throws:

Exception

isOpen

boolean isOpen()

exists

boolean exists()

open

void open(int maxIO,
        boolean useExecutor)
          throws Exception

The maximum number of simultaneous writes accepted

Parameters:

maxIO -

Throws:

Exception

fits

boolean fits(int size)

getAlignment

int getAlignment()
                 throws Exception

Throws:

Exception

calculateBlockStart

int calculateBlockStart(int position)
                        throws Exception

Throws:

Exception

getFileName

String getFileName()

fill

void fill(int position,
        int size,
        byte fillCharacter)
          throws Exception

Throws:

Exception

delete

void delete()
            throws IOException,
                   InterruptedException,
                   HornetQException

Throws:

IOException

InterruptedException

HornetQException

write

void write(HornetQBuffer bytes,
         boolean sync,
         IOAsyncTask callback)
           throws Exception

Throws:

Exception

write

void write(HornetQBuffer bytes,
         boolean sync)
           throws Exception

Throws:

Exception

write

void write(EncodingSupport bytes,
         boolean sync,
         IOAsyncTask callback)
           throws Exception

Throws:

Exception

write

void write(EncodingSupport bytes,
         boolean sync)
           throws Exception

Throws:

Exception

writeDirect

void writeDirect(ByteBuffer bytes,
               boolean sync,
               IOAsyncTask callback)

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

void writeDirect(ByteBuffer bytes,
               boolean sync)
                 throws Exception

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).

Throws:

Exception

writeInternal

void writeInternal(ByteBuffer bytes)
                   throws Exception

Write directly to the file. This is used by compacting and other places where we write a big buffer in a single shot. writeInternal should always block until the entire write is sync on disk.

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

int read(ByteBuffer bytes,
       IOAsyncTask callback)
         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

read

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

position

void position(long pos)
              throws IOException

Throws:

IOException

position

long position()

close

void close()
           throws Exception

Throws:

Exception

waitForClose

void waitForClose()
                  throws Exception

Throws:

Exception

sync

void sync()
          throws IOException

Throws:

IOException

size

long size()
          throws Exception

Throws:

Exception

renameTo

void renameTo(String newFileName)
              throws Exception

Throws:

Exception

cloneFile

SequentialFile cloneFile()

copyTo

void copyTo(SequentialFile newFileName)
            throws Exception

Throws:

Exception

setTimedBuffer

void setTimedBuffer(TimedBuffer buffer)

getJavaFile

File getJavaFile()

Returns a native File of the file underlying this sequential file.