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.

Data Fields
RdmUid	rdmnet_source_uid

uint16_t	source_endpoint

uint32_t	seq_num

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

uint8_t	original_cmd_data [RDM_MAX_PDL]

uint8_t	original_cmd_data_len

RdmResponseHeader	rdm_header

uint8_t *	rdm_data

size_t	rdm_data_len

Field Documentation

◆ is_response_to_me

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

◆ original_cmd_data

uint8_t original_cmd_data[RDM_MAX_PDL]

Any parameter data associated with the original RDM command; valid if seq_num != 0.

◆ original_cmd_data_len

uint8_t original_cmd_data_len

The length of the parameter data associated with the original RDM command; valid if seq_num != 0.

◆ original_cmd_header

RdmCommandHeader original_cmd_header

The header of the original command associated with this response; valid if seq_num != 0.

◆ rdm_data

uint8_t* 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().

◆ rdm_data_len

size_t rdm_data_len

The length of the parameter data associated with the RDM response.

◆ rdm_header

RdmResponseHeader rdm_header

The header information from the encapsulated RDM response.

◆ rdmnet_source_uid

RdmUid rdmnet_source_uid

The UID of the RDMnet component that sent this response.

◆ seq_num

uint32_t seq_num

The sequence number of the response, for matching with a corresponding command.

◆ source_endpoint

uint16_t source_endpoint

The endpoint from which the response was sent.

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

include/rdmnet/message.h