Collaboration diagram for Accessors - Functions for accessing information about an existing MIP packet.:

Functions
void	mip::C::mip_packet_from_buffer (mip_packet packet, uint8_t buffer, size_t length)

uint8_t	mip::C::mip_packet_descriptor_set (const mip_packet *packet)

packet_length	mip::C::mip_packet_total_length (const mip_packet *packet)

uint8_t	mip::C::mip_packet_payload_length (const mip_packet *packet)

uint8_t *	mip::C::mip_packet_buffer (mip_packet *packet)

const uint8_t *	mip::C::mip_packet_pointer (const mip_packet *packet)

const uint8_t *	mip::C::mip_packet_payload (const mip_packet *packet)

uint16_t	mip::C::mip_packet_checksum_value (const mip_packet *packet)

uint16_t	mip::C::mip_packet_compute_checksum (const mip_packet *packet)

bool	mip::C::mip_packet_is_sane (const mip_packet *packet)

bool	mip::C::mip_packet_is_valid (const mip_packet *packet)

bool	mip::C::mip_packet_is_empty (const mip_packet *packet)

packet_length	mip::C::mip_packet_buffer_size (const mip_packet *packet)

remaining_count	mip::C::mip_packet_remaining_space (const mip_packet *packet)

bool	mip::C::mip_packet_is_data (const mip_packet *packet)

Detailed Description

Use these functions to get information about a MIP packet after it has been parsed. Generally, first the descriptor set would be inspected followed by iterating the fields using the MipFieldIteration functions.

With the exception of mip_packet_checksum_value() (and any function which calls it, e.g. mip_packet_is_valid()), these functions may also be used on packets which are under construction via the PacketBuilding functions.

Function Documentation

◆ mip_packet_buffer()

uint8_t* mip::C::mip_packet_buffer ( mip_packet * packet )

◆ mip_packet_buffer_size()

packet_length mip::C::mip_packet_buffer_size ( const mip_packet * packet )

◆ mip_packet_checksum_value()

uint16_t mip::C::mip_packet_checksum_value ( const mip_packet * packet )

◆ mip_packet_compute_checksum()

uint16_t mip::C::mip_packet_compute_checksum ( const mip_packet * packet )

◆ mip_packet_descriptor_set()

uint8_t mip::C::mip_packet_descriptor_set ( const mip_packet * packet )

◆ mip_packet_from_buffer()

void mip::C::mip_packet_from_buffer	(	mip_packet *	packet,
		uint8_t *	buffer,
		size_t	length
	)

◆ mip_packet_is_data()

bool mip::C::mip_packet_is_data ( const mip_packet * packet )

◆ mip_packet_is_empty()

bool mip::C::mip_packet_is_empty ( const mip_packet * packet )

◆ mip_packet_is_sane()

bool mip::C::mip_packet_is_sane ( const mip_packet * packet )

◆ mip_packet_is_valid()

bool mip::C::mip_packet_is_valid ( const mip_packet * packet )

◆ mip_packet_payload()

const uint8_t* mip::C::mip_packet_payload ( const mip_packet * packet )

◆ mip_packet_payload_length()

uint8_t mip::C::mip_packet_payload_length ( const mip_packet * packet )

◆ mip_packet_pointer()

const uint8_t* mip::C::mip_packet_pointer ( const mip_packet * packet )

◆ mip_packet_remaining_space()

remaining_count mip::C::mip_packet_remaining_space ( const mip_packet * packet )

◆ mip_packet_total_length()

packet_length mip::C::mip_packet_total_length ( const mip_packet * packet )