AzureIoTHubClientOptions Struct Reference

Options list for the hub client. More...

#include <azure_iot_hub_client.h>

Data Fields
const uint8_t *	pucModuleID
uint32_t	ulModuleIDLength
const uint8_t *	pucModelID
uint32_t	ulModelIDLength
AzureIoTHubClientComponent_t *	pxComponentList
uint32_t	ulComponentListLength
const uint8_t *	pucUserAgent
uint32_t	ulUserAgentLength
AzureIoTTelemetryAckCallback_t	xTelemetryCallback

Detailed Description

Options list for the hub client.

Field Documentation

pucModelID

const uint8_t* AzureIoTHubClientOptions::pucModelID

The Azure Digital Twin Definition Language model ID used to identify the capabilities of this device based on the Digital Twin document.

pucModuleID

const uint8_t* AzureIoTHubClientOptions::pucModuleID

The optional module ID to use for this device.

pucUserAgent

const uint8_t* AzureIoTHubClientOptions::pucUserAgent

The user agent to use for this device.

pxComponentList

AzureIoTHubClientComponent_t* AzureIoTHubClientOptions::pxComponentList

The list of component names to use for the device.

ulComponentListLength

uint32_t AzureIoTHubClientOptions::ulComponentListLength

The number of components in the list.

ulModelIDLength

uint32_t AzureIoTHubClientOptions::ulModelIDLength

The length of the model ID.

ulModuleIDLength

uint32_t AzureIoTHubClientOptions::ulModuleIDLength

The length of the module ID.

ulUserAgentLength

uint32_t AzureIoTHubClientOptions::ulUserAgentLength

The length of the user agent.

xTelemetryCallback

AzureIoTTelemetryAckCallback_t AzureIoTHubClientOptions::xTelemetryCallback

The callback to invoke to notify user a puback was received for QOS 1. Can be NULL if user does not want to be notified.

---

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

• azure_iot_hub_client.h