message.h File Reference

Overview

Basic types for parsed RDMnet messages.

Go to the source code of this file.

Data Structures
struct	RdmnetRdmCommand
struct	RdmnetSavedRdmCommand
struct	RdmnetRdmResponse
struct	RdmnetSavedRdmResponse
	An RDM response received over RDMnet and saved for later processing. More...
struct	RdmnetRptStatus
struct	RdmnetSavedRptStatus
	An RPT status received over RDMnet and saved for later processing. More...
struct	RdmnetDynamicUidMapping
struct	RdmnetDynamicUidAssignmentList
struct	RdmnetEptData
struct	RdmnetSavedEptData
	An EPT data message received over RDMnet and saved for later processing. More...
struct	RdmnetEptStatus
struct	RdmnetSavedEptStatus
	An EPT status received over RDMnet and saved for later processing. More...
struct	RdmnetRptClientEntry
struct	RdmnetEptSubProtocol
	A description of an EPT sub-protocol. More...
struct	RdmnetEptClientEntry
struct	RdmnetRptClientList
struct	RdmnetEptClientList
struct	LlrpRdmCommand
struct	LlrpSavedRdmCommand
struct	LlrpRdmResponse
struct	LlrpSavedRdmResponse

Typedefs
Other RPT messages
typedef struct RdmnetRptStatus	RdmnetRptStatus
typedef struct RdmnetSavedRptStatus	RdmnetSavedRptStatus
	An RPT status received over RDMnet and saved for later processing. More...
typedef struct RdmnetDynamicUidMapping	RdmnetDynamicUidMapping
typedef struct RdmnetDynamicUidAssignmentList	RdmnetDynamicUidAssignmentList
EPT messages
typedef struct RdmnetEptData	RdmnetEptData
typedef struct RdmnetSavedEptData	RdmnetSavedEptData
	An EPT data message received over RDMnet and saved for later processing. More...
typedef struct RdmnetEptStatus	RdmnetEptStatus
typedef struct RdmnetSavedEptStatus	RdmnetSavedEptStatus
	An EPT status received over RDMnet and saved for later processing. More...
LLRP messages
typedef struct LlrpRdmCommand	LlrpRdmCommand
typedef struct LlrpSavedRdmCommand	LlrpSavedRdmCommand
typedef struct LlrpRdmResponse	LlrpRdmResponse
typedef struct LlrpSavedRdmResponse	LlrpSavedRdmResponse

Functions
const char *	rdmnet_rpt_client_type_to_string (rpt_client_type_t client_type)
	Get a string description of an RPT client type. More...
etcpal_error_t	rdmnet_save_rdm_command (const RdmnetRdmCommand *command, RdmnetSavedRdmCommand *saved_command)
	Save the data in a received RDM command for later use with API functions from a different context. More...
etcpal_error_t	rdmnet_save_rdm_response (const RdmnetRdmResponse *response, RdmnetSavedRdmResponse *saved_response)
	Save the data in a received RDM response for later use from a different context. More...
etcpal_error_t	rdmnet_append_to_saved_rdm_response (const RdmnetRdmResponse *new_response, RdmnetSavedRdmResponse *previously_saved_response)
	Append more data to a SavedRdmResponse's parameter data. More...
etcpal_error_t	rdmnet_save_rpt_status (const RdmnetRptStatus *status, RdmnetSavedRptStatus *saved_status)
	Save the data in a received RPT status message for later use from a different context. More...
etcpal_error_t	rdmnet_copy_saved_rdm_response (const RdmnetSavedRdmResponse *saved_resp_old, RdmnetSavedRdmResponse *saved_resp_new)
	Copy the data from a saved RDM response to a different saved RDM response. More...
etcpal_error_t	rdmnet_copy_saved_rpt_status (const RdmnetSavedRptStatus *saved_status_old, RdmnetSavedRptStatus *saved_status_new)
	Copy the data from a saved RPT status message to a different saved RPT status message. More...
etcpal_error_t	rdmnet_free_saved_rdm_response (RdmnetSavedRdmResponse *saved_response)
	Free the memory owned by a saved RDM response. More...
etcpal_error_t	rdmnet_free_saved_rpt_status (RdmnetSavedRptStatus *saved_status)
	Free the memory owned by a saved RPT status message. More...
etcpal_error_t	rdmnet_save_ept_data (const RdmnetEptData *data, RdmnetSavedEptData *saved_data)
	Save the data in a received EPT data message for later use from a different context. More...
etcpal_error_t	rdmnet_save_ept_status (const RdmnetEptStatus *status, RdmnetSavedEptStatus *saved_status)
	Save the data in a received EPT status message for later use from a different context. More...
etcpal_error_t	rdmnet_copy_saved_ept_data (const RdmnetSavedEptData *saved_data_old, RdmnetSavedEptData *saved_data_new)
	Copy the data from a saved EPT data message to a different saved EPT data message. More...
etcpal_error_t	rdmnet_copy_saved_ept_status (const RdmnetSavedEptStatus *saved_status_old, RdmnetSavedEptStatus *saved_status_new)
	Copy the data from a saved EPT status message to a different saved EPT status message. More...
etcpal_error_t	rdmnet_free_saved_ept_data (RdmnetSavedEptData *saved_data)
	Free the memory owned by a saved EPT data message. More...
etcpal_error_t	rdmnet_free_saved_ept_status (RdmnetSavedEptStatus *saved_status)
	Free the memory owned by a saved EPT status message. More...
etcpal_error_t	rdmnet_save_llrp_rdm_command (const LlrpRdmCommand *command, LlrpSavedRdmCommand *saved_command)
	Save the data in a received LLRP RDM command for later use with API functions from a different context. More...
etcpal_error_t	rdmnet_save_llrp_rdm_response (const LlrpRdmResponse *response, LlrpSavedRdmResponse *saved_response)
	Save the data in a received LLRP RDM response for later use from a different context. More...
etcpal_error_t	rdmnet_copy_saved_llrp_rdm_response (const LlrpSavedRdmResponse *saved_resp_old, LlrpSavedRdmResponse *saved_resp_new)
	Copy the data from a saved LLRP RDM response to a different saved LLRP RDM response. More...

RDM commands and responses
#define	RDMNET_COMMAND_IS_TO_DEFAULT_RESPONDER(cmd_ptr)   ((cmd_ptr) && ((cmd_ptr)->dest_endpoint == E133_NULL_ENDPOINT))
#define	RDMNET_RESP_ORIGINAL_COMMAND_INCLUDED(resp)   ((resp) && ((resp)->seq_num == 0))
	Whether the original command is included in an RdmnetRdmResponse or RdmnetSavedRdmResponse. More...
typedef struct RdmnetRdmCommand	RdmnetRdmCommand
typedef struct RdmnetSavedRdmCommand	RdmnetSavedRdmCommand
typedef struct RdmnetRdmResponse	RdmnetRdmResponse
typedef struct RdmnetSavedRdmResponse	RdmnetSavedRdmResponse
	An RDM response received over RDMnet and saved for later processing. More...

Client list messages
#define	EPT_PROTOCOL_STRING_PADDED_LENGTH   32
enum	rpt_client_type_t { kRPTClientTypeDevice = E133_RPT_CLIENT_TYPE_DEVICE , kRPTClientTypeController = E133_RPT_CLIENT_TYPE_CONTROLLER , kRPTClientTypeUnknown = 0xffffffff }
typedef struct RdmnetRptClientEntry	RdmnetRptClientEntry
typedef struct RdmnetEptSubProtocol	RdmnetEptSubProtocol
	A description of an EPT sub-protocol. More...
typedef struct RdmnetEptClientEntry	RdmnetEptClientEntry
typedef struct RdmnetRptClientList	RdmnetRptClientList
typedef struct RdmnetEptClientList	RdmnetEptClientList