Package com.yahoo.memory

The memory package contains classes that extend the Java Unsafe class and provide direct primitive and array access to off-heap memory as well as compatible views into heap-based arrays and the Java ByteBuffer class.

See: Description

Interface Summary

Interface	Description
Memory	The Memory interface defines get and put methods for all Java primitive and primitive array types to/from a byte offset that is relative to the base address of some object or region of native memory defined by the implementing class.
MemoryRequest	The MemoryRequest is a callback interface that is accessible from the Memory interface and provides a means for a Memory object to request more memory from the calling class and to free Memory that is no longer needed.

Class Summary

Class	Description
AllocMemory	The AllocMemory class is a subclass of NativeMemory1.
MemoryMappedFile	MemoryMappedFile class extends NativeMemory and is used to memory map files (including those > 2GB) off heap.
MemoryRegion	The MemoryRegion class implements the Memory interface and provides a means of hierarchically partitioning a large block of native memory into smaller regions of memory, each with their own capacity and offsets.
MemoryUtil	Useful utilities that work with Memory.
NativeMemory	The NativeMemory class implements the Memory interface and is used to access Java primitive arrays, and ByteBuffers by presenting them as arguments to the constructors of this class.
UnsafeUtil	Provides access to the sun.misc.Unsafe class and its key static fields.

Exception Summary

Exception	Description
ReadOnlyMemoryException	The exception thrown when attempting to write into a read-only Memory.

Package com.yahoo.memory Description

The memory package contains classes that extend the Java Unsafe class and provide direct primitive and array access to off-heap memory as well as compatible views into heap-based arrays and the Java ByteBuffer class. This package is general purpose, has no external dependencies and can be used in any application that needs to manage data structures outside the Java heap.

This package requires JDK8 or higher.

Author:

Lee Rhodes