mip_field Struct Reference

A structure representing a MIP field. More...

#include <mip_field.h>

Private Attributes
uint8_t	_descriptor_set
	MIP descriptor set (from the packet) More...
uint8_t	_field_descriptor
	MIP field descriptor. Field not valid if set to 0x00. More...
const uint8_t *	_payload
	The field payload, excluding the header. More...
uint8_t	_payload_length
	The length of the payload, excluding the header. More...
uint8_t	_remaining_length
	Remaining space after this field. More...

Detailed Description

A structure representing a MIP field.

Use to access fields from a received MIP packet.

This structure references the original packet data and does not contain a copy of the field payload. Therefore, the data buffer must exist as long as there are mip_field instances which reference it (even if the field payload itself is not used directly).

Note

This should be considered an "opaque" structure; its members should be considered an internal implementation detail. Avoid accessing them directly as they are subject to change in future versions of this software.

Definition at line 52 of file mip_field.h.

Member Data Documentation

_descriptor_set

uint8_t mip_field::_descriptor_set

private

MIP descriptor set (from the packet)

Definition at line 57 of file mip_field.h.

_field_descriptor

uint8_t mip_field::_field_descriptor

private

MIP field descriptor. Field not valid if set to 0x00.

Definition at line 56 of file mip_field.h.

_payload

const uint8_t* mip_field::_payload

private

The field payload, excluding the header.

Definition at line 54 of file mip_field.h.

_payload_length

uint8_t mip_field::_payload_length

private

The length of the payload, excluding the header.

Definition at line 55 of file mip_field.h.

_remaining_length

uint8_t mip_field::_remaining_length

private

Remaining space after this field.

Definition at line 58 of file mip_field.h.

---

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

• mip_field.h