com.serialpundit.serial

Class SerialComLineErrors

java.lang.Object

com.serialpundit.serial.SerialComLineErrors

public final class SerialComLineErrors
extends Object

An instance of this class should be passed if the application wish to know whether parity, framing, overrun etc errors has happened on serial port while receiving data or not. Pass instance of this class to readBytes() method.

Author:

Rishi Gupta

Field Summary

Fields

Modifier and Type	Field and Description
static int	ERR_FRAME The value indicating framing error while receiving data at serial port.
static int	ERR_OVERRUN The value indicating overrun error while receiving data at serial port.
static int	ERR_PARITY The value indicating parity error while receiving data at serial port.
static int	RCV_BREAK The value indicating that a break condition has been received at the serial port.

Constructor Summary

Constructors

Constructor and Description
SerialComLineErrors() Allocate and reset the errors bit mask.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	hasAnyErrorOccurred() Tells whether any error has occurred while receiving data at serial port or not.
boolean	hasFramingErrorOccurred() Tells whether framing error has occurred while receiving data at serial port or not.
boolean	hasOverrunErrorOccurred() Tells whether overrun error has occurred while receiving data at serial port or not.
boolean	hasParityErrorOccurred() Tells whether parity error has occurred while receiving data at serial port or not.
boolean	isBreakReceived() Tells whether a break condition is seen at serial port or not.
void	resetLineErrors() Reset the errors bit mask.

Methods inherited from class java.lang.Object

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

Field Detail

ERR_PARITY

public static final int ERR_PARITY

The value indicating parity error while receiving data at serial port. Integer constant with value 0x01.

See Also:

Constant Field Values

ERR_FRAME

public static final int ERR_FRAME

The value indicating framing error while receiving data at serial port. Integer constant with value 0x02.

See Also:

Constant Field Values

ERR_OVERRUN

public static final int ERR_OVERRUN

The value indicating overrun error while receiving data at serial port. Integer constant with value 0x03.

See Also:

Constant Field Values

RCV_BREAK

public static final int RCV_BREAK

The value indicating that a break condition has been received at the serial port. Integer constant with value 0x04.

See Also:

Constant Field Values

Constructor Detail

SerialComLineErrors

public SerialComLineErrors()

Allocate and reset the errors bit mask.

Method Detail

resetLineErrors

public void resetLineErrors()

Reset the errors bit mask.

hasParityErrorOccurred

public boolean hasParityErrorOccurred()

Tells whether parity error has occurred while receiving data at serial port or not.

Linux does not differentiate between framing and parity errors. So if either error occurs both parity and framing error will be set.

Returns:

true if parity error has occurred otherwise false.

hasFramingErrorOccurred

public boolean hasFramingErrorOccurred()

Tells whether framing error has occurred while receiving data at serial port or not.

Linux does not differentiate between framing and parity errors. So if either error occurs both parity and framing error will be set.

Returns:

true if framing error has occurred otherwise false.

hasOverrunErrorOccurred

public boolean hasOverrunErrorOccurred()

Tells whether overrun error has occurred while receiving data at serial port or not.

Returns:

true if overrun error has occurred otherwise false.

hasAnyErrorOccurred

public boolean hasAnyErrorOccurred()

Tells whether any error has occurred while receiving data at serial port or not. This method can be used to save time that would have been spent in checking individual errors. Typically applications discard data read from serial port if any error occurs.

Returns:

true if any error has occurred otherwise false.

isBreakReceived

public boolean isBreakReceived()

Tells whether a break condition is seen at serial port or not.

Returns:

true if break condition is received at serial port otherwise false