org.vesalainen.comm.channel

Class SerialChannel

java.lang.Object

java.nio.channels.spi.AbstractInterruptibleChannel

java.nio.channels.SelectableChannel

java.nio.channels.spi.AbstractSelectableChannel

org.vesalainen.comm.channel.SerialChannel

All Implemented Interfaces:

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

Direct Known Subclasses:

LinuxSerialChannel, WinSerialChannel

public abstract class SerialChannel
extends AbstractSelectableChannel
implements GatheringByteChannel, ScatteringByteChannel

A class for making connection to a serial port E.g RS232. You make the connection by using SerialChannel.Builder

It is also possible to use Streams. Use getInputStream and getOutputStream.

Author:

tkv

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SerialChannel.Builder A class that is used to configure serial port and open it.
static class	SerialChannel.Configuration
static class	SerialChannel.DataBits
static class	SerialChannel.FlowControl
static class	SerialChannel.Parity
static class	SerialChannel.Speed Baud rate.
static class	SerialChannel.StopBits

Field Summary

Fields

Modifier and Type	Field and Description
protected long	address
protected boolean	block
protected boolean	clearOnClose
protected SerialChannel.Configuration	configuration
protected static org.vesalainen.util.logging.JavaLogging	log
static int	MaxSelectors The maximum number of reads or writes in select
protected String	port
protected ReentrantLock	readLock
protected ReentrantLock	writeLock

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SerialChannel()

Method Summary

Modifier and Type	Method and Description
void	clearBuffers() Clears input and output buffers.
void	configure(SerialChannel.Configuration config) Change channel configuration
static void	debug(boolean on) Sets the debug state.
protected abstract void	doClearBuffers(long address)
protected void	doClose()
protected abstract void	doClose(long handle)
protected abstract void	doConfigure(long handle, int baudRate, int parity, int dataBits, int stopBits, int flowControl, boolean replaceError)
protected abstract long	doOpen(byte[] port)
protected abstract int	doRead(long handle, ByteBuffer dst)
protected abstract int	doWrite(long handle, ByteBuffer src)
static List<String>	getAllPorts() Returns all available ports.
SerialChannel.Configuration	getConfiguration() Returns the current configuration
SerialChannel.DataBits	getDataBits()
static SerialChannel.DataBits	getDataBits(int bits)
static byte[]	getErrorReplacement()
SerialChannel.FlowControl	getFlowControl()
static SerialChannel.FlowControl	getFlowControl(String flow)
static List<String>	getFreePorts() Returns all ports that can be opened.
InputStream	getInputStream(int bufferSize) Returns InputStream.
OutputStream	getOutputStream(int bufferSize) Returns OutputStream.
SerialChannel.Parity	getParity()
static SerialChannel.Parity	getParity(String parity)
String	getPort() Returns the port.
SerialChannel.Speed	getSpeed()
static SerialChannel.Speed	getSpeed(int speed) Return the speed
static int	getSpeed(SerialChannel.Speed speed) Return the speed
SerialChannel.StopBits	getStopBits()
static SerialChannel.StopBits	getStopBits(int bits)
protected void	implCloseSelectableChannel()
protected void	implConfigureBlocking(boolean block)
boolean	isClearOnClose()
boolean	isReplaceError()
protected void	open() Creates actual connection.
int	read(ByteBuffer dst) Reads data at buffers position and then increments the position.
long	read(ByteBuffer[] dsts)
long	read(ByteBuffer[] dsts, int offset, int length)
void	setClearOnClose(boolean clearOnClose)
protected abstract void	setTimeouts()
protected abstract int	version()
int	write(ByteBuffer src) Writes data at buffers position and then increments the position.
long	write(ByteBuffer[] srcs)
long	write(ByteBuffer[] srcs, int offset, int length)

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, validOps

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, toString, wait, wait, wait

Methods inherited from interface java.nio.channels.Channel

close, isOpen

Field Detail

MaxSelectors

public static final int MaxSelectors

The maximum number of reads or writes in select

See Also:

Constant Field Values

address

protected long address

port

protected String port

configuration

protected SerialChannel.Configuration configuration

block

protected boolean block

clearOnClose

protected boolean clearOnClose

readLock

protected ReentrantLock readLock

writeLock

protected ReentrantLock writeLock

log

protected static final org.vesalainen.util.logging.JavaLogging log

Constructor Detail

SerialChannel

protected SerialChannel()

Method Detail

version

protected abstract int version()

clearBuffers

public void clearBuffers()

Clears input and output buffers.

doClearBuffers

protected abstract void doClearBuffers(long address)

getConfiguration

public SerialChannel.Configuration getConfiguration()

Returns the current configuration

Returns:

isClearOnClose

public boolean isClearOnClose()

setClearOnClose

public void setClearOnClose(boolean clearOnClose)

implConfigureBlocking

protected void implConfigureBlocking(boolean block)
                              throws IOException

Specified by:

implConfigureBlocking in class AbstractSelectableChannel

Throws:

IOException

setTimeouts

protected abstract void setTimeouts()
                             throws IOException

Throws:

IOException

getSpeed

public static int getSpeed(SerialChannel.Speed speed)

Return the speed

Parameters:

speed -

Returns:

getSpeed

public static SerialChannel.Speed getSpeed(int speed)

Return the speed

Parameters:

speed -

Returns:

getDataBits

public static SerialChannel.DataBits getDataBits(int bits)

getStopBits

public static SerialChannel.StopBits getStopBits(int bits)

getParity

public static SerialChannel.Parity getParity(String parity)

getFlowControl

public static SerialChannel.FlowControl getFlowControl(String flow)

getPort

public String getPort()

Returns the port.

Returns:

open

protected void open()
             throws IOException

Creates actual connection.

Throws:

IOException

doOpen

protected abstract long doOpen(byte[] port)

getErrorReplacement

public static byte[] getErrorReplacement()

configure

public void configure(SerialChannel.Configuration config)
               throws IOException

Change channel configuration

Parameters:

config -

Throws:

IOException

doConfigure

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

Throws:

IOException

getInputStream

public InputStream getInputStream(int bufferSize)

Returns InputStream. Allocates direct ByteBuffer bufferSize length. Note! closing the stream doesn't close the channel.

Using streams is not allowed in non-blocking mode.

Parameters:

bufferSize -

Returns:

Throws:

IllegalStateException - if in non-blocking mode.

getOutputStream

public OutputStream getOutputStream(int bufferSize)

Returns OutputStream. Allocates direct ByteBuffer bufferSize length. Note that write doesn't actually write anything before the buffer comes full. Use flush to flush the buffer. Note! closing the stream doesn't close the channel.

Using streams is not allowed in non-blocking mode.

Parameters:

bufferSize -

Returns:

Throws:

IllegalStateException - if in non-blocking mode.

read

public int read(ByteBuffer dst)
         throws IOException

Reads data at buffers position and then increments the position.

Specified by:

read in interface ReadableByteChannel

Parameters:

dst -

Returns:

Number of bytes read.

Throws:

IOException

doRead

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

Throws:

IOException

write

public int write(ByteBuffer src)
          throws IOException

Writes data at buffers position and then increments the position.

Specified by:

write in interface WritableByteChannel

Parameters:

src -

Returns:

Returns number of characters written.

Throws:

IOException

doWrite

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

Throws:

IOException

debug

public static void debug(boolean on)

Sets the debug state. When set to true, writes trace text to System.err

Parameters:

on -

getFreePorts

public static List<String> getFreePorts()

Returns all ports that can be opened.

Returns:

getAllPorts

public static List<String> getAllPorts()

Returns all available ports.

Returns:

getDataBits

public SerialChannel.DataBits getDataBits()

getFlowControl

public SerialChannel.FlowControl getFlowControl()

getParity

public SerialChannel.Parity getParity()

getSpeed

public SerialChannel.Speed getSpeed()

getStopBits

public SerialChannel.StopBits getStopBits()

isReplaceError

public boolean isReplaceError()

implCloseSelectableChannel

protected void implCloseSelectableChannel()
                                   throws IOException

Specified by:

implCloseSelectableChannel in class AbstractSelectableChannel

Throws:

IOException

doClose

protected void doClose()
                throws IOException

Throws:

IOException

doClose

protected abstract void doClose(long handle)
                         throws IOException

Throws:

IOException

write

public long write(ByteBuffer[] srcs,
                  int offset,
                  int length)
           throws IOException

Specified by:

write in interface GatheringByteChannel

Throws:

IOException

write

public long write(ByteBuffer[] srcs)
           throws IOException

Specified by:

write in interface GatheringByteChannel

Throws:

IOException

read

public long read(ByteBuffer[] dsts,
                 int offset,
                 int length)
          throws IOException

Specified by:

read in interface ScatteringByteChannel

Throws:

IOException

read

public long read(ByteBuffer[] dsts)
          throws IOException

Specified by:

read in interface ScatteringByteChannel

Throws:

IOException