jdk.dio

Class DeviceEvent<P extends Device<? super P>>

java.lang.Object

jdk.dio.DeviceEvent<P>

Type Parameters:

P - the device type the event is defined for.

Direct Known Subclasses:

CountingEvent, GenerationEvent, GenericEvent, MMIOEvent, ModemSignalEvent, MonitoringEvent, PinEvent, PortEvent, RoundCompletionEvent, UARTEvent

public abstract class DeviceEvent<P extends Device<? super P>>
extends java.lang.Object

The DeviceEvent class encapsulates events fired by or on behalf of a device. An event may correspond to an hardware interrupt or to some software signal.

When an event burst occurs - that is more events occurred than can be handled - events may be coalesced. Coalescing of events is platform and device-dependent.

Field Summary

Fields

Modifier and Type	Field and Description
protected int	count The number of underlying coalesced hardware interrupts or software signals this event may represent.
protected P	device The Device instance that fired this event or for which this event was fired.
protected long	lastTimeStamp The time (in milliseconds) when the last coalesced event occurred.
protected int	lastTimeStampMicros The additional microseconds to the timestamp for when the last coalesced event occurred.
protected long	timeStamp The time (in milliseconds) when this event (first) occurred.
protected int	timeStampMicros The additional microseconds to the timestamp for when this event (first) occurred.

Constructor Summary

Constructors

Constructor and Description
DeviceEvent()

Method Summary

Methods

Modifier and Type	Method and Description
int	getCount() Returns the number of underlying coalesced hardware interrupts or software signals this event may represent.
P	getDevice() Returns the Device instance that fired this event or for which this event was fired.
long	getLastTimeStamp() Returns the time (in milliseconds) when the last coalesced event occurred.
int	getLastTimeStampMicros() Returns the additional microseconds to the timestamp for when the last coalesced event occurred.
long	getTimeStamp() Returns the time (in milliseconds) when this event (first) occurred.
int	getTimeStampMicros() Returns the additional microseconds to the timestamp for when this event (first) occurred.

Methods inherited from class java.lang.Object

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

Field Detail

count

protected int count

The number of underlying coalesced hardware interrupts or software signals this event may represent.

lastTimeStamp

protected long lastTimeStamp

The time (in milliseconds) when the last coalesced event occurred. If events were not coalesced then the time is the same as that of the first event.

lastTimeStampMicros

protected int lastTimeStampMicros

The additional microseconds to the timestamp for when the last coalesced event occurred. If events were not coalesced then this is the same as that of the first event.

The actual last timestamp in microseconds is equal to: (lastTimeStamp * 1000) + lastTimeStampMicros.

device

protected P extends Device<? super P> device

The Device instance that fired this event or for which this event was fired.

timeStamp

protected long timeStamp

The time (in milliseconds) when this event (first) occurred. If events were coalesced then the time is that of the first event.

timeStampMicros

protected int timeStampMicros

The additional microseconds to the timestamp for when this event (first) occurred. If events were coalesced then this is that of the first event.

The actual timestamp in microseconds is equal to: (timeStamp * 1000) + timeStampMicros.

Constructor Detail

DeviceEvent

public DeviceEvent()

Method Detail

getCount

public final int getCount()

Returns the number of underlying coalesced hardware interrupts or software signals this event may represent.

Returns:

the number of underlying coalesced hardware interrupts software signals this event may represent.

getLastTimeStamp

public final long getLastTimeStamp()

Returns the time (in milliseconds) when the last coalesced event occurred. If events were not coalesced then the time is the same as that of the first event.

Returns:

the time (in milliseconds) when this event last occurred.

getLastTimeStampMicros

public final int getLastTimeStampMicros()

Returns the additional microseconds to the timestamp for when the last coalesced event occurred. If events were not coalesced then this is the same as that of the first event.

Returns:

the additional microseconds to the timestamp for when the last coalesced event occurred.

getDevice

public final P getDevice()

Returns the Device instance that fired this event or for which this event was fired.

Returns:

the Device instance that fired this event.

getTimeStamp

public final long getTimeStamp()

Returns the time (in milliseconds) when this event (first) occurred. If events were coalesced then the time is that of the first event.

Returns:

the time (in milliseconds) when this event (first) occurred.

getTimeStampMicros

public final int getTimeStampMicros()

Returns the additional microseconds to the timestamp for when this event (first) occurred. If events were coalesced then the time is that of the first event.

Returns:

the additional microseconds to the timestamp for when this event (first) occurred.