com.oracle.deviceaccess.mmio

Class MMIOEvent

java.lang.Object

com.oracle.deviceaccess.PeripheralEvent

com.oracle.deviceaccess.mmio.MMIOEvent

public class MMIOEvent
extends PeripheralEvent

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

See Also:

MMIODevice, MMIOEventListener

Field Summary

Fields inherited from class com.oracle.deviceaccess.PeripheralEvent

count, lastTimeStamp, lastTimeStampMicros, peripheral, timeStamp, timeStampMicros

Constructor Summary

Constructors

Constructor and Description
MMIOEvent(MMIODevice device, int id) Creates a new MMIOEvent with the specified value and time-stamped with the current time and time-stamped with the current time.
MMIOEvent(MMIODevice device, int id, byte[] capturedMemoryContent, long timeStamp, int timeStampMicros) Creates a new MMIOEvent with the specified value and timestamp.
MMIOEvent(MMIODevice device, int id, int capturedRegisterValue, long timeStamp, int timeStampMicros) Creates a new MMIOEvent with the specified value and timestamp.
MMIOEvent(MMIODevice device, int id, long timeStamp, int timeStampMicros) Creates a new MMIOEvent with the specified value and timestamp.

Method Summary

Methods

Modifier and Type	Method and Description
byte[]	getCapturedMemoryContent() Gets the captured content of the memory area or memory block designated upon registration.
int	getCapturedRegisterValue() Gets the captured value of the register designated upon registration (as a 32bit integer).
int	getID() Returns this event ID.

Methods inherited from class com.oracle.deviceaccess.PeripheralEvent

getCount, getLastTimeStamp, getLastTimeStampMicros, getPeripheral, getTimeStamp, getTimeStampMicros

Methods inherited from class java.lang.Object

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

Constructor Detail

MMIOEvent

public MMIOEvent(MMIODevice device,
         int id)

Creates a new MMIOEvent with the specified value and time-stamped with the current time 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,
         byte[] capturedMemoryContent,
         long timeStamp,
         int timeStampMicros)

Creates a new MMIOEvent with the specified value and timestamp.

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,
         int capturedRegisterValue,
         long timeStamp,
         int timeStampMicros)

Creates a new MMIOEvent with the specified value and timestamp.

Parameters:

device - the source device.

id - the event ID.

capturedRegisterValue - the captured value of the register designated upon registration (as a 32bit integer).

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.

MMIOEvent

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

Creates a new MMIOEvent with the specified value 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.

Method Detail

getCapturedMemoryContent

public byte[] 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.

See Also:

MMIODevice.setMMIOEventListener(int, java.lang.String, com.oracle.deviceaccess.mmio.MMIOEventListener), MMIODevice.setMMIOEventListener(int, byte[], int, int, com.oracle.deviceaccess.mmio.MMIOEventListener)

getCapturedRegisterValue

public int getCapturedRegisterValue()

Gets the captured value of the register designated upon registration (as a 32bit integer).

Returns:

the captured value of the register designated upon registration (as a 32bit integer)..

See Also:

MMIODevice.setMMIOEventListener(int, java.lang.String, com.oracle.deviceaccess.mmio.MMIOEventListener)

getID

public int getID()

Returns this event ID.

Returns:

this event ID.