RDMnet  0.3.0
Implementation of ANSI E1.33 (RDMnet)
View other versions:
RdmnetControllerConfig Struct Reference

Overview

A set of information that defines the startup parameters of an RDMnet Controller.

#include <rdmnet/controller.h>

Data Fields

EtcPalUuid cid
 The controller's CID.
 
RdmnetControllerCallbacks callbacks
 A set of callbacks for the controller to receive RDMnet notifications.
 
RdmnetControllerRdmCmdHandler rdm_handler
 Callbacks and a buffer for the controller to receive RDM commands over RDMnet. More...
 
RdmnetControllerRdmData rdm_data
 Data for the library to use for handling RDM commands internally. More...
 
RdmUid uid
 (optional) The controller's UID. More...
 
const char * search_domain
 (optional) The controller's configured search domain for discovery. More...
 
bool create_llrp_target
 (optional) Whether to create an LLRP target associated with this controller. More...
 
const RdmnetMcastNetintIdllrp_netints
 (optional) A set of network interfaces to use for the LLRP target associated with this controller. More...
 
size_t num_llrp_netints
 (optional) The size of the llrp_netints array.
 

Field Documentation

◆ create_llrp_target

bool RdmnetControllerConfig::create_llrp_target

(optional) Whether to create an LLRP target associated with this controller.

Default is false.

◆ llrp_netints

const RdmnetMcastNetintId* RdmnetControllerConfig::llrp_netints

(optional) A set of network interfaces to use for the LLRP target associated with this controller.

If NULL, the set passed to rdmnet_init() will be used, or all network interfaces on the system if that was not provided.

◆ rdm_data

RdmnetControllerRdmData RdmnetControllerConfig::rdm_data

Data for the library to use for handling RDM commands internally.

Either this or rdm_handler must be provided; see Using the Controller API for more information.

◆ rdm_handler

RdmnetControllerRdmCmdHandler RdmnetControllerConfig::rdm_handler

Callbacks and a buffer for the controller to receive RDM commands over RDMnet.

Either this or rdm_data must be provided; see Using the Controller API for more information.

◆ search_domain

const char* RdmnetControllerConfig::search_domain

(optional) The controller's configured search domain for discovery.

NULL to use the default search domain(s).

◆ uid

RdmUid RdmnetControllerConfig::uid

(optional) The controller's UID.

This will be initialized with a Dynamic UID request using the initialization functions/macros for this structure. If you want to use a static UID instead, just fill this in with the static UID after initializing.


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