jdk.dio.mmio

Class MMIOEvent

java.lang.Object

jdk.dio.DeviceEvent<MMIODevice>

jdk.dio.mmio.MMIOEvent

public class MMIOEvent
extends DeviceEvent<MMIODevice>

The MMIOEvent class encapsulates events fired by devices mapped to memory.

See Also:

MMIODevice, MMIOEventListener

Field Summary

Fields inherited from class jdk.dio.DeviceEvent

count, device, lastTimeStamp, lastTimeStampMicros, timeStamp, timeStampMicros

Constructor Summary

Constructors

Constructor and Description
MMIOEvent(MMIODevice device, int id) Creates a new MMIOEvent with the specified event ID and time-stamped with the current time.
MMIOEvent(MMIODevice device, int id, java.nio.ByteBuffer capturedMemoryContent, long timeStamp, int timeStampMicros) Creates a new MMIOEvent with the specified event ID and timestamp, and with the captured content of the memory area or memory block designated upon registration.
MMIOEvent(MMIODevice device, int id, long timeStamp, int timeStampMicros) Creates a new MMIOEvent with the specified event ID and timestamp.
MMIOEvent(MMIODevice device, int id, T capturedRegisterValue, long timeStamp, int timeStampMicros) Creates a new MMIOEvent with the specified event ID and timestamp, and the captured value of the register designated upon registration.

Method Summary

Methods

Modifier and Type	Method and Description
java.nio.ByteBuffer	getCapturedMemoryContent() Gets the captured content of the memory area or memory block designated upon registration.
<T extends java.lang.Number> T	getCapturedRegisterValue() Gets the captured value of the register designated upon registration.
int	getID() Returns this event ID.

Methods inherited from class jdk.dio.DeviceEvent

getCount, getDevice, getLastTimeStamp, getLastTimeStampMicros, getTimeStamp, getTimeStampMicros

Methods inherited from class java.lang.Object

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

Constructor Detail

MMIOEvent

public MMIOEvent(MMIODevice device,
         int id)

Creates a new MMIOEvent with the specified event ID and time-stamped with the current time.

Parameters:

device - the source device.

id - the event ID.

Throws:

java.lang.NullPointerException - if device is null.

java.lang.IllegalArgumentException - if id is negative.

MMIOEvent

public MMIOEvent(MMIODevice device,
         int id,
         java.nio.ByteBuffer capturedMemoryContent,
         long timeStamp,
         int timeStampMicros)

Creates a new MMIOEvent with the specified event ID and timestamp, and with the captured content of the memory area or memory block designated upon registration.

Parameters:

device - the source device.

id - the event ID.

capturedMemoryContent - the captured content of the memory area or memory block designated upon registration.

timeStamp - the timestamp (in milliseconds).

timeStampMicros - the additional microseconds to the timestamp.

Throws:

java.lang.NullPointerException - if device or capturedMemoryContent is null.

java.lang.IllegalArgumentException - if id, timeStamp or timeStampMicros is negative.

MMIOEvent

public MMIOEvent(MMIODevice device,
         int id,
         long timeStamp,
         int timeStampMicros)

Creates a new MMIOEvent with the specified event ID and timestamp.

Parameters:

device - the source device.

id - the event ID.

timeStamp - the timestamp (in milliseconds).

timeStampMicros - the additional microseconds to the timestamp.

Throws:

java.lang.NullPointerException - if device is null.

java.lang.IllegalArgumentException - if id, timeStamp or timeStampMicros is negative.

MMIOEvent

public MMIOEvent(MMIODevice device,
         int id,
         T capturedRegisterValue,
         long timeStamp,
         int timeStampMicros)

Creates a new MMIOEvent with the specified event ID and timestamp, and the captured value of the register designated upon registration.

Type Parameters:

T - the type of the captured value.

Parameters:

device - the source device.

id - the event ID.

capturedRegisterValue - the captured value of the register designated upon registration.

timeStamp - the timestamp (in milliseconds).

timeStampMicros - the additional microseconds to the timestamp.

Throws:

java.lang.NullPointerException - if device or capturedRegisterValue is null.

java.lang.IllegalArgumentException - if id, timeStamp or timeStampMicros is negative.

Method Detail

getCapturedMemoryContent

public java.nio.ByteBuffer getCapturedMemoryContent()

Gets the captured content of the memory area or memory block designated upon registration.

Returns:

the captured content of the memory area or block; or null if no memory area or block content was captured. If the listener was registered using the MMIODevice#setMMIOEventListener(int, int, ByteBuffer, jdk.dio.mmio.MMIOEventListener) method the ByteBuffer returned is the ByteBuffer that was passed as the captureBuffer parameter.

See Also:

MMIODevice.setMMIOEventListener(int, java.lang.String, jdk.dio.mmio.MMIOEventListener), MMIODevice.setMMIOEventListener(int, int, ByteBuffer, jdk.dio.mmio.MMIOEventListener)

getCapturedRegisterValue

public <T extends java.lang.Number> T getCapturedRegisterValue()

Gets the captured value of the register designated upon registration.

Type Parameters:

T - the type of the value held by the register.

Returns:

the captured value of the register designated upon registration or null if no register value was captured.

See Also:

MMIODevice.setMMIOEventListener(int, java.lang.String, jdk.dio.mmio.MMIOEventListener)

getID

public int getID()

Returns this event ID.

Returns:

this event ID.