Azure IoT / iothub_client

Microsoft Azure IoTHub client libraries

Dependents:   sht15_remote_monitoring RobotArmDemo iothub_client_sample_amqp f767zi_mqtt ... more

This library implements the Microsoft Azure IoTHub client library. The code is replicated from https://github.com/Azure/azure-iot-sdks

iothub_client_ll.h@76:943524fee0b7, 2017-09-25 (annotated)

Committer:
AzureIoTClient
Date:
Mon Sep 25 13:37:53 2017 -0700
Revision:
76:943524fee0b7
Parent:
63:1bf1c2d60aab
Child:
80:db5f5237bc95
1.1.24

Who changed what in which revision?

UserRevisionLine numberNew contents of line
AzureIoTClient 16:deba40344375 1 // Copyright (c) Microsoft. All rights reserved.
AzureIoTClient 16:deba40344375 2 // Licensed under the MIT license. See LICENSE file in the project root for full license information.
AzureIoTClient 16:deba40344375 3
AzureIoTClient 16:deba40344375 4 /** @file iothub_client_ll.h
AzureIoTClient 16:deba40344375 5 * @brief APIs that allow a user (usually a device) to communicate
AzureIoTClient 16:deba40344375 6 * with an Azure IoTHub.
AzureIoTClient 16:deba40344375 7 *
AzureIoTClient 16:deba40344375 8 * @details IoTHubClient_LL is a module that allows a user (usually a
AzureIoTClient 16:deba40344375 9 * device) to communicate with an Azure IoTHub. It can send events
AzureIoTClient 16:deba40344375 10 * and receive messages. At any given moment in time there can only
AzureIoTClient 16:deba40344375 11 * be at most 1 message callback function.
AzureIoTClient 40:1a94db9139ea 12 *
AzureIoTClient 16:deba40344375 13 * This API surface contains a set of APIs that allows the user to
AzureIoTClient 16:deba40344375 14 * interact with the lower layer portion of the IoTHubClient. These APIs
AzureIoTClient 16:deba40344375 15 * contain @c _LL_ in their name, but retain the same functionality like the
AzureIoTClient 16:deba40344375 16 * @c IoTHubClient_... APIs, with one difference. If the @c _LL_ APIs are
AzureIoTClient 16:deba40344375 17 * used then the user is responsible for scheduling when the actual work done
AzureIoTClient 16:deba40344375 18 * by the IoTHubClient happens (when the data is sent/received on/from the wire).
AzureIoTClient 16:deba40344375 19 * This is useful for constrained devices where spinning a separate thread is
AzureIoTClient 16:deba40344375 20 * often not desired.
AzureIoTClient 16:deba40344375 21 */
AzureIoTClient 16:deba40344375 22
AzureIoTClient 16:deba40344375 23 #ifndef IOTHUB_CLIENT_LL_H
AzureIoTClient 16:deba40344375 24 #define IOTHUB_CLIENT_LL_H
AzureIoTClient 16:deba40344375 25
Azure.IoT Build 38:a05929a75111 26 #include "azure_c_shared_utility/macro_utils.h"
AzureIoTClient 53:1e5a1ca1f274 27 #include "azure_c_shared_utility/umock_c_prod.h"
AzureIoTClient 16:deba40344375 28
AzureIoTClient 16:deba40344375 29 #define IOTHUB_CLIENT_RESULT_VALUES \
AzureIoTClient 16:deba40344375 30 IOTHUB_CLIENT_OK, \
AzureIoTClient 16:deba40344375 31 IOTHUB_CLIENT_INVALID_ARG, \
AzureIoTClient 16:deba40344375 32 IOTHUB_CLIENT_ERROR, \
AzureIoTClient 16:deba40344375 33 IOTHUB_CLIENT_INVALID_SIZE, \
AzureIoTClient 53:1e5a1ca1f274 34 IOTHUB_CLIENT_INDEFINITE_TIME
AzureIoTClient 16:deba40344375 35
AzureIoTClient 43:038d8511e817 36 /** @brief Enumeration specifying the status of calls to various APIs in this module.
AzureIoTClient 43:038d8511e817 37 */
AzureIoTClient 43:038d8511e817 38
AzureIoTClient 43:038d8511e817 39 DEFINE_ENUM(IOTHUB_CLIENT_RESULT, IOTHUB_CLIENT_RESULT_VALUES);
AzureIoTClient 43:038d8511e817 40
AzureIoTClient 53:1e5a1ca1f274 41 #define IOTHUB_CLIENT_RETRY_POLICY_VALUES \
AzureIoTClient 53:1e5a1ca1f274 42 IOTHUB_CLIENT_RETRY_NONE, \
AzureIoTClient 53:1e5a1ca1f274 43 IOTHUB_CLIENT_RETRY_IMMEDIATE, \
AzureIoTClient 53:1e5a1ca1f274 44 IOTHUB_CLIENT_RETRY_INTERVAL, \
AzureIoTClient 53:1e5a1ca1f274 45 IOTHUB_CLIENT_RETRY_LINEAR_BACKOFF, \
AzureIoTClient 53:1e5a1ca1f274 46 IOTHUB_CLIENT_RETRY_EXPONENTIAL_BACKOFF, \
AzureIoTClient 53:1e5a1ca1f274 47 IOTHUB_CLIENT_RETRY_EXPONENTIAL_BACKOFF_WITH_JITTER, \
AzureIoTClient 53:1e5a1ca1f274 48 IOTHUB_CLIENT_RETRY_RANDOM
AzureIoTClient 53:1e5a1ca1f274 49
AzureIoTClient 53:1e5a1ca1f274 50 /** @brief Enumeration passed in by the IoT Hub when the event confirmation
AzureIoTClient 53:1e5a1ca1f274 51 * callback is invoked to indicate status of the event processing in
AzureIoTClient 53:1e5a1ca1f274 52 * the hub.
AzureIoTClient 53:1e5a1ca1f274 53 */
AzureIoTClient 53:1e5a1ca1f274 54 DEFINE_ENUM(IOTHUB_CLIENT_RETRY_POLICY, IOTHUB_CLIENT_RETRY_POLICY_VALUES);
AzureIoTClient 53:1e5a1ca1f274 55
AzureIoTClient 48:cc5d91f2b06d 56 struct IOTHUBTRANSPORT_CONFIG_TAG;
AzureIoTClient 43:038d8511e817 57 typedef struct IOTHUBTRANSPORT_CONFIG_TAG IOTHUBTRANSPORT_CONFIG;
AzureIoTClient 43:038d8511e817 58
AzureIoTClient 43:038d8511e817 59 typedef struct IOTHUB_CLIENT_LL_HANDLE_DATA_TAG* IOTHUB_CLIENT_LL_HANDLE;
AzureIoTClient 43:038d8511e817 60
AzureIoTClient 43:038d8511e817 61 #define IOTHUB_CLIENT_STATUS_VALUES \
AzureIoTClient 43:038d8511e817 62 IOTHUB_CLIENT_SEND_STATUS_IDLE, \
AzureIoTClient 53:1e5a1ca1f274 63 IOTHUB_CLIENT_SEND_STATUS_BUSY
AzureIoTClient 43:038d8511e817 64
AzureIoTClient 43:038d8511e817 65 /** @brief Enumeration returned by the ::IoTHubClient_LL_GetSendStatus
AzureIoTClient 43:038d8511e817 66 * API to indicate the current sending status of the IoT Hub client.
AzureIoTClient 43:038d8511e817 67 */
AzureIoTClient 43:038d8511e817 68 DEFINE_ENUM(IOTHUB_CLIENT_STATUS, IOTHUB_CLIENT_STATUS_VALUES);
AzureIoTClient 43:038d8511e817 69
AzureIoTClient 53:1e5a1ca1f274 70 #define IOTHUB_IDENTITY_TYPE_VALUE \
AzureIoTClient 53:1e5a1ca1f274 71 IOTHUB_TYPE_TELEMETRY, \
AzureIoTClient 53:1e5a1ca1f274 72 IOTHUB_TYPE_DEVICE_TWIN, \
AzureIoTClient 53:1e5a1ca1f274 73 IOTHUB_TYPE_DEVICE_METHODS
AzureIoTClient 53:1e5a1ca1f274 74 DEFINE_ENUM(IOTHUB_IDENTITY_TYPE, IOTHUB_IDENTITY_TYPE_VALUE);
AzureIoTClient 53:1e5a1ca1f274 75
AzureIoTClient 53:1e5a1ca1f274 76 #define IOTHUB_PROCESS_ITEM_RESULT_VALUE \
AzureIoTClient 53:1e5a1ca1f274 77 IOTHUB_PROCESS_OK, \
AzureIoTClient 53:1e5a1ca1f274 78 IOTHUB_PROCESS_ERROR, \
AzureIoTClient 53:1e5a1ca1f274 79 IOTHUB_PROCESS_NOT_CONNECTED, \
AzureIoTClient 53:1e5a1ca1f274 80 IOTHUB_PROCESS_CONTINUE
AzureIoTClient 53:1e5a1ca1f274 81 DEFINE_ENUM(IOTHUB_PROCESS_ITEM_RESULT, IOTHUB_PROCESS_ITEM_RESULT_VALUE);
AzureIoTClient 53:1e5a1ca1f274 82
AzureIoTClient 61:8b85a4e797cf 83 #define IOTHUBMESSAGE_DISPOSITION_RESULT_VALUES \
AzureIoTClient 61:8b85a4e797cf 84 IOTHUBMESSAGE_ACCEPTED, \
AzureIoTClient 61:8b85a4e797cf 85 IOTHUBMESSAGE_REJECTED, \
AzureIoTClient 61:8b85a4e797cf 86 IOTHUBMESSAGE_ABANDONED
AzureIoTClient 61:8b85a4e797cf 87
AzureIoTClient 61:8b85a4e797cf 88 /** @brief Enumeration returned by the callback which is invoked whenever the
AzureIoTClient 61:8b85a4e797cf 89 * IoT Hub sends a message to the device.
AzureIoTClient 61:8b85a4e797cf 90 */
AzureIoTClient 61:8b85a4e797cf 91 DEFINE_ENUM(IOTHUBMESSAGE_DISPOSITION_RESULT, IOTHUBMESSAGE_DISPOSITION_RESULT_VALUES);
AzureIoTClient 61:8b85a4e797cf 92
AzureIoTClient 43:038d8511e817 93 #include "azure_c_shared_utility/agenttime.h"
AzureIoTClient 43:038d8511e817 94 #include "azure_c_shared_utility/xio.h"
AzureIoTClient 43:038d8511e817 95 #include "azure_c_shared_utility/doublylinkedlist.h"
AzureIoTClient 43:038d8511e817 96 #include "iothub_message.h"
AzureIoTClient 43:038d8511e817 97 #include "iothub_transport_ll.h"
AzureIoTClient 63:1bf1c2d60aab 98 #include "iothub_client_authorization.h"
AzureIoTClient 53:1e5a1ca1f274 99 #include <stddef.h>
AzureIoTClient 53:1e5a1ca1f274 100 #include <stdint.h>
AzureIoTClient 53:1e5a1ca1f274 101
AzureIoTClient 53:1e5a1ca1f274 102 #define IOTHUB_CLIENT_IOTHUB_METHOD_STATUS_VALUES \
AzureIoTClient 53:1e5a1ca1f274 103 IOTHUB_CLIENT_IOTHUB_METHOD_STATUS_SUCCESS, \
AzureIoTClient 53:1e5a1ca1f274 104 IOTHUB_CLIENT_IOTHUB_METHOD_STATUS_ERROR \
AzureIoTClient 53:1e5a1ca1f274 105
AzureIoTClient 53:1e5a1ca1f274 106 /** @brief Enumeration returned by remotely executed functions
AzureIoTClient 53:1e5a1ca1f274 107 */
AzureIoTClient 53:1e5a1ca1f274 108 DEFINE_ENUM(IOTHUB_CLIENT_IOTHUB_METHOD_STATUS, IOTHUB_CLIENT_IOTHUB_METHOD_STATUS_VALUES);
AzureIoTClient 43:038d8511e817 109
AzureIoTClient 43:038d8511e817 110 #ifdef __cplusplus
AzureIoTClient 43:038d8511e817 111 extern "C"
AzureIoTClient 43:038d8511e817 112 {
AzureIoTClient 43:038d8511e817 113 #endif
AzureIoTClient 16:deba40344375 114
AzureIoTClient 16:deba40344375 115 #define IOTHUB_CLIENT_CONFIRMATION_RESULT_VALUES \
AzureIoTClient 16:deba40344375 116 IOTHUB_CLIENT_CONFIRMATION_OK, \
AzureIoTClient 16:deba40344375 117 IOTHUB_CLIENT_CONFIRMATION_BECAUSE_DESTROY, \
Azure.IoT Build 36:67300d5a4c1f 118 IOTHUB_CLIENT_CONFIRMATION_MESSAGE_TIMEOUT, \
AzureIoTClient 16:deba40344375 119 IOTHUB_CLIENT_CONFIRMATION_ERROR \
AzureIoTClient 16:deba40344375 120
AzureIoTClient 53:1e5a1ca1f274 121 /** @brief Enumeration passed in by the IoT Hub when the event confirmation
AzureIoTClient 53:1e5a1ca1f274 122 * callback is invoked to indicate status of the event processing in
AzureIoTClient 53:1e5a1ca1f274 123 * the hub.
AzureIoTClient 53:1e5a1ca1f274 124 */
AzureIoTClient 53:1e5a1ca1f274 125 DEFINE_ENUM(IOTHUB_CLIENT_CONFIRMATION_RESULT, IOTHUB_CLIENT_CONFIRMATION_RESULT_VALUES);
AzureIoTClient 16:deba40344375 126
AzureIoTClient 53:1e5a1ca1f274 127 #define IOTHUB_CLIENT_CONNECTION_STATUS_VALUES \
AzureIoTClient 53:1e5a1ca1f274 128 IOTHUB_CLIENT_CONNECTION_AUTHENTICATED, \
AzureIoTClient 53:1e5a1ca1f274 129 IOTHUB_CLIENT_CONNECTION_UNAUTHENTICATED \
AzureIoTClient 53:1e5a1ca1f274 130
AzureIoTClient 52:1cc3c6d07cad 131
AzureIoTClient 52:1cc3c6d07cad 132 /** @brief Enumeration passed in by the IoT Hub when the connection status
AzureIoTClient 52:1cc3c6d07cad 133 * callback is invoked to indicate status of the connection in
AzureIoTClient 52:1cc3c6d07cad 134 * the hub.
AzureIoTClient 52:1cc3c6d07cad 135 */
AzureIoTClient 52:1cc3c6d07cad 136 DEFINE_ENUM(IOTHUB_CLIENT_CONNECTION_STATUS, IOTHUB_CLIENT_CONNECTION_STATUS_VALUES);
AzureIoTClient 52:1cc3c6d07cad 137
AzureIoTClient 53:1e5a1ca1f274 138 #define IOTHUB_CLIENT_CONNECTION_STATUS_REASON_VALUES \
AzureIoTClient 53:1e5a1ca1f274 139 IOTHUB_CLIENT_CONNECTION_EXPIRED_SAS_TOKEN, \
AzureIoTClient 53:1e5a1ca1f274 140 IOTHUB_CLIENT_CONNECTION_DEVICE_DISABLED, \
AzureIoTClient 53:1e5a1ca1f274 141 IOTHUB_CLIENT_CONNECTION_BAD_CREDENTIAL, \
AzureIoTClient 53:1e5a1ca1f274 142 IOTHUB_CLIENT_CONNECTION_RETRY_EXPIRED, \
AzureIoTClient 53:1e5a1ca1f274 143 IOTHUB_CLIENT_CONNECTION_NO_NETWORK, \
AzureIoTClient 62:5a4cdacf5090 144 IOTHUB_CLIENT_CONNECTION_COMMUNICATION_ERROR, \
AzureIoTClient 53:1e5a1ca1f274 145 IOTHUB_CLIENT_CONNECTION_OK \
AzureIoTClient 52:1cc3c6d07cad 146
AzureIoTClient 52:1cc3c6d07cad 147 /** @brief Enumeration passed in by the IoT Hub when the connection status
AzureIoTClient 52:1cc3c6d07cad 148 * callback is invoked to indicate status of the connection in
AzureIoTClient 52:1cc3c6d07cad 149 * the hub.
AzureIoTClient 52:1cc3c6d07cad 150 */
AzureIoTClient 52:1cc3c6d07cad 151 DEFINE_ENUM(IOTHUB_CLIENT_CONNECTION_STATUS_REASON, IOTHUB_CLIENT_CONNECTION_STATUS_REASON_VALUES);
AzureIoTClient 52:1cc3c6d07cad 152
AzureIoTClient 16:deba40344375 153 #define TRANSPORT_TYPE_VALUES \
AzureIoTClient 16:deba40344375 154 TRANSPORT_LL, /*LL comes from "LowLevel" */ \
AzureIoTClient 16:deba40344375 155 TRANSPORT_THREADED
AzureIoTClient 16:deba40344375 156
AzureIoTClient 53:1e5a1ca1f274 157 DEFINE_ENUM(TRANSPORT_TYPE, TRANSPORT_TYPE_VALUES);
AzureIoTClient 16:deba40344375 158
AzureIoTClient 53:1e5a1ca1f274 159 #define DEVICE_TWIN_UPDATE_STATE_VALUES \
AzureIoTClient 53:1e5a1ca1f274 160 DEVICE_TWIN_UPDATE_COMPLETE, \
AzureIoTClient 53:1e5a1ca1f274 161 DEVICE_TWIN_UPDATE_PARTIAL
AzureIoTClient 16:deba40344375 162
AzureIoTClient 53:1e5a1ca1f274 163 DEFINE_ENUM(DEVICE_TWIN_UPDATE_STATE, DEVICE_TWIN_UPDATE_STATE_VALUES);
AzureIoTClient 52:1cc3c6d07cad 164
AzureIoTClient 53:1e5a1ca1f274 165 typedef void(*IOTHUB_CLIENT_EVENT_CONFIRMATION_CALLBACK)(IOTHUB_CLIENT_CONFIRMATION_RESULT result, void* userContextCallback);
AzureIoTClient 53:1e5a1ca1f274 166 typedef void(*IOTHUB_CLIENT_CONNECTION_STATUS_CALLBACK)(IOTHUB_CLIENT_CONNECTION_STATUS result, IOTHUB_CLIENT_CONNECTION_STATUS_REASON reason, void* userContextCallback);
AzureIoTClient 53:1e5a1ca1f274 167 typedef IOTHUBMESSAGE_DISPOSITION_RESULT (*IOTHUB_CLIENT_MESSAGE_CALLBACK_ASYNC)(IOTHUB_MESSAGE_HANDLE message, void* userContextCallback);
AzureIoTClient 53:1e5a1ca1f274 168 typedef const TRANSPORT_PROVIDER*(*IOTHUB_CLIENT_TRANSPORT_PROVIDER)(void);
AzureIoTClient 53:1e5a1ca1f274 169
AzureIoTClient 53:1e5a1ca1f274 170 typedef void(*IOTHUB_CLIENT_DEVICE_TWIN_CALLBACK)(DEVICE_TWIN_UPDATE_STATE update_state, const unsigned char* payLoad, size_t size, void* userContextCallback);
AzureIoTClient 53:1e5a1ca1f274 171 typedef void(*IOTHUB_CLIENT_REPORTED_STATE_CALLBACK)(int status_code, void* userContextCallback);
AzureIoTClient 55:59b527ab3452 172 typedef int(*IOTHUB_CLIENT_DEVICE_METHOD_CALLBACK_ASYNC)(const char* method_name, const unsigned char* payload, size_t size, unsigned char** response, size_t* response_size, void* userContextCallback);
AzureIoTClient 55:59b527ab3452 173 typedef int(*IOTHUB_CLIENT_INBOUND_DEVICE_METHOD_CALLBACK)(const char* method_name, const unsigned char* payload, size_t size, METHOD_HANDLE method_id, void* userContextCallback);
AzureIoTClient 52:1cc3c6d07cad 174
AzureIoTClient 53:1e5a1ca1f274 175 /** @brief This struct captures IoTHub client configuration. */
AzureIoTClient 53:1e5a1ca1f274 176 typedef struct IOTHUB_CLIENT_CONFIG_TAG
AzureIoTClient 53:1e5a1ca1f274 177 {
AzureIoTClient 53:1e5a1ca1f274 178 /** @brief A function pointer that is passed into the @c IoTHubClientCreate.
AzureIoTClient 53:1e5a1ca1f274 179 * A function definition for AMQP is defined in the include @c iothubtransportamqp.h.
AzureIoTClient 53:1e5a1ca1f274 180 * A function definition for HTTP is defined in the include @c iothubtransporthttp.h
AzureIoTClient 53:1e5a1ca1f274 181 * A function definition for MQTT is defined in the include @c iothubtransportmqtt.h */
AzureIoTClient 53:1e5a1ca1f274 182 IOTHUB_CLIENT_TRANSPORT_PROVIDER protocol;
AzureIoTClient 16:deba40344375 183
AzureIoTClient 53:1e5a1ca1f274 184 /** @brief A string that identifies the device. */
AzureIoTClient 53:1e5a1ca1f274 185 const char* deviceId;
AzureIoTClient 16:deba40344375 186
AzureIoTClient 53:1e5a1ca1f274 187 /** @brief The device key used to authenticate the device.
AzureIoTClient 53:1e5a1ca1f274 188 If neither deviceSasToken nor deviceKey is present then the authentication is assumed x509.*/
AzureIoTClient 53:1e5a1ca1f274 189 const char* deviceKey;
AzureIoTClient 40:1a94db9139ea 190
AzureIoTClient 53:1e5a1ca1f274 191 /** @brief The device SAS Token used to authenticate the device in place of device key.
Azure.IoT Build 45:54c11b1b1407 192 If neither deviceSasToken nor deviceKey is present then the authentication is assumed x509.*/
AzureIoTClient 53:1e5a1ca1f274 193 const char* deviceSasToken;
AzureIoTClient 40:1a94db9139ea 194
AzureIoTClient 53:1e5a1ca1f274 195 /** @brief The IoT Hub name to which the device is connecting. */
AzureIoTClient 53:1e5a1ca1f274 196 const char* iotHubName;
AzureIoTClient 40:1a94db9139ea 197
AzureIoTClient 53:1e5a1ca1f274 198 /** @brief IoT Hub suffix goes here, e.g., private.azure-devices-int.net. */
AzureIoTClient 53:1e5a1ca1f274 199 const char* iotHubSuffix;
AzureIoTClient 16:deba40344375 200
AzureIoTClient 53:1e5a1ca1f274 201 const char* protocolGatewayHostName;
AzureIoTClient 53:1e5a1ca1f274 202 } IOTHUB_CLIENT_CONFIG;
AzureIoTClient 16:deba40344375 203
AzureIoTClient 53:1e5a1ca1f274 204 /** @brief This struct captures IoTHub client device configuration. */
AzureIoTClient 53:1e5a1ca1f274 205 typedef struct IOTHUB_CLIENT_DEVICE_CONFIG_TAG
AzureIoTClient 53:1e5a1ca1f274 206 {
AzureIoTClient 53:1e5a1ca1f274 207 /** @brief A function pointer that is passed into the @c IoTHubClientCreate.
AzureIoTClient 53:1e5a1ca1f274 208 * A function definition for AMQP is defined in the include @c iothubtransportamqp.h.
AzureIoTClient 53:1e5a1ca1f274 209 * A function definition for HTTP is defined in the include @c iothubtransporthttp.h
AzureIoTClient 53:1e5a1ca1f274 210 * A function definition for MQTT is defined in the include @c iothubtransportmqtt.h */
AzureIoTClient 53:1e5a1ca1f274 211 IOTHUB_CLIENT_TRANSPORT_PROVIDER protocol;
Azure.IoT Build 36:67300d5a4c1f 212
AzureIoTClient 53:1e5a1ca1f274 213 /** @brief a transport handle implementing the protocol */
AzureIoTClient 53:1e5a1ca1f274 214 void * transportHandle;
Azure.IoT Build 36:67300d5a4c1f 215
AzureIoTClient 53:1e5a1ca1f274 216 /** @brief A string that identifies the device. */
AzureIoTClient 53:1e5a1ca1f274 217 const char* deviceId;
Azure.IoT Build 36:67300d5a4c1f 218
AzureIoTClient 53:1e5a1ca1f274 219 /** @brief The device key used to authenticate the device.
Azure.IoT Build 45:54c11b1b1407 220 x509 authentication is is not supported for multiplexed connections*/
AzureIoTClient 53:1e5a1ca1f274 221 const char* deviceKey;
Azure.IoT Build 36:67300d5a4c1f 222
AzureIoTClient 53:1e5a1ca1f274 223 /** @brief The device SAS Token used to authenticate the device in place of device key.
Azure.IoT Build 45:54c11b1b1407 224 x509 authentication is is not supported for multiplexed connections.*/
AzureIoTClient 53:1e5a1ca1f274 225 const char* deviceSasToken;
AzureIoTClient 53:1e5a1ca1f274 226 } IOTHUB_CLIENT_DEVICE_CONFIG;
Azure.IoT Build 36:67300d5a4c1f 227
AzureIoTClient 53:1e5a1ca1f274 228 /** @brief This struct captures IoTHub transport configuration. */
AzureIoTClient 53:1e5a1ca1f274 229 struct IOTHUBTRANSPORT_CONFIG_TAG
AzureIoTClient 53:1e5a1ca1f274 230 {
AzureIoTClient 53:1e5a1ca1f274 231 const IOTHUB_CLIENT_CONFIG* upperConfig;
AzureIoTClient 53:1e5a1ca1f274 232 PDLIST_ENTRY waitingToSend;
AzureIoTClient 63:1bf1c2d60aab 233 IOTHUB_AUTHORIZATION_HANDLE auth_module_handle;
AzureIoTClient 53:1e5a1ca1f274 234 };
Azure.IoT Build 37:18310e4d888d 235
Azure.IoT Build 37:18310e4d888d 236
AzureIoTClient 53:1e5a1ca1f274 237 /**
AzureIoTClient 53:1e5a1ca1f274 238 * @brief Creates a IoT Hub client for communication with an existing
AzureIoTClient 53:1e5a1ca1f274 239 * IoT Hub using the specified connection string parameter.
AzureIoTClient 53:1e5a1ca1f274 240 *
AzureIoTClient 53:1e5a1ca1f274 241 * @param connectionString Pointer to a character string
AzureIoTClient 53:1e5a1ca1f274 242 * @param protocol Function pointer for protocol implementation
AzureIoTClient 53:1e5a1ca1f274 243 *
AzureIoTClient 53:1e5a1ca1f274 244 * Sample connection string:
AzureIoTClient 53:1e5a1ca1f274 245 * <blockquote>
AzureIoTClient 53:1e5a1ca1f274 246 * <pre>HostName=[IoT Hub name goes here].[IoT Hub suffix goes here, e.g., private.azure-devices-int.net];DeviceId=[Device ID goes here];SharedAccessKey=[Device key goes here];</pre>
AzureIoTClient 53:1e5a1ca1f274 247 * </blockquote>
AzureIoTClient 53:1e5a1ca1f274 248 *
AzureIoTClient 53:1e5a1ca1f274 249 * @return A non-NULL @c IOTHUB_CLIENT_LL_HANDLE value that is used when
AzureIoTClient 53:1e5a1ca1f274 250 * invoking other functions for IoT Hub client and @c NULL on failure.
AzureIoTClient 53:1e5a1ca1f274 251 */
AzureIoTClient 53:1e5a1ca1f274 252 MOCKABLE_FUNCTION(, IOTHUB_CLIENT_LL_HANDLE, IoTHubClient_LL_CreateFromConnectionString, const char*, connectionString, IOTHUB_CLIENT_TRANSPORT_PROVIDER, protocol);
AzureIoTClient 16:deba40344375 253
AzureIoTClient 53:1e5a1ca1f274 254 /**
AzureIoTClient 53:1e5a1ca1f274 255 * @brief Creates a IoT Hub client for communication with an existing IoT
AzureIoTClient 53:1e5a1ca1f274 256 * Hub using the specified parameters.
AzureIoTClient 53:1e5a1ca1f274 257 *
AzureIoTClient 53:1e5a1ca1f274 258 * @param config Pointer to an @c IOTHUB_CLIENT_CONFIG structure
AzureIoTClient 53:1e5a1ca1f274 259 *
AzureIoTClient 53:1e5a1ca1f274 260 * The API does not allow sharing of a connection across multiple
AzureIoTClient 53:1e5a1ca1f274 261 * devices. This is a blocking call.
AzureIoTClient 53:1e5a1ca1f274 262 *
AzureIoTClient 53:1e5a1ca1f274 263 * @return A non-NULL @c IOTHUB_CLIENT_LL_HANDLE value that is used when
AzureIoTClient 53:1e5a1ca1f274 264 * invoking other functions for IoT Hub client and @c NULL on failure.
AzureIoTClient 53:1e5a1ca1f274 265 */
AzureIoTClient 53:1e5a1ca1f274 266 MOCKABLE_FUNCTION(, IOTHUB_CLIENT_LL_HANDLE, IoTHubClient_LL_Create, const IOTHUB_CLIENT_CONFIG*, config);
AzureIoTClient 16:deba40344375 267
AzureIoTClient 53:1e5a1ca1f274 268 /**
AzureIoTClient 53:1e5a1ca1f274 269 * @brief Creates a IoT Hub client for communication with an existing IoT
AzureIoTClient 53:1e5a1ca1f274 270 * Hub using an existing transport.
AzureIoTClient 53:1e5a1ca1f274 271 *
AzureIoTClient 53:1e5a1ca1f274 272 * @param config Pointer to an @c IOTHUB_CLIENT_DEVICE_CONFIG structure
AzureIoTClient 53:1e5a1ca1f274 273 *
AzureIoTClient 53:1e5a1ca1f274 274 * The API *allows* sharing of a connection across multiple
AzureIoTClient 53:1e5a1ca1f274 275 * devices. This is a blocking call.
AzureIoTClient 53:1e5a1ca1f274 276 *
AzureIoTClient 53:1e5a1ca1f274 277 * @return A non-NULL @c IOTHUB_CLIENT_LL_HANDLE value that is used when
AzureIoTClient 53:1e5a1ca1f274 278 * invoking other functions for IoT Hub client and @c NULL on failure.
AzureIoTClient 53:1e5a1ca1f274 279 */
AzureIoTClient 53:1e5a1ca1f274 280 MOCKABLE_FUNCTION(, IOTHUB_CLIENT_LL_HANDLE, IoTHubClient_LL_CreateWithTransport, const IOTHUB_CLIENT_DEVICE_CONFIG*, config);
Azure.IoT Build 36:67300d5a4c1f 281
AzureIoTClient 53:1e5a1ca1f274 282 /**
AzureIoTClient 53:1e5a1ca1f274 283 * @brief Disposes of resources allocated by the IoT Hub client. This is a
AzureIoTClient 53:1e5a1ca1f274 284 * blocking call.
AzureIoTClient 53:1e5a1ca1f274 285 *
AzureIoTClient 53:1e5a1ca1f274 286 * @param iotHubClientHandle The handle created by a call to the create function.
AzureIoTClient 53:1e5a1ca1f274 287 */
AzureIoTClient 53:1e5a1ca1f274 288 MOCKABLE_FUNCTION(, void, IoTHubClient_LL_Destroy, IOTHUB_CLIENT_LL_HANDLE, iotHubClientHandle);
AzureIoTClient 16:deba40344375 289
AzureIoTClient 53:1e5a1ca1f274 290 /**
AzureIoTClient 53:1e5a1ca1f274 291 * @brief Asynchronous call to send the message specified by @p eventMessageHandle.
AzureIoTClient 53:1e5a1ca1f274 292 *
AzureIoTClient 53:1e5a1ca1f274 293 * @param iotHubClientHandle The handle created by a call to the create function.
AzureIoTClient 53:1e5a1ca1f274 294 * @param eventMessageHandle The handle to an IoT Hub message.
AzureIoTClient 53:1e5a1ca1f274 295 * @param eventConfirmationCallback The callback specified by the device for receiving
AzureIoTClient 53:1e5a1ca1f274 296 * confirmation of the delivery of the IoT Hub message.
AzureIoTClient 53:1e5a1ca1f274 297 * This callback can be expected to invoke the
AzureIoTClient 53:1e5a1ca1f274 298 * ::IoTHubClient_LL_SendEventAsync function for the
AzureIoTClient 53:1e5a1ca1f274 299 * same message in an attempt to retry sending a failing
AzureIoTClient 53:1e5a1ca1f274 300 * message. The user can specify a @c NULL value here to
AzureIoTClient 53:1e5a1ca1f274 301 * indicate that no callback is required.
AzureIoTClient 53:1e5a1ca1f274 302 * @param userContextCallback User specified context that will be provided to the
AzureIoTClient 53:1e5a1ca1f274 303 * callback. This can be @c NULL.
AzureIoTClient 53:1e5a1ca1f274 304 *
AzureIoTClient 53:1e5a1ca1f274 305 * @b NOTE: The application behavior is undefined if the user calls
AzureIoTClient 53:1e5a1ca1f274 306 * the ::IoTHubClient_LL_Destroy function from within any callback.
AzureIoTClient 53:1e5a1ca1f274 307 *
AzureIoTClient 53:1e5a1ca1f274 308 * @return IOTHUB_CLIENT_OK upon success or an error code upon failure.
AzureIoTClient 53:1e5a1ca1f274 309 */
AzureIoTClient 53:1e5a1ca1f274 310 MOCKABLE_FUNCTION(, IOTHUB_CLIENT_RESULT, IoTHubClient_LL_SendEventAsync, IOTHUB_CLIENT_LL_HANDLE, iotHubClientHandle, IOTHUB_MESSAGE_HANDLE, eventMessageHandle, IOTHUB_CLIENT_EVENT_CONFIRMATION_CALLBACK, eventConfirmationCallback, void*, userContextCallback);
AzureIoTClient 16:deba40344375 311
AzureIoTClient 53:1e5a1ca1f274 312 /**
AzureIoTClient 53:1e5a1ca1f274 313 * @brief This function returns the current sending status for IoTHubClient.
AzureIoTClient 53:1e5a1ca1f274 314 *
AzureIoTClient 53:1e5a1ca1f274 315 * @param iotHubClientHandle The handle created by a call to the create function.
AzureIoTClient 53:1e5a1ca1f274 316 * @param iotHubClientStatus The sending state is populated at the address pointed
AzureIoTClient 53:1e5a1ca1f274 317 * at by this parameter. The value will be set to
AzureIoTClient 53:1e5a1ca1f274 318 * @c IOTHUBCLIENT_SENDSTATUS_IDLE if there is currently
AzureIoTClient 53:1e5a1ca1f274 319 * no item to be sent and @c IOTHUBCLIENT_SENDSTATUS_BUSY
AzureIoTClient 53:1e5a1ca1f274 320 * if there are.
AzureIoTClient 53:1e5a1ca1f274 321 *
AzureIoTClient 53:1e5a1ca1f274 322 * @return IOTHUB_CLIENT_OK upon success or an error code upon failure.
AzureIoTClient 53:1e5a1ca1f274 323 */
AzureIoTClient 53:1e5a1ca1f274 324 MOCKABLE_FUNCTION(, IOTHUB_CLIENT_RESULT, IoTHubClient_LL_GetSendStatus, IOTHUB_CLIENT_LL_HANDLE, iotHubClientHandle, IOTHUB_CLIENT_STATUS*, iotHubClientStatus);
AzureIoTClient 16:deba40344375 325
AzureIoTClient 53:1e5a1ca1f274 326 /**
AzureIoTClient 53:1e5a1ca1f274 327 * @brief Sets up the message callback to be invoked when IoT Hub issues a
AzureIoTClient 53:1e5a1ca1f274 328 * message to the device. This is a blocking call.
AzureIoTClient 53:1e5a1ca1f274 329 *
AzureIoTClient 53:1e5a1ca1f274 330 * @param iotHubClientHandle The handle created by a call to the create function.
AzureIoTClient 53:1e5a1ca1f274 331 * @param messageCallback The callback specified by the device for receiving
AzureIoTClient 53:1e5a1ca1f274 332 * messages from IoT Hub.
AzureIoTClient 53:1e5a1ca1f274 333 * @param userContextCallback User specified context that will be provided to the
AzureIoTClient 53:1e5a1ca1f274 334 * callback. This can be @c NULL.
AzureIoTClient 53:1e5a1ca1f274 335 *
AzureIoTClient 53:1e5a1ca1f274 336 * @b NOTE: The application behavior is undefined if the user calls
AzureIoTClient 53:1e5a1ca1f274 337 * the ::IoTHubClient_LL_Destroy function from within any callback.
AzureIoTClient 53:1e5a1ca1f274 338 *
AzureIoTClient 53:1e5a1ca1f274 339 * @return IOTHUB_CLIENT_OK upon success or an error code upon failure.
AzureIoTClient 53:1e5a1ca1f274 340 */
AzureIoTClient 53:1e5a1ca1f274 341 MOCKABLE_FUNCTION(, IOTHUB_CLIENT_RESULT, IoTHubClient_LL_SetMessageCallback, IOTHUB_CLIENT_LL_HANDLE, iotHubClientHandle, IOTHUB_CLIENT_MESSAGE_CALLBACK_ASYNC, messageCallback, void*, userContextCallback);
AzureIoTClient 16:deba40344375 342
AzureIoTClient 52:1cc3c6d07cad 343 /**
AzureIoTClient 52:1cc3c6d07cad 344 * @brief Sets up the connection status callback to be invoked representing the status of
AzureIoTClient 52:1cc3c6d07cad 345 * the connection to IOT Hub. This is a blocking call.
AzureIoTClient 52:1cc3c6d07cad 346 *
AzureIoTClient 52:1cc3c6d07cad 347 * @param iotHubClientHandle The handle created by a call to the create function.
AzureIoTClient 52:1cc3c6d07cad 348 * @param connectionStatusCallback The callback specified by the device for receiving
AzureIoTClient 52:1cc3c6d07cad 349 * updates about the status of the connection to IoT Hub.
AzureIoTClient 52:1cc3c6d07cad 350 * @param userContextCallback User specified context that will be provided to the
AzureIoTClient 52:1cc3c6d07cad 351 * callback. This can be @c NULL.
AzureIoTClient 52:1cc3c6d07cad 352 *
AzureIoTClient 52:1cc3c6d07cad 353 * @b NOTE: The application behavior is undefined if the user calls
AzureIoTClient 52:1cc3c6d07cad 354 * the ::IoTHubClient_LL_Destroy function from within any callback.
AzureIoTClient 52:1cc3c6d07cad 355 *
AzureIoTClient 52:1cc3c6d07cad 356 * @return IOTHUB_CLIENT_OK upon success or an error code upon failure.
AzureIoTClient 52:1cc3c6d07cad 357 */
AzureIoTClient 53:1e5a1ca1f274 358 MOCKABLE_FUNCTION(, IOTHUB_CLIENT_RESULT, IoTHubClient_LL_SetConnectionStatusCallback, IOTHUB_CLIENT_LL_HANDLE, iotHubClientHandle, IOTHUB_CLIENT_CONNECTION_STATUS_CALLBACK, connectionStatusCallback, void*, userContextCallback);
AzureIoTClient 52:1cc3c6d07cad 359
AzureIoTClient 52:1cc3c6d07cad 360 /**
AzureIoTClient 52:1cc3c6d07cad 361 * @brief Sets up the connection status callback to be invoked representing the status of
AzureIoTClient 52:1cc3c6d07cad 362 * the connection to IOT Hub. This is a blocking call.
AzureIoTClient 52:1cc3c6d07cad 363 *
AzureIoTClient 52:1cc3c6d07cad 364 * @param iotHubClientHandle The handle created by a call to the create function.
AzureIoTClient 52:1cc3c6d07cad 365 * @param retryPolicy The policy to use to reconnect to IoT Hub when a
AzureIoTClient 52:1cc3c6d07cad 366 * connection drops.
AzureIoTClient 53:1e5a1ca1f274 367 * @param retryTimeoutLimitInSeconds Maximum amount of time(seconds) to attempt reconnection when a
AzureIoTClient 52:1cc3c6d07cad 368 * connection drops to IOT Hub.
AzureIoTClient 52:1cc3c6d07cad 369 *
AzureIoTClient 52:1cc3c6d07cad 370 * @b NOTE: The application behavior is undefined if the user calls
AzureIoTClient 52:1cc3c6d07cad 371 * the ::IoTHubClient_LL_Destroy function from within any callback.
AzureIoTClient 52:1cc3c6d07cad 372 *
AzureIoTClient 52:1cc3c6d07cad 373 * @return IOTHUB_CLIENT_OK upon success or an error code upon failure.
AzureIoTClient 52:1cc3c6d07cad 374 */
AzureIoTClient 53:1e5a1ca1f274 375 MOCKABLE_FUNCTION(, IOTHUB_CLIENT_RESULT, IoTHubClient_LL_SetRetryPolicy, IOTHUB_CLIENT_LL_HANDLE, iotHubClientHandle, IOTHUB_CLIENT_RETRY_POLICY, retryPolicy, size_t, retryTimeoutLimitInSeconds);
AzureIoTClient 52:1cc3c6d07cad 376
AzureIoTClient 52:1cc3c6d07cad 377
AzureIoTClient 52:1cc3c6d07cad 378 /**
AzureIoTClient 52:1cc3c6d07cad 379 * @brief Sets up the connection status callback to be invoked representing the status of
AzureIoTClient 52:1cc3c6d07cad 380 * the connection to IOT Hub. This is a blocking call.
AzureIoTClient 52:1cc3c6d07cad 381 *
AzureIoTClient 52:1cc3c6d07cad 382 * @param iotHubClientHandle The handle created by a call to the create function.
AzureIoTClient 52:1cc3c6d07cad 383 * @param retryPolicy Out parameter containing the policy to use to reconnect to IoT Hub.
AzureIoTClient 53:1e5a1ca1f274 384 * @param retryTimeoutLimitInSeconds Out parameter containing maximum amount of time in seconds to attempt reconnection
AzureIoTClient 52:1cc3c6d07cad 385 to IOT Hub.
AzureIoTClient 52:1cc3c6d07cad 386 *
AzureIoTClient 52:1cc3c6d07cad 387 * @b NOTE: The application behavior is undefined if the user calls
AzureIoTClient 52:1cc3c6d07cad 388 * the ::IoTHubClient_LL_Destroy function from within any callback.
AzureIoTClient 52:1cc3c6d07cad 389 *
AzureIoTClient 52:1cc3c6d07cad 390 * @return IOTHUB_CLIENT_OK upon success or an error code upon failure.
AzureIoTClient 52:1cc3c6d07cad 391 */
AzureIoTClient 53:1e5a1ca1f274 392 MOCKABLE_FUNCTION(, IOTHUB_CLIENT_RESULT, IoTHubClient_LL_GetRetryPolicy, IOTHUB_CLIENT_LL_HANDLE, iotHubClientHandle, IOTHUB_CLIENT_RETRY_POLICY*, retryPolicy, size_t*, retryTimeoutLimitInSeconds);
AzureIoTClient 52:1cc3c6d07cad 393
AzureIoTClient 53:1e5a1ca1f274 394 /**
AzureIoTClient 53:1e5a1ca1f274 395 * @brief This function returns in the out parameter @p lastMessageReceiveTime
AzureIoTClient 53:1e5a1ca1f274 396 * what was the value of the @c time function when the last message was
AzureIoTClient 53:1e5a1ca1f274 397 * received at the client.
AzureIoTClient 53:1e5a1ca1f274 398 *
AzureIoTClient 53:1e5a1ca1f274 399 * @param iotHubClientHandle The handle created by a call to the create function.
AzureIoTClient 53:1e5a1ca1f274 400 * @param lastMessageReceiveTime Out parameter containing the value of @c time function
AzureIoTClient 53:1e5a1ca1f274 401 * when the last message was received.
AzureIoTClient 53:1e5a1ca1f274 402 *
AzureIoTClient 53:1e5a1ca1f274 403 * @return IOTHUB_CLIENT_OK upon success or an error code upon failure.
AzureIoTClient 53:1e5a1ca1f274 404 */
AzureIoTClient 53:1e5a1ca1f274 405 MOCKABLE_FUNCTION(, IOTHUB_CLIENT_RESULT, IoTHubClient_LL_GetLastMessageReceiveTime, IOTHUB_CLIENT_LL_HANDLE, iotHubClientHandle, time_t*, lastMessageReceiveTime);
AzureIoTClient 16:deba40344375 406
AzureIoTClient 53:1e5a1ca1f274 407 /**
AzureIoTClient 53:1e5a1ca1f274 408 * @brief This function is meant to be called by the user when work
AzureIoTClient 53:1e5a1ca1f274 409 * (sending/receiving) can be done by the IoTHubClient.
AzureIoTClient 53:1e5a1ca1f274 410 *
AzureIoTClient 53:1e5a1ca1f274 411 * @param iotHubClientHandle The handle created by a call to the create function.
AzureIoTClient 53:1e5a1ca1f274 412 *
AzureIoTClient 53:1e5a1ca1f274 413 * All IoTHubClient interactions (in regards to network traffic
AzureIoTClient 53:1e5a1ca1f274 414 * and/or user level callbacks) are the effect of calling this
AzureIoTClient 53:1e5a1ca1f274 415 * function and they take place synchronously inside _DoWork.
AzureIoTClient 53:1e5a1ca1f274 416 */
AzureIoTClient 53:1e5a1ca1f274 417 MOCKABLE_FUNCTION(, void, IoTHubClient_LL_DoWork, IOTHUB_CLIENT_LL_HANDLE, iotHubClientHandle);
AzureIoTClient 16:deba40344375 418
AzureIoTClient 53:1e5a1ca1f274 419 /**
AzureIoTClient 53:1e5a1ca1f274 420 * @brief This API sets a runtime option identified by parameter @p optionName
AzureIoTClient 53:1e5a1ca1f274 421 * to a value pointed to by @p value. @p optionName and the data type
AzureIoTClient 53:1e5a1ca1f274 422 * @p value is pointing to are specific for every option.
AzureIoTClient 53:1e5a1ca1f274 423 *
AzureIoTClient 53:1e5a1ca1f274 424 * @param iotHubClientHandle The handle created by a call to the create function.
AzureIoTClient 53:1e5a1ca1f274 425 * @param optionName Name of the option.
AzureIoTClient 53:1e5a1ca1f274 426 * @param value The value.
AzureIoTClient 53:1e5a1ca1f274 427 *
AzureIoTClient 53:1e5a1ca1f274 428 * The options that can be set via this API are:
AzureIoTClient 53:1e5a1ca1f274 429 * - @b timeout - the maximum time in milliseconds a communication is
AzureIoTClient 53:1e5a1ca1f274 430 * allowed to use. @p value is a pointer to an @c unsigned @c int with
AzureIoTClient 53:1e5a1ca1f274 431 * the timeout value in milliseconds. This is only supported for the HTTP
AzureIoTClient 53:1e5a1ca1f274 432 * protocol as of now. When the HTTP protocol uses CURL, the meaning of
AzureIoTClient 53:1e5a1ca1f274 433 * the parameter is <em>total request time</em>. When the HTTP protocol uses
AzureIoTClient 53:1e5a1ca1f274 434 * winhttp, the meaning is the same as the @c dwSendTimeout and
AzureIoTClient 53:1e5a1ca1f274 435 * @c dwReceiveTimeout parameters of the
AzureIoTClient 53:1e5a1ca1f274 436 * <a href="https://msdn.microsoft.com/en-us/library/windows/desktop/aa384116(v=vs.85).aspx">
AzureIoTClient 53:1e5a1ca1f274 437 * WinHttpSetTimeouts</a> API.
AzureIoTClient 53:1e5a1ca1f274 438 * - @b CURLOPT_LOW_SPEED_LIMIT - only available for HTTP protocol and only
AzureIoTClient 53:1e5a1ca1f274 439 * when CURL is used. It has the same meaning as CURL's option with the same
AzureIoTClient 53:1e5a1ca1f274 440 * name. @p value is pointer to a long.
AzureIoTClient 53:1e5a1ca1f274 441 * - @b CURLOPT_LOW_SPEED_TIME - only available for HTTP protocol and only
AzureIoTClient 53:1e5a1ca1f274 442 * when CURL is used. It has the same meaning as CURL's option with the same
AzureIoTClient 53:1e5a1ca1f274 443 * name. @p value is pointer to a long.
AzureIoTClient 53:1e5a1ca1f274 444 * - @b CURLOPT_FORBID_REUSE - only available for HTTP protocol and only
AzureIoTClient 53:1e5a1ca1f274 445 * when CURL is used. It has the same meaning as CURL's option with the same
AzureIoTClient 53:1e5a1ca1f274 446 * name. @p value is pointer to a long.
AzureIoTClient 53:1e5a1ca1f274 447 * - @b CURLOPT_FRESH_CONNECT - only available for HTTP protocol and only
AzureIoTClient 53:1e5a1ca1f274 448 * when CURL is used. It has the same meaning as CURL's option with the same
AzureIoTClient 53:1e5a1ca1f274 449 * name. @p value is pointer to a long.
AzureIoTClient 53:1e5a1ca1f274 450 * - @b CURLOPT_VERBOSE - only available for HTTP protocol and only
AzureIoTClient 53:1e5a1ca1f274 451 * when CURL is used. It has the same meaning as CURL's option with the same
AzureIoTClient 53:1e5a1ca1f274 452 * name. @p value is pointer to a long.
AzureIoTClient 53:1e5a1ca1f274 453 * - @b keepalive - available for MQTT protocol. Integer value that sets the
AzureIoTClient 53:1e5a1ca1f274 454 * interval in seconds when pings are sent to the server.
AzureIoTClient 53:1e5a1ca1f274 455 * - @b logtrace - available for MQTT protocol. Boolean value that turns on and
AzureIoTClient 53:1e5a1ca1f274 456 * off the diagnostic logging.
AzureIoTClient 76:943524fee0b7 457 * - @b sas_token_lifetime - available for MQTT & AMQP protocol. size_t value that that determines the
AzureIoTClient 76:943524fee0b7 458 * sas token timeout length.
AzureIoTClient 53:1e5a1ca1f274 459 *
AzureIoTClient 53:1e5a1ca1f274 460 * @return IOTHUB_CLIENT_OK upon success or an error code upon failure.
AzureIoTClient 53:1e5a1ca1f274 461 */
AzureIoTClient 53:1e5a1ca1f274 462 MOCKABLE_FUNCTION(, IOTHUB_CLIENT_RESULT, IoTHubClient_LL_SetOption, IOTHUB_CLIENT_LL_HANDLE, iotHubClientHandle, const char*, optionName, const void*, value);
AzureIoTClient 53:1e5a1ca1f274 463
AzureIoTClient 53:1e5a1ca1f274 464 /**
AzureIoTClient 53:1e5a1ca1f274 465 * @brief This API specifies a call back to be used when the device receives a desired state update.
AzureIoTClient 53:1e5a1ca1f274 466 *
AzureIoTClient 53:1e5a1ca1f274 467 * @param iotHubClientHandle The handle created by a call to the create function.
AzureIoTClient 53:1e5a1ca1f274 468 * @param deviceTwinCallback The callback specified by the device client to be used for updating
AzureIoTClient 53:1e5a1ca1f274 469 * the desired state. The callback will be called in response to patch
AzureIoTClient 53:1e5a1ca1f274 470 * request send by the IoTHub services. The payload will be passed to the
AzureIoTClient 53:1e5a1ca1f274 471 * callback, along with two version numbers:
AzureIoTClient 53:1e5a1ca1f274 472 * - Desired:
AzureIoTClient 53:1e5a1ca1f274 473 * - LastSeenReported:
AzureIoTClient 53:1e5a1ca1f274 474 * @param userContextCallback User specified context that will be provided to the
AzureIoTClient 53:1e5a1ca1f274 475 * callback. This can be @c NULL.
AzureIoTClient 53:1e5a1ca1f274 476 *
AzureIoTClient 53:1e5a1ca1f274 477 * @b NOTE: The application behavior is undefined if the user calls
AzureIoTClient 53:1e5a1ca1f274 478 * the ::IoTHubClient_LL_Destroy function from within any callback.
AzureIoTClient 53:1e5a1ca1f274 479 *
AzureIoTClient 53:1e5a1ca1f274 480 * @return IOTHUB_CLIENT_OK upon success or an error code upon failure.
AzureIoTClient 53:1e5a1ca1f274 481 */
AzureIoTClient 53:1e5a1ca1f274 482 MOCKABLE_FUNCTION(, IOTHUB_CLIENT_RESULT, IoTHubClient_LL_SetDeviceTwinCallback, IOTHUB_CLIENT_LL_HANDLE, iotHubClientHandle, IOTHUB_CLIENT_DEVICE_TWIN_CALLBACK, deviceTwinCallback, void*, userContextCallback);
AzureIoTClient 53:1e5a1ca1f274 483
AzureIoTClient 53:1e5a1ca1f274 484 /**
AzureIoTClient 53:1e5a1ca1f274 485 * @brief This API sneds a report of the device's properties and their current values.
AzureIoTClient 53:1e5a1ca1f274 486 *
AzureIoTClient 53:1e5a1ca1f274 487 * @param iotHubClientHandle The handle created by a call to the create function.
AzureIoTClient 53:1e5a1ca1f274 488 * @param reportedState The current device property values to be 'reported' to the IoTHub.
AzureIoTClient 53:1e5a1ca1f274 489 * @param reportedStateCallback The callback specified by the device client to be called with the
AzureIoTClient 53:1e5a1ca1f274 490 * result of the transaction.
AzureIoTClient 53:1e5a1ca1f274 491 * @param userContextCallback User specified context that will be provided to the
AzureIoTClient 53:1e5a1ca1f274 492 * callback. This can be @c NULL.
AzureIoTClient 53:1e5a1ca1f274 493 *
AzureIoTClient 53:1e5a1ca1f274 494 * @b NOTE: The application behavior is undefined if the user calls
AzureIoTClient 53:1e5a1ca1f274 495 * the ::IoTHubClient_LL_Destroy function from within any callback.
AzureIoTClient 53:1e5a1ca1f274 496 *
AzureIoTClient 53:1e5a1ca1f274 497 * @return IOTHUB_CLIENT_OK upon success or an error code upon failure.
AzureIoTClient 53:1e5a1ca1f274 498 */
AzureIoTClient 53:1e5a1ca1f274 499 MOCKABLE_FUNCTION(, IOTHUB_CLIENT_RESULT, IoTHubClient_LL_SendReportedState, IOTHUB_CLIENT_LL_HANDLE, iotHubClientHandle, const unsigned char*, reportedState, size_t, size, IOTHUB_CLIENT_REPORTED_STATE_CALLBACK, reportedStateCallback, void*, userContextCallback);
AzureIoTClient 53:1e5a1ca1f274 500
AzureIoTClient 53:1e5a1ca1f274 501 /**
AzureIoTClient 53:1e5a1ca1f274 502 * @brief This API sets callback for cloud to device method call.
AzureIoTClient 53:1e5a1ca1f274 503 *
AzureIoTClient 53:1e5a1ca1f274 504 * @param iotHubClientHandle The handle created by a call to the create function.
AzureIoTClient 53:1e5a1ca1f274 505 * @param deviceMethodCallback The callback which will be called by IoTHub.
AzureIoTClient 53:1e5a1ca1f274 506 * @param userContextCallback User specified context that will be provided to the
AzureIoTClient 53:1e5a1ca1f274 507 * callback. This can be @c NULL.
AzureIoTClient 53:1e5a1ca1f274 508 *
AzureIoTClient 53:1e5a1ca1f274 509 * @return IOTHUB_CLIENT_OK upon success or an error code upon failure.
AzureIoTClient 53:1e5a1ca1f274 510 */
AzureIoTClient 53:1e5a1ca1f274 511 MOCKABLE_FUNCTION(, IOTHUB_CLIENT_RESULT, IoTHubClient_LL_SetDeviceMethodCallback, IOTHUB_CLIENT_LL_HANDLE, iotHubClientHandle, IOTHUB_CLIENT_DEVICE_METHOD_CALLBACK_ASYNC, deviceMethodCallback, void*, userContextCallback);
AzureIoTClient 16:deba40344375 512
Azure.IoT.Build 54:6dcad9019a64 513 /**
Azure.IoT.Build 54:6dcad9019a64 514 * @brief This API sets callback for async cloud to device method call.
Azure.IoT.Build 54:6dcad9019a64 515 *
Azure.IoT.Build 54:6dcad9019a64 516 * @param iotHubClientHandle The handle created by a call to the create function.
Azure.IoT.Build 54:6dcad9019a64 517 * @param inboundDeviceMethodCallback The callback which will be called by IoTHub.
Azure.IoT.Build 54:6dcad9019a64 518 * @param userContextCallback User specified context that will be provided to the
Azure.IoT.Build 54:6dcad9019a64 519 * callback. This can be @c NULL.
Azure.IoT.Build 54:6dcad9019a64 520 *
Azure.IoT.Build 54:6dcad9019a64 521 * @return IOTHUB_CLIENT_OK upon success or an error code upon failure.
Azure.IoT.Build 54:6dcad9019a64 522 */
AzureIoTClient 55:59b527ab3452 523 MOCKABLE_FUNCTION(, IOTHUB_CLIENT_RESULT, IoTHubClient_LL_SetDeviceMethodCallback_Ex, IOTHUB_CLIENT_LL_HANDLE, iotHubClientHandle, IOTHUB_CLIENT_INBOUND_DEVICE_METHOD_CALLBACK, inboundDeviceMethodCallback, void*, userContextCallback);
Azure.IoT.Build 54:6dcad9019a64 524
Azure.IoT.Build 54:6dcad9019a64 525 /**
Azure.IoT.Build 54:6dcad9019a64 526 * @brief This API responses to a asnyc method callback identified the methodId.
Azure.IoT.Build 54:6dcad9019a64 527 *
Azure.IoT.Build 54:6dcad9019a64 528 * @param iotHubClientHandle The handle created by a call to the create function.
Azure.IoT.Build 54:6dcad9019a64 529 * @param methodId The methodId of the Device Method callback.
Azure.IoT.Build 54:6dcad9019a64 530 * @param response The response data for the method callback.
AzureIoTClient 55:59b527ab3452 531 * @param response_size The size of the response data buffer.
Azure.IoT.Build 54:6dcad9019a64 532 * @param status_response The status response of the method callback.
Azure.IoT.Build 54:6dcad9019a64 533 *
Azure.IoT.Build 54:6dcad9019a64 534 * @return IOTHUB_CLIENT_OK upon success or an error code upon failure.
Azure.IoT.Build 54:6dcad9019a64 535 */
AzureIoTClient 55:59b527ab3452 536 MOCKABLE_FUNCTION(, IOTHUB_CLIENT_RESULT, IoTHubClient_LL_DeviceMethodResponse, IOTHUB_CLIENT_LL_HANDLE, iotHubClientHandle, METHOD_HANDLE, methodId, const unsigned char*, response, size_t, respSize, int, statusCode);
Azure.IoT.Build 54:6dcad9019a64 537
AzureIoTClient 44:33dd78697616 538 #ifndef DONT_USE_UPLOADTOBLOB
AzureIoTClient 43:038d8511e817 539 /**
AzureIoTClient 43:038d8511e817 540 * @brief This API uploads to Azure Storage the content pointed to by @p source having the size @p size
AzureIoTClient 43:038d8511e817 541 * under the blob name devicename/@pdestinationFileName
AzureIoTClient 43:038d8511e817 542 *
AzureIoTClient 43:038d8511e817 543 * @param iotHubClientHandle The handle created by a call to the create function.
AzureIoTClient 43:038d8511e817 544 * @param destinationFileName name of the file.
AzureIoTClient 43:038d8511e817 545 * @param source pointer to the source for file content (can be NULL)
AzureIoTClient 43:038d8511e817 546 * @param size the size of the source in memory (if @p source is NULL then size needs to be 0).
AzureIoTClient 43:038d8511e817 547 *
AzureIoTClient 43:038d8511e817 548 * @return IOTHUB_CLIENT_OK upon success or an error code upon failure.
AzureIoTClient 43:038d8511e817 549 */
AzureIoTClient 53:1e5a1ca1f274 550 MOCKABLE_FUNCTION(, IOTHUB_CLIENT_RESULT, IoTHubClient_LL_UploadToBlob, IOTHUB_CLIENT_LL_HANDLE, iotHubClientHandle, const char*, destinationFileName, const unsigned char*, source, size_t, size);
AzureIoTClient 42:448eecc3676e 551
AzureIoTClient 44:33dd78697616 552 #endif /*DONT_USE_UPLOADTOBLOB*/
AzureIoTClient 43:038d8511e817 553
AzureIoTClient 16:deba40344375 554 #ifdef __cplusplus
AzureIoTClient 16:deba40344375 555 }
AzureIoTClient 16:deba40344375 556 #endif
AzureIoTClient 16:deba40344375 557
AzureIoTClient 16:deba40344375 558 #endif /* IOTHUB_CLIENT_LL_H */