message.h File Reference

Overview

Basic types for parsed RDMnet messages.

#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
#include "etcpal/acn_rlp.h"
#include "etcpal/uuid.h"
#include "rdm/message.h"
#include "rdm/uid.h"
#include "rdmnet/common.h"

Go to the source code of this file.

Data Structures
struct	RdmnetRdmCommand
	An RDMnet RDM command received by this component. More...
struct	RdmnetSavedRdmCommand
	An RDM command received by this component and saved for a later response. More...
struct	RdmnetRdmResponse
	An RDMnet RDM response received by a local component. More...
struct	RdmnetSavedRdmResponse
	An RDM response received over RDMnet and saved for later processing. More...
struct	RdmnetRptStatus
	An RDMnet RPT status message received by a local component. More...
struct	RdmnetSavedRptStatus
	An RPT status received over RDMnet and saved for later processing. More...
struct	RdmnetDynamicUidMapping
	A mapping from a dynamic UID to a responder ID (RID). More...
struct	RdmnetDynamicUidAssignmentList
	A list of mappings from dynamic UIDs to responder IDs received from an RDMnet broker. More...
struct	RdmnetEptData
	An RDMnet EPT data message received by a local component. More...
struct	RdmnetSavedEptData
	An EPT data message received over RDMnet and saved for later processing. More...
struct	RdmnetEptStatus
	An RDMnet EPT status message received by a local component. More...
struct	RdmnetSavedEptStatus
	An EPT status received over RDMnet and saved for later processing. More...
struct	RdmnetRptClientEntry
	A descriptive structure for an RPT client. More...
struct	RdmnetEptSubProtocol
	A description of an EPT sub-protocol. More...
struct	RdmnetEptClientEntry
	A descriptive structure for an EPT client. More...
struct	RdmnetRptClientList
	A structure that represents a list of RPT Client Entries. More...
struct	RdmnetEptClientList
	A structure that represents a list of EPT Client Entries. More...
struct	LlrpRdmCommand
	An RDM command received from a remote LLRP Manager. More...
struct	LlrpSavedRdmCommand
	An RDM command received from a remote LLRP Manager. More...
struct	LlrpRdmResponse
	An RDM response received from a remote LLRP Target. More...
struct	LlrpSavedRdmResponse
	An RDM command received from a remote LLRP Manager. More...

Typedefs
Other RPT messages
typedef struct RdmnetRptStatus	RdmnetRptStatus
	An RDMnet RPT status message received by a local component.
typedef struct RdmnetSavedRptStatus	RdmnetSavedRptStatus
	An RPT status received over RDMnet and saved for later processing. More...
typedef struct RdmnetDynamicUidMapping	RdmnetDynamicUidMapping
	A mapping from a dynamic UID to a responder ID (RID).
typedef struct RdmnetDynamicUidAssignmentList	RdmnetDynamicUidAssignmentList
	A list of mappings from dynamic UIDs to responder IDs received from an RDMnet broker.
EPT messages
typedef struct RdmnetEptData	RdmnetEptData
	An RDMnet EPT data message received by a local component.
typedef struct RdmnetSavedEptData	RdmnetSavedEptData
	An EPT data message received over RDMnet and saved for later processing. More...
typedef struct RdmnetEptStatus	RdmnetEptStatus
	An RDMnet EPT status message received by a local component.
typedef struct RdmnetSavedEptStatus	RdmnetSavedEptStatus
	An EPT status received over RDMnet and saved for later processing. More...
LLRP messages
typedef struct LlrpRdmCommand	LlrpRdmCommand
	An RDM command received from a remote LLRP Manager.
typedef struct LlrpSavedRdmCommand	LlrpSavedRdmCommand
	An RDM command received from a remote LLRP Manager.
typedef struct LlrpRdmResponse	LlrpRdmResponse
	An RDM response received from a remote LLRP Target.
typedef struct LlrpSavedRdmResponse	LlrpSavedRdmResponse
	An RDM command received from a remote LLRP Manager.

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)->dest_endpoint == E133_NULL_ENDPOINT)
	Whether an RdmnetRdmCommand is addressed to the default responder.
#define	RDMNET_RESP_ORIGINAL_COMMAND_INCLUDED(resp)   ((resp)->seq_num == 0)
	Whether the original command is included in an RdmnetRdmResponse or RdmnetSavedRdmResponse. More...
typedef struct RdmnetRdmCommand	RdmnetRdmCommand
	An RDMnet RDM command received by this component.
typedef struct RdmnetSavedRdmCommand	RdmnetSavedRdmCommand
	An RDM command received by this component and saved for a later response.
typedef struct RdmnetRdmResponse	RdmnetRdmResponse
	An RDMnet RDM response received by a local component.
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
	The maximum length of an EPT sub-protocol string, including the null terminator.
enum	rpt_client_type_t {   kRPTClientTypeDevice = E133_RPT_CLIENT_TYPE_DEVICE ,   kRPTClientTypeController = E133_RPT_CLIENT_TYPE_CONTROLLER ,   kRPTClientTypeUnknown = 0xffffffff }
	An RPT client type. More...
typedef struct RdmnetRptClientEntry	RdmnetRptClientEntry
	A descriptive structure for an RPT client.
typedef struct RdmnetEptSubProtocol	RdmnetEptSubProtocol
	A description of an EPT sub-protocol. More...
typedef struct RdmnetEptClientEntry	RdmnetEptClientEntry
	A descriptive structure for an EPT client.
typedef struct RdmnetRptClientList	RdmnetRptClientList
	A structure that represents a list of RPT Client Entries.
typedef struct RdmnetEptClientList	RdmnetEptClientList
	A structure that represents a list of EPT Client Entries.