net.openhft.lang.io

Class MappedStore

java.lang.Object

net.openhft.lang.io.MappedStore

All Implemented Interfaces:

Closeable, AutoCloseable, BytesStore

public class MappedStore
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
protected net.openhft.lang.io.AbstractMappedStore.MmapInfoHolder	mmapInfoHolder

Constructor Summary

Constructors

Constructor and Description
MappedStore(File file, FileChannel.MapMode mode, long size)
MappedStore(File file, FileChannel.MapMode mode, long size, BytesMarshallerFactory bytesMarshallerFactory) Deprecated.
MappedStore(File file, FileChannel.MapMode mode, long startInFile, long size, ObjectSerializer objectSerializer)
MappedStore(File file, FileChannel.MapMode mode, long size, ObjectSerializer objectSerializer)

Method Summary

Modifier and Type	Method and Description
long	address()
DirectBytes	bytes() Create a bytes whose content is the whole bytes store.
DirectBytes	bytes(long offset, long length) Slice a Bytes object with start address of address+ offset and capacity of length.
void	close()
File	file()
void	free()
protected void	map(long startInFile)
ObjectSerializer	objectSerializer()
protected void	resizeIfNeeded(long startInFile, long newSize)
long	size()
void	syncToDisk()
protected void	unmapAndSyncToDisk()
protected static void	validateSize(long size)

Methods inherited from class java.lang.Object

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

Field Detail

mmapInfoHolder

protected final net.openhft.lang.io.AbstractMappedStore.MmapInfoHolder mmapInfoHolder

Constructor Detail

MappedStore

public MappedStore(File file,
                   FileChannel.MapMode mode,
                   long size)
            throws IOException

Throws:

IOException

MappedStore

@Deprecated
public MappedStore(File file,
                               FileChannel.MapMode mode,
                               long size,
                               BytesMarshallerFactory bytesMarshallerFactory)
                        throws IOException

Deprecated.

Throws:

IOException

MappedStore

public MappedStore(File file,
                   FileChannel.MapMode mode,
                   long size,
                   ObjectSerializer objectSerializer)
            throws IOException

Throws:

IOException

MappedStore

public MappedStore(File file,
                   FileChannel.MapMode mode,
                   long startInFile,
                   long size,
                   ObjectSerializer objectSerializer)
            throws IOException

Throws:

IOException

Method Detail

validateSize

protected static void validateSize(long size)

resizeIfNeeded

protected final void resizeIfNeeded(long startInFile,
                                    long newSize)
                             throws IOException

Throws:

IOException

map

protected final void map(long startInFile)
                  throws IOException

Throws:

IOException

unmapAndSyncToDisk

protected final void unmapAndSyncToDisk()
                                 throws IOException

Throws:

IOException

syncToDisk

public final void syncToDisk()
                      throws IOException

Throws:

IOException

objectSerializer

public final ObjectSerializer objectSerializer()

Specified by:

objectSerializer in interface BytesStore

address

public final long address()

Specified by:

address in interface BytesStore

size

public final long size()

Specified by:

size in interface BytesStore

free

public final void free()

Specified by:

free in interface BytesStore

close

public final void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

bytes

@NotNull
public final DirectBytes bytes()

Description copied from interface: BytesStore

Create a bytes whose content is the whole bytes store. Call of this method is equivalent to bytes(0, size()) call.

Specified by:

bytes in interface BytesStore

Returns:

the new bytes

See Also:

BytesStore.bytes(long, long)

bytes

@NotNull
public final DirectBytes bytes(long offset,
                                        long length)

Description copied from interface: BytesStore

Slice a Bytes object with start address of address+ offset and capacity of length.

If this BytesStore is Bytes itself rather than natural BytesStore object, this method will offset the new bytes from the bytes' start, not from bytes' position like BytesCommon.slice(long, long).

offset should be non-negative, length should be positive, offset + length should be less or equal to size.

Specified by:

bytes in interface BytesStore

Parameters:

offset - offset of the new bytes from the bytes store address

length - capacity and limit of the new bytes

Returns:

the sliced Bytes

See Also:

BytesStore.bytes()

file

public final File file()

Specified by:

file in interface BytesStore