com.intelligt.modbus.jlibmodbus.net.stream.base

Class ModbusInputStream

java.lang.Object

java.io.InputStream

com.intelligt.modbus.jlibmodbus.net.stream.base.ModbusInputStream

All Implemented Interfaces:

Closeable, AutoCloseable

Direct Known Subclasses:

LoggingInputStream

public abstract class ModbusInputStream
extends InputStream

extends the InputStream class with ModbusInputStream#readShortLE() and ModbusInputStream#readShortBE() methods. Also it allows to set max read operation time with ModbusInputStream#setReadTimeout() method.

Since:

1.0

Author:

kochedykov

Constructor Summary

Constructors

Constructor and Description
ModbusInputStream()

Method Summary

Modifier and Type	Method and Description
int	read(byte[] b) default implementation of reading of a byte array.
int	readShortBE() read two bytes in Big Endian Byte Order
int	readShortLE() read two bytes in Little Endian Byte Order
abstract void	setReadTimeout(int readTimeout) sets a timeout value. if there is a timeout of read operation a stream must throw new IO exception.

Methods inherited from class java.io.InputStream

available, close, mark, markSupported, read, read, reset, skip

Methods inherited from class java.lang.Object

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

Constructor Detail

ModbusInputStream

public ModbusInputStream()

Method Detail

read

public int read(byte[] b)
         throws IOException

default implementation of reading of a byte array.

Overrides:

read in class InputStream

Parameters:

b - a byte array to fill by values from the input stream.

Returns:

total number of values read from the input stream into the byte array

Throws:

IOException - if there is a read operation timeout

NullPointerException - if b is null.

setReadTimeout

public abstract void setReadTimeout(int readTimeout)

sets a timeout value. if there is a timeout of read operation a stream must throw new IO exception.

Parameters:

readTimeout - is a timeout value in milliseconds

readShortBE

public int readShortBE()
                throws IOException

read two bytes in Big Endian Byte Order

Returns:

16-bit value placed in first two bytes of integer value, second two bytes is equal zero.

Throws:

IOException

See Also:

readShortLE()

readShortLE

public int readShortLE()
                throws IOException

read two bytes in Little Endian Byte Order

Returns:

16-bit value placed in first two bytes of integer value, second two bytes is equal zero.

Throws:

IOException

See Also:

readShortBE()