Motion Master
Loading...
Searching...
No Matches
Public Attributes | Static Public Attributes | List of all members
mm::comm::spoe::Message Struct Reference

#include <spoe.h>

Public Attributes

SpoeMessageType type
 The type of the response message. More...
 
uint16_t id
 The sequence ID of the response message. More...
 
uint16_t status
 The status of the response message. More...
 
uint16_t size
 The size of the buffer in the response message. More...
 
std::vector< uint8_t > data
 The payload data of the response message. More...
 

Static Public Attributes

static constexpr size_t kHeaderSize = 7
 
static constexpr size_t kBufferSize = 1500 - kHeaderSize
 

Member Data Documentation

◆ data

std::vector<uint8_t> mm::comm::spoe::Message::data

The payload data of the response message.

This vector contains the raw data of the response message, excluding the header fields.

◆ id

uint16_t mm::comm::spoe::Message::id

The sequence ID of the response message.

This is a two-byte field that contains the unique sequence ID of the response message.

◆ kBufferSize

constexpr size_t mm::comm::spoe::Message::kBufferSize = 1500 - kHeaderSize
staticconstexpr

The buffer size used for communication, excluding the message header.

◆ kHeaderSize

constexpr size_t mm::comm::spoe::Message::kHeaderSize = 7
staticconstexpr

The size of the message header.

◆ size

uint16_t mm::comm::spoe::Message::size

The size of the buffer in the response message.

This is a two-byte field that specifies the size of the data buffer in the response message.

◆ status

uint16_t mm::comm::spoe::Message::status

The status of the response message.

This is a two-byte field that contains the status code of the response message.

◆ type

SpoeMessageType mm::comm::spoe::Message::type

The type of the response message.

This is a one-byte field representing the type of the response.


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