com.ghgande.j2mod.modbus.msg

Class IllegalFunctionRequest

java.lang.Object

com.ghgande.j2mod.modbus.msg.ModbusMessageImpl

com.ghgande.j2mod.modbus.msg.ModbusRequest

com.ghgande.j2mod.modbus.msg.IllegalFunctionRequest

All Implemented Interfaces:

ModbusMessage

public class IllegalFunctionRequest
extends ModbusRequest

Class implementing a ModbusRequest which is created for illegal or non implemented function codes.

This is just a helper class to keep the implementation patterns the same for all cases.

Version:

2.0 (March 2016)

Author:

Dieter Wimberger, Steve O'Hara (4NG)

Constructor Summary

Constructors

Constructor and Description
IllegalFunctionRequest(int function) Constructs a new IllegalFunctionRequest instance for a given function code.
IllegalFunctionRequest(int unit, int function) Constructs a new IllegalFunctionRequest instance for a given function code.

Method Summary

Modifier and Type	Method and Description
ModbusResponse	createResponse(AbstractModbusListener listener) Returns the ModbusResponse that represents the answer to this ModbusRequest.
byte[]	getMessage() Returns the raw message as an array of bytes.
ModbusResponse	getResponse() There is no unit number associated with this exception.
void	readData(DataInput din) Read all of the data that can be read.
void	writeData(DataOutput dout) Writes the subclass specific data to the given DataOutput.

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

createExceptionResponse, createModbusRequest

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

IllegalFunctionRequest

public IllegalFunctionRequest(int function)

Constructs a new IllegalFunctionRequest instance for a given function code.

Used to implement slave devices when an illegal function code has been requested.

Parameters:

function - the function code as int.

IllegalFunctionRequest

public IllegalFunctionRequest(int unit,
                              int function)

Constructs a new IllegalFunctionRequest instance for a given function code.

Used to implement slave devices when an illegal function code has been requested.

Parameters:

unit - Unit ID

function - the function code as int.

Method Detail

getResponse

public ModbusResponse getResponse()

There is no unit number associated with this exception.

Specified by:

getResponse in class ModbusRequest

Returns:

Modbus excepion response

createResponse

public ModbusResponse createResponse(AbstractModbusListener listener)

Description copied from class: ModbusRequest

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.

Specified by:

createResponse in class ModbusRequest

Parameters:

listener - Listener that received the request

Returns:

the corresponding ModbusResponse.

writeData

public void writeData(DataOutput dout)
               throws IOException

Description copied from class: ModbusMessageImpl

Writes the subclass specific data to the given DataOutput.

Specified by:

writeData in class ModbusMessageImpl

Parameters:

dout - the DataOutput to be written to.

Throws:

IOException - if an I/O related error occurs.

readData

public void readData(DataInput din)
              throws IOException

Read all of the data that can be read. This is an unsupported function, so it may not be possible to know exactly how much data needs to be read.

Specified by:

readData in class ModbusMessageImpl

Parameters:

din - the DataInput to read from.

Throws:

IOException - If the data cannot be read from the socket/port

getMessage

public byte[] getMessage()

Description copied from interface: ModbusMessage

Returns the raw message as an array of bytes.

Returns:

the raw message as byte[].