com.ghgande.j2mod.modbus.io

Class ModbusSerialTransport

java.lang.Object

com.ghgande.j2mod.modbus.io.AbstractModbusTransport

com.ghgande.j2mod.modbus.io.ModbusSerialTransport

Direct Known Subclasses:

ModbusASCIITransport, ModbusRTUTransport

public abstract class ModbusSerialTransport
extends AbstractModbusTransport

Abstract base class for serial ModbusTransport implementations.

Version:

2.0 (March 2016)

Author:

Dieter Wimberger, John Charlton, Steve O'Hara (4NG)

Constructor Summary

Constructors

Constructor and Description
ModbusSerialTransport()

Method Summary

Modifier and Type	Method and Description
void	addListener(AbstractSerialTransportListener listener) Adds a listener to the transport to be called when an event occurs
void	clearListeners() Clears the list of listeners
void	close() Closes the comms port and any streams associated with it
ModbusTransaction	createTransaction() Creates a new transaction suitable for the serial port
AbstractSerialConnection	getCommPort() Returns the comms port being used for this transport
boolean	isEcho() isEcho method returns the output echo state.
void	notifyListenersDisconnected() Calls any listeners with the given event and current port
ModbusRequest	readRequest(AbstractModbusListener listener) Reads a ModbusRequest from the input stream of this ModbusTransport.
ModbusResponse	readResponse() Reads a ModbusResponse from the input stream of this ModbusTransport.
void	removeListener(AbstractSerialTransportListener listener) Removes a listener from the event callback chain
void	setCommPort(AbstractSerialConnection cp) setCommPort sets the comm port member and prepares the input and output streams to be used for reading from and writing to.
void	setEcho(boolean b) setEcho method sets the output echo state.
void	setTimeout(int time) Set the socket timeout
void	writeRequest(ModbusRequest msg) Writes a ModbusMessage to the output stream of this ModbusTransport.
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

ModbusSerialTransport

public ModbusSerialTransport()

Method Detail

createTransaction

public ModbusTransaction createTransaction()

Creates a new transaction suitable for the serial port

Specified by:

createTransaction in class AbstractModbusTransport

Returns:

SerialTransaction

writeResponse

public void writeResponse(ModbusResponse msg)
                   throws ModbusIOException

Description copied from class: AbstractModbusTransport

Writes a ModbusResponseMessage to the output stream of this ModbusTransport.

Specified by:

writeResponse in class AbstractModbusTransport

Parameters:

msg - a ModbusMessage.

Throws:

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

writeRequest

public void writeRequest(ModbusRequest msg)
                  throws ModbusIOException

Description copied from class: AbstractModbusTransport

Writes a ModbusMessage to the output stream of this ModbusTransport.

Specified by:

writeRequest in class AbstractModbusTransport

Parameters:

msg - a ModbusMessage.

Throws:

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

readRequest

public ModbusRequest readRequest(AbstractModbusListener listener)
                          throws ModbusIOException

Description copied from class: AbstractModbusTransport

Reads a ModbusRequest from the input stream of this ModbusTransport.

Specified by:

readRequest in class AbstractModbusTransport

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 ModbusResponse readResponse()
                            throws ModbusIOException

Description copied from class: AbstractModbusTransport

Reads a ModbusResponse from the input stream of this ModbusTransport.

Specified by:

readResponse in class AbstractModbusTransport

Returns:

res the ModbusResponse read from the underlying stream.

Throws:

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

setTimeout

public void setTimeout(int time)

Description copied from class: AbstractModbusTransport

Set the socket timeout

Overrides:

setTimeout in class AbstractModbusTransport

Parameters:

time - Timeout in milliseconds

addListener

public void addListener(AbstractSerialTransportListener listener)

Adds a listener to the transport to be called when an event occurs

Parameters:

listener - Listner callback

removeListener

public void removeListener(AbstractSerialTransportListener listener)

Removes a listener from the event callback chain

Parameters:

listener - Listener to remove

clearListeners

public void clearListeners()

Clears the list of listeners

notifyListenersDisconnected

public void notifyListenersDisconnected()

Calls any listeners with the given event and current port

setCommPort

public void setCommPort(AbstractSerialConnection cp)
                 throws IOException

setCommPort sets the comm port member and prepares the input and output streams to be used for reading from and writing to.

Parameters:

cp - the comm port to read from/write to.

Throws:

IOException - if an I/O related error occurs.

getCommPort

public AbstractSerialConnection getCommPort()

Returns the comms port being used for this transport

Returns:

Comms port

isEcho

public boolean isEcho()

isEcho method returns the output echo state.

Returns:

a boolean value

setEcho

public void setEcho(boolean b)

setEcho method sets the output echo state.

Parameters:

b - a boolean value

close

public void close()
           throws IOException

Closes the comms port and any streams associated with it

Specified by:

close in class AbstractModbusTransport

Throws:

IOException - Comm port close failed