com.ghgande.j2mod.modbus.msg

Class ModbusRequest

java.lang.Object

com.ghgande.j2mod.modbus.msg.ModbusMessageImpl

com.ghgande.j2mod.modbus.msg.ModbusRequest

All Implemented Interfaces:

ModbusMessage

Direct Known Subclasses:

IllegalFunctionRequest, MaskWriteRegisterRequest, ReadCoilsRequest, ReadCommEventCounterRequest, ReadCommEventLogRequest, ReadExceptionStatusRequest, ReadFIFOQueueRequest, ReadFileRecordRequest, ReadInputDiscretesRequest, ReadInputRegistersRequest, ReadMEIRequest, ReadMultipleRegistersRequest, ReadSerialDiagnosticsRequest, ReadWriteMultipleRequest, ReportSlaveIDRequest, WriteCoilRequest, WriteFileRecordRequest, WriteMultipleCoilsRequest, WriteMultipleRegistersRequest, WriteSingleRegisterRequest

public abstract class ModbusRequest
extends ModbusMessageImpl

Abstract class implementing a ModbusRequest. This class provides specialised implementations with the functionality they have in common.

Version:

2.0 (March 2016)

Author:

Dieter Wimberger, jfhaugh (jfh@ghgande.com), Steve O'Hara (4NG)

Constructor Summary

Constructors

Constructor and Description
ModbusRequest()

Method Summary

Modifier and Type	Method and Description
ModbusResponse	createExceptionResponse(int code) Factory method for creating exception responses with the given exception code.
static ModbusRequest	createModbusRequest(int functionCode) Factory method creating the required specialized ModbusRequest instance.
abstract ModbusResponse	createResponse(AbstractModbusListener listener) Returns the ModbusResponse that represents the answer to this ModbusRequest.
abstract ModbusResponse	getResponse() Returns the ModbusResponse that correlates with this ModbusRequest.

Methods inherited from class com.ghgande.j2mod.modbus.msg.ModbusMessageImpl

getDataLength, getFunctionCode, getHexMessage, getOutputLength, getProtocolID, getTransactionID, getUnitID, isHeadless, readData, readFrom, setDataLength, setHeadless, setHeadless, setProtocolID, setTransactionID, setUnitID, writeData, writeTo

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.ghgande.j2mod.modbus.msg.ModbusMessage

getMessage

Constructor Detail

ModbusRequest

public ModbusRequest()

Method Detail

createModbusRequest

public static ModbusRequest createModbusRequest(int functionCode)

Factory method creating the required specialized ModbusRequest instance.

Parameters:

functionCode - the function code of the request as int.

Returns:

a ModbusRequest instance specific for the given function type.

getResponse

public abstract ModbusResponse getResponse()

Returns the ModbusResponse that correlates with this ModbusRequest.

The response must include the unit number, function code, as well as any transport-specific header information.

This method is used to create an empty response which must be populated by the caller. It is commonly used to un-marshal responses from Modbus slaves.

Returns:

the corresponding ModbusResponse.

createResponse

public abstract ModbusResponse createResponse(AbstractModbusListener listener)

Returns the ModbusResponse that represents the answer to this ModbusRequest.

The implementation should take care about assembling the reply to this ModbusRequest.

This method is used to create responses from the process image associated with the listener. It is commonly used to implement Modbus slave instances.

Parameters:

listener - Listener that received the request

Returns:

the corresponding ModbusResponse.

createExceptionResponse

public ModbusResponse createExceptionResponse(int code)

Factory method for creating exception responses with the given exception code.

Parameters:

code - the code of the exception.

Returns:

a ModbusResponse instance representing the exception response.