com.serialpundit.serial

Class SerialComLineEvent

java.lang.Object

com.serialpundit.serial.SerialComLineEvent

public final class SerialComLineEvent
extends Object

Encapsulate events that happens on serial port control lines. Application can call various methods on an instance of this class to know which event has happen and to get its details. Whenever an event happens, an object of this class containing details about the event is passed to registered listener.

Author:

Rishi Gupta

Constructor Summary

Constructors

Constructor and Description
SerialComLineEvent(int oldLineState, int newLineState) The looper object remembers state of lines and pass both previous and new state.

Method Summary

Methods

Modifier and Type	Method and Description
int	getCTS() Gives the status of CTS (clear to send) control line.
int	getDCD() Gives the status of DCD (data carrier detect) control line.
int	getDSR() Gives the status of DSR (data set ready) control line.
int	getRI() Gives the status of RI (ring indicator) control line.

Methods inherited from class java.lang.Object

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

Constructor Detail

SerialComLineEvent

public SerialComLineEvent(int oldLineState,
                  int newLineState)

The looper object remembers state of lines and pass both previous and new state.

Parameters:

oldLineState - previous line state

newLineState - new line state

Method Detail

getCTS

public int getCTS()

Gives the status of CTS (clear to send) control line. Transition from 0 to 1 means line is asserted and vice-versa.

Returns:

0 if CTS is not changed, 1 if CTS went from 0 to 1, 2 if CTS went from 1 to 0

getDSR

public int getDSR()

Gives the status of DSR (data set ready) control line. Transition from 0 to 1 means line is asserted and vice-versa.

Returns:

0 if DSR is not changed, 1 if DSR went from 0 to 1, 2 if DSR went from 1 to 0

getDCD

public int getDCD()

Gives the status of DCD (data carrier detect) control line. Transition from 0 to 1 means line is asserted and vice-versa.

Returns:

0 if DCD is not changed, 1 if DCD went from 0 to 1, 2 if DCD went from 1 to 0

getRI

public int getRI()

Gives the status of RI (ring indicator) control line. Transition from 0 to 1 means line is asserted and vice-versa.

Returns:

0 if RI is not changed, 1 if RI went from 0 to 1, 2 if RI went from 1 to 0