public class UARTEvent extends PeripheralEvent<UART>
UARTEvent
class encapsulates events fired by peripherals that
implement the UART
interface.UART
,
UARTEventListener
Modifier and Type | Field and Description |
---|---|
static int |
BREAK_INTERRUPT
Event ID indicating a break interrupt.
|
static int |
FRAMING_ERROR
Event ID indicating a parity error.
|
static int |
INPUT_BUFFER_OVERRUN
Event ID indicating that input buffer overrun.
|
static int |
INPUT_DATA_AVAILABLE
Event ID indicating that input data is available for reading.
|
static int |
OUTPUT_BUFFER_EMPTY
Event ID indicating that the output buffer is empty and that additional
data may be written.
|
static int |
PARITY_ERROR
Event ID indicating a parity error.
|
count, lastTimeStamp, lastTimeStampMicros, peripheral, timeStamp, timeStampMicros
Constructor and Description |
---|
UARTEvent(UART uart,
int id)
Creates a new
UARTEvent with the specified value and time-stamped
with the current time. |
UARTEvent(UART uart,
int id,
long timeStamp,
int timeStampMicros)
Creates a new
UARTEvent with the specified value and timestamp. |
Modifier and Type | Method and Description |
---|---|
int |
getID()
Returns this event ID.
|
getCount, getLastTimeStamp, getLastTimeStampMicros, getPeripheral, getTimeStamp, getTimeStampMicros
public static final int INPUT_BUFFER_OVERRUN
public static final int INPUT_DATA_AVAILABLE
public static final int OUTPUT_BUFFER_EMPTY
public static final int BREAK_INTERRUPT
public static final int PARITY_ERROR
public static final int FRAMING_ERROR
public UARTEvent(UART uart, int id)
UARTEvent
with the specified value and time-stamped
with the current time.uart
- the source uart.id
- the event ID: INPUT_DATA_AVAILABLE
, INPUT_BUFFER_OVERRUN
,
OUTPUT_BUFFER_EMPTY
, BREAK_INTERRUPT
,
FRAMING_ERROR
or PARITY_ERROR
.java.lang.NullPointerException
- if uart
is null
.java.lang.IllegalArgumentException
- if id
is not a valid event ID.public UARTEvent(UART uart, int id, long timeStamp, int timeStampMicros)
UARTEvent
with the specified value and timestamp.uart
- the source uart.id
- the event ID: INPUT_DATA_AVAILABLE
, INPUT_BUFFER_OVERRUN
,
OUTPUT_BUFFER_EMPTY
, BREAK_INTERRUPT
,
FRAMING_ERROR
or PARITY_ERROR
.timeStamp
- the timestamp (in milliseconds).timeStampMicros
- the additional microseconds to the timestamp.java.lang.NullPointerException
- if uart
is null
.java.lang.IllegalArgumentException
- if id
is not a valid event ID or
if timeStamp
or timeStampMicros
is negative.public int getID()
INPUT_DATA_AVAILABLE
, INPUT_BUFFER_OVERRUN
,
OUTPUT_BUFFER_EMPTY
, BREAK_INTERRUPT
,
FRAMING_ERROR
or PARITY_ERROR
.Copyright © 2012, 2013, Oracle and/or its affiliates. All rights reserved.
Legal Notices