net.openhft.lang.io

Class MappedFile

java.lang.Object

net.openhft.lang.io.MappedFile

public class MappedFile
extends Object

This manages the full life cycle of a file and its mappings.

Constructor Summary

Constructors

Constructor and Description
MappedFile(String filename, long blockSize)
MappedFile(String filename, long blockSize, long overlapSize)

Method Summary

Modifier and Type	Method and Description
MappedMemory	acquire(long index)
long	blockSize()
void	close()
static MappedByteBuffer	getMap(FileChannel fileChannel, long start, int size)
int	getRefCount(long index) gets the refCount a given index, or returns 0, if the there is no mapping for this index
String	name()
void	release(MappedMemory mappedMemory)
long	size()

Methods inherited from class java.lang.Object

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

Constructor Detail

MappedFile

public MappedFile(String filename,
                  long blockSize)
           throws FileNotFoundException

Throws:

FileNotFoundException

MappedFile

public MappedFile(String filename,
                  long blockSize,
                  long overlapSize)
           throws FileNotFoundException

Throws:

FileNotFoundException

Method Detail

getMap

public static MappedByteBuffer getMap(@NotNull
                                      FileChannel fileChannel,
                                      long start,
                                      int size)
                               throws IOException

Throws:

IOException

name

public String name()

acquire

public MappedMemory acquire(long index)
                     throws IOException

Throws:

IOException

getRefCount

public int getRefCount(long index)

gets the refCount a given index, or returns 0, if the there is no mapping for this index

Parameters:

index -

Returns:

the mapping at this index

Throws:

IndexOutOfBoundsException - if the index is out of range

close

public void close()
           throws IOException

Throws:

IOException

size

public long size()

blockSize

public long blockSize()

release

public void release(MappedMemory mappedMemory)