ModbusMessage (j2mod 3.3.0 API)

All Known Implementing Classes:

ExceptionResponse, IllegalAddressExceptionResponse, IllegalFunctionExceptionResponse, IllegalFunctionRequest, IllegalValueExceptionResponse, MaskWriteRegisterRequest, MaskWriteRegisterResponse, ModbusMessageImpl, ModbusRequest, ModbusResponse, ReadCoilsRequest, ReadCoilsResponse, ReadCommEventCounterRequest, ReadCommEventCounterResponse, ReadCommEventLogRequest, ReadCommEventLogResponse, ReadExceptionStatusRequest, ReadExceptionStatusResponse, ReadFIFOQueueRequest, ReadFIFOQueueResponse, ReadFileRecordRequest, ReadFileRecordResponse, ReadInputDiscretesRequest, ReadInputDiscretesResponse, ReadInputRegistersRequest, ReadInputRegistersResponse, ReadMEIRequest, ReadMEIResponse, ReadMultipleRegistersRequest, ReadMultipleRegistersResponse, ReadSerialDiagnosticsRequest, ReadSerialDiagnosticsResponse, ReadWriteMultipleRequest, ReadWriteMultipleResponse, ReportSlaveIDRequest, ReportSlaveIDResponse, WriteCoilRequest, WriteCoilResponse, WriteFileRecordRequest, WriteFileRecordResponse, WriteMultipleCoilsRequest, WriteMultipleCoilsResponse, WriteMultipleRegistersRequest, WriteMultipleRegistersResponse, WriteSingleRegisterRequest, WriteSingleRegisterResponse
```
public interface ModbusMessage
```
Interface defining a ModbusMessage.

Version:

2.0 (March 2016)

Author:

Dieter Wimberger, Steve O'Hara (4NG)

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`int`	`getDataLength()` Returns the length of the data appended after the protocol header.
`int`	`getFunctionCode()` Returns the function code of this `ModbusMessage` as `int`. The function code is a 1-byte non negative integer value valid in the range of 0-127.
`String`	`getHexMessage()` Returns the raw message as `String` containing a hexadecimal series of bytes.
`byte[]`	`getMessage()` Returns the raw message as an array of bytes.
`int`	`getOutputLength()` Returns the number of bytes that will be written by `writeTo(DataOutput)`.
`int`	`getProtocolID()` Returns the protocol identifier of this `ModbusMessage` as `int`.
`int`	`getTransactionID()` Returns the transaction identifier of this `ModbusMessage` as `int`.
`int`	`getUnitID()` Returns the unit identifier of this `ModbusMessage` as `int`.
`boolean`	`isHeadless()` Check the flag which indicates that this `ModbusMessage` is for a headless (serial, or headless networked) connection.
`void`	`readFrom(DataInput din)` Reads this `Transportable` from the given `DataInput`.
`void`	`setHeadless()` Sets the flag that marks this `ModbusMessage` as headless (for serial transport).
`void`	`writeTo(DataOutput dout)` Writes this `Transportable` to the given `DataOutput`.

- Method Detail
  - isHeadless
```
boolean isHeadless()
```
    Check the flag which indicates that this ModbusMessage is for a headless (serial, or headless networked) connection.
    
    Returns:
    
    is for a headless (serial, or headless networked) connection
  - setHeadless
```
void setHeadless()
```
    Sets the flag that marks this ModbusMessage as headless (for serial transport).
  - getTransactionID
```
int getTransactionID()
```
    Returns the transaction identifier of this ModbusMessage as int.
    The identifier is a 2-byte (short) non negative integer value valid in the range of 0-65535.
    
    Returns:
    
    the transaction identifier as int.
  - getProtocolID
```
int getProtocolID()
```
    Returns the protocol identifier of this ModbusMessage as int.
    The identifier is a 2-byte (short) non negative integer value valid in the range of 0-65535.
    
    Returns:
    
    the protocol identifier as int.
  - getDataLength
```
int getDataLength()
```
    Returns the length of the data appended after the protocol header.
    
    Returns:
    
    the data length as int.
  - getUnitID
```
int getUnitID()
```
    Returns the unit identifier of this ModbusMessage as int.
    The identifier is a 1-byte non negative integer value valid in the range of 0-255.
    
    Returns:
    
    the unit identifier as int.
  - getFunctionCode
```
int getFunctionCode()
```
    Returns the function code of this ModbusMessage as int.
    The function code is a 1-byte non negative integer value valid in the range of 0-127.
    Function codes are ordered in conformance classes their values are specified in com.ghgande.j2mod.modbus.Modbus.
    
    Returns:
    
    the function code as int.
    
    See Also:
    
    Modbus
  - getMessage
```
byte[] getMessage()
```
    Returns the raw message as an array of bytes.
    
    Returns:
    
    the raw message as byte[].
  - getHexMessage
```
String getHexMessage()
```
    Returns the raw message as String containing a hexadecimal series of bytes.
    This method is specially for debugging purposes, allowing the user to log the communication in a manner used in the specification document.
    
    Returns:
    
    the raw message as String containing a hexadecimal series of bytes.
  - getOutputLength
```
int getOutputLength()
```
    Returns the number of bytes that will be written by writeTo(DataOutput).
    
    Returns:
    
    the number of bytes that will be written as int.
  - writeTo
```
void writeTo(DataOutput dout)
      throws IOException
```
    Writes this Transportable to the given DataOutput.
    
    Parameters:
    
    dout - the DataOutput to write to.
    
    Throws:
    
    IOException - if an I/O error occurs.
  - readFrom
```
void readFrom(DataInput din)
       throws IOException
```
    Reads this Transportable from the given DataInput.
    
    Parameters:
    
    din - the DataInput to read from.
    
    Throws:
    
    IOException - if an I/O error occurs or the data is invalid.

Interface ModbusMessage

Method Summary

Method Detail

isHeadless

setHeadless

getTransactionID

getProtocolID

getDataLength

getUnitID

getFunctionCode

getMessage

getHexMessage

getOutputLength

writeTo

readFrom