Structure representing a parsed Ethernet response message. More...

#include <ethernet_client.h>

Public Attributes
EthernetMessageType	type
	The type of the response message. More...

uint16_t	id
	The sequence ID of the response message. More...

EthernetMessageStatus	status
	The status of the response message. More...

EthernetSqiReplyStatus	sqiStatus
	The status of the SQI reply in 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

Detailed Description

Structure representing a parsed Ethernet response message.

This structure is used to hold the parsed information from an Ethernet response message, including its type, sequence ID, status, size, and payload data.

Member Data Documentation

◆ data

std::vector<uint8_t> EthernetMessage::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 EthernetMessage::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 EthernetMessage::kBufferSize = 1500 - kHeaderSize

staticconstexpr

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

◆ kHeaderSize

constexpr size_t EthernetMessage::kHeaderSize = 7

staticconstexpr

The size of the message header.

◆ size

uint16_t EthernetMessage::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.

◆ sqiStatus

EthernetSqiReplyStatus EthernetMessage::sqiStatus

The status of the SQI reply in the response message.

This member stores the SQI reply status, indicating whether the communication with the SoC over SQI was successful or if an error occurred during the exchange. It reflects the outcome of the response message received from the SoC.

◆ status

EthernetMessageStatus EthernetMessage::status

The status of the response message.

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

◆ type

EthernetMessageType EthernetMessage::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:

libs/ethernet_client/ethernet_client.h

Public Attributes

Static Public Attributes