net.kuujo.catalyst.buffer.util

Class MappedMemory

java.lang.Object

net.kuujo.catalyst.buffer.util.NativeMemory

net.kuujo.catalyst.buffer.util.MappedMemory

All Implemented Interfaces:

Memory

public class MappedMemory
extends NativeMemory

Mapped memory.

This is a special memory descriptor that handles management of MappedByteBuffer based memory. The mapped memory descriptor simply points to the memory address of the underlying byte buffer. When memory is reallocated, the parent MappedMemoryAllocator is used to create a new MappedByteBuffer and free the existing buffer.

Author:

Jordan Halterman

Nested Class Summary

Nested classes/interfaces inherited from interface net.kuujo.catalyst.buffer.util.Memory

Memory.Util

Field Summary

Fields

Modifier and Type	Field and Description
static long	MAX_SIZE

Constructor Summary

Constructors

Constructor and Description
MappedMemory(MappedByteBuffer buffer, MappedMemoryAllocator allocator)

Method Summary

Modifier and Type	Method and Description
static MappedMemory	allocate(File file, FileChannel.MapMode mode, long size) Allocates memory mapped to a file on disk.
static MappedMemory	allocate(File file, long size) Allocates memory mapped to a file on disk.
void	flush() Flushes the mapped buffer to disk.
void	free() Frees the memory.

Methods inherited from class net.kuujo.catalyst.buffer.util.NativeMemory

address, address, allocate, allocator, clear, copy, getByte, getChar, getDouble, getFloat, getInt, getLong, getShort, putByte, putChar, putDouble, putFloat, putInt, putLong, putShort, size, unsafe

Methods inherited from class java.lang.Object

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

Field Detail

MAX_SIZE

public static final long MAX_SIZE

See Also:

Constant Field Values

Constructor Detail

MappedMemory

public MappedMemory(MappedByteBuffer buffer,
                    MappedMemoryAllocator allocator)

Method Detail

allocate

public static MappedMemory allocate(File file,
                                    long size)

Allocates memory mapped to a file on disk.

Parameters:

file - The file to which to map memory.

size - The count of the memory to map.

Returns:

The mapped memory.

Throws:

IllegalArgumentException - If count is greater than Integer.MAX_VALUE

allocate

public static MappedMemory allocate(File file,
                                    FileChannel.MapMode mode,
                                    long size)

Allocates memory mapped to a file on disk.

Parameters:

file - The file to which to map memory.

mode - The mode with which to map memory.

size - The count of the memory to map.

Returns:

The mapped memory.

Throws:

IllegalArgumentException - If count is greater than Integer.MAX_VALUE

flush

public void flush()

Flushes the mapped buffer to disk.

free

public void free()

Description copied from interface: Memory

Frees the memory.

Specified by:

free in interface Memory

Overrides:

free in class NativeMemory