NIOSequentialFileFactory (HornetQ Parent 2.4.0.Beta2 API)

java.lang.Object
- org.hornetq.core.journal.impl.NIOSequentialFileFactory

All Implemented Interfaces:

SequentialFileFactory
```
public class NIOSequentialFileFactory
extends Object
```
A NIOSequentialFileFactory

Author:

Tim Fox, Clebert Suconic

Field Summary

Fields
Modifier and Type	Field and Description
`protected int`	`bufferSize`
`protected long`	`bufferTimeout`
`protected static int`	`EXECUTOR_TIMEOUT`
`protected String`	`journalDir`
`protected TimedBuffer`	`timedBuffer`
`protected ExecutorService`	`writeExecutor` Asynchronous writes need to be done at another executor.

Constructor Summary

Constructors
Constructor and Description
`NIOSequentialFileFactory(String journalDir)`
`NIOSequentialFileFactory(String journalDir, boolean buffered)`
`NIOSequentialFileFactory(String journalDir, boolean buffered, int bufferSize, int bufferTimeout, boolean logRates)`
`NIOSequentialFileFactory(String journalDir, boolean buffered, int bufferSize, int bufferTimeout, boolean logRates, IOCriticalErrorListener listener)`
`NIOSequentialFileFactory(String journalDir, boolean buffered, IOCriticalErrorListener listener)`
`NIOSequentialFileFactory(String journalDir, IOCriticalErrorListener listener)`

Method Summary

Methods
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)`
`void`	`clearBuffer(ByteBuffer buffer)`
`void`	`createDirs()` Create the directory if it doesn't exist yet
`SequentialFile`	`createSequentialFile(String fileName, int maxIO)`
`void`	`deactivateBuffer()`
`void`	`flush()`
`int`	`getAlignment()`
`String`	`getDirectory()`
`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.
`void`	`releaseBuffer(ByteBuffer buffer)`
`void`	`releaseDirectBuffer(ByteBuffer buffer)` used for cases where you need direct buffer outside of the journal context.
`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

- Field Detail
  - EXECUTOR_TIMEOUT
```
protected static final int EXECUTOR_TIMEOUT
```
    See Also:
    Constant Field Values
  - journalDir
```
protected final String journalDir
```
  - timedBuffer
```
protected final TimedBuffer timedBuffer
```
  - bufferSize
```
protected final int bufferSize
```
  - bufferTimeout
```
protected final long bufferTimeout
```
  - 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
  - NIOSequentialFileFactory
```
public NIOSequentialFileFactory(String journalDir)
```
  - NIOSequentialFileFactory
```
public NIOSequentialFileFactory(String journalDir,
                        IOCriticalErrorListener listener)
```
  - NIOSequentialFileFactory
```
public NIOSequentialFileFactory(String journalDir,
                        boolean buffered)
```
  - NIOSequentialFileFactory
```
public NIOSequentialFileFactory(String journalDir,
                        boolean buffered,
                        IOCriticalErrorListener listener)
```
  - NIOSequentialFileFactory
```
public NIOSequentialFileFactory(String journalDir,
                        boolean buffered,
                        int bufferSize,
                        int bufferTimeout,
                        boolean logRates)
```
  - NIOSequentialFileFactory
```
public NIOSequentialFileFactory(String journalDir,
                        boolean buffered,
                        int bufferSize,
                        int bufferTimeout,
                        boolean logRates,
                        IOCriticalErrorListener listener)
```
- Method Detail
  - createSequentialFile
```
public SequentialFile createSequentialFile(String fileName,
                                  int maxIO)
```
  - isSupportsCallbacks
```
public boolean isSupportsCallbacks()
```
  - 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
  - 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
  - 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)
    
    Returns:
    the allocated ByteBuffer
  - clearBuffer
```
public void clearBuffer(ByteBuffer buffer)
```
  - wrapBuffer
```
public ByteBuffer wrapBuffer(byte[] bytes)
```
  - getAlignment
```
public int getAlignment()
```
  - calculateBlockSize
```
public int calculateBlockSize(int bytes)
```
  - stop
```
public void stop()
```
    Specified by:
    
    stop in interface SequentialFileFactory
  - getDirectory
```
public String getDirectory()
```
    Specified by:
    
    getDirectory in interface SequentialFileFactory
  - start
```
public void start()
```
    Specified by:
    
    start 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
  - 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

Class NIOSequentialFileFactory

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

EXECUTOR_TIMEOUT

journalDir

timedBuffer

bufferSize

bufferTimeout

writeExecutor

Constructor Detail

NIOSequentialFileFactory

NIOSequentialFileFactory

NIOSequentialFileFactory

NIOSequentialFileFactory

NIOSequentialFileFactory

NIOSequentialFileFactory

Method Detail

createSequentialFile

isSupportsCallbacks

allocateDirectBuffer

releaseDirectBuffer

newBuffer

clearBuffer

wrapBuffer

getAlignment

calculateBlockSize

stop

getDirectory

start

onIOError

activateBuffer

flush

deactivateBuffer

releaseBuffer

createDirs

listFiles