Overview

Functions and definitions common to all RDMnet API modules.

Data Structures
struct	RdmnetSyncRdmResponse

struct	RdmnetSyncEptResponse

struct	RdmnetNetintConfig

Macros
#define	RDMNET_SYNC_SEND_RDM_ACK(response_ptr, response_data_len_in)
	Indicate that an RDM ACK should be sent when this callback returns. More...

#define	RDMNET_SYNC_SEND_RDM_NACK(response_ptr, nack_reason_in)
	Indicate that an RDM NACK should be sent when this callback returns. More...

#define	RDMNET_SYNC_DEFER_RDM_RESPONSE(response_ptr)
	Defer the RDM response to be sent later from another context. More...

#define	RDMNET_SYNC_RETRY_LATER(response_ptr)
	Trigger another notification for the (non-LLRP) RDM command on the next tick. More...

#define	RDMNET_SYNC_SEND_EPT_DATA(response_ptr, response_data_len_in)
	Indicate that an EPT data message should be sent when this callback returns. More...

#define	RDMNET_SYNC_SEND_EPT_STATUS(response_ptr, status_code_in)
	Indicate that an EPT status message should be sent when this callback returns. More...

#define	RDMNET_SYNC_DEFER_EPT_RESPONSE(response_ptr)
	Defer the response to the EPT message, either to be sent later or because no response is necessary. More...

#define	RDMNET_NETINT_CONFIG_DEFAULT_INIT
	A default-value initializer for an RdmnetNetintConfig struct. More...

Typedefs
typedef struct RdmnetSyncRdmResponse	RdmnetSyncRdmResponse

typedef struct RdmnetSyncEptResponse	RdmnetSyncEptResponse

typedef struct RdmnetNetintConfig	RdmnetNetintConfig

Enumerations
enum	rpt_status_code_t { kRptStatusUnknownRptUid = VECTOR_RPT_STATUS_UNKNOWN_RPT_UID , kRptStatusRdmTimeout = VECTOR_RPT_STATUS_RDM_TIMEOUT , kRptStatusInvalidRdmResponse = VECTOR_RPT_STATUS_RDM_INVALID_RESPONSE , kRptStatusUnknownRdmUid = VECTOR_RPT_STATUS_UNKNOWN_RDM_UID , kRptStatusUnknownEndpoint = VECTOR_RPT_STATUS_UNKNOWN_ENDPOINT , kRptStatusBroadcastComplete = VECTOR_RPT_STATUS_BROADCAST_COMPLETE , kRptStatusUnknownVector = VECTOR_RPT_STATUS_UNKNOWN_VECTOR , kRptStatusInvalidMessage = VECTOR_RPT_STATUS_INVALID_MESSAGE , kRptStatusInvalidCommandClass = VECTOR_RPT_STATUS_INVALID_COMMAND_CLASS }

enum	ept_status_code_t { kEptStatusUnknownCid = VECTOR_EPT_STATUS_UNKNOWN_CID , kEptStatusUnknownVector = VECTOR_EPT_STATUS_UNKNOWN_VECTOR }

enum	rdmnet_disconnect_reason_t { kRdmnetDisconnectShutdown = E133_DISCONNECT_SHUTDOWN , kRdmnetDisconnectCapacityExhausted = E133_DISCONNECT_CAPACITY_EXHAUSTED , kRdmnetDisconnectHardwareFault = E133_DISCONNECT_HARDWARE_FAULT , kRdmnetDisconnectSoftwareFault = E133_DISCONNECT_SOFTWARE_FAULT , kRdmnetDisconnectSoftwareReset = E133_DISCONNECT_SOFTWARE_RESET , kRdmnetDisconnectIncorrectScope = E133_DISCONNECT_INCORRECT_SCOPE , kRdmnetDisconnectRptReconfigure = E133_DISCONNECT_RPT_RECONFIGURE , kRdmnetDisconnectLlrpReconfigure = E133_DISCONNECT_LLRP_RECONFIGURE , kRdmnetDisconnectUserReconfigure = E133_DISCONNECT_USER_RECONFIGURE }

enum	rdmnet_connect_status_t { kRdmnetConnectOk = E133_CONNECT_OK , kRdmnetConnectScopeMismatch = E133_CONNECT_SCOPE_MISMATCH , kRdmnetConnectCapacityExceeded = E133_CONNECT_CAPACITY_EXCEEDED , kRdmnetConnectDuplicateUid = E133_CONNECT_DUPLICATE_UID , kRdmnetConnectInvalidClientEntry = E133_CONNECT_INVALID_CLIENT_ENTRY , kRdmnetConnectInvalidUid = E133_CONNECT_INVALID_UID }

enum	rdmnet_dynamic_uid_status_t { kRdmnetDynamicUidStatusOk = E133_DYNAMIC_UID_STATUS_OK , kRdmnetDynamicUidStatusInvalidRequest = E133_DYNAMIC_UID_STATUS_INVALID_REQUEST , kRdmnetDynamicUidStatusUidNotFound = E133_DYNAMIC_UID_STATUS_UID_NOT_FOUND , kRdmnetDynamicUidStatusDuplicateRid = E133_DYNAMIC_UID_STATUS_DUPLICATE_RID , kRdmnetDynamicUidStatusCapacityExhausted = E133_DYNAMIC_UID_STATUS_CAPACITY_EXHAUSTED }

enum	rdmnet_connect_fail_event_t { kRdmnetConnectFailSocketFailure , kRdmnetConnectFailTcpLevel , kRdmnetConnectFailNoReply , kRdmnetConnectFailRejected }

enum	rdmnet_disconnect_event_t { kRdmnetDisconnectAbruptClose , kRdmnetDisconnectNoHeartbeat , kRdmnetDisconnectRedirected , kRdmnetDisconnectGracefulRemoteInitiated , kRdmnetDisconnectGracefulLocalInitiated }

enum	rdmnet_rdm_response_action_t { kRdmnetRdmResponseActionSendAck , kRdmnetRdmResponseActionSendNack , kRdmnetRdmResponseActionDefer , kRdmnetRdmResponseActionRetryLater }

enum	rdmnet_ept_response_action_t { kRdmnetEptResponseActionSendData , kRdmnetEptResponseActionSendStatus , kRdmnetEptResponseActionDefer }

enum	rdmnet_command_class_t { kRdmnetCCGetCommand = 0x20 , kRdmnetCCSetCommand = 0x30 }
	An RDM command class, for RDMnet purposes. More...

Functions
etcpal_error_t	rdmnet_init (const EtcPalLogParams log_params, const RdmnetNetintConfig netint_config)
	Initialize the RDMnet library. More...

void	rdmnet_deinit (void)
	Deinitialize the RDMnet library. More...

const char *	rdmnet_rpt_status_code_to_string (rpt_status_code_t code)
	Get a string representation of an RPT status code.

const char *	rdmnet_ept_status_code_to_string (ept_status_code_t code)
	Get a string representation of an EPT status code.

const char *	rdmnet_connect_fail_event_to_string (rdmnet_connect_fail_event_t event)
	Get a string description of an RDMnet connection failure event. More...

const char *	rdmnet_disconnect_event_to_string (rdmnet_disconnect_event_t event)
	Get a string description of an RDMnet disconnect event. More...

const char *	rdmnet_connect_status_to_string (rdmnet_connect_status_t code)
	Get a string description of an RDMnet connect status code. More...

const char *	rdmnet_disconnect_reason_to_string (rdmnet_disconnect_reason_t code)
	Get a string description of an RDMnet disconnect reason code. More...

const char *	rdmnet_dynamic_uid_status_to_string (rdmnet_dynamic_uid_status_t code)
	Get a string description of an RDMnet Dynamic UID status code. More...

Overview

Data Structures

Macros

Typedefs

Enumerations

Functions