net.sf.atmodem4j.spsw

Class AbstractSerialPortSocket

java.lang.Object

net.sf.atmodem4j.spsw.AbstractSerialPortSocket

All Implemented Interfaces:

Closeable, AutoCloseable, SerialPortSocket

Direct Known Subclasses:

GenericTermiosSerialPortSocket, GenericWinSerialPortSocket

public abstract class AbstractSerialPortSocket
extends Object
implements SerialPortSocket

Author:

scream3r

Nested Class Summary

Nested classes/interfaces inherited from interface net.sf.atmodem4j.spsw.SerialPortSocket

SerialPortSocket.SerialPortSocketFactory

Field Summary

Fields

Modifier and Type	Field and Description
protected net.sf.atmodem4j.spsw.AbstractSerialPortSocket.SerialInputStream	is
protected static Logger	LOG
protected net.sf.atmodem4j.spsw.AbstractSerialPortSocket.SerialOutputStream	os
static String	SPSW_PROPERTIES

Fields inherited from interface net.sf.atmodem4j.spsw.SerialPortSocket

FACTORY

Constructor Summary

Constructors

Constructor and Description
AbstractSerialPortSocket(String portName)

Method Summary

Modifier and Type	Method and Description
void	close() Close port.
protected abstract void	close0() Close port
protected void	finalize()
static String	getArch()
Baudrate	getBaudrate()
protected abstract int	getBaudrate0()
protected abstract int	getDataBits0()
DataBits	getDatatBits()
Set<FlowControl>	getFlowControl()
protected abstract int	getFlowControl0()
InputStream	getInputStream()
static String	getLibName()
static String	getOsName()
OutputStream	getOutputStream()
Parity	getParity()
protected abstract int	getParity0()
String	getPortName() Getting port name under operation
StopBits	getStopBits()
protected abstract int	getStopBits0()
boolean	isClosed()
static boolean	isLibLoaded()
boolean	isOpen() Getting port state
static boolean	loadNativeLib()
protected abstract void	open(String portName, int type) Open port
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()
protected abstract int	readBytes(byte[] b, int off, int len) Read data from port
protected abstract int	readSingle()
void	setBaudrate(Baudrate baudrate)
protected abstract void	setBaudrate(int baudRate)
void	setDataBits(DataBits dataBits)
protected abstract void	setDataBits(int value)
protected abstract void	setFlowControl(int mask)
void	setFlowControl(Set<FlowControl> flowControls)
protected abstract void	setParity(int parity)
void	setParity(Parity parity)
protected abstract void	setStopBits(int value)
void	setStopBits(StopBits stopBits)
String	toString()
protected abstract void	writeBytes(byte[] b, int off, int len) Write data to port
protected abstract void	writeSingle(int b)
static boolean	yesIhaveLoadedTheNativeLibMyself(String libName) Someone else has loaded the correct native lib somplace else, Or know what she is doingt...

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sf.atmodem4j.spsw.SerialPortSocket

getInBufferBytesCount, getOutBufferBytesCount, getXOFFChar, getXONChar, isCTS, isDSR, isIncommingRI, sendXOFF, sendXON, setBreak, setDTR, setRTS, setXOFFChar, setXONChar

Field Detail

LOG

protected static final Logger LOG

SPSW_PROPERTIES

public static final String SPSW_PROPERTIES

See Also:

Constant Field Values

is

protected net.sf.atmodem4j.spsw.AbstractSerialPortSocket.SerialInputStream is

os

protected net.sf.atmodem4j.spsw.AbstractSerialPortSocket.SerialOutputStream os

Constructor Detail

AbstractSerialPortSocket

public AbstractSerialPortSocket(String portName)

Method Detail

isLibLoaded

public static boolean isLibLoaded()

getLibName

public static String getLibName()

getArch

public static String getArch()

getOsName

public static String getOsName()

yesIhaveLoadedTheNativeLibMyself

public static boolean yesIhaveLoadedTheNativeLibMyself(String libName)

Someone else has loaded the correct native lib somplace else, Or know what she is doingt...

Parameters:

libName - the name of the lib

Returns:

false if the lib was loaded before, false otherwise.

loadNativeLib

public static boolean loadNativeLib()

isClosed

public boolean isClosed()

Specified by:

isClosed in interface SerialPortSocket

close

public void close()
           throws IOException

Description copied from interface: SerialPortSocket

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

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface SerialPortSocket

Throws:

IOException

getInputStream

public InputStream getInputStream()
                           throws IOException

Specified by:

getInputStream in interface SerialPortSocket

Throws:

IOException

getOutputStream

public OutputStream getOutputStream()
                             throws IOException

Specified by:

getOutputStream in interface SerialPortSocket

Throws:

IOException

getPortName

public String getPortName()

Description copied from interface: SerialPortSocket

Getting port name under operation

Specified by:

getPortName in interface SerialPortSocket

Returns:

Method returns port name under operation as a String

isOpen

public boolean isOpen()

Description copied from interface: SerialPortSocket

Getting port state

Specified by:

isOpen in interface SerialPortSocket

Returns:

Method returns true if port is open, otherwise false

openAsIs

public void openAsIs()
              throws IOException

Description copied from interface: SerialPortSocket

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.

Specified by:

openAsIs in interface SerialPortSocket

Throws:

SerialPortException

IOException

openRaw

public void openRaw()
             throws IOException

Specified by:

openRaw in interface SerialPortSocket

Throws:

IOException

openTerminal

public void openTerminal()
                  throws IOException

Specified by:

openTerminal in interface SerialPortSocket

Throws:

IOException

openModem

public void openModem()
               throws IOException

Specified by:

openModem in interface SerialPortSocket

Throws:

IOException

openRaw

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

Description copied from interface: SerialPortSocket

Setting the parameters of port

Specified by:

openRaw in interface SerialPortSocket

Parameters:

baudRate - data transfer rate

dataBits - number of data bits

stopBits - number of stop bits

parity - parity

Throws:

IOException

setFlowControl

public void setFlowControl(Set<FlowControl> flowControls)
                    throws IOException

Specified by:

setFlowControl in interface SerialPortSocket

Throws:

IOException

getFlowControl

public Set<FlowControl> getFlowControl()
                                throws IOException

Specified by:

getFlowControl in interface SerialPortSocket

Throws:

IOException

open

protected abstract void open(String portName,
                             int type)
                      throws IOException

Open port

Parameters:

portName - name of port for opening

Throws:

IOException

close0

protected abstract void close0()
                        throws IOException

Close port

Throws:

IOException

finalize

protected void finalize()
                 throws Throwable

Overrides:

finalize in class Object

Throws:

Throwable

setBaudrate

public void setBaudrate(Baudrate baudrate)
                 throws IOException

Specified by:

setBaudrate in interface SerialPortSocket

Throws:

IOException

setDataBits

public void setDataBits(DataBits dataBits)
                 throws IOException

Specified by:

setDataBits in interface SerialPortSocket

Throws:

IOException

setStopBits

public void setStopBits(StopBits stopBits)
                 throws IOException

Specified by:

setStopBits in interface SerialPortSocket

Throws:

IOException

setParity

public void setParity(Parity parity)
               throws IOException

Specified by:

setParity in interface SerialPortSocket

Throws:

IOException

getBaudrate

public Baudrate getBaudrate()
                     throws IOException

Specified by:

getBaudrate in interface SerialPortSocket

Throws:

IOException

getDatatBits

public DataBits getDatatBits()
                      throws IOException

Specified by:

getDatatBits in interface SerialPortSocket

Throws:

IOException

getStopBits

public StopBits getStopBits()
                     throws IOException

Specified by:

getStopBits in interface SerialPortSocket

Throws:

IOException

getParity

public Parity getParity()
                 throws IOException

Specified by:

getParity in interface SerialPortSocket

Throws:

IOException

readSingle

protected abstract int readSingle()
                           throws IOException

Throws:

IOException

readBytes

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

Read data from port

Parameters:

b - the data to be written

off - the start offset in the data

len - the number of bytes that are written

Throws:

IOException - If an I/O error has occurred.

writeSingle

protected abstract void writeSingle(int b)
                             throws IOException

Throws:

IOException

writeBytes

protected abstract void writeBytes(byte[] b,
                                   int off,
                                   int len)
                            throws IOException

Write data to port

Parameters:

b -

off - the start offset in the data.

len - the number of bytes to write.

Throws:

IOException

setFlowControl

protected abstract void setFlowControl(int mask)
                                throws IOException

Throws:

IOException

getFlowControl0

protected abstract int getFlowControl0()
                                throws IOException

Throws:

IOException

setBaudrate

protected abstract void setBaudrate(int baudRate)
                             throws IOException

Throws:

IOException

setDataBits

protected abstract void setDataBits(int value)
                             throws IOException

Throws:

IOException

setStopBits

protected abstract void setStopBits(int value)
                             throws IOException

Throws:

IOException

setParity

protected abstract void setParity(int parity)
                           throws IOException

Throws:

IOException

getBaudrate0

protected abstract int getBaudrate0()
                             throws IOException

Throws:

IOException

getDataBits0

protected abstract int getDataBits0()
                             throws IOException

Throws:

IOException

getStopBits0

protected abstract int getStopBits0()
                             throws IOException

Throws:

IOException

getParity0

protected abstract int getParity0()
                           throws IOException

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object