com.ghgande.j2mod.modbus.io

Class ModbusTransaction

java.lang.Object

com.ghgande.j2mod.modbus.io.ModbusTransaction

Direct Known Subclasses:

ModbusSerialTransaction, ModbusTCPTransaction, ModbusUDPTransaction

public abstract class ModbusTransaction
extends Object

Interface defining a ModbusTransaction.

A transaction is defined by the sequence of sending a request message and receiving a related response message.

Version:

2.0 (March 2016)

Author:

Dieter Wimberger, Steve O'Hara (4NG)

Constructor Summary

Constructors

Constructor and Description
ModbusTransaction()

Method Summary

Modifier and Type	Method and Description
abstract void	execute() Executes this ModbusTransaction.
ModbusRequest	getRequest() Returns the ModbusRequest instance associated with this ModbusTransaction.
ModbusResponse	getResponse() Returns the ModbusResponse instance associated with this ModbusTransaction.
int	getTransactionID() getTransactionID -- get the next transaction ID to use.
boolean	isCheckingValidity() Tests whether the validity of a transaction will be checked.
void	setCheckingValidity(boolean b) Sets the flag that controls whether the validity of a transaction will be checked.
void	setRequest(ModbusRequest req) Sets the ModbusRequest for this ModbusTransaction.
void	setRetries(int retries) Set the amount of retries for opening the connection for executing the transaction.

Methods inherited from class java.lang.Object

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

Constructor Detail

ModbusTransaction

public ModbusTransaction()

Method Detail

getRequest

public ModbusRequest getRequest()

Returns the ModbusRequest instance associated with this ModbusTransaction.

Returns:

the associated ModbusRequest instance.

setRequest

public void setRequest(ModbusRequest req)

Sets the ModbusRequest for this ModbusTransaction.

The related ModbusResponse is acquired from the passed in ModbusRequest instance.

Parameters:

req - a ModbusRequest.

getResponse

public ModbusResponse getResponse()

Returns the ModbusResponse instance associated with this ModbusTransaction.

Returns:

the associated ModbusRequest instance.

setRetries

public void setRetries(int retries)

Set the amount of retries for opening the connection for executing the transaction.

Parameters:

retries - the amount of retries as int.

isCheckingValidity

public boolean isCheckingValidity()

Tests whether the validity of a transaction will be checked.

Returns:

true if checking validity, false otherwise.

setCheckingValidity

public void setCheckingValidity(boolean b)

Sets the flag that controls whether the validity of a transaction will be checked.

Parameters:

b - true if checking validity, false otherwise.

getTransactionID

public int getTransactionID()

getTransactionID -- get the next transaction ID to use.

Returns:

next transaction ID to use

execute

public abstract void execute()
                      throws ModbusException

Executes this ModbusTransaction. Locks the ModbusTransport for sending the ModbusRequest and reading the related ModbusResponse. If reconnecting is activated the connection will be opened for the transaction and closed afterwards.

Throws:

ModbusException - if an I/O error occurs, or the response is a modbus protocol exception.