Module de.ibapl.spsw.jniprovider

Package de.ibapl.spsw.jniprovider

Class AbstractSerialPortSocket<T extends AbstractSerialPortSocket<T>>

java.lang.Object

java.nio.channels.spi.AbstractInterruptibleChannel

de.ibapl.spsw.jniprovider.AbstractSerialPortSocket<T>

All Implemented Interfaces:

SerialPortConfiguration, SerialPortSocket, Closeable, AutoCloseable, ByteChannel, Channel, InterruptibleChannel, ReadableByteChannel, WritableByteChannel

Direct Known Subclasses:

GenericTermiosSerialPortSocket, GenericWinSerialPortSocket

public abstract class AbstractSerialPortSocket<T extends AbstractSerialPortSocket<T>>
extends AbstractInterruptibleChannel
implements SerialPortSocket

Base class for GenericTermiosSerialPortSocket and GenericWinSerialPortSocket with common JNI bindings.

Author:

scream3r, Arne Plöse

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	AbstractSerialPortSocket.SerialInputStream
protected class	AbstractSerialPortSocket.SerialOutputStream

Field Summary

Fields

Modifier and Type	Field	Description
protected AbstractSerialPortSocket.SerialInputStream	is
protected AbstractSerialPortSocket.SerialOutputStream	os

Fields inherited from interface de.ibapl.spsw.api.SerialPortConfiguration

INFINITE_TIMEOUT, PORT_FD_INVALID, PORT_IS_CLOSED, PORT_IS_OPEN

Constructor Summary

Constructors

Constructor	Description
AbstractSerialPortSocket(String portName)	Creates a new Instance.

Method Summary

Modifier and Type	Method	Description
void	ensureOpen()
DataBits	getDatatBits()
Set<FlowControl>	getFlowControl()
int	getInBufferBytesCount()
InputStream	getInputStream()
int	getOutBufferBytesCount()
OutputStream	getOutputStream()
protected int	getParameters(int parameterBitSetMask)	Returns the parameters as masked bit set.
Parity	getParity()
String	getPortName()
Speed	getSpeed()
StopBits	getStopBits()
char	getXOFFChar()
char	getXONChar()
protected void	implCloseChannel()
boolean	isCTS()
boolean	isDCD()
boolean	isDSR()
boolean	isRI()
protected void	open(Speed speed, DataBits dataBits, StopBits stopBits, Parity parity, Set<FlowControl> flowControls)
protected abstract void	open(String portName, int paramBitSet)	Open port
int	read(ByteBuffer dst)
void	sendBreak(int duration)
void	setBreak(boolean value)
void	setDataBits(DataBits dataBits)
void	setDTR(boolean value)
void	setFlowControl(Set<FlowControl> flowControls)
protected void	setParameters(int parameterBitSet)	Set the parameters that are set in the parameterBitSet.
void	setParity(Parity parity)
void	setRTS(boolean value)
void	setSpeed(Speed speed)
void	setStopBits(StopBits stopBits)
void	setXOFFChar(char c)
void	setXONChar(char c)
String	toString()
int	write(ByteBuffer src)
protected void	writeBytes_ParamsOK(byte[] b, int off, int len)	Write data to port
protected void	writeSingle(int b)

Methods inherited from class java.nio.channels.spi.AbstractInterruptibleChannel

begin, close, end, isOpen

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.nio.channels.Channel

isOpen

Methods inherited from interface java.nio.channels.InterruptibleChannel

close

Methods inherited from interface de.ibapl.spsw.api.SerialPortConfiguration

calculateMillisForCharacters, calculateMillisPerCharacter, calculateSpeedInCharactersPerSecond, drainOutputBuffer, getInterByteReadTimeout, getOverallReadTimeout, getOverallWriteTimeout, sendXOFF, sendXON, setTimeouts

Field Detail

is

protected AbstractSerialPortSocket.SerialInputStream is

os

protected AbstractSerialPortSocket.SerialOutputStream os

Constructor Detail

AbstractSerialPortSocket

public AbstractSerialPortSocket(String portName)

Creates a new Instance.

Parameters:

portName - the name of the port.

See Also:

FileOutputStream(String)

Method Detail

getXOFFChar

public char getXOFFChar()
                 throws IOException

Specified by:

getXOFFChar in interface SerialPortConfiguration

Throws:

IOException

getXONChar

public char getXONChar()
                throws IOException

Specified by:

getXONChar in interface SerialPortConfiguration

Throws:

IOException

isCTS

public boolean isCTS()
              throws IOException

Specified by:

isCTS in interface SerialPortConfiguration

Throws:

IOException

isDSR

public boolean isDSR()
              throws IOException

Specified by:

isDSR in interface SerialPortConfiguration

Throws:

IOException

isDCD

public boolean isDCD()
              throws IOException

Specified by:

isDCD in interface SerialPortConfiguration

Throws:

IOException

isRI

public boolean isRI()
             throws IOException

Specified by:

isRI in interface SerialPortConfiguration

Throws:

IOException

getParameters

protected int getParameters(int parameterBitSetMask)
                     throws IOException

Returns the parameters as masked bit set.

Returns:

the parameters as masked bit set.

Throws:

IOException

getInBufferBytesCount

public int getInBufferBytesCount()
                          throws IOException

Specified by:

getInBufferBytesCount in interface SerialPortConfiguration

Throws:

IOException

getOutBufferBytesCount

public int getOutBufferBytesCount()
                           throws IOException

Specified by:

getOutBufferBytesCount in interface SerialPortConfiguration

Throws:

IOException

setDTR

public void setDTR(boolean value)
            throws IOException

Specified by:

setDTR in interface SerialPortConfiguration

Throws:

IOException

setParameters

protected void setParameters(int parameterBitSet)
                      throws IOException

Set the parameters that are set in the parameterBitSet.

Parameters:

parameterBitSet - the parameters to set in a masked bit set.

Throws:

IOException

setXOFFChar

public void setXOFFChar(char c)
                 throws IOException

Specified by:

setXOFFChar in interface SerialPortConfiguration

Throws:

IOException

setXONChar

public void setXONChar(char c)
                throws IOException

Specified by:

setXONChar in interface SerialPortConfiguration

Throws:

IOException

writeBytes_ParamsOK

protected void writeBytes_ParamsOK(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

writeSingle

protected void writeSingle(int b)
                    throws IOException

Throws:

IOException

read

public int read(ByteBuffer dst)
         throws IOException

Specified by:

read in interface ReadableByteChannel

Throws:

IOException

write

public int write(ByteBuffer src)
          throws IOException

Specified by:

write in interface WritableByteChannel

Throws:

IOException

implCloseChannel

protected void implCloseChannel()
                         throws IOException

Specified by:

implCloseChannel in class AbstractInterruptibleChannel

Throws:

IOException

getSpeed

public Speed getSpeed()
               throws IOException

Specified by:

getSpeed in interface SerialPortConfiguration

Throws:

IOException

getDatatBits

public DataBits getDatatBits()
                      throws IOException

Specified by:

getDatatBits in interface SerialPortConfiguration

Throws:

IOException

getFlowControl

public Set<FlowControl> getFlowControl()
                                throws IOException

Specified by:

getFlowControl in interface SerialPortConfiguration

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

getParity

public Parity getParity()
                 throws IOException

Specified by:

getParity in interface SerialPortConfiguration

Throws:

IOException

getPortName

public String getPortName()

Specified by:

getPortName in interface SerialPortConfiguration

getStopBits

public StopBits getStopBits()
                     throws IOException

Specified by:

getStopBits in interface SerialPortConfiguration

Throws:

IOException

ensureOpen

public void ensureOpen()
                throws IOException

Throws:

IOException

open

protected void open(Speed speed,
                    DataBits dataBits,
                    StopBits stopBits,
                    Parity parity,
                    Set<FlowControl> flowControls)
             throws IOException

Throws:

IOException

open

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

Open port

Parameters:

portName - the name of port for opening

paramBitSet - the parameters as masked bit set.

Throws:

IOException

sendBreak

public void sendBreak(int duration)
               throws IOException

Specified by:

sendBreak in interface SerialPortConfiguration

Throws:

IOException

setSpeed

public void setSpeed(Speed speed)
              throws IOException

Specified by:

setSpeed in interface SerialPortConfiguration

Throws:

IOException

setBreak

public void setBreak(boolean value)
              throws IOException

Specified by:

setBreak in interface SerialPortConfiguration

Throws:

IOException

setDataBits

public void setDataBits(DataBits dataBits)
                 throws IOException

Specified by:

setDataBits in interface SerialPortConfiguration

Throws:

IOException

setFlowControl

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

Specified by:

setFlowControl in interface SerialPortConfiguration

Throws:

IOException

setParity

public void setParity(Parity parity)
               throws IOException

Specified by:

setParity in interface SerialPortConfiguration

Throws:

IOException

setRTS

public void setRTS(boolean value)
            throws IOException

Specified by:

setRTS in interface SerialPortConfiguration

Throws:

IOException

setStopBits

public void setStopBits(StopBits stopBits)
                 throws IOException

Specified by:

setStopBits in interface SerialPortConfiguration

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object