RdmnetSavedRdmResponse Struct Reference

Overview

An RDM response received over RDMnet and saved for later processing.

This type is not used by the library API, but can come in handy if an application wants to queue or copy RDM responses before acting on them. The rdm_data member is heap-allocated and owned; be sure to call rdmnet_free_saved_rdm_response() to free this data before disposing of an instance.

#include <rdmnet/message.h>

Data Fields
RdmUid	rdmnet_source_uid
	The UID of the RDMnet component that sent this response.
uint16_t	source_endpoint
	The endpoint from which the response was sent.
uint32_t	seq_num
	The sequence number of the response, for matching with a corresponding command.
bool	is_response_to_me
	Whether the response was sent in response to a command previously sent by this controller. More...
RdmCommandHeader	original_cmd_header
	The header of the original command associated with this response; valid if seq_num != 0.
uint8_t	original_cmd_data [RDM_MAX_PDL]
	Any parameter data associated with the original RDM command; valid if seq_num != 0.
uint8_t	original_cmd_data_len
	The length of the parameter data associated with the original RDM command; valid if seq_num != 0.
RdmResponseHeader	rdm_header
	The header information from the encapsulated RDM response.
uint8_t *	rdm_data
	Any parameter data associated with the RDM response. More...
size_t	rdm_data_len
	The length of the parameter data associated with the RDM response.

Field Documentation

is_response_to_me

bool RdmnetSavedRdmResponse::is_response_to_me

Whether the response was sent in response to a command previously sent by this controller.

If this is false, the command was a broadcast sent to all controllers.

rdm_data

uint8_t* RdmnetSavedRdmResponse::rdm_data

Any parameter data associated with the RDM response.

This pointer is owned and must be freed before this type goes out of scope using rdmnet_free_saved_rdm_response().

---

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

• include/rdmnet/message.h