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

Overview

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

#include <rdmnet/device.h>

Data Fields

EtcPalUuid cid
 The device's CID.
 
RdmnetDeviceCallbacks callbacks
 A set of callbacks for the device to receive RDMnet notifications.
 
uint8_t * response_buf
 (optional) A data buffer to be used to respond synchronously to RDM commands. More...
 
RdmnetScopeConfig scope_config
 (optional) The device's configured RDMnet scope. More...
 
RdmUid uid
 (optional) The device's UID. More...
 
const char * search_domain
 (optional) The device's configured search domain for discovery. More...
 
const RdmnetPhysicalEndpointConfigphysical_endpoints
 An array of initial physical endpoints that the device uses.
 
size_t num_physical_endpoints
 Size of the physical_endpoints array.
 
const RdmnetVirtualEndpointConfigvirtual_endpoints
 An array of initial virtual endpoints that the device uses.
 
size_t num_virtual_endpoints
 Size of the virtual_endpoints array.
 
const RdmnetMcastNetintIdllrp_netints
 (optional) A set of network interfaces to use for the LLRP target associated with this device. More...
 
size_t num_llrp_netints
 (optional) The size of the llrp_netints array.
 

Field Documentation

◆ llrp_netints

const RdmnetMcastNetintId* RdmnetDeviceConfig::llrp_netints

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

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

◆ response_buf

uint8_t* RdmnetDeviceConfig::response_buf

(optional) A data buffer to be used to respond synchronously to RDM commands.

See Handling RDM Commands for more information.

◆ scope_config

RdmnetScopeConfig RdmnetDeviceConfig::scope_config

(optional) The device's configured RDMnet scope.

Will be initialized to the RDMnet default scope using the initialization functions/macros for this structure.

◆ search_domain

const char* RdmnetDeviceConfig::search_domain

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

NULL to use the default search domain(s).

◆ uid

RdmUid RdmnetDeviceConfig::uid

(optional) The device's UID.

This will be intialized with a Dynamic UID request value using the initialization functions/macros for this structure. If you want 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: