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(@NotNull File file, @NotNull RandomAccessFile raf, long chunkSize, long overlapSize, long capacity, boolean readOnly)

Method Summary

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

Method Detail

checkMappedFiles

public static void checkMappedFiles()

of

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

Throws:

FileNotFoundException

mappedFile

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

Throws:

FileNotFoundException

mappedFile

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

Throws:

FileNotFoundException

mappedFile

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

Throws:

FileNotFoundException

mappedFile

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

Throws:

FileNotFoundException

mappedFile

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

Throws:

FileNotFoundException

readOnly

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

Throws:

FileNotFoundException

mappedFile

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

Throws:

IOException

warmup

public static void warmup()

withSizes

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

file

@NotNull
public @NotNull File file()

acquireByteStore

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

Throws:

IOException

IllegalArgumentException

IllegalStateException

acquireByteStore

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

Throws:

IOException

IllegalArgumentException

IllegalStateException

acquireBytesForRead

@NotNull
public @NotNull 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
                                @NotNull VanillaBytes bytes)
                         throws IOException,
                                IllegalStateException,
                                IllegalArgumentException

Throws:

IOException

IllegalStateException

IllegalArgumentException

acquireBytesForWrite

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

Throws:

IOException

IllegalStateException

IllegalArgumentException

acquireBytesForWrite

public void acquireBytesForWrite(long position,
                                 @NotNull
                                 @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 @NotNull 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()

raf

@NotNull
public @NotNull RandomAccessFile raf()