com.oracle.svm.core.heap

Class PinnedBuffer

java.lang.Object

com.oracle.svm.core.heap.PinnedBuffer

All Implemented Interfaces:

AutoCloseable

public final class PinnedBuffer
extends Object
implements AutoCloseable

Provides access to the raw underlying memory of a Buffer. For direct buffers, the address of the raw native memory encapsulated by the buffer is returned. For array-based buffers, the array is pinned and the address to the pinned Java memory is returned. Not all kinds of buffers are supported. For example, when you create an array-based ByteBuffer and wrap it as an IntBuffer, a complicated nested structure is created that is not supported yet.

Method Summary

Modifier and Type	Method and Description
<T extends org.graalvm.word.PointerBase> T	addressOf(int position) Returns a pointer to the specified buffer element.
void	close() Releases the pin for the buffer.
Buffer	getBuffer()
boolean	isOpen()
static PinnedBuffer	open(Buffer buffer) Creates an open PinnedBuffer for the provided Buffer.

Methods inherited from class java.lang.Object

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

Method Detail

open

public static PinnedBuffer open(Buffer buffer)

Creates an open PinnedBuffer for the provided Buffer.

getBuffer

public Buffer getBuffer()

isOpen

public boolean isOpen()

addressOf

public <T extends org.graalvm.word.PointerBase> T addressOf(int position)

Returns a pointer to the specified buffer element. The method does not take the Buffer.position() of the buffer into account, but you can provide the Buffer.position() of the buffer as the argument of this method.

close

public void close()

Releases the pin for the buffer. After this call, the previous results of PinnedBuffer.addressOf(int) are no longer valid and must not be used anymore.

Specified by:

close in interface AutoCloseable