Module de.ibapl.spsw.jniprovider

Package de.ibapl.spsw.jniprovider

Class GenericTermiosSerialPortSocket

java.lang.Object

java.nio.channels.spi.AbstractInterruptibleChannel

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

de.ibapl.spsw.jniprovider.GenericTermiosSerialPortSocket

All Implemented Interfaces:

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

public class GenericTermiosSerialPortSocket
extends AbstractSerialPortSocket<GenericTermiosSerialPortSocket>
implements InOutSpeedConfiguration

JNI wrapper around the POSIX termios structure. Use serial_struct TIOCGSERIAL to get more infos?

Author:

scream3r, Arne Plöse

Nested Class Summary

Nested classes/interfaces inherited from class de.ibapl.spsw.jniprovider.AbstractSerialPortSocket

AbstractSerialPortSocket.SerialInputStream, AbstractSerialPortSocket.SerialOutputStream

Field Summary

Fields

Modifier and Type	Field	Description
static Cleaner	CLEANER

Fields inherited from class de.ibapl.spsw.jniprovider.AbstractSerialPortSocket

is, 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
GenericTermiosSerialPortSocket(String portName)
GenericTermiosSerialPortSocket(String portName, Speed speed, DataBits dataBits, StopBits stopBits, Parity parity, Set<FlowControl> flowControls)

Method Summary

Modifier and Type	Method	Description
void	drainOutputBuffer()
Speed	getInSpeed()
int	getInterByteReadTimeout()
Speed	getOutSpeed()
int	getOverallReadTimeout()
int	getOverallWriteTimeout()
protected void	implCloseChannel()
boolean	isDTR()
boolean	isRTS()
protected void	open(String portName, int paramBitSet)	Open port
void	sendXOFF()
void	sendXON()
void	setInSpeed(Speed speed)
protected void	setInSpeed0(int parameterBitSet)
void	setOutSpeed(Speed speed)
protected void	setOutSpeed0(int parameterBitSet)
void	setTimeouts(int interByteReadTimeout, int overallReadTimeout, int overallWriteTimeout)

Methods inherited from class de.ibapl.spsw.jniprovider.AbstractSerialPortSocket

ensureOpen, getDatatBits, getFlowControl, getInBufferBytesCount, getInputStream, getOutBufferBytesCount, getOutputStream, getParameters, getParity, getPortName, getSpeed, getStopBits, getXOFFChar, getXONChar, isCTS, isDCD, isDSR, isRI, open, read, sendBreak, setBreak, setDataBits, setDTR, setFlowControl, setParameters, setParity, setRTS, setSpeed, setStopBits, setXOFFChar, setXONChar, toString, write, writeBytes_ParamsOK, writeSingle

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

Field Detail

CLEANER

public static final Cleaner CLEANER

Constructor Detail

GenericTermiosSerialPortSocket

public GenericTermiosSerialPortSocket(String portName)
                               throws IOException

Throws:

IOException

GenericTermiosSerialPortSocket

public GenericTermiosSerialPortSocket(String portName,
                                      Speed speed,
                                      DataBits dataBits,
                                      StopBits stopBits,
                                      Parity parity,
                                      Set<FlowControl> flowControls)
                               throws IOException

Throws:

IOException

Method Detail

open

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

Description copied from class: AbstractSerialPortSocket

Open port

Specified by:

open in class AbstractSerialPortSocket<GenericTermiosSerialPortSocket>

Parameters:

portName - the name of port for opening

paramBitSet - the parameters as masked bit set.

Throws:

IOException

implCloseChannel

protected void implCloseChannel()
                         throws IOException

Overrides:

implCloseChannel in class AbstractSerialPortSocket<GenericTermiosSerialPortSocket>

Throws:

IOException

drainOutputBuffer

public void drainOutputBuffer()
                       throws IOException

Specified by:

drainOutputBuffer in interface SerialPortConfiguration

Throws:

IOException

getInterByteReadTimeout

public int getInterByteReadTimeout()
                            throws IOException

Specified by:

getInterByteReadTimeout in interface SerialPortConfiguration

Throws:

IOException

getOverallReadTimeout

public int getOverallReadTimeout()
                          throws IOException

Specified by:

getOverallReadTimeout in interface SerialPortConfiguration

Throws:

IOException

getOverallWriteTimeout

public int getOverallWriteTimeout()
                           throws IOException

Specified by:

getOverallWriteTimeout in interface SerialPortConfiguration

Throws:

IOException

getInSpeed

public Speed getInSpeed()
                 throws IOException

Specified by:

getInSpeed in interface InOutSpeedConfiguration

Throws:

IOException

getOutSpeed

public Speed getOutSpeed()
                  throws IOException

Specified by:

getOutSpeed in interface InOutSpeedConfiguration

Throws:

IOException

isDTR

public boolean isDTR()
              throws IOException

Throws:

IOException

isRTS

public boolean isRTS()
              throws IOException

Throws:

IOException

sendXOFF

public void sendXOFF()
              throws IOException

Specified by:

sendXOFF in interface SerialPortConfiguration

Throws:

IOException

sendXON

public void sendXON()
             throws IOException

Specified by:

sendXON in interface SerialPortConfiguration

Throws:

IOException

setTimeouts

public void setTimeouts(int interByteReadTimeout,
                        int overallReadTimeout,
                        int overallWriteTimeout)
                 throws IOException

Specified by:

setTimeouts in interface SerialPortConfiguration

Throws:

IOException

setInSpeed0

protected void setInSpeed0(int parameterBitSet)
                    throws IOException

Throws:

IOException

setOutSpeed0

protected void setOutSpeed0(int parameterBitSet)
                     throws IOException

Throws:

IOException

setInSpeed

public void setInSpeed(Speed speed)
                throws IOException

Specified by:

setInSpeed in interface InOutSpeedConfiguration

Throws:

IOException

setOutSpeed

public void setOutSpeed(Speed speed)
                 throws IOException

Specified by:

setOutSpeed in interface InOutSpeedConfiguration

Throws:

IOException