RDMnet  HEAD (unstable)
Implementation of ANSI E1.33 (RDMnet)
View other versions:
Controller::Settings Struct Reference

Overview

A set of configuration settings that a controller needs to initialize.

Note that network interfaces that the LLRP target of the controller should use are no longer specified here. Instead, the set of interfaces passed to rdmnet::Init() is used.

Public Member Functions

 Settings ()=default
 Create an empty, invalid data structure by default.
 
 Settings (const etcpal::Uuid &new_cid, const rdm::Uid &new_uid)
 Create a controller Settings instance by passing the required members explicitly. More...
 
 Settings (const etcpal::Uuid &new_cid, uint16_t manufacturer_id)
 Create a controller Settings instance by passing the required members explicitly. More...
 
bool IsValid () const
 Determine whether a controller Settings instance contains valid data for RDMnet operation.
 

Data Fields

etcpal::Uuid cid
 The controller's Component Identifier (CID).
 
rdm::Uid uid
 The controller's RDM UID. For a dynamic UID, use rdm::Uid::DynamicUidRequest().
 
std::string search_domain
 (optional) The controller's search domain for discovering brokers.
 
bool create_llrp_target {false}
 (optional) Whether to create an LLRP target associated with this controller.
 

Constructor & Destructor Documentation

◆ Settings() [1/2]

Settings ( const etcpal::Uuid new_cid,
const rdm::Uid &  new_uid 
)
inline

Create a controller Settings instance by passing the required members explicitly.

This version takes the fully-formed RDM UID that the controller will use.

◆ Settings() [2/2]

Settings ( const etcpal::Uuid new_cid,
uint16_t  manufacturer_id 
)
inline

Create a controller Settings instance by passing the required members explicitly.

This version just takes the controller's ESTA manufacturer ID and uses it to generate an RDMnet dynamic UID request.


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