org.vesalainen.comm.channel

Class WinSerialChannel

java.lang.Object

java.nio.channels.spi.AbstractInterruptibleChannel

java.nio.channels.SelectableChannel

java.nio.channels.spi.AbstractSelectableChannel

org.vesalainen.comm.channel.SerialChannel

org.vesalainen.comm.channel.WinSerialChannel

All Implemented Interfaces:

Closeable, AutoCloseable, Channel, GatheringByteChannel, InterruptibleChannel, ReadableByteChannel, ScatteringByteChannel, WritableByteChannel

public class WinSerialChannel
extends SerialChannel

A Windows implementation of SerialChannel

Implementation notes:

Scattering/Gathering IO is implemented in java.

Select implementation uses CancelIo function which cancels all io for the channel. Currently this will cause problem if one thread calls read/write, while another thread calls select. Since select is usually used in one thread applications, it is not problem at all.

If this class later implements AsynchronousChannel, the CancelIo has to be implemented in another way!

Author:

tkv

Nested Class Summary

Nested classes/interfaces inherited from class org.vesalainen.comm.channel.SerialChannel

SerialChannel.Builder, SerialChannel.Configuration, SerialChannel.DataBits, SerialChannel.FlowControl, SerialChannel.Parity, SerialChannel.Speed, SerialChannel.StopBits

Field Summary

Fields

Modifier and Type	Field and Description
static int	EV_RXCHAR
static int	MAXDWORD
static int	MaxSelect
static int	VERSION

Fields inherited from class org.vesalainen.comm.channel.SerialChannel

address, block, clearOnClose, configuration, log, MaxSelectors, port, readLock, writeLock

Method Summary

Modifier and Type	Method and Description
protected void	checkVersion()
protected void	doClearBuffers(long address)
protected void	doClose(long handle)
protected void	doConfigure(long handle, int baudRate, int parity, int dataBits, int stopBits, int flowControl, boolean replaceError)
static void	doEnumPorts(List<String> list)
protected long	doOpen(byte[] port)
protected int	doRead(long handle, ByteBuffer dst)
protected int	doWrite(long handle, ByteBuffer src)
static byte[]	errorReplacement()
int	getReadIntervalTimeout()
int	getReadTotalTimeoutConstant()
int	getReadTotalTimeoutMultiplier()
int	getWriteTotalTimeoutConstant()
int	getWriteTotalTimeoutMultiplier()
int	read(ByteBuffer dst) Reads data at buffers position and then increments the position.
static void	setDebug(boolean on)
protected void	setEventMask(int mask)
WinSerialChannel	setReadIntervalTimeout(int readIntervalTimeout)
WinSerialChannel	setReadTotalTimeoutConstant(int readTotalTimeoutConstant)
WinSerialChannel	setReadTotalTimeoutMultiplier(int readTotalTimeoutMultiplier)
protected void	setTimeouts()
WinSerialChannel	setWriteTotalTimeoutConstant(int writeTotalTimeoutConstant)
WinSerialChannel	setWriteTotalTimeoutMultiplier(int writeTotalTimeoutMultiplier)
String	toString()
int	validOps()
protected int	version()
protected int	waitEvent(int mask)

Methods inherited from class org.vesalainen.comm.channel.SerialChannel

clearBuffers, configure, debug, doClose, getAllPorts, getConfiguration, getDataBits, getDataBits, getErrorReplacement, getFlowControl, getFlowControl, getFreePorts, getInputStream, getOutputStream, getParity, getParity, getPort, getSpeed, getSpeed, getSpeed, getStopBits, getStopBits, implCloseSelectableChannel, implConfigureBlocking, isClearOnClose, isReplaceError, open, read, read, setClearOnClose, write, write, write

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

blockingLock, configureBlocking, implCloseChannel, isBlocking, isRegistered, keyFor, provider, register

Methods inherited from class java.nio.channels.SelectableChannel

register

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

close, isOpen

Field Detail

VERSION

public static final int VERSION

See Also:

Constant Field Values

MAXDWORD

public static final int MAXDWORD

See Also:

Constant Field Values

EV_RXCHAR

public static final int EV_RXCHAR

See Also:

Constant Field Values

MaxSelect

public static final int MaxSelect

See Also:

Constant Field Values

Method Detail

doClearBuffers

protected void doClearBuffers(long address)

Specified by:

doClearBuffers in class SerialChannel

doConfigure

protected void doConfigure(long handle,
                           int baudRate,
                           int parity,
                           int dataBits,
                           int stopBits,
                           int flowControl,
                           boolean replaceError)
                    throws IOException

Specified by:

doConfigure in class SerialChannel

Throws:

IOException

version

protected int version()

Specified by:

version in class SerialChannel

doOpen

protected long doOpen(byte[] port)

Specified by:

doOpen in class SerialChannel

doRead

protected int doRead(long handle,
                     ByteBuffer dst)
              throws IOException

Specified by:

doRead in class SerialChannel

Throws:

IOException

doWrite

protected int doWrite(long handle,
                      ByteBuffer src)
               throws IOException

Specified by:

doWrite in class SerialChannel

Throws:

IOException

setDebug

public static void setDebug(boolean on)

doEnumPorts

public static void doEnumPorts(List<String> list)

doClose

protected void doClose(long handle)
                throws IOException

Specified by:

doClose in class SerialChannel

Throws:

IOException

checkVersion

protected void checkVersion()

setTimeouts

protected void setTimeouts()
                    throws IOException

Specified by:

setTimeouts in class SerialChannel

Throws:

IOException

validOps

public int validOps()

Specified by:

validOps in class SelectableChannel

errorReplacement

public static byte[] errorReplacement()

read

public int read(ByteBuffer dst)
         throws IOException

Description copied from class: SerialChannel

Reads data at buffers position and then increments the position.

Specified by:

read in interface ReadableByteChannel

Overrides:

read in class SerialChannel

Returns:

Number of bytes read.

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object

setEventMask

protected void setEventMask(int mask)
                     throws IOException

Throws:

IOException

waitEvent

protected int waitEvent(int mask)
                 throws IOException

Throws:

IOException

getReadIntervalTimeout

public int getReadIntervalTimeout()

setReadIntervalTimeout

public WinSerialChannel setReadIntervalTimeout(int readIntervalTimeout)

getReadTotalTimeoutMultiplier

public int getReadTotalTimeoutMultiplier()

setReadTotalTimeoutMultiplier

public WinSerialChannel setReadTotalTimeoutMultiplier(int readTotalTimeoutMultiplier)

getReadTotalTimeoutConstant

public int getReadTotalTimeoutConstant()

setReadTotalTimeoutConstant

public WinSerialChannel setReadTotalTimeoutConstant(int readTotalTimeoutConstant)

getWriteTotalTimeoutMultiplier

public int getWriteTotalTimeoutMultiplier()

setWriteTotalTimeoutMultiplier

public WinSerialChannel setWriteTotalTimeoutMultiplier(int writeTotalTimeoutMultiplier)

getWriteTotalTimeoutConstant

public int getWriteTotalTimeoutConstant()

setWriteTotalTimeoutConstant

public WinSerialChannel setWriteTotalTimeoutConstant(int writeTotalTimeoutConstant)