net.openhft.chronicle.bytes

Class MappedFile

java.lang.Object

net.openhft.chronicle.bytes.MappedFile

All Implemented Interfaces:

Closeable, AutoCloseable, 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.

Field Summary

Fields

Modifier and Type	Field and Description
static long	DEFAULT_CAPACITY

Constructor Summary

Constructors

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

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()
long	chunkSize()
void	close()
File	file()
NewChunkListener	getNewChunkListener()
static MappedFile	mappedFile(File file, long chunkSize)
static MappedFile	mappedFile(File file, long chunkSize, long overlapSize)
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)
long	overlapSize()
long	refCount()
String	referenceCounts()
void	release()
void	reserve()
void	setNewChunkListener(NewChunkListener listener)
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, tryReserve

Methods inherited from interface net.openhft.chronicle.core.io.Closeable

closeQuietly, isClosed, notifyClosing

Field Detail

DEFAULT_CAPACITY

public static final long DEFAULT_CAPACITY

See Also:

Constant Field Values

Constructor Detail

MappedFile

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

Method Detail

of

public static MappedFile of(@NotNull
                            File file,
                            long chunkSize,
                            long overlapSize)
                     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

withSizes

public MappedFile withSizes(long chunkSize,
                            long overlapSize)

file

public File file()

acquireByteStore

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

Throws:

IOException

IllegalArgumentException

IllegalStateException

acquireByteStore

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

Throws:

IOException

IllegalArgumentException

IllegalStateException

acquireBytesForRead

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

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

close

public void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close 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()