net.solarnetwork.io.modbus.tcp.netty

Class TcpModbusMessage

java.lang.Object

net.solarnetwork.io.modbus.tcp.netty.TcpModbusMessage

All Implemented Interfaces:

net.solarnetwork.io.modbus.ModbusMessage, net.solarnetwork.io.modbus.netty.msg.ModbusPayloadEncoder, TcpModbusMessage

public class TcpModbusMessage
extends Object
implements TcpModbusMessage, net.solarnetwork.io.modbus.netty.msg.ModbusPayloadEncoder

A TCP-encapsulated Modbus message.

Field Summary

Fields

Modifier and Type	Field	Description
static int	TCP_PROTOCOL_ID	The TCP protocol ID.

Fields inherited from interface net.solarnetwork.io.modbus.tcp.TcpModbusMessage

MAX_TRANSACTION_ID

Constructor Summary

Constructors

Constructor	Description
TcpModbusMessage(int transactionId, net.solarnetwork.io.modbus.ModbusMessage body)	Constructor.
TcpModbusMessage(long timestamp, int transactionId, net.solarnetwork.io.modbus.ModbusMessage body)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	encodeModbusPayload(io.netty.buffer.ByteBuf out)
net.solarnetwork.io.modbus.ModbusMessage	getBody()	Get the wrapped message.
net.solarnetwork.io.modbus.ModbusError	getError()
net.solarnetwork.io.modbus.ModbusFunction	getFunction()
long	getTimestamp()	Get a message creation date.
int	getTransactionId()	Get the transaction identifier.
int	getUnitId()
boolean	isSameAs(net.solarnetwork.io.modbus.ModbusMessage obj)
int	payloadLength()
String	toString()
<T extends net.solarnetwork.io.modbus.ModbusMessage> T	unwrap(Class<T> msgType)
TcpModbusMessage	validate()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.solarnetwork.io.modbus.tcp.TcpModbusMessage

getProtocolId

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

equals, hashCode, isException

Field Detail

TCP_PROTOCOL_ID

public static final int TCP_PROTOCOL_ID

The TCP protocol ID.

See Also:

Constant Field Values

Constructor Detail

TcpModbusMessage

public TcpModbusMessage(int transactionId,
                        net.solarnetwork.io.modbus.ModbusMessage body)

Constructor.

The current system time will be used for the timestamp value.

Parameters:

transactionId - the transaction ID

body - the message body, must implement ModbusPayloadEncoder.

Throws:

IllegalArgumentException - if body does not implement ModbusPayloadEncoder

TcpModbusMessage

public TcpModbusMessage(long timestamp,
                        int transactionId,
                        net.solarnetwork.io.modbus.ModbusMessage body)

Constructor.

Parameters:

timestamp - the timestamp

transactionId - the transaction ID

body - the message body, must implement ModbusPayloadEncoder.

Throws:

IllegalArgumentException - if body does not implement ModbusPayloadEncoder

Method Detail

validate

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

Specified by:

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

Specified by:

validate in interface TcpModbusMessage

Throws:

net.solarnetwork.io.modbus.ModbusValidationException

isSameAs

public boolean isSameAs(net.solarnetwork.io.modbus.ModbusMessage obj)

Specified by:

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

unwrap

public <T extends net.solarnetwork.io.modbus.ModbusMessage> T unwrap(Class<T> msgType)

Specified by:

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

toString

public String toString()

Overrides:

toString in class Object

getBody

public net.solarnetwork.io.modbus.ModbusMessage getBody()

Get the wrapped message.

Returns:

the wrapped message

getTimestamp

public long getTimestamp()

Description copied from interface: TcpModbusMessage

Get a message creation date.

Specified by:

getTimestamp in interface TcpModbusMessage

Returns:

the message creation date

getTransactionId

public int getTransactionId()

Description copied from interface: TcpModbusMessage

Get the transaction identifier.

Specified by:

getTransactionId in interface TcpModbusMessage

Returns:

the transaction identifier

getUnitId

public int getUnitId()

Specified by:

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

getFunction

public net.solarnetwork.io.modbus.ModbusFunction getFunction()

Specified by:

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

getError

public net.solarnetwork.io.modbus.ModbusError getError()

Specified by:

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

encodeModbusPayload

public void encodeModbusPayload(io.netty.buffer.ByteBuf out)

Specified by:

encodeModbusPayload in interface net.solarnetwork.io.modbus.netty.msg.ModbusPayloadEncoder

payloadLength

public int payloadLength()

Specified by:

payloadLength in interface net.solarnetwork.io.modbus.netty.msg.ModbusPayloadEncoder