net.openhft.chronicle.bytes.internal

Class SingleMappedFile

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.SingleMappedFile

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 SingleMappedFile
extends MappedFile

A memory mapped files which can be randomly accessed in a single chunk. It has no overlapping region to avoid wasting bytes at the end of file.

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
SingleMappedFile(@NotNull File file, @NotNull RandomAccessFile raf, long capacity, boolean readOnly)
SingleMappedFile(@NotNull File file, @NotNull RandomAccessFile raf, long capacity, int pageSize, boolean readOnly) Constructs a new SingleMappedFile with specified parameters.

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 the MappedBytesStore at the specified position
long	actualSize() Returns the actual size of this mapped file
long	capacity() Returns the capacity of this mapped file
long	chunkCount() Returns the number of chunks in this mapped file
void	chunkCount(long[] chunkCount) Fills the provided array with the number of chunks in this mapped file
long	chunkSize() Returns the size of chunks in this mapped file
MappedBytes	createBytesFor() Creates a new SingleMappedBytes 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) Locks a region of this mapped file
long	overlapSize() Returns the size of overlaps in this mapped file
protected void	performRelease() Releases resources held by this mapped file
@NotNull RandomAccessFile	raf() Returns the RandomAccessFile of this mapped file
@NotNull String	referenceCounts() Returns a string representing the reference counts of this mapped file and its store
void	setNewChunkListener(NewChunkListener listener) Sets the listener to be notified when a new chunk is created.
void	syncMode(SyncMode syncMode) Sets the synchronization mode for the underlying MappedBytesStore
protected boolean	threadSafetyCheck(boolean isUsed) Performs a thread safety check on the component.
FileLock	tryLock(long position, long size, boolean shared) Attempts to lock a region of this mapped file

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

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

SingleMappedFile

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

Constructs a new SingleMappedFile with specified parameters.

Parameters:

file - the file to be mapped.

raf - the RandomAccessFile associated with the file.

capacity - the capacity of the mapped file.

readOnly - if the file is read-only.

Throws:

net.openhft.chronicle.core.io.IORuntimeException - if any I/O error occurs.

SingleMappedFile

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

Throws:

net.openhft.chronicle.core.io.IORuntimeException

Method Detail

syncMode

public void syncMode(SyncMode syncMode)

Sets the synchronization mode for the underlying MappedBytesStore

Specified by:

syncMode in class MappedFile

Parameters:

syncMode - The synchronization mode to set

acquireByteStore

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

Acquires the MappedBytesStore at the specified position

Specified by:

acquireByteStore in class MappedFile

Parameters:

owner - The owner of the MappedBytesStore

position - The position to acquire

oldByteStore - The old byte store

mappedBytesStoreFactory - The factory to use when creating new MappedBytesStore

Returns:

The MappedBytesStore at the specified position

Throws:

IllegalArgumentException - If position is not zero

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

performRelease

protected void performRelease()

Releases resources held by this mapped file

Specified by:

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

referenceCounts

@NotNull
public @NotNull String referenceCounts()

Returns a string representing the reference counts of this mapped file and its store

Specified by:

referenceCounts in class MappedFile

Returns:

A string representing the reference counts

capacity

public long capacity()

Returns the capacity of this mapped file

Specified by:

capacity in class MappedFile

Returns:

The capacity of this mapped file

chunkSize

public long chunkSize()

Returns the size of chunks in this mapped file

Specified by:

chunkSize in class MappedFile

Returns:

The size of chunks in this mapped file

overlapSize

public long overlapSize()

Returns the size of overlaps in this mapped file

Specified by:

overlapSize in class MappedFile

Returns:

The size of overlaps in this mapped file

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

Returns the actual size of this mapped file

Specified by:

actualSize in class MappedFile

Returns:

The actual size of this mapped file

Throws:

net.openhft.chronicle.core.io.IORuntimeException - If an I/O error occurs

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

IllegalStateException

raf

@NotNull
public @NotNull RandomAccessFile raf()

Returns the RandomAccessFile of this mapped file

Specified by:

raf in class MappedFile

Returns:

The RandomAccessFile of this 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

Locks a region of this mapped file

Specified by:

lock in class MappedFile

Parameters:

position - The position at which to start the locked region

size - The size of the locked region

shared - Whether the lock is shared

Returns:

A lock object representing the locked region

Throws:

IOException - If an I/O error occurs

tryLock

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

Attempts to lock a region of this mapped file

Specified by:

tryLock in class MappedFile

Parameters:

position - The position at which to start the locked region

size - The size of the locked region

shared - Whether the lock is shared

Returns:

A lock object representing the locked region, or null if the region cannot be locked

Throws:

IOException - If an I/O error occurs

chunkCount

public long chunkCount()

Returns the number of chunks in this mapped file

Specified by:

chunkCount in class MappedFile

Returns:

The number of chunks in this mapped file

chunkCount

public void chunkCount(long[] chunkCount)

Fills the provided array with the number of chunks in this mapped file

Specified by:

chunkCount in class MappedFile

Parameters:

chunkCount - The array to fill

createBytesFor

public MappedBytes createBytesFor()

Creates a new SingleMappedBytes for this mapped file

Specified by:

createBytesFor in class MappedFile

Returns:

A new SingleMappedBytes