net.sf.atmodem4j.spsw

Interface SerialPortSocket

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

AbstractSerialPortSocket, GenericTermiosSerialPortSocket, GenericWinSerialPortSocket

public interface SerialPortSocket
extends Closeable

Author:

scream3r

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	SerialPortSocket.SerialPortSocketFactory

Field Summary

Fields

Modifier and Type	Field and Description
static SerialPortSocket.SerialPortSocketFactory	FACTORY

Method Summary

Modifier and Type	Method and Description
void	close() Close port.
Baudrate	getBaudrate()
DataBits	getDatatBits()
Set<FlowControl>	getFlowControl()
int	getInBufferBytesCount() Get bytes count in in buffer of port
InputStream	getInputStream()
int	getOutBufferBytesCount() Get bytes count out inbuffer of port
OutputStream	getOutputStream()
Parity	getParity()
String	getPortName() Getting port name under operation
StopBits	getStopBits()
char	getXOFFChar()
char	getXONChar()
boolean	isClosed()
boolean	isCTS()
boolean	isDSR()
boolean	isIncommingRI()
boolean	isOpen() Getting port state
void	openAsIs() Port opening Note: If port busy TYPE_PORT_BUSY exception will be thrown.
void	openModem()
void	openRaw()
void	openRaw(Baudrate baudRate, DataBits dataBits, StopBits stopBits, Parity parity, Set<FlowControl> flowControls) Setting the parameters of port
void	openTerminal()
void	sendXOFF()
void	sendXON()
void	setBaudrate(Baudrate baudrate)
void	setBreak(boolean value) Set Break singnal
void	setDataBits(DataBits dataBits)
void	setDTR(boolean value) Change DTR line state
void	setFlowControl(Set<FlowControl> flowControls)
void	setParity(Parity parity)
void	setRTS(boolean value) Change RTS line state
void	setStopBits(StopBits stopBits)
void	setXOFFChar(char c)
void	setXONChar(char c)

Field Detail

FACTORY

static final SerialPortSocket.SerialPortSocketFactory FACTORY

Method Detail

isClosed

boolean isClosed()

isCTS

boolean isCTS()

isDSR

boolean isDSR()

isIncommingRI

boolean isIncommingRI()

getInputStream

InputStream getInputStream()
                    throws IOException

Throws:

IOException

getOutputStream

OutputStream getOutputStream()
                      throws IOException

Throws:

IOException

getPortName

String getPortName()

Getting port name under operation

Returns:

Method returns port name under operation as a String

isOpen

boolean isOpen()

Getting port state

Returns:

Method returns true if port is open, otherwise false

openAsIs

void openAsIs()
       throws IOException

Port opening

Note: If port busy TYPE_PORT_BUSY exception will be thrown. If port not found TYPE_PORT_NOT_FOUND exception will be thrown.

Throws:

SerialPortException

IOException

openRaw

void openRaw()
      throws IOException

Throws:

IOException

openTerminal

void openTerminal()
           throws IOException

Throws:

IOException

openModem

void openModem()
        throws IOException

Throws:

IOException

openRaw

void openRaw(Baudrate baudRate,
             DataBits dataBits,
             StopBits stopBits,
             Parity parity,
             Set<FlowControl> flowControls)
      throws IOException

Setting the parameters of port

Parameters:

baudRate - data transfer rate

dataBits - number of data bits

stopBits - number of stop bits

parity - parity

flowControls -

Throws:

IOException

Since:

0.8

close

void close()
    throws IOException

Close port. This method deletes event listener first, then closes the port

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException

setRTS

void setRTS(boolean value)
     throws IOException

Change RTS line state

Parameters:

value - true - ON, false - OFF

Throws:

IOException

setDTR

void setDTR(boolean value)
     throws IOException

Change DTR line state

Parameters:

value - true - ON, false - OFF

Throws:

IOException

setXONChar

void setXONChar(char c)
         throws IOException

Throws:

IOException

setXOFFChar

void setXOFFChar(char c)
          throws IOException

Throws:

IOException

getXONChar

char getXONChar()
         throws IOException

Throws:

IOException

getXOFFChar

char getXOFFChar()
          throws IOException

Throws:

IOException

sendXON

void sendXON()
      throws IOException

Throws:

IOException

sendXOFF

void sendXOFF()
       throws IOException

Throws:

IOException

getInBufferBytesCount

int getInBufferBytesCount()
                   throws IOException

Get bytes count in in buffer of port

Returns:

Method returns the array that contains info about bytes count in buffers:

Throws:

IOException

getOutBufferBytesCount

int getOutBufferBytesCount()
                    throws IOException

Get bytes count out inbuffer of port

Returns:

Method returns the array that contains info about bytes count in buffers:

Throws:

IOException

setBreak

void setBreak(boolean value)
       throws IOException

Set Break singnal

Parameters:

value - the value

Throws:

IOException

setFlowControl

void setFlowControl(Set<FlowControl> flowControls)
             throws IOException

Throws:

IOException

setBaudrate

void setBaudrate(Baudrate baudrate)
          throws IOException

Throws:

IOException

setDataBits

void setDataBits(DataBits dataBits)
          throws IOException

Throws:

IOException

setStopBits

void setStopBits(StopBits stopBits)
          throws IOException

Throws:

IOException

setParity

void setParity(Parity parity)
        throws IOException

Throws:

IOException

getBaudrate

Baudrate getBaudrate()
              throws IOException

Throws:

IOException

getDatatBits

DataBits getDatatBits()
               throws IOException

Throws:

IOException

getStopBits

StopBits getStopBits()
              throws IOException

Throws:

IOException

getParity

Parity getParity()
          throws IOException

Throws:

IOException

getFlowControl

Set<FlowControl> getFlowControl()
                         throws IOException

Throws:

IOException