com.ghgande.j2mod.modbus.io

Class ModbusTCPTransport

java.lang.Object

com.ghgande.j2mod.modbus.io.AbstractModbusTransport

com.ghgande.j2mod.modbus.io.ModbusTCPTransport

Direct Known Subclasses:

ModbusRTUTCPTransport

public class ModbusTCPTransport
extends AbstractModbusTransport

Class that implements the Modbus transport flavor.

Version:

2.0 (March 2016)

Author:

Dieter Wimberger, Steve O'Hara (4NG)

Constructor Summary

Constructors

Constructor and Description
ModbusTCPTransport() Default constructor
ModbusTCPTransport(Socket socket) Constructs a new ModbusTransport instance, for a given Socket.

Method Summary

Modifier and Type	Method and Description
void	close() Closes the raw input and output streams of this ModbusTransport.
ModbusTransaction	createTransaction() Creates a Modbus transaction for the underlying transport.
long	getLastActivityTimestamp()
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	setHeadless() Set the transport to be headless
void	setHeadless(boolean headless) Set the transport to be headless
void	setMaster(TCPMasterConnection master) Sets the master connection for the transport to use
void	setSocket(Socket socket) Sets the Socket used for message transport and prepares the streams used for the actual I/O.
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

ModbusTCPTransport

public ModbusTCPTransport()

Default constructor

ModbusTCPTransport

public ModbusTCPTransport(Socket socket)

Constructs a new ModbusTransport instance, for a given Socket.

Parameters:

socket - the Socket used for message transport.

Method Detail

setSocket

public void setSocket(Socket socket)
               throws IOException

Sets the Socket used for message transport and prepares the streams used for the actual I/O.

Parameters:

socket - the Socket used for message transport.

Throws:

IOException - if an I/O related error occurs.

setHeadless

public void setHeadless()

Set the transport to be headless

setHeadless

public void setHeadless(boolean headless)

Set the transport to be headless

Parameters:

headless - True if headless

setMaster

public void setMaster(TCPMasterConnection master)

Sets the master connection for the transport to use

Parameters:

master - Master

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

getLastActivityTimestamp

public long getLastActivityTimestamp()

Returns:

last activity timestamp for the transport (System.nanoTime() timestamp)

See Also:

System.nanoTime()

close

public void close()
           throws IOException

Description copied from class: AbstractModbusTransport

Closes the raw input and output streams of this ModbusTransport.

Specified by:

close in class AbstractModbusTransport

Throws:

IOException - if a stream cannot be closed properly.

createTransaction

public ModbusTransaction createTransaction()

Description copied from class: AbstractModbusTransport

Creates a Modbus transaction for the underlying transport.

Specified by:

createTransaction in class AbstractModbusTransport

Returns:

the new transaction

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.