#include <hcommand.h>

Collaboration diagram for HCommand:

Public Attributes
int16_t	Class

int16_t	Opcode

int16_t	Length

HCommandData	Data

Detailed Description

Command structure. Contains the opcode and data required by a command

Member Data Documentation

◆ Class

int16_t HCommand::Class

Command class - define the possible target types

◆ Data

HCommandData HCommand::Data

Data block. Depending on the class and opcode of the command, this block contains either a 32bit (signed) value, a boolean true/false or a buffer containing a number

◆ Length

int16_t HCommand::Length

Length of data, for boolean and integer values, this should be 0 otherwise set to the length of the content not including an eventual terminating zero byte. (that is. Use the exact length of the content block, and let the receiver convert it into a zero-terminated buffer if they prefer so.). The length of the content is in 8bit bytes, no matter what type of data is really encoded in the buffer (in the future, some commands may carry a serialized object, structured data or other types of advanced data in the content field. Only the sender and receiver knowns how to handle the content. All others should handle the content as an oblige blob of bytes.

◆ Opcode

int16_t HCommand::Opcode

The command to execute

The documentation for this struct was generated from the following file:

/home/henrik/Git/Hardt/hardt/libhardt/include/hcommand.h