org.ardulink.core.serial.jssc

Class SerialInputStream

java.lang.Object

java.io.InputStream

org.ardulink.core.serial.jssc.SerialInputStream

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public class SerialInputStream
extends java.io.InputStream

Class that wraps a SerialPort to provide InputStream functionality. This stream also provides support for performing blocking reads with timeouts.
It is instantiated by passing the constructor a SerialPort instance. Do not create multiple streams for the same serial port unless you implement your own synchronization.

Author:

Charles Hache

Constructor Summary

Constructors

Constructor and Description
SerialInputStream(jssc.SerialPort sp) Instantiates a SerialInputStream for the given SerialPort Do not create multiple streams for the same serial port unless you implement your own synchronization.

Method Summary

Modifier and Type	Method and Description
int	available()
int	blockingRead(byte[] buf) Blocks until buf.length bytes are read, an error occurs, or the default timeout is hit (if specified).
int	blockingRead(byte[] buf, int timeout) The same contract as blockingRead(byte[]) except overrides this stream's default timeout with the given one.
int	blockingRead(byte[] buf, int offset, int length) Blocks until length bytes are read, an error occurs, or the default timeout is hit (if specified).
int	blockingRead(byte[] buf, int offset, int length, int timeout) The same contract as blockingRead(byte[], int, int) except overrides this stream's default timeout with the given one.
int	read() Reads the next byte from the port.
int	read(byte[] buf) Non-blocking read of up to buf.length bytes from the stream.
int	read(byte[] buf, int offset, int length) Non-blocking read of up to length bytes from the stream.
int	read(int timeout) The same contract as read(), except overrides this stream's default timeout with the given timeout in milliseconds.
void	setTimeout(int time) Set the default timeout (ms) of this SerialInputStream.

Methods inherited from class java.io.InputStream

close, mark, markSupported, reset, skip

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SerialInputStream

public SerialInputStream(jssc.SerialPort sp)

Instantiates a SerialInputStream for the given SerialPort Do not create multiple streams for the same serial port unless you implement your own synchronization.

Parameters:

sp - The serial port to stream.

Method Detail

setTimeout

public void setTimeout(int time)

Set the default timeout (ms) of this SerialInputStream. This affects subsequent calls to read(), #blockingRead(int[]), and #blockingRead(int[], int, int) The default timeout can be 'unset' by setting it to 0.

Parameters:

time - The timeout in milliseconds.

read

public int read()
         throws java.io.IOException

Reads the next byte from the port. If the timeout of this stream has been set, then this method blocks until data is available or until the timeout has been hit. If the timeout is not set or has been set to 0, then this method blocks indefinitely.

Specified by:

read in class java.io.InputStream

Throws:

java.io.IOException

read

public int read(int timeout)
         throws java.io.IOException

The same contract as read(), except overrides this stream's default timeout with the given timeout in milliseconds.

Parameters:

timeout - The timeout in milliseconds.

Returns:

The read byte.

Throws:

java.io.IOException - On serial port error or timeout

read

public int read(byte[] buf)
         throws java.io.IOException

Non-blocking read of up to buf.length bytes from the stream. This call behaves as read(buf, 0, buf.length) would.

Overrides:

read in class java.io.InputStream

Parameters:

buf - The buffer to fill.

Returns:

The number of bytes read, which can be 0.

Throws:

java.io.IOException - on error.

read

public int read(byte[] buf,
                int offset,
                int length)
         throws java.io.IOException

Non-blocking read of up to length bytes from the stream. This method returns what is immediately available in the input buffer.

Overrides:

read in class java.io.InputStream

Parameters:

buf - The buffer to fill.

offset - The offset into the buffer to start copying data.

length - The maximum number of bytes to read.

Returns:

The actual number of bytes read, which can be 0.

Throws:

java.io.IOException - on error.

blockingRead

public int blockingRead(byte[] buf)
                 throws java.io.IOException

Blocks until buf.length bytes are read, an error occurs, or the default timeout is hit (if specified). This behaves as blockingRead(buf, 0, buf.length) would.

Parameters:

buf - The buffer to fill with data.

Returns:

The number of bytes read.

Throws:

java.io.IOException - On error or timeout.

blockingRead

public int blockingRead(byte[] buf,
                        int timeout)
                 throws java.io.IOException

The same contract as blockingRead(byte[]) except overrides this stream's default timeout with the given one.

Parameters:

buf - The buffer to fill.

timeout - The timeout in milliseconds.

Returns:

The number of bytes read.

Throws:

java.io.IOException - On error or timeout.

blockingRead

public int blockingRead(byte[] buf,
                        int offset,
                        int length)
                 throws java.io.IOException

Blocks until length bytes are read, an error occurs, or the default timeout is hit (if specified). Saves the data into the given buffer at the specified offset. If the stream's timeout is not set, behaves as read(byte[], int, int) would.

Parameters:

buf - The buffer to fill.

offset - The offset in buffer to save the data.

length - The number of bytes to read.

Returns:

the number of bytes read.

Throws:

java.io.IOException - on error or timeout.

blockingRead

public int blockingRead(byte[] buf,
                        int offset,
                        int length,
                        int timeout)
                 throws java.io.IOException

The same contract as blockingRead(byte[], int, int) except overrides this stream's default timeout with the given one.

Parameters:

buf - The buffer to fill.

offset - Offset in the buffer to start saving data.

length - The number of bytes to read.

timeout - The timeout in milliseconds.

Returns:

The number of bytes read.

Throws:

java.io.IOException - On error or timeout.

available

public int available()
              throws java.io.IOException

Overrides:

available in class java.io.InputStream

Throws:

java.io.IOException