RdmnetRdmResponse Struct Reference

Overview

An RDMnet RDM response received by a local component.

#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.
const uint8_t *	original_cmd_data
	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.
const uint8_t *	rdm_data
	Any parameter data associated with the RDM response.
size_t	rdm_data_len
	The length of the parameter data associated with the RDM response.
bool	more_coming
	This message contains partial RDM data. More...

Field Documentation

is_response_to_me

bool RdmnetRdmResponse::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.

more_coming

bool RdmnetRdmResponse::more_coming

This message contains partial RDM data.

This can be set when the library runs out of static memory in which to store RDM response data and must deliver a partial data buffer before continuing (this only applies to the data buffer within the RDM response). The application should store the partial data but should not act on it until another RdmnetRdmResponse is received with more_coming set to false.

---

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

• include/rdmnet/message.h