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.

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	capacity()
void	close()
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)
long	refCount()
String	referenceCounts()
void	release()
void	reserve()

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

Method Detail

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

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