com.oracle.deviceaccess.mmio

Interface RawBlock

All Superinterfaces:

RawMemory

public interface RawBlock
extends RawMemory

The RawBlock interface provides methods to access a continuous range of physical memory (raw memory) as a ByteBuffer. A RawBlock instance can be obtained from a MMIODevice instance.

The index parameter of ByteBuffer absolute operations map to physical memory addresses. The index values are relative to the base address of the raw memory area. The index value 0 corresponds to the base address of the raw memory area.

Method Summary

Methods

Modifier and Type	Method and Description
java.nio.ByteBuffer	asDirectBuffer() Gets the complete memory area this RawBlock is mapped to as a direct ByteBuffer.
java.lang.String	getName() Returns the name assigned to this RawBlock instance.

Method Detail

asDirectBuffer

java.nio.ByteBuffer asDirectBuffer()
                                   throws java.io.IOException,
                                          UnavailablePeripheralException,
                                          ClosedPeripheralException

Gets the complete memory area this RawBlock is mapped to as a direct ByteBuffer. The byte order of the retrieved buffer will be that of this device unless the byte ordering is not standard (as indicated by the value Peripheral.MIXED_ENDIAN; in which case the buffer's byte order will be set to ByteOrder.BIG_ENDIAN.

When the returned ByteBuffer instance is invalidated because the peripheral is either closed or in exclusive use by some other application then an attempt to access the ByteBuffer instance will not change the buffer's content and will cause a ClosedPeripheralException or some other unspecified exception to be thrown either at the time of the access or at some later time.

Returns:

the direct ByteBuffer for the complete raw memory area associated with this RawBlock.

Throws:

java.io.IOException - if some other I/O error occurs.

UnavailablePeripheralException - if this peripheral is not currently available - such as it is locked by another application.

ClosedPeripheralException - if the peripheral has been closed.

getName

java.lang.String getName()

Returns the name assigned to this RawBlock instance.

Specified by:

getName in interface RawMemory

Returns:

this RawBlock instance's name or null if this RawBlock instance was obtained by a call to MMIODevice.getAsRawBlock().