net.openhft.chronicle.bytes

Class MappedFile

java.lang.Object

net.openhft.chronicle.core.io.AbstractReferenceCounted

net.openhft.chronicle.core.io.AbstractCloseableReferenceCounted

net.openhft.chronicle.bytes.MappedFile

All Implemented Interfaces:

Closeable, AutoCloseable, net.openhft.chronicle.core.io.ManagedCloseable, net.openhft.chronicle.core.io.QueryCloseable, net.openhft.chronicle.core.io.ReferenceCounted, net.openhft.chronicle.core.io.ReferenceCountedTracer, net.openhft.chronicle.core.io.ReferenceOwner

Direct Known Subclasses:

ChunkedMappedFile, SingleMappedFile

public abstract class MappedFile
extends net.openhft.chronicle.core.io.AbstractCloseableReferenceCounted

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
protected String	canonicalPath
protected NewChunkListener	newChunkListener

Fields inherited from class net.openhft.chronicle.core.io.AbstractReferenceCounted

referenceCounted, WARN_COUNT, WARN_NS

Fields inherited from interface net.openhft.chronicle.core.io.ReferenceOwner

INIT

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MappedFile(@NotNull File file, boolean readOnly)

Method Summary

Modifier and Type	Method and Description
@NotNull Bytes	acquireBytesForRead(net.openhft.chronicle.core.io.ReferenceOwner owner, long position) Convenience method so you don't need to release the BytesStore
void	acquireBytesForRead(net.openhft.chronicle.core.io.ReferenceOwner owner, long position, @NotNull VanillaBytes bytes)
@NotNull Bytes	acquireBytesForWrite(net.openhft.chronicle.core.io.ReferenceOwner owner, long position)
void	acquireBytesForWrite(net.openhft.chronicle.core.io.ReferenceOwner owner, long position, @NotNull VanillaBytes bytes)
@NotNull MappedBytesStore	acquireByteStore(net.openhft.chronicle.core.io.ReferenceOwner owner, long position)
@NotNull MappedBytesStore	acquireByteStore(net.openhft.chronicle.core.io.ReferenceOwner owner, long position, BytesStore oldByteStore)
abstract @NotNull MappedBytesStore	acquireByteStore(net.openhft.chronicle.core.io.ReferenceOwner owner, long position, BytesStore oldByteStore, @NotNull MappedBytesStoreFactory mappedBytesStoreFactory)
abstract long	actualSize()
protected boolean	canReleaseInBackground()
abstract long	capacity()
abstract long	chunkCount()
abstract void	chunkCount(long[] chunkCount)
abstract long	chunkSize()
abstract MappedBytes	createBytesFor()
@NotNull File	file()
protected void	finalize()
NewChunkListener	getNewChunkListener()
abstract FileLock	lock(long position, long size, boolean shared) Calls lock on the underlying file channel
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)
static @NotNull MappedFile	ofSingle(@NotNull File file, long capacity, boolean readOnly)
abstract long	overlapSize()
abstract @NotNull RandomAccessFile	raf()
boolean	readOnly()
static @NotNull MappedFile	readOnly(@NotNull File file)
abstract @NotNull String	referenceCounts()
void	setNewChunkListener(NewChunkListener listener)
protected boolean	threadSafetyCheck(boolean isUsed)
abstract FileLock	tryLock(long position, long size, boolean shared) Calls tryLock on the underlying file channel
static void	warmup()

Methods inherited from class net.openhft.chronicle.core.io.AbstractCloseableReferenceCounted

backgroundPerformRelease, close, isClosed, release, releaseLast, reserve, reserveTransfer, setClosed, setClosing, throwExceptionIfClosed, throwExceptionIfClosedInSetter, tryReserve

Methods inherited from class net.openhft.chronicle.core.io.AbstractReferenceCounted

assertReferencesReleased, clearUsedByThread, createdHere, disableReferenceTracing, enableReferenceTracing, performRelease, refCount, referenceId, reservedBy, throwExceptionIfNotReleased, throwExceptionIfReleased, toString, unmonitor, warnAndReleaseIfNotReleased

Methods inherited from class java.lang.Object

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

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

createdHere, warnAndCloseIfNotClosed

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

closeQuietly, closeQuietly

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

isClosing

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

onReleased

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

releaseLast

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

referenceName, temporary

Field Detail

canonicalPath

protected final String canonicalPath

newChunkListener

protected NewChunkListener newChunkListener

Constructor Detail

MappedFile

protected MappedFile(@NotNull
                     @NotNull File file,
                     boolean readOnly)
              throws net.openhft.chronicle.core.io.IORuntimeException

Throws:

net.openhft.chronicle.core.io.IORuntimeException

Method Detail

of

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

Throws:

FileNotFoundException

ofSingle

@NotNull
public static @NotNull MappedFile ofSingle(@NotNull
                                                    @NotNull File file,
                                                    long capacity,
                                                    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()

file

@NotNull
public @NotNull File file()

readOnly

public boolean readOnly()

acquireByteStore

@NotNull
public @NotNull MappedBytesStore acquireByteStore(net.openhft.chronicle.core.io.ReferenceOwner owner,
                                                           long position)
                                                    throws IOException,
                                                           IllegalArgumentException,
                                                           IllegalStateException

Throws:

IllegalStateException - if closed.

IOException

IllegalArgumentException

acquireByteStore

@NotNull
public @NotNull MappedBytesStore acquireByteStore(net.openhft.chronicle.core.io.ReferenceOwner owner,
                                                           long position,
                                                           BytesStore oldByteStore)
                                                    throws IOException,
                                                           IllegalStateException

Throws:

IOException

IllegalStateException

acquireByteStore

@NotNull
public abstract @NotNull MappedBytesStore acquireByteStore(net.openhft.chronicle.core.io.ReferenceOwner owner,
                                                                    long position,
                                                                    BytesStore oldByteStore,
                                                                    @NotNull
                                                                    @NotNull MappedBytesStoreFactory mappedBytesStoreFactory)
                                                             throws IOException,
                                                                    IllegalArgumentException,
                                                                    IllegalStateException

Throws:

IOException

IllegalArgumentException

IllegalStateException

acquireBytesForRead

@NotNull
public @NotNull Bytes acquireBytesForRead(net.openhft.chronicle.core.io.ReferenceOwner owner,
                                                   long position)
                                            throws IOException,
                                                   IllegalStateException,
                                                   BufferUnderflowException

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

Throws:

IOException

IllegalStateException

BufferUnderflowException

acquireBytesForRead

public void acquireBytesForRead(net.openhft.chronicle.core.io.ReferenceOwner owner,
                                long position,
                                @NotNull
                                @NotNull VanillaBytes bytes)
                         throws IOException,
                                IllegalStateException,
                                IllegalArgumentException,
                                BufferUnderflowException,
                                BufferOverflowException

Throws:

IOException

IllegalStateException

IllegalArgumentException

BufferUnderflowException

BufferOverflowException

acquireBytesForWrite

@NotNull
public @NotNull Bytes acquireBytesForWrite(net.openhft.chronicle.core.io.ReferenceOwner owner,
                                                    long position)
                                             throws IOException,
                                                    IllegalStateException,
                                                    IllegalArgumentException,
                                                    BufferOverflowException

Throws:

IOException

IllegalStateException

IllegalArgumentException

BufferOverflowException

acquireBytesForWrite

public void acquireBytesForWrite(net.openhft.chronicle.core.io.ReferenceOwner owner,
                                 long position,
                                 @NotNull
                                 @NotNull VanillaBytes bytes)
                          throws IOException,
                                 IllegalStateException,
                                 IllegalArgumentException,
                                 BufferUnderflowException,
                                 BufferOverflowException

Throws:

IOException

IllegalStateException

IllegalArgumentException

BufferUnderflowException

BufferOverflowException

canReleaseInBackground

protected boolean canReleaseInBackground()

Overrides:

canReleaseInBackground in class net.openhft.chronicle.core.io.AbstractReferenceCounted

referenceCounts

@NotNull
public abstract @NotNull String referenceCounts()

capacity

public abstract long capacity()

chunkSize

public abstract long chunkSize()

overlapSize

public abstract long overlapSize()

getNewChunkListener

public NewChunkListener getNewChunkListener()

setNewChunkListener

public void setNewChunkListener(NewChunkListener listener)

actualSize

public abstract long actualSize()

raf

@NotNull
public abstract @NotNull RandomAccessFile raf()

finalize

protected void finalize()
                 throws Throwable

Overrides:

finalize in class Object

Throws:

Throwable

threadSafetyCheck

protected boolean threadSafetyCheck(boolean isUsed)

Overrides:

threadSafetyCheck in class net.openhft.chronicle.core.io.AbstractReferenceCounted

lock

public abstract FileLock lock(long position,
                              long size,
                              boolean shared)
                       throws IOException

Calls lock on the underlying file channel

Throws:

IOException

tryLock

public abstract FileLock tryLock(long position,
                                 long size,
                                 boolean shared)
                          throws IOException

Calls tryLock on the underlying file channel

Throws:

IOException

chunkCount

public abstract long chunkCount()

chunkCount

public abstract void chunkCount(long[] chunkCount)

createBytesFor

public abstract MappedBytes createBytesFor()