Common Definitions

Overview

Definitions shared by other APIs in this module.

Data Structures
class	rdmnet::SourceAddr
	The source address for an unsolicited RDM response generated by a local component. More...
class	rdmnet::DestinationAddr
	A destination address for an RDM command in RDMnet's RPT protocol. More...
class	rdmnet::ClientConnectedInfo
	Information about a successful connection to a broker delivered to an RDMnet callback function. More...
class	rdmnet::ClientConnectFailedInfo
	Information about a failed connection to a broker delivered to an RDMnet callback function. More...
class	rdmnet::ClientDisconnectedInfo
	Information about a disconnect event from a broker delivered to an RDMnet callback function. More...
class	rdmnet::Scope
	An RDMnet scope configuration. More...
class	rdmnet::RdmResponseAction
	A class representing a synchronous action to take in response to a received RDM command. More...
class	rdmnet::EptResponseAction
	A class representing a synchronous action to take in response to a received EPT data message. More...
struct	rdmnet::DynamicUidMapping
	A mapping from a dynamic UID to a responder ID (RID). More...
class	rdmnet::DynamicUidAssignmentList
	A list of mappings from dynamic UIDs to responder IDs received from an RDMnet broker. More...
struct	rdmnet::EptSubProtocol
	A description of an EPT sub-protocol. More...
struct	rdmnet::EptClientEntry
	A descriptive structure for an EPT client. More...
class	rdmnet::EptClientList
	A list of EPT client entries. More...
class	rdmnet::EptData
	An EPT data message received over RDMnet and delivered to an RDMnet callback function. More...
class	rdmnet::SavedEptData
	An EPT data message received over RDMnet and saved for later processing. More...
class	rdmnet::EptStatus
	An EPT status message received over RDMnet and delivered to an RDMnet callback function. More...
class	rdmnet::SavedEptStatus
	An EPT status message received over RDMnet and saved for later processing. More...
class	rdmnet::llrp::RdmCommand
	An RDM command received over LLRP and delivered to an RDMnet callback function. More...
class	rdmnet::llrp::SavedRdmCommand
	An RDM command received over LLRP by a local component and saved for a later response. More...
class	rdmnet::llrp::RdmResponse
	An RDM response received over LLRP and delivered to an RDMnet callback function. More...
class	rdmnet::llrp::SavedRdmResponse
	An RDM response received over LLRP and saved for later processing. More...
class	rdmnet::RdmCommand
	An RDM command received over RDMnet and delivered to an RDMnet callback function. More...
class	rdmnet::SavedRdmCommand
	An RDM command received over RDMnet by a local component and saved for a later response. More...
class	rdmnet::RdmResponse
	An RDM response received over RDMnet and delivered to an RDMnet callback function. More...
class	rdmnet::SavedRdmResponse
	An RDM response received over RDMnet and saved for later processing. More...
struct	rdmnet::RptClientEntry
	A descriptive structure for an RPT client. More...
class	rdmnet::RptClientList
	A list of RPT client entries. More...
class	rdmnet::RptStatus
	An RPT status message received over RDMnet and delivered to an RDMnet callback function. More...
class	rdmnet::SavedRptStatus
	An RPT status message received over RDMnet and saved for later processing. More...

Typedefs
using	rdmnet::ScopeHandle = rdmnet_client_scope_t
	A handle to a scope that an RDMnet client participates in. More...

Functions
etcpal::Error	rdmnet::Init (const EtcPalLogParams *log_params=nullptr, const std::vector< RdmnetMcastNetintId > &mcast_netints=std::vector< RdmnetMcastNetintId >{})
	Initialize the RDMnet library. More...
etcpal::Error	rdmnet::Init (const etcpal::Logger &logger, const std::vector< RdmnetMcastNetintId > &mcast_netints=std::vector< RdmnetMcastNetintId >{})
	Initialize the RDMnet library. More...
void	rdmnet::Deinit ()
	Deinitialize the RDMnet library. More...

Variables
constexpr uint16_t	rdmnet::kNullEndpoint = E133_NULL_ENDPOINT
	Identifies the NULL_ENDPOINT, the endpoint of the RDMnet default responder.

Typedef Documentation

ScopeHandle

using rdmnet::ScopeHandle = typedef rdmnet_client_scope_t

A handle to a scope that an RDMnet client participates in.

Function Documentation

Deinit()

void rdmnet::Deinit ( )

inline

Deinitialize the RDMnet library.

Closes all connections, deallocates all resources and joins the background thread. No RDMnet API functions are usable after this function is called.

Init() [1/2]

etcpal::Error rdmnet::Init ( const etcpal::Logger &  logger, const std::vector< RdmnetMcastNetintId > &  mcast_netints = std::vector<RdmnetMcastNetintId>{}  )

inline

Initialize the RDMnet library.

Wraps rdmnet_init(). Does all initialization required before the RDMnet API modules can be used. Starts the message dispatch thread.

Parameters

logger	Logger instance for the RDMnet library to use to log messages.
mcast_netints	(optional) A set of network interfaces to which to restrict multicast operation.

Returns

etcpal::Error::Ok(): Initialization successful.

Errors from rdmnet_init().

Init() [2/2]

etcpal::Error rdmnet::Init ( const EtcPalLogParams *  log_params = nullptr, const std::vector< RdmnetMcastNetintId > &  mcast_netints = std::vector<RdmnetMcastNetintId>{}  )

inline

Initialize the RDMnet library.

Wraps rdmnet_init(). Does all initialization required before the RDMnet API modules can be used. Starts the message dispatch thread.

Parameters

log_params	(optional) Log parameters for the RDMnet library to use to log messages. If not provided, no logging will be performed.
mcast_netints	(optional) A set of network interfaces to which to restrict multicast operation.

Returns

etcpal::Error::Ok(): Initialization successful.

Errors from rdmnet_init().