Mip Fields [C]

Functions for processing received MIP fields. More...

Collaboration diagram for Mip Fields [C]:

Modules
	Field Accessors [C]
	Functions for inspecting a MIP field.
	Field Iteration [C]
	Functions for iterating over fields in a MIP packet.

Classes
struct	mip_field
	A structure representing a MIP field. More...

Typedefs
typedef struct mip_field	mip_field
	A structure representing a MIP field. More...

Functions
void	mip_field_init (mip_field *field, uint8_t descriptor_set, uint8_t field_descriptor, const uint8_t *payload, uint8_t payload_length)
	Constructs a mip_field given the parameters. More...

Detailed Description

Functions for processing received MIP fields.

---------------+------------+------------+-----/ /-----+------------+
 ...   Header  |   Field    |   Field    |     ...     |  Checksum  |
---------------+------------+------------+-----/ /-----+------------+
             _/              \_
           _/                  \_
          /                      \.
         +------+------+---/ /----+
         | Len  | desc | payload  |        The MIP Field
         +------+------+---/ /----+

Typedef Documentation

mip_field

typedef struct mip_field mip_field

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.

Function Documentation

mip_field_init()

void mip_field_init	(	mip_field *	field,
		uint8_t	descriptor_set,
		uint8_t	field_descriptor,
		const uint8_t *	payload,
		uint8_t	payload_length
	)

Constructs a mip_field given the parameters.

Parameters

field
descriptor_set	The MIP descriptor set of the packet.
field_descriptor	The MIP field descriptor.
payload	A pointer to a buffer containing the field payload, not including the field header. The data must exist while the field is in use. Can be NULL if payload_length is 0.
payload_length	The length of the payload. Cannot exceed MIP_FIELD_PAYLOAD_LENGTH_MAX.

Returns

A mip_field initialized with the specified values.

Definition at line 28 of file mip_field.c.