gnu.io

Class RXTXPort

java.lang.Object

gnu.io.CommPort

gnu.io.SerialPort

gnu.io.RXTXPort

public final class RXTXPort
extends SerialPort

An extension of gnu.io.SerialPort

See Also:

SerialPort

Field Summary

Fields

Modifier and Type	Field and Description
protected static boolean	debug
protected static boolean	debug_events
protected static boolean	debug_read
protected static boolean	debug_read_results
protected static boolean	debug_verbose
protected static boolean	debug_write

Fields inherited from class gnu.io.SerialPort

DATABITS_5, DATABITS_6, DATABITS_7, DATABITS_8, FLOWCONTROL_NONE, FLOWCONTROL_RTSCTS_IN, FLOWCONTROL_RTSCTS_OUT, FLOWCONTROL_XONXOFF_IN, FLOWCONTROL_XONXOFF_OUT, PARITY_EVEN, PARITY_MARK, PARITY_NONE, PARITY_ODD, PARITY_SPACE, STOPBITS_1, STOPBITS_1_5, STOPBITS_2

Fields inherited from class gnu.io.CommPort

name

Constructor Summary

Constructors

Constructor and Description
RXTXPort(String name) Open the named port

Method Summary

Modifier and Type	Method and Description
void	addEventListener(SerialPortEventListener lsnr)
boolean	checkMonitorThread()
boolean	clearCommInput() Extension to CommAPI returns boolean true on success
void	close()
void	disableReceiveFraming()
void	disableReceiveThreshold()
void	disableReceiveTimeout()
void	enableReceiveFraming(int f) Receive framing control
void	enableReceiveThreshold(int thresh)
void	enableReceiveTimeout(int time)
protected void	finalize() Finalize the port
int	getBaudBase() Extension to CommAPI
int	getBaudRate()
boolean	getCallOutHangup() Extension to CommAPI returns boolean true on success
int	getDataBits()
int	getDivisor() Extension to CommAPI
byte	getEndOfInputChar() Extension to CommAPI This is an extension to CommAPI.
int	getFlowControlMode()
int	getInputBufferSize()
InputStream	getInputStream() get the InputStream
boolean	getLowLatency() Extension to CommAPI returns boolean true on success
int	getOutputBufferSize()
OutputStream	getOutputStream() get the OutputStream
int	getParity()
byte	getParityErrorChar() Extension to CommAPI This is an extension to CommAPI.
int	getReceiveFramingByte()
int	getReceiveThreshold()
int	getReceiveTimeout()
int	getStopBits()
String	getUARTType() Extension to CommAPI This is an extension to CommAPI.
boolean	isCD()
boolean	isCTS()
boolean	isDSR()
boolean	isDTR()
boolean	isReceiveFramingEnabled()
boolean	isReceiveThresholdEnabled()
boolean	isReceiveTimeoutEnabled()
boolean	isRI()
boolean	isRTS()
protected int	nativeavailable() RXTXPort read methods
protected boolean	nativeDrain(boolean i)
int	NativegetReceiveTimeout()
void	notifyOnBreakInterrupt(boolean enable)
void	notifyOnCarrierDetect(boolean enable)
void	notifyOnCTS(boolean enable)
void	notifyOnDataAvailable(boolean enable)
void	notifyOnDSR(boolean enable)
void	notifyOnFramingError(boolean enable)
void	notifyOnOutputEmpty(boolean enable)
void	notifyOnOverrunError(boolean enable)
void	notifyOnParityError(boolean enable)
void	notifyOnRingIndicator(boolean enable)
protected int	readArray(byte[] b, int off, int len)
protected int	readByte()
protected int	readTerminatedArray(byte[] b, int off, int len, byte[] t)
void	removeEventListener() Remove the serial port event listener
void	sendBreak(int duration) Write to the port
boolean	sendEvent(int event, boolean state)
boolean	setBaudBase(int BaudBase) Extension to CommAPI.
boolean	setCallOutHangup(boolean NoHup) Extension to CommAPI returns boolean true on success
boolean	setDivisor(int Divisor) Extension to CommAPI.
void	setDTR(boolean state)
boolean	setEndOfInputChar(byte b) Extension to CommAPI This is an extension to CommAPI.
void	setFlowControlMode(int flowcontrol)
void	setInputBufferSize(int size)
boolean	setLowLatency() Extension to CommAPI returns boolean true on success
void	setOutputBufferSize(int size)
boolean	setParityErrorChar(byte b) Extension to CommAPI This is an extension to CommAPI.
void	setRcvFifoTrigger(int trigger) Deprecated. deprecated but used in Kaffe
void	setRTS(boolean state)
void	setSerialPortParams(int b, int d, int s, int p)
boolean	setUARTType(String type, boolean test) Extension to CommAPI This is an extension to CommAPI.
static int	staticGetBaudRate(String port) Extension to CommAPI This is an extension to CommAPI.
static int	staticGetDataBits(String port) Extension to CommAPI This is an extension to CommAPI.
static int	staticGetParity(String port) Extension to CommAPI This is an extension to CommAPI.
static int	staticGetStopBits(String port) Extension to CommAPI This is an extension to CommAPI.
static boolean	staticIsCD(String port) Extension to CommAPI This is an extension to CommAPI.
static boolean	staticIsCTS(String port) Extension to CommAPI This is an extension to CommAPI.
static boolean	staticIsDSR(String port) Extension to CommAPI This is an extension to CommAPI.
static boolean	staticIsDTR(String port) Extension to CommAPI This is an extension to CommAPI.
static boolean	staticIsRI(String port) Extension to CommAPI This is an extension to CommAPI.
static boolean	staticIsRTS(String port) Extension to CommAPI This is an extension to CommAPI.
static boolean	staticSetDSR(String port, boolean flag) Extension to CommAPI This is an extension to CommAPI.
static boolean	staticSetDTR(String port, boolean flag) Extension to CommAPI This is an extension to CommAPI.
static boolean	staticSetRTS(String port, boolean flag) Extension to CommAPI This is an extension to CommAPI.
static void	staticSetSerialPortParams(String f, int b, int d, int s, int p) Extension to CommAPI This is an extension to CommAPI.
protected void	waitForTheNativeCodeSilly() Give the native code a chance to start listening to the hardware or should we say give the native code control of the issue.
protected void	writeArray(byte[] b, int off, int len, boolean i)
protected void	writeByte(int b, boolean i)

Methods inherited from class gnu.io.CommPort

getName, toString

Methods inherited from class java.lang.Object

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

Field Detail

debug

protected static final boolean debug

See Also:

Constant Field Values

debug_read

protected static final boolean debug_read

See Also:

Constant Field Values

debug_read_results

protected static final boolean debug_read_results

See Also:

Constant Field Values

debug_write

protected static final boolean debug_write

See Also:

Constant Field Values

debug_events

protected static final boolean debug_events

See Also:

Constant Field Values

debug_verbose

protected static final boolean debug_verbose

See Also:

Constant Field Values

Constructor Detail

RXTXPort

public RXTXPort(String name)
         throws PortInUseException

Open the named port

Parameters:

name - the name of the device to open

Throws:

PortInUseException

See Also:

SerialPort

Method Detail

getOutputStream

public OutputStream getOutputStream()

get the OutputStream

Specified by:

getOutputStream in class CommPort

Returns:

OutputStream

getInputStream

public InputStream getInputStream()

get the InputStream

Specified by:

getInputStream in class CommPort

Returns:

InputStream

See Also:

InputStream

setSerialPortParams

public void setSerialPortParams(int b,
                                int d,
                                int s,
                                int p)
                         throws UnsupportedCommOperationException

Specified by:

setSerialPortParams in class SerialPort

Throws:

UnsupportedCommOperationException

getBaudRate

public int getBaudRate()

Specified by:

getBaudRate in class SerialPort

Returns:

int representing the baudrate This will not behave as expected with custom speeds

getDataBits

public int getDataBits()

Specified by:

getDataBits in class SerialPort

Returns:

int representing the databits

getStopBits

public int getStopBits()

Specified by:

getStopBits in class SerialPort

Returns:

int representing the stopbits

getParity

public int getParity()

Specified by:

getParity in class SerialPort

Returns:

int representing the parity

setFlowControlMode

public void setFlowControlMode(int flowcontrol)

Specified by:

setFlowControlMode in class SerialPort

Parameters:

flowcontrol - FLOWCONTROL_NONE is default

See Also:

SerialPort.FLOWCONTROL_NONE

getFlowControlMode

public int getFlowControlMode()

Specified by:

getFlowControlMode in class SerialPort

Returns:

int representing the flowmode

enableReceiveFraming

public void enableReceiveFraming(int f)
                          throws UnsupportedCommOperationException

Receive framing control

Specified by:

enableReceiveFraming in class CommPort

Parameters:

f - framming

Throws:

UnsupportedCommOperationException

disableReceiveFraming

public void disableReceiveFraming()

Specified by:

disableReceiveFraming in class CommPort

isReceiveFramingEnabled

public boolean isReceiveFramingEnabled()

Specified by:

isReceiveFramingEnabled in class CommPort

Returns:

true if framing is enabled

getReceiveFramingByte

public int getReceiveFramingByte()

Specified by:

getReceiveFramingByte in class CommPort

Returns:

int representing the framing byte

NativegetReceiveTimeout

public int NativegetReceiveTimeout()

Returns:

int the timeout

disableReceiveTimeout

public void disableReceiveTimeout()

Specified by:

disableReceiveTimeout in class CommPort

enableReceiveTimeout

public void enableReceiveTimeout(int time)

Specified by:

enableReceiveTimeout in class CommPort

Parameters:

time -

isReceiveTimeoutEnabled

public boolean isReceiveTimeoutEnabled()

Specified by:

isReceiveTimeoutEnabled in class CommPort

Returns:

boolean true if recieve timeout is enabled

getReceiveTimeout

public int getReceiveTimeout()

Specified by:

getReceiveTimeout in class CommPort

Returns:

int the timeout

enableReceiveThreshold

public void enableReceiveThreshold(int thresh)

Specified by:

enableReceiveThreshold in class CommPort

Parameters:

thresh - threshold

disableReceiveThreshold

public void disableReceiveThreshold()

Specified by:

disableReceiveThreshold in class CommPort

getReceiveThreshold

public int getReceiveThreshold()

Specified by:

getReceiveThreshold in class CommPort

Returns:

int the recieve threshold

isReceiveThresholdEnabled

public boolean isReceiveThresholdEnabled()

Specified by:

isReceiveThresholdEnabled in class CommPort

Returns:

boolean true if receive threshold is enabled

setInputBufferSize

public void setInputBufferSize(int size)

Specified by:

setInputBufferSize in class CommPort

Parameters:

size -

getInputBufferSize

public int getInputBufferSize()

Specified by:

getInputBufferSize in class CommPort

setOutputBufferSize

public void setOutputBufferSize(int size)

Specified by:

setOutputBufferSize in class CommPort

Parameters:

size -

getOutputBufferSize

public int getOutputBufferSize()

Specified by:

getOutputBufferSize in class CommPort

Returns:

in the output buffer size

isDTR

public boolean isDTR()

Specified by:

isDTR in class SerialPort

Returns:

true if DTR is set

setDTR

public void setDTR(boolean state)

Specified by:

setDTR in class SerialPort

Parameters:

state -

setRTS

public void setRTS(boolean state)

Specified by:

setRTS in class SerialPort

Parameters:

state -

isCTS

public boolean isCTS()

Specified by:

isCTS in class SerialPort

Returns:

boolean true if CTS is set

isDSR

public boolean isDSR()

Specified by:

isDSR in class SerialPort

Returns:

boolean true if DSR is set

isCD

public boolean isCD()

Specified by:

isCD in class SerialPort

Returns:

boolean true if CD is set

isRI

public boolean isRI()

Specified by:

isRI in class SerialPort

Returns:

boolean true if RI is set

isRTS

public boolean isRTS()

Specified by:

isRTS in class SerialPort

Returns:

boolean true if RTS is set

sendBreak

public void sendBreak(int duration)

Write to the port

Specified by:

sendBreak in class SerialPort

Parameters:

duration -

writeByte

protected void writeByte(int b,
                         boolean i)
                  throws IOException

Throws:

IOException

writeArray

protected void writeArray(byte[] b,
                          int off,
                          int len,
                          boolean i)
                   throws IOException

Throws:

IOException

nativeDrain

protected boolean nativeDrain(boolean i)
                       throws IOException

Throws:

IOException

nativeavailable

protected int nativeavailable()
                       throws IOException

RXTXPort read methods

Throws:

IOException

readByte

protected int readByte()
                throws IOException

Throws:

IOException

readArray

protected int readArray(byte[] b,
                        int off,
                        int len)
                 throws IOException

Throws:

IOException

readTerminatedArray

protected int readTerminatedArray(byte[] b,
                                  int off,
                                  int len,
                                  byte[] t)
                           throws IOException

Throws:

IOException

checkMonitorThread

public boolean checkMonitorThread()

sendEvent

public boolean sendEvent(int event,
                         boolean state)

Parameters:

event -

state -

Returns:

boolean true if the port is closing

addEventListener

public void addEventListener(SerialPortEventListener lsnr)
                      throws TooManyListenersException

Specified by:

addEventListener in class SerialPort

Throws:

TooManyListenersException

removeEventListener

public void removeEventListener()

Remove the serial port event listener

Specified by:

removeEventListener in class SerialPort

waitForTheNativeCodeSilly

protected void waitForTheNativeCodeSilly()

Give the native code a chance to start listening to the hardware or should we say give the native code control of the issue. This is important for applications that flicker the Monitor thread while keeping the port open. In worst case test cases this loops once or twice every time.

notifyOnDataAvailable

public void notifyOnDataAvailable(boolean enable)

Specified by:

notifyOnDataAvailable in class SerialPort

notifyOnOutputEmpty

public void notifyOnOutputEmpty(boolean enable)

Specified by:

notifyOnOutputEmpty in class SerialPort

Parameters:

enable -

notifyOnCTS

public void notifyOnCTS(boolean enable)

Specified by:

notifyOnCTS in class SerialPort

Parameters:

enable -

notifyOnDSR

public void notifyOnDSR(boolean enable)

Specified by:

notifyOnDSR in class SerialPort

Parameters:

enable -

notifyOnRingIndicator

public void notifyOnRingIndicator(boolean enable)

Specified by:

notifyOnRingIndicator in class SerialPort

Parameters:

enable -

notifyOnCarrierDetect

public void notifyOnCarrierDetect(boolean enable)

Specified by:

notifyOnCarrierDetect in class SerialPort

Parameters:

enable -

notifyOnOverrunError

public void notifyOnOverrunError(boolean enable)

Specified by:

notifyOnOverrunError in class SerialPort

Parameters:

enable -

notifyOnParityError

public void notifyOnParityError(boolean enable)

Specified by:

notifyOnParityError in class SerialPort

Parameters:

enable -

notifyOnFramingError

public void notifyOnFramingError(boolean enable)

Specified by:

notifyOnFramingError in class SerialPort

Parameters:

enable -

notifyOnBreakInterrupt

public void notifyOnBreakInterrupt(boolean enable)

Specified by:

notifyOnBreakInterrupt in class SerialPort

Parameters:

enable -

close

public void close()

Overrides:

close in class CommPort

finalize

protected void finalize()

Finalize the port

Overrides:

finalize in class Object

setRcvFifoTrigger

public void setRcvFifoTrigger(int trigger)

Deprecated. deprecated but used in Kaffe

A dummy method added so RXTX compiles on Kaffee

staticGetBaudRate

public static int staticGetBaudRate(String port)
                             throws UnsupportedCommOperationException

Extension to CommAPI This is an extension to CommAPI. It may not be supported on all operating systems. This is only accurate up to 38600 baud currently.

Parameters:

port - the name of the port thats been preopened

Returns:

BaudRate on success

Throws:

UnsupportedCommOperationException - This will not behave as expected with custom speeds

staticGetDataBits

public static int staticGetDataBits(String port)
                             throws UnsupportedCommOperationException

Extension to CommAPI This is an extension to CommAPI. It may not be supported on all operating systems.

Parameters:

port - the name of the port thats been preopened

Returns:

DataBits on success

Throws:

UnsupportedCommOperationException

staticGetParity

public static int staticGetParity(String port)
                           throws UnsupportedCommOperationException

Extension to CommAPI This is an extension to CommAPI. It may not be supported on all operating systems.

Parameters:

port - the name of the port thats been preopened

Returns:

Parity on success

Throws:

UnsupportedCommOperationException

staticGetStopBits

public static int staticGetStopBits(String port)
                             throws UnsupportedCommOperationException

Extension to CommAPI This is an extension to CommAPI. It may not be supported on all operating systems.

Parameters:

port - the name of the port thats been preopened

Returns:

StopBits on success

Throws:

UnsupportedCommOperationException

staticSetSerialPortParams

public static void staticSetSerialPortParams(String f,
                                             int b,
                                             int d,
                                             int s,
                                             int p)
                                      throws UnsupportedCommOperationException

Extension to CommAPI This is an extension to CommAPI. It may not be supported on all operating systems. Set the SerialPort parameters 1.5 stop bits requires 5 databits

Parameters:

f - filename

b - baudrate

d - databits

s - stopbits

p - parity

Throws:

UnsupportedCommOperationException

See Also:

UnsupportedCommOperationException

staticSetDSR

public static boolean staticSetDSR(String port,
                                   boolean flag)
                            throws UnsupportedCommOperationException

Extension to CommAPI This is an extension to CommAPI. It may not be supported on all operating systems. Open the port and set DSR. remove lockfile and do not close This is so some software can appear to set the DSR before 'opening' the port a second time later on.

Returns:

true on success

Throws:

UnsupportedCommOperationException

staticSetDTR

public static boolean staticSetDTR(String port,
                                   boolean flag)
                            throws UnsupportedCommOperationException

Extension to CommAPI This is an extension to CommAPI. It may not be supported on all operating systems. Open the port and set DTR. remove lockfile and do not close This is so some software can appear to set the DTR before 'opening' the port a second time later on.

Returns:

true on success

Throws:

UnsupportedCommOperationException

staticSetRTS

public static boolean staticSetRTS(String port,
                                   boolean flag)
                            throws UnsupportedCommOperationException

Extension to CommAPI This is an extension to CommAPI. It may not be supported on all operating systems. Open the port and set RTS. remove lockfile and do not close This is so some software can appear to set the RTS before 'opening' the port a second time later on.

Returns:

none

Throws:

UnsupportedCommOperationException

staticIsRTS

public static boolean staticIsRTS(String port)
                           throws UnsupportedCommOperationException

Extension to CommAPI This is an extension to CommAPI. It may not be supported on all operating systems. find the fd and return RTS without using a Java open() call

Parameters:

port -

Returns:

true if asserted

Throws:

UnsupportedCommOperationException

staticIsCD

public static boolean staticIsCD(String port)
                          throws UnsupportedCommOperationException

Extension to CommAPI This is an extension to CommAPI. It may not be supported on all operating systems. find the fd and return CD without using a Java open() call

Parameters:

port -

Returns:

true if asserted

Throws:

UnsupportedCommOperationException

staticIsCTS

public static boolean staticIsCTS(String port)
                           throws UnsupportedCommOperationException

Extension to CommAPI This is an extension to CommAPI. It may not be supported on all operating systems. find the fd and return CTS without using a Java open() call

Parameters:

port -

Returns:

true if asserted

Throws:

UnsupportedCommOperationException

staticIsDSR

public static boolean staticIsDSR(String port)
                           throws UnsupportedCommOperationException

Extension to CommAPI This is an extension to CommAPI. It may not be supported on all operating systems. find the fd and return DSR without using a Java open() call

Parameters:

port -

Returns:

true if asserted

Throws:

UnsupportedCommOperationException

staticIsDTR

public static boolean staticIsDTR(String port)
                           throws UnsupportedCommOperationException

Extension to CommAPI This is an extension to CommAPI. It may not be supported on all operating systems. find the fd and return DTR without using a Java open() call

Parameters:

port -

Returns:

true if asserted

Throws:

UnsupportedCommOperationException

staticIsRI

public static boolean staticIsRI(String port)
                          throws UnsupportedCommOperationException

Extension to CommAPI This is an extension to CommAPI. It may not be supported on all operating systems. find the fd and return RI without using a Java open() call

Parameters:

port -

Returns:

true if asserted

Throws:

UnsupportedCommOperationException

getParityErrorChar

public byte getParityErrorChar()
                        throws UnsupportedCommOperationException

Extension to CommAPI This is an extension to CommAPI. It may not be supported on all operating systems.

Specified by:

getParityErrorChar in class SerialPort

Returns:

int the Parity Error Character

Throws:

UnsupportedCommOperationException - Anyone know how to do this in Unix?

setParityErrorChar

public boolean setParityErrorChar(byte b)
                           throws UnsupportedCommOperationException

Extension to CommAPI This is an extension to CommAPI. It may not be supported on all operating systems.

Specified by:

setParityErrorChar in class SerialPort

Parameters:

b - Parity Error Character

Returns:

boolean true on success

Throws:

UnsupportedCommOperationException - Anyone know how to do this in Unix?

getEndOfInputChar

public byte getEndOfInputChar()
                       throws UnsupportedCommOperationException

Extension to CommAPI This is an extension to CommAPI. It may not be supported on all operating systems.

Specified by:

getEndOfInputChar in class SerialPort

Returns:

int the End of Input Character

Throws:

UnsupportedCommOperationException - Anyone know how to do this in Unix?

setEndOfInputChar

public boolean setEndOfInputChar(byte b)
                          throws UnsupportedCommOperationException

Extension to CommAPI This is an extension to CommAPI. It may not be supported on all operating systems.

Specified by:

setEndOfInputChar in class SerialPort

Parameters:

b - End Of Input Character

Returns:

boolean true on success

Throws:

UnsupportedCommOperationException

setUARTType

public boolean setUARTType(String type,
                           boolean test)
                    throws UnsupportedCommOperationException

Extension to CommAPI This is an extension to CommAPI. It may not be supported on all operating systems.

Specified by:

setUARTType in class SerialPort

Parameters:

type - String representation of the UART type which mayb be "none", "8250", "16450", "16550", "16550A", "16650", "16550V2" or "16750".

test - boolean flag to determin if the UART should be tested.

Returns:

boolean true on success

Throws:

UnsupportedCommOperationException

getUARTType

public String getUARTType()
                   throws UnsupportedCommOperationException

Extension to CommAPI This is an extension to CommAPI. It may not be supported on all operating systems.

Specified by:

getUARTType in class SerialPort

Returns:

type String representation of the UART type which mayb be "none", "8250", "16450", "16550", "16550A", "16650", "16550V2" or "16750".

Throws:

UnsupportedCommOperationException

setBaudBase

public boolean setBaudBase(int BaudBase)
                    throws UnsupportedCommOperationException,
                           IOException

Extension to CommAPI. Set Baud Base to 38600 on Linux and W32 before using.

Specified by:

setBaudBase in class SerialPort

Parameters:

BaudBase - The clock frequency divided by 16. Default BaudBase is 115200.

Returns:

true on success

Throws:

UnsupportedCommOperationException

IOException

getBaudBase

public int getBaudBase()
                throws UnsupportedCommOperationException,
                       IOException

Extension to CommAPI

Specified by:

getBaudBase in class SerialPort

Returns:

BaudBase

Throws:

UnsupportedCommOperationException

IOException

setDivisor

public boolean setDivisor(int Divisor)
                   throws UnsupportedCommOperationException,
                          IOException

Extension to CommAPI. Set Baud Base to 38600 on Linux and W32 before using.

Specified by:

setDivisor in class SerialPort

Parameters:

Divisor -

Throws:

UnsupportedCommOperationException

IOException

getDivisor

public int getDivisor()
               throws UnsupportedCommOperationException,
                      IOException

Extension to CommAPI

Specified by:

getDivisor in class SerialPort

Returns:

Divisor;

Throws:

UnsupportedCommOperationException

IOException

setLowLatency

public boolean setLowLatency()
                      throws UnsupportedCommOperationException

Extension to CommAPI returns boolean true on success

Specified by:

setLowLatency in class SerialPort

Throws:

UnsupportedCommOperationException

getLowLatency

public boolean getLowLatency()
                      throws UnsupportedCommOperationException

Extension to CommAPI returns boolean true on success

Specified by:

getLowLatency in class SerialPort

Throws:

UnsupportedCommOperationException

setCallOutHangup

public boolean setCallOutHangup(boolean NoHup)
                         throws UnsupportedCommOperationException

Extension to CommAPI returns boolean true on success

Specified by:

setCallOutHangup in class SerialPort

Throws:

UnsupportedCommOperationException

getCallOutHangup

public boolean getCallOutHangup()
                         throws UnsupportedCommOperationException

Extension to CommAPI returns boolean true on success

Specified by:

getCallOutHangup in class SerialPort

Throws:

UnsupportedCommOperationException

clearCommInput

public boolean clearCommInput()
                       throws UnsupportedCommOperationException

Extension to CommAPI returns boolean true on success

Throws:

UnsupportedCommOperationException