#include <NetworkMessage.h>

Public Attributes
uint32_t	securityMode

uint32_t	messageID

uint32_t	timestampHigh

uint32_t	timestampLow

uint32_t	messageType

uint32_t	messageDestination

uint32_t	message

uint32_t	parameter1

uint32_t	parameter2

uint32_t	xorChecksum

Detailed Description

This structure represents a network message. A network message is transmitted via ethernet to the device and is processed.

Member Data Documentation

◆ message

uint32_t networkMessageStruct::message

This is the message that is to be sent.

◆ messageDestination

uint32_t networkMessageStruct::messageDestination

This is the destination. This is a numerical destination on the given device for the message (i.e. the queue). If the message type is Broadcast message, then this parameter is ignored and the message should be enqueued to any queue within the system.

◆ messageID

uint32_t networkMessageStruct::messageID

This is a unique ID for this message. It should always increase by 1 each time a message is sent. There never should be a duplicate message ID until the system rolls over after 2^32-1 messages, which should take a while we hope.

◆ messageType

uint32_t networkMessageStruct::messageType

This is the type of message that is being transmitted. Types that are supported are defined in the header file NetworkCommandTypes.h

◆ parameter1

uint32_t networkMessageStruct::parameter1

This is the first parameter for the message.

◆ parameter2

uint32_t networkMessageStruct::parameter2

This is the second parameter for the message.

◆ securityMode

uint32_t networkMessageStruct::securityMode

This is a flag for the security mode. Overall, it is 0 unless the message is encrypted in some format. If it is non zero, then some form of encryption is being used.

◆ timestampHigh

uint32_t networkMessageStruct::timestampHigh

This is the timestamp for this message. It is the number of ms since the start of the Epoch. It is split into two parts, high and low.

◆ timestampLow

uint32_t networkMessageStruct::timestampLow