com.ghgande.j2mod.modbus.io

Class AbstractModbusTransport

java.lang.Object

com.ghgande.j2mod.modbus.io.AbstractModbusTransport

Direct Known Subclasses:

ModbusSerialTransport, ModbusTCPTransport, ModbusUDPTransport

public abstract class AbstractModbusTransport
extends Object

Interface defining the I/O mechanisms for ModbusMessage instances.

Version:

2.0 (March 2016)

Author:

Dieter Wimberger, Steve O'Hara (4NG)

Constructor Summary

Constructors

Constructor and Description
AbstractModbusTransport()

Method Summary

Modifier and Type	Method and Description
abstract void	close() Closes the raw input and output streams of this ModbusTransport.
abstract ModbusTransaction	createTransaction() Creates a Modbus transaction for the underlying transport.
abstract ModbusRequest	readRequest(AbstractModbusListener listener) Reads a ModbusRequest from the input stream of this ModbusTransport.
abstract ModbusResponse	readResponse() Reads a ModbusResponse from the input stream of this ModbusTransport.
void	setTimeout(int time) Set the socket timeout
abstract void	writeRequest(ModbusRequest msg) Writes a ModbusMessage to the output stream of this ModbusTransport.
abstract void	writeResponse(ModbusResponse msg) Writes a ModbusResponseMessage to the output stream of this ModbusTransport.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractModbusTransport

public AbstractModbusTransport()

Method Detail

setTimeout

public void setTimeout(int time)

Set the socket timeout

Parameters:

time - Timeout in milliseconds

close

public abstract void close()
                    throws IOException

Closes the raw input and output streams of this ModbusTransport.

Throws:

IOException - if a stream cannot be closed properly.

createTransaction

public abstract ModbusTransaction createTransaction()

Creates a Modbus transaction for the underlying transport.

Returns:

the new transaction

writeRequest

public abstract void writeRequest(ModbusRequest msg)
                           throws ModbusIOException

Writes a ModbusMessage to the output stream of this ModbusTransport.

Parameters:

msg - a ModbusMessage.

Throws:

ModbusIOException - data cannot be written properly to the raw output stream of this ModbusTransport.

writeResponse

public abstract void writeResponse(ModbusResponse msg)
                            throws ModbusIOException

Writes a ModbusResponseMessage to the output stream of this ModbusTransport.

Parameters:

msg - a ModbusMessage.

Throws:

ModbusIOException - data cannot be written properly to the raw output stream of this ModbusTransport.

readRequest

public abstract ModbusRequest readRequest(AbstractModbusListener listener)
                                   throws ModbusIOException

Reads a ModbusRequest from the input stream of this ModbusTransport.

Parameters:

listener - Listener the request was received by

Returns:

req the ModbusRequest read from the underlying stream.

Throws:

ModbusIOException - data cannot be read properly from the raw input stream of this ModbusTransport.

readResponse

public abstract ModbusResponse readResponse()
                                     throws ModbusIOException

Reads a ModbusResponse from the input stream of this ModbusTransport.

Returns:

res the ModbusResponse read from the underlying stream.

Throws:

ModbusIOException - data cannot be read properly from the raw input stream of this ModbusTransport.