net.solarnetwork.io.modbus.tcp

Interface TcpModbusMessage

All Superinterfaces:

net.solarnetwork.io.modbus.ModbusMessage

All Known Implementing Classes:

TcpModbusMessage

public interface TcpModbusMessage
extends net.solarnetwork.io.modbus.ModbusMessage

TCP encapsulated Modbus message API.

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_TRANSACTION_ID The maximum transaction ID value.

Method Summary

Modifier and Type	Method and Description
default int	getProtocolId() Get the protocol identifier.
long	getTimestamp() Get a message creation date.
int	getTransactionId() Get the transaction identifier.
default TcpModbusMessage	validate()

Methods inherited from interface net.solarnetwork.io.modbus.ModbusMessage

equals, getError, getFunction, getUnitId, hashCode, isException, isSameAs, unwrap

Field Detail

MAX_TRANSACTION_ID

static final int MAX_TRANSACTION_ID

The maximum transaction ID value.

See Also:

Constant Field Values

Method Detail

getTimestamp

long getTimestamp()

Get a message creation date.

Returns:

the message creation date

getTransactionId

int getTransactionId()

Get the transaction identifier.

Returns:

the transaction identifier

getProtocolId

default int getProtocolId()

Get the protocol identifier.

This implementation returns 0 for Modbus/TCP.

Returns:

the protocol identifier

validate

default TcpModbusMessage validate()
                           throws net.solarnetwork.io.modbus.ModbusValidationException

Specified by:

validate in interface net.solarnetwork.io.modbus.ModbusMessage

Throws:

net.solarnetwork.io.modbus.ModbusValidationException