rdmnet::DestinationAddr Class Reference

Overview

A destination address for an RDM command in RDMnet's RPT protocol.

See Roles and Addressing and Devices and Gateways for more information.

#include <rdmnet/cpp/client.h>

Public Member Functions
constexpr const RdmnetDestinationAddr &	get () const noexcept
	Get a const reference to the underlying C type. More...

Static Public Member Functions
static constexpr DestinationAddr	ToDefaultResponder (const rdm::Uid &rdmnet_uid, uint16_t subdevice=0)
	Get a DestinationAddr representing a message addressed to a component's default responder. More...
static constexpr DestinationAddr	ToDefaultResponder (uint16_t manufacturer_id, uint32_t device_id, uint16_t subdevice=0)
	Get a DestinationAddr representing a message addressed to a component's default responder. More...
static constexpr DestinationAddr	ToSubResponder (const rdm::Uid &rdmnet_uid, uint16_t endpoint, const rdm::Uid &rdm_uid, uint16_t subdevice=0)
	Get a DestinationAddr representing a message addressed to a sub-responder on a component. More...

Member Function Documentation

get()

constexpr const RdmnetDestinationAddr & rdmnet::DestinationAddr::get ( ) const

constexprnoexcept

Get a const reference to the underlying C type.

This function should normally only be used by the library implementation.

ToDefaultResponder() [1/2]

constexpr DestinationAddr rdmnet::DestinationAddr::ToDefaultResponder ( const rdm::Uid &  rdmnet_uid, uint16_t  subdevice = 0  )

staticconstexpr

Get a DestinationAddr representing a message addressed to a component's default responder.

Parameters

rdmnet_uid	The UID of the RDMnet component to which the command is addressed.
subdevice	(optional) The subdevice to which the command is addressed (0 for the root device by default).

ToDefaultResponder() [2/2]

constexpr DestinationAddr rdmnet::DestinationAddr::ToDefaultResponder ( uint16_t  manufacturer_id, uint32_t  device_id, uint16_t  subdevice = 0  )

staticconstexpr

Get a DestinationAddr representing a message addressed to a component's default responder.

Parameters

manufacturer_id	The manufacturer ID portion of the destination RDMnet component's UID.
device_id	The device ID portion of the destination RDMnet component's UID.
subdevice	(optional) The subdevice to which the command is addressed (0 for the root device by default).

ToSubResponder()

constexpr DestinationAddr rdmnet::DestinationAddr::ToSubResponder ( const rdm::Uid &  rdmnet_uid, uint16_t  endpoint, const rdm::Uid &  rdm_uid, uint16_t  subdevice = 0  )

staticconstexpr

Get a DestinationAddr representing a message addressed to a sub-responder on a component.

Sub-responders can be physical or virtual but are always addressed by UID; see Devices and Gateways for more information.

Parameters

rdmnet_uid	The UID of the RDMnet component which contains the sub-responder to which the command is addressed.
endpoint	The endpoint the sub-responder is associated with.
rdm_uid	The sub-responders's UID.
subdevice	(optional) The subdevice to which the command is addressed (0 for the root device by default).

---

The documentation for this class was generated from the following file:

• include/rdmnet/cpp/client.h