rdmnet Namespace Reference

Overview

A namespace which contains all C++ language definitions in the RDMnet library.

Namespaces
	llrp
	A namespace which contains all LLRP C++ language definitions.

Data Structures
struct	DnsTxtRecordItem
	A key/value pair representing a DNS TXT record item. More...
class	Broker
	Defines an instance of RDMnet broker functionality. More...
class	SourceAddr
	The source address for an unsolicited RDM response generated by a local component. More...
class	DestinationAddr
	A destination address for an RDM command in RDMnet's RPT protocol. More...
class	ClientConnectedInfo
	Information about a successful connection to a broker delivered to an RDMnet callback function. More...
class	ClientConnectFailedInfo
	Information about a failed connection to a broker delivered to an RDMnet callback function. More...
class	ClientDisconnectedInfo
	Information about a disconnect event from a broker delivered to an RDMnet callback function. More...
class	Scope
	An RDMnet scope configuration. More...
class	RdmResponseAction
	A class representing a synchronous action to take in response to a received RDM command. More...
class	EptResponseAction
	A class representing a synchronous action to take in response to a received EPT data message. More...
class	Controller
	An instance of RDMnet controller functionality. More...
class	VirtualEndpointConfig
	Configuration information for a virtual endpoint on a device. More...
class	PhysicalEndpointResponder
	Identifying information for a physical RDM responder connected to an RDMnet gateway. More...
class	PhysicalEndpointConfig
	Configuration information for a physical endpoint on a device. More...
class	Device
	An instance of RDMnet device functionality. More...
class	EptClient
	An instance of RDMnet EPT client functionality. More...
struct	DynamicUidMapping
	A mapping from a dynamic UID to a responder ID (RID). More...
class	DynamicUidAssignmentList
	A list of mappings from dynamic UIDs to responder IDs received from an RDMnet broker. More...
struct	EptSubProtocol
	A description of an EPT sub-protocol. More...
struct	EptClientEntry
	A descriptive structure for an EPT client. More...
class	EptClientList
	A list of EPT client entries. More...
class	EptData
	An EPT data message received over RDMnet and delivered to an RDMnet callback function. More...
class	SavedEptData
	An EPT data message received over RDMnet and saved for later processing. More...
class	EptStatus
	An EPT status message received over RDMnet and delivered to an RDMnet callback function. More...
class	SavedEptStatus
	An EPT status message received over RDMnet and saved for later processing. More...
class	RdmCommand
	An RDM command received over RDMnet and delivered to an RDMnet callback function. More...
class	SavedRdmCommand
	An RDM command received over RDMnet by a local component and saved for a later response. More...
class	RdmResponse
	An RDM response received over RDMnet and delivered to an RDMnet callback function. More...
class	SavedRdmResponse
	An RDM response received over RDMnet and saved for later processing. More...
struct	RptClientEntry
	A descriptive structure for an RPT client. More...
class	RptClientList
	A list of RPT client entries. More...
class	RptStatus
	An RPT status message received over RDMnet and delivered to an RDMnet callback function. More...
class	SavedRptStatus
	An RPT status message received over RDMnet and saved for later processing. More...

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

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

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