net.openhft.chronicle.bytes

Class MappedFile

java.lang.Object

net.openhft.chronicle.bytes.MappedFile

All Implemented Interfaces:

net.openhft.chronicle.core.ReferenceCounted

public class MappedFile
extends Object
implements net.openhft.chronicle.core.ReferenceCounted

A memory mapped files which can be randomly accessed in chunks. It has overlapping regions to avoid wasting bytes at the end of chunks.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MappedFile(File file, RandomAccessFile raf, long chunkSize, long overlapSize, long capacity, boolean readOnly)

Method Summary

Modifier and Type	Method and Description
Bytes	acquireBytesForRead(long position) Convenience method so you don't need to release the BytesStore
void	acquireBytesForRead(long position, VanillaBytes bytes)
Bytes	acquireBytesForWrite(long position)
void	acquireBytesForWrite(long position, VanillaBytes bytes)
MappedBytesStore	acquireByteStore(long position)
<T extends MappedBytesStore> T	acquireByteStore(long position, MappedBytesStoreFactory<T> mappedBytesStoreFactory)
long	actualSize()
long	capacity()
static void	checkMappedFiles()
long	chunkSize()
File	file()
NewChunkListener	getNewChunkListener()
boolean	isClosed()
static MappedFile	mappedFile(File file, long chunkSize)
static MappedFile	mappedFile(File file, long chunkSize, long overlapSize)
static MappedFile	mappedFile(File file, long chunkSize, long overlapSize, boolean readOnly)
static MappedFile	mappedFile(File file, long capacity, long chunkSize, long overlapSize, boolean readOnly)
static MappedFile	mappedFile(String filename, long chunkSize)
static MappedFile	mappedFile(String filename, long chunkSize, long overlapSize)
static MappedFile	of(File file, long chunkSize, long overlapSize, boolean readOnly)
long	overlapSize()
static MappedFile	readOnly(File file)
long	refCount()
String	referenceCounts()
void	release()
void	reserve()
void	setNewChunkListener(NewChunkListener listener)
boolean	tryReserve()
static void	warmup()
MappedFile	withSizes(long chunkSize, long overlapSize)

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.openhft.chronicle.core.ReferenceCounted

release, releaseAll

Constructor Detail

MappedFile

protected MappedFile(@NotNull
                     File file,
                     @NotNull
                     RandomAccessFile raf,
                     long chunkSize,
                     long overlapSize,
                     long capacity,
                     boolean readOnly)

Method Detail

checkMappedFiles

public static void checkMappedFiles()

of

@NotNull
public static MappedFile of(@NotNull
                                     File file,
                                     long chunkSize,
                                     long overlapSize,
                                     boolean readOnly)
                              throws FileNotFoundException

Throws:

FileNotFoundException

mappedFile

@NotNull
public static MappedFile mappedFile(@NotNull
                                             File file,
                                             long chunkSize)
                                      throws FileNotFoundException

Throws:

FileNotFoundException

mappedFile

@NotNull
public static MappedFile mappedFile(@NotNull
                                             String filename,
                                             long chunkSize)
                                      throws FileNotFoundException

Throws:

FileNotFoundException

mappedFile

@NotNull
public static MappedFile mappedFile(@NotNull
                                             String filename,
                                             long chunkSize,
                                             long overlapSize)
                                      throws FileNotFoundException

Throws:

FileNotFoundException

mappedFile

@NotNull
public static MappedFile mappedFile(@NotNull
                                             File file,
                                             long chunkSize,
                                             long overlapSize)
                                      throws FileNotFoundException

Throws:

FileNotFoundException

mappedFile

@NotNull
public static MappedFile mappedFile(@NotNull
                                             File file,
                                             long chunkSize,
                                             long overlapSize,
                                             boolean readOnly)
                                      throws FileNotFoundException

Throws:

FileNotFoundException

readOnly

@NotNull
public static MappedFile readOnly(@NotNull
                                           File file)
                                    throws FileNotFoundException

Throws:

FileNotFoundException

mappedFile

@NotNull
public static MappedFile mappedFile(@NotNull
                                             File file,
                                             long capacity,
                                             long chunkSize,
                                             long overlapSize,
                                             boolean readOnly)
                                      throws IOException

Throws:

IOException

warmup

public static void warmup()

withSizes

@NotNull
public MappedFile withSizes(long chunkSize,
                                     long overlapSize)

file

@NotNull
public File file()

acquireByteStore

@NotNull
public MappedBytesStore acquireByteStore(long position)
                                           throws IOException,
                                                  IllegalArgumentException,
                                                  IllegalStateException

Throws:

IOException

IllegalArgumentException

IllegalStateException

acquireByteStore

@NotNull
public <T extends MappedBytesStore> T acquireByteStore(long position,
                                                                @NotNull
                                                                MappedBytesStoreFactory<T> mappedBytesStoreFactory)
                                                         throws IOException,
                                                                IllegalArgumentException,
                                                                IllegalStateException

Throws:

IOException

IllegalArgumentException

IllegalStateException

acquireBytesForRead

@NotNull
public Bytes acquireBytesForRead(long position)
                                   throws IOException,
                                          IllegalStateException,
                                          IllegalArgumentException

Convenience method so you don't need to release the BytesStore

Throws:

IOException

IllegalStateException

IllegalArgumentException

acquireBytesForRead

public void acquireBytesForRead(long position,
                                @NotNull
                                VanillaBytes bytes)
                         throws IOException,
                                IllegalStateException,
                                IllegalArgumentException

Throws:

IOException

IllegalStateException

IllegalArgumentException

acquireBytesForWrite

@NotNull
public Bytes acquireBytesForWrite(long position)
                                    throws IOException,
                                           IllegalStateException,
                                           IllegalArgumentException

Throws:

IOException

IllegalStateException

IllegalArgumentException

acquireBytesForWrite

public void acquireBytesForWrite(long position,
                                 @NotNull
                                 VanillaBytes bytes)
                          throws IOException,
                                 IllegalStateException,
                                 IllegalArgumentException

Throws:

IOException

IllegalStateException

IllegalArgumentException

reserve

public void reserve()
             throws IllegalStateException

Specified by:

reserve in interface net.openhft.chronicle.core.ReferenceCounted

Throws:

IllegalStateException

release

public void release()
             throws IllegalStateException

Specified by:

release in interface net.openhft.chronicle.core.ReferenceCounted

Throws:

IllegalStateException

refCount

public long refCount()

Specified by:

refCount in interface net.openhft.chronicle.core.ReferenceCounted

tryReserve

public boolean tryReserve()

Specified by:

tryReserve in interface net.openhft.chronicle.core.ReferenceCounted

referenceCounts

@NotNull
public String referenceCounts()

capacity

public long capacity()

chunkSize

public long chunkSize()

overlapSize

public long overlapSize()

getNewChunkListener

public NewChunkListener getNewChunkListener()

setNewChunkListener

public void setNewChunkListener(NewChunkListener listener)

actualSize

public long actualSize()
                throws net.openhft.chronicle.core.io.IORuntimeException

Throws:

net.openhft.chronicle.core.io.IORuntimeException

isClosed

public boolean isClosed()