net.openhft.chronicle.bytes.internal

Class ChunkedMappedFile

java.lang.Object

net.openhft.chronicle.core.io.AbstractReferenceCounted

net.openhft.chronicle.core.io.AbstractCloseableReferenceCounted

net.openhft.chronicle.bytes.MappedFile

net.openhft.chronicle.bytes.internal.ChunkedMappedFile

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, net.openhft.chronicle.core.io.SingleThreadedChecked

public class ChunkedMappedFile
extends MappedFile

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 inherited from class net.openhft.chronicle.bytes.MappedFile

DEFAULT_SYNC_MODE, newChunkListener, RETAIN

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, TMP

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

DISABLE_SINGLE_THREADED_CHECK

Constructor Summary

Constructors

Constructor and Description
ChunkedMappedFile(@NotNull File file, @NotNull RandomAccessFile raf, long chunkSize, long overlapSize, int pageSize, long capacity, boolean readOnly)
ChunkedMappedFile(@NotNull File file, @NotNull RandomAccessFile raf, long chunkSize, long overlapSize, long capacity, boolean readOnly)

Method Summary

Modifier and Type	Method and Description
@NotNull MappedBytesStore	acquireByteStore(net.openhft.chronicle.core.io.ReferenceOwner owner, long position, BytesStore oldByteStore, @NotNull MappedBytesStoreFactory mappedBytesStoreFactory) Acquires a byte store at the specified position with the ability to re-use an existing byte store, and specify a custom byte store factory.
long	actualSize() Returns the actual size of the mapped file in bytes, including any space reserved for metadata, headers, etc.
long	capacity() Returns the capacity of the mapped file in bytes.
long	chunkCount() Returns the number of chunks in this mapped file.
void	chunkCount(long[] chunkCount) Populates the provided array with detailed chunk count information.
long	chunkSize() Returns the size of each chunk in the mapped file in bytes.
MappedBytes	createBytesFor() Creates a MappedBytes object for this mapped file.
protected void	finalize() This finalize() is used to detect when a component is not released deterministically.
NewChunkListener	getNewChunkListener() Returns the listener that is notified when a new chunk is created.
FileLock	lock(long position, long size, boolean shared) Calls lock on the underlying file channel
long	overlapSize() Returns the size of the overlap between consecutive chunks in the mapped file in bytes.
protected void	performRelease()
@NotNull RandomAccessFile	raf() Returns the RandomAccessFile associated with the mapped file.
@NotNull String	referenceCounts() Returns a string representation of the reference counts for the underlying mapped byte stores.
void	setNewChunkListener(NewChunkListener listener) Sets the listener to be notified when a new chunk is created.
void	syncMode(SyncMode syncMode) This mode determines whether an MS_ASYNC or MS_SYNC should be performed on a chunk release.
protected boolean	threadSafetyCheck(boolean isUsed) Performs a thread safety check on the component.
FileLock	tryLock(long position, long size, boolean shared) Calls tryLock on the underlying file channel
static void	warmup() Not compatible with hugetlbfs

Methods inherited from class net.openhft.chronicle.bytes.MappedFile

acquireBytesForRead, acquireBytesForRead, acquireBytesForWrite, acquireBytesForWrite, acquireByteStore, acquireByteStore, canReleaseInBackground, file, internalizedToken, mappedFile, mappedFile, mappedFile, mappedFile, mappedFile, mappedFile, of, of, ofSingle, readOnly, readOnly

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

addReferenceChangeListener, assertReferencesReleased, clearUsedByThread, createdHere, disableReferenceTracing, enableReferenceTracing, refCount, referenceCountedUnmonitored, referenceId, removeReferenceChangeListener, reservedBy, singleThreadedCheckDisabled, singleThreadedCheckReset, 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

Constructor Detail

ChunkedMappedFile

public ChunkedMappedFile(@NotNull
                         @NotNull File file,
                         @NotNull
                         @NotNull RandomAccessFile raf,
                         long chunkSize,
                         long overlapSize,
                         long capacity,
                         boolean readOnly)
                  throws net.openhft.chronicle.core.io.IORuntimeException

Throws:

net.openhft.chronicle.core.io.IORuntimeException

ChunkedMappedFile

public ChunkedMappedFile(@NotNull
                         @NotNull File file,
                         @NotNull
                         @NotNull RandomAccessFile raf,
                         long chunkSize,
                         long overlapSize,
                         int pageSize,
                         long capacity,
                         boolean readOnly)
                  throws net.openhft.chronicle.core.io.IORuntimeException

Throws:

net.openhft.chronicle.core.io.IORuntimeException

Method Detail

warmup

public static void warmup()

Not compatible with hugetlbfs

acquireByteStore

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

Description copied from class: MappedFile

Acquires a byte store at the specified position with the ability to re-use an existing byte store, and specify a custom byte store factory.

Specified by:

acquireByteStore in class MappedFile

Parameters:

owner - The owner of the byte store.

position - The position at which the byte store should be acquired.

oldByteStore - The old byte store that can be re-used, or null if not available.

mappedBytesStoreFactory - The factory to use for creating the MappedBytesStore.

Returns:

A MappedBytesStore object.

Throws:

IOException - If an I/O error occurs.

IllegalArgumentException - If an illegal argument is provided.

net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.

net.openhft.chronicle.core.io.ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way

syncMode

public void syncMode(SyncMode syncMode)

Description copied from class: MappedFile

This mode determines whether an MS_ASYNC or MS_SYNC should be performed on a chunk release.

Performs this sync on any open store as well

Specified by:

syncMode in class MappedFile

Parameters:

syncMode - of sync to perform.

performRelease

protected void performRelease()

Specified by:

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

referenceCounts

@NotNull
public @NotNull String referenceCounts()

Description copied from class: MappedFile

Returns a string representation of the reference counts for the underlying mapped byte stores.

Specified by:

referenceCounts in class MappedFile

Returns:

A string representing the reference counts.

capacity

public long capacity()

Description copied from class: MappedFile

Returns the capacity of the mapped file in bytes.

Specified by:

capacity in class MappedFile

Returns:

The capacity in bytes.

chunkSize

public long chunkSize()

Description copied from class: MappedFile

Returns the size of each chunk in the mapped file in bytes.

Specified by:

chunkSize in class MappedFile

Returns:

The chunk size in bytes.

overlapSize

public long overlapSize()

Description copied from class: MappedFile

Returns the size of the overlap between consecutive chunks in the mapped file in bytes.

Specified by:

overlapSize in class MappedFile

Returns:

The overlap size in bytes.

getNewChunkListener

public NewChunkListener getNewChunkListener()

Description copied from class: MappedFile

Returns the listener that is notified when a new chunk is created.

Overrides:

getNewChunkListener in class MappedFile

Returns:

The listener for new chunks.

setNewChunkListener

public void setNewChunkListener(NewChunkListener listener)

Description copied from class: MappedFile

Sets the listener to be notified when a new chunk is created.

Overrides:

setNewChunkListener in class MappedFile

Parameters:

listener - The listener to be set.

actualSize

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

Description copied from class: MappedFile

Returns the actual size of the mapped file in bytes, including any space reserved for metadata, headers, etc.

Specified by:

actualSize in class MappedFile

Returns:

The actual size in bytes.

Throws:

net.openhft.chronicle.core.io.IORuntimeException

IllegalStateException

raf

@NotNull
public @NotNull RandomAccessFile raf()

Description copied from class: MappedFile

Returns the RandomAccessFile associated with the mapped file. This can be used for lower-level operations that are not directly supported by the MappedFile API.

Specified by:

raf in class MappedFile

Returns:

The RandomAccessFile associated with the mapped file.

finalize

protected void finalize()
                 throws Throwable

This finalize() is used to detect when a component is not released deterministically. It is not required to be run, but provides a warning

Overrides:

finalize in class MappedFile

Throws:

Throwable

threadSafetyCheck

protected boolean threadSafetyCheck(boolean isUsed)

Description copied from class: MappedFile

Performs a thread safety check on the component.

Overrides:

threadSafetyCheck in class MappedFile

Parameters:

isUsed - Flag to indicate whether the component is used.

Returns:

Always returns true as the component is thread-safe.

lock

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

Calls lock on the underlying file channel

Specified by:

lock in class MappedFile

Parameters:

position - The byte position at which the locked region begins.

size - The size of the region to lock, in bytes.

shared - If true, the lock will be shared. Otherwise, it will be exclusive.

Returns:

A FileLock object representing the lock on the specified region.

Throws:

IOException - If an I/O error occurs.

tryLock

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

Calls tryLock on the underlying file channel

Specified by:

tryLock in class MappedFile

Parameters:

position - The byte position at which the locked region begins.

size - The size of the region to lock, in bytes.

shared - If true, the lock will be shared. Otherwise, it will be exclusive.

Returns:

A FileLock object representing the lock on the specified region, or null if the lock could not be acquired.

Throws:

IOException - If an I/O error occurs.

chunkCount

public long chunkCount()

Description copied from class: MappedFile

Returns the number of chunks in this mapped file.

Specified by:

chunkCount in class MappedFile

Returns:

The number of chunks.

chunkCount

public void chunkCount(long[] chunkCount)

Description copied from class: MappedFile

Populates the provided array with detailed chunk count information. This may include, for example, counts of specific types of chunks.

Specified by:

chunkCount in class MappedFile

Parameters:

chunkCount - The array to be populated with detailed chunk count information.

createBytesFor

public MappedBytes createBytesFor()
                           throws net.openhft.chronicle.core.io.ClosedIllegalStateException

Description copied from class: MappedFile

Creates a MappedBytes object for this mapped file. The MappedBytes object can be used for reading from and writing to the mapped file.

Specified by:

createBytesFor in class MappedFile

Returns:

A new MappedBytes object associated with this mapped file.

Throws:

net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.