org.jperipheral

Class SerialChannel

java.lang.Object

org.jperipheral.SerialChannel

All Implemented Interfaces:

Closeable, AutoCloseable, AsynchronousByteChannel, AsynchronousChannel, Channel

public class SerialChannel
extends Object
implements AsynchronousByteChannel

An asynchronous channel for serial ports.

Timeouts

The read and write methods defined by this class allow a timeout to be specified when initiating a read or write operation. If the timeout elapses before an operation completes then the operation completes with the exception InterruptedByTimeoutException. A timeout may leave the channel, or the underlying connection, in an inconsistent state. Where the implementation cannot guarantee that bytes have not been read from the channel then it puts the channel into an implementation specific error state. A subsequent attempt to initiate a {

Author:

Gili Tzabari

Method Summary

Methods

Modifier and Type	Method and Description
void	close()
void	configure(SerialPort.BaudRate baudRate, SerialPort.DataBits dataBits, SerialPort.Parity parity, SerialPort.StopBits stopBits, SerialPort.FlowControl flowControl) Configures the serial port channel.
SerialPort.BaudRate	getBaudRate() Returns the baud rate being used.
SerialPort.DataBits	getDataBits() Returns the number of data bits being used.
SerialPort.FlowControl	getFlowControl() Returns the flow control mechanism being used.
SerialPort.Parity	getParity() Returns the parity type being used.
SerialPort	getPort() Returns the serial port associated with the channel.
SerialPort.StopBits	getStopBits() Returns the number of stop bits being used.
boolean	isOpen()
Future<Integer>	read(ByteBuffer target)
<A> void	read(ByteBuffer target, A attachment, CompletionHandler<Integer,? super A> handler)
String	toString()
Future<Integer>	write(ByteBuffer source)
<A> void	write(ByteBuffer source, A attachment, CompletionHandler<Integer,? super A> handler)

Methods inherited from class java.lang.Object

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

Method Detail

getBaudRate

public SerialPort.BaudRate getBaudRate()

Returns the baud rate being used.

Returns:

the baud rate being used

getDataBits

public SerialPort.DataBits getDataBits()

Returns the number of data bits being used.

Returns:

the number of data bits being used

getStopBits

public SerialPort.StopBits getStopBits()

Returns the number of stop bits being used.

Returns:

the number of stop bits being used

getParity

public SerialPort.Parity getParity()

Returns the parity type being used.

Returns:

the parity type being used

getFlowControl

public SerialPort.FlowControl getFlowControl()

Returns the flow control mechanism being used.

Returns:

the flow control mechanism being used

read

public <A> void read(ByteBuffer target,
            A attachment,
            CompletionHandler<Integer,? super A> handler)
          throws IllegalArgumentException,
                 ReadPendingException,
                 ShutdownChannelGroupException

Specified by:

read in interface AsynchronousByteChannel

Throws:

IllegalArgumentException

ReadPendingException

ShutdownChannelGroupException

read

public Future<Integer> read(ByteBuffer target)
                     throws IllegalArgumentException,
                            ReadPendingException

Specified by:

read in interface AsynchronousByteChannel

Throws:

IllegalArgumentException

ReadPendingException

write

public <A> void write(ByteBuffer source,
             A attachment,
             CompletionHandler<Integer,? super A> handler)
           throws IllegalArgumentException,
                  WritePendingException,
                  ShutdownChannelGroupException

Specified by:

write in interface AsynchronousByteChannel

Throws:

IllegalArgumentException

WritePendingException

ShutdownChannelGroupException

write

public Future<Integer> write(ByteBuffer source)
                      throws WritePendingException

Specified by:

write in interface AsynchronousByteChannel

Throws:

WritePendingException

configure

public void configure(SerialPort.BaudRate baudRate,
             SerialPort.DataBits dataBits,
             SerialPort.Parity parity,
             SerialPort.StopBits stopBits,
             SerialPort.FlowControl flowControl)
               throws PeripheralConfigurationException

Configures the serial port channel.

Parameters:

baudRate - the baud rate

dataBits - the number of data bits per word

parity - the parity mechanism to use

stopBits - the number of stop bits to use

flowControl - the flow control to use

Throws:

PeripheralConfigurationException - if an I/O error occurs while configuring the channel

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface AsynchronousChannel

Specified by:

close in interface Channel

Throws:

IOException

isOpen

public boolean isOpen()

Specified by:

isOpen in interface Channel

getPort

public SerialPort getPort()

Returns the serial port associated with the channel.

Returns:

the serial port associated with the channel

toString

public String toString()

Overrides:

toString in class Object