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.h@88:248736be106e, 2018-06-11 (annotated)

Committer:
AzureIoTClient
Date:
Mon Jun 11 15:39:23 2018 -0700
Revision:
88:248736be106e
Parent:
82:f94e6bed4495
Child:
89:a2ed767a532e
1.2.5

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.h
AzureIoTClient 16:deba40344375 5 * @brief Extends the IoTHubCLient_LL module with additional features.
AzureIoTClient 16:deba40344375 6 *
AzureIoTClient 16:deba40344375 7 * @details IoTHubClient is a module that extends the IoTHubCLient_LL
AzureIoTClient 16:deba40344375 8 * module with 2 features:
AzureIoTClient 40:1a94db9139ea 9 * - scheduling the work for the IoTHubCLient from a
AzureIoTClient 16:deba40344375 10 * thread, so that the user does not need to create their
AzureIoTClient 16:deba40344375 11 * own thread
AzureIoTClient 16:deba40344375 12 * - thread-safe APIs
AzureIoTClient 16:deba40344375 13 */
AzureIoTClient 16:deba40344375 14
AzureIoTClient 16:deba40344375 15 #ifndef IOTHUB_CLIENT_H
AzureIoTClient 22:b8732db970af 16 #define IOTHUB_CLIENT_H
AzureIoTClient 16:deba40344375 17
AzureIoTClient 88:248736be106e 18 #include <stddef.h>
AzureIoTClient 88:248736be106e 19 #include <stdint.h>
AzureIoTClient 88:248736be106e 20
AzureIoTClient 88:248736be106e 21 #include "azure_c_shared_utility/umock_c_prod.h"
AzureIoTClient 88:248736be106e 22
AzureIoTClient 88:248736be106e 23 #include "iothub_transport_ll.h"
AzureIoTClient 88:248736be106e 24 #include "iothub_client_core_ll.h"
AzureIoTClient 88:248736be106e 25 #include "iothub_client_core.h"
AzureIoTClient 88:248736be106e 26 #include "iothub_client_ll.h"
AzureIoTClient 88:248736be106e 27
Azure.IoT.Build 54:6dcad9019a64 28 #ifndef IOTHUB_CLIENT_INSTANCE_TYPE
AzureIoTClient 88:248736be106e 29 typedef IOTHUB_CLIENT_CORE_HANDLE IOTHUB_CLIENT_HANDLE;
Azure.IoT.Build 54:6dcad9019a64 30 #define IOTHUB_CLIENT_INSTANCE_TYPE
Azure.IoT.Build 54:6dcad9019a64 31 #endif // IOTHUB_CLIENT_INSTANCE
AzureIoTClient 53:1e5a1ca1f274 32
AzureIoTClient 16:deba40344375 33
AzureIoTClient 16:deba40344375 34 #ifdef __cplusplus
AzureIoTClient 16:deba40344375 35 extern "C"
AzureIoTClient 16:deba40344375 36 {
AzureIoTClient 16:deba40344375 37 #endif
AzureIoTClient 16:deba40344375 38
AzureIoTClient 53:1e5a1ca1f274 39 /**
AzureIoTClient 53:1e5a1ca1f274 40 * @brief Creates a IoT Hub client for communication with an existing
AzureIoTClient 53:1e5a1ca1f274 41 * IoT Hub using the specified connection string parameter.
AzureIoTClient 53:1e5a1ca1f274 42 *
AzureIoTClient 53:1e5a1ca1f274 43 * @param connectionString Pointer to a character string
AzureIoTClient 53:1e5a1ca1f274 44 * @param protocol Function pointer for protocol implementation
AzureIoTClient 53:1e5a1ca1f274 45 *
AzureIoTClient 53:1e5a1ca1f274 46 * Sample connection string:
AzureIoTClient 53:1e5a1ca1f274 47 * <blockquote>
AzureIoTClient 53:1e5a1ca1f274 48 * <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 49 * <pre>HostName=[IoT Hub name goes here].[IoT Hub suffix goes here, e.g., private.azure-devices-int.net];DeviceId=[Device ID goes here];SharedAccessSignature=SharedAccessSignature sr=[IoT Hub name goes here].[IoT Hub suffix goes here, e.g., private.azure-devices-int.net]/devices/[Device ID goes here]&sig=[SAS Token goes here]&se=[Expiry Time goes here];</pre>
AzureIoTClient 53:1e5a1ca1f274 50 * </blockquote>
AzureIoTClient 53:1e5a1ca1f274 51 *
AzureIoTClient 53:1e5a1ca1f274 52 * @return A non-NULL @c IOTHUB_CLIENT_HANDLE value that is used when
AzureIoTClient 53:1e5a1ca1f274 53 * invoking other functions for IoT Hub client and @c NULL on failure.
AzureIoTClient 53:1e5a1ca1f274 54 */
AzureIoTClient 53:1e5a1ca1f274 55 MOCKABLE_FUNCTION(, IOTHUB_CLIENT_HANDLE, IoTHubClient_CreateFromConnectionString, const char*, connectionString, IOTHUB_CLIENT_TRANSPORT_PROVIDER, protocol);
AzureIoTClient 16:deba40344375 56
AzureIoTClient 53:1e5a1ca1f274 57 /**
AzureIoTClient 53:1e5a1ca1f274 58 * @brief Creates a IoT Hub client for communication with an existing IoT
AzureIoTClient 53:1e5a1ca1f274 59 * Hub using the specified parameters.
AzureIoTClient 53:1e5a1ca1f274 60 *
AzureIoTClient 53:1e5a1ca1f274 61 * @param config Pointer to an @c IOTHUB_CLIENT_CONFIG structure
AzureIoTClient 53:1e5a1ca1f274 62 *
AzureIoTClient 53:1e5a1ca1f274 63 * The API does not allow sharing of a connection across multiple
AzureIoTClient 53:1e5a1ca1f274 64 * devices. This is a blocking call.
AzureIoTClient 53:1e5a1ca1f274 65 *
AzureIoTClient 53:1e5a1ca1f274 66 * @return A non-NULL @c IOTHUB_CLIENT_HANDLE value that is used when
AzureIoTClient 53:1e5a1ca1f274 67 * invoking other functions for IoT Hub client and @c NULL on failure.
AzureIoTClient 53:1e5a1ca1f274 68 */
AzureIoTClient 53:1e5a1ca1f274 69 MOCKABLE_FUNCTION(, IOTHUB_CLIENT_HANDLE, IoTHubClient_Create, const IOTHUB_CLIENT_CONFIG*, config);
AzureIoTClient 16:deba40344375 70
AzureIoTClient 53:1e5a1ca1f274 71 /**
AzureIoTClient 53:1e5a1ca1f274 72 * @brief Creates a IoT Hub client for communication with an existing IoT
AzureIoTClient 53:1e5a1ca1f274 73 * Hub using the specified parameters.
AzureIoTClient 53:1e5a1ca1f274 74 *
AzureIoTClient 53:1e5a1ca1f274 75 * @param transportHandle TRANSPORT_HANDLE which represents a connection.
AzureIoTClient 53:1e5a1ca1f274 76 * @param config Pointer to an @c IOTHUB_CLIENT_CONFIG structure
AzureIoTClient 53:1e5a1ca1f274 77 *
AzureIoTClient 53:1e5a1ca1f274 78 * The API allows sharing of a connection across multiple
AzureIoTClient 53:1e5a1ca1f274 79 * devices. This is a blocking call.
AzureIoTClient 53:1e5a1ca1f274 80 *
AzureIoTClient 53:1e5a1ca1f274 81 * @return A non-NULL @c IOTHUB_CLIENT_HANDLE value that is used when
AzureIoTClient 53:1e5a1ca1f274 82 * invoking other functions for IoT Hub client and @c NULL on failure.
AzureIoTClient 53:1e5a1ca1f274 83 */
AzureIoTClient 53:1e5a1ca1f274 84 MOCKABLE_FUNCTION(, IOTHUB_CLIENT_HANDLE, IoTHubClient_CreateWithTransport, TRANSPORT_HANDLE, transportHandle, const IOTHUB_CLIENT_CONFIG*, config);
Azure.IoT Build 37:18310e4d888d 85
AzureIoTClient 53:1e5a1ca1f274 86 /**
AzureIoTClient 78:74a8d3068204 87 * @brief Creates a IoT Hub client for communication with an existing IoT
AzureIoTClient 78:74a8d3068204 88 * Hub using the device auth module.
AzureIoTClient 78:74a8d3068204 89 *
AzureIoTClient 78:74a8d3068204 90 * @param iothub_uri Pointer to an ioThub hostname received in the registration process
AzureIoTClient 78:74a8d3068204 91 * @param device_id Pointer to the device Id of the device
AzureIoTClient 78:74a8d3068204 92 * @param protocol Function pointer for protocol implementation
AzureIoTClient 78:74a8d3068204 93 *
AzureIoTClient 78:74a8d3068204 94 * @return A non-NULL @c IOTHUB_CLIENT_LL_HANDLE value that is used when
AzureIoTClient 78:74a8d3068204 95 * invoking other functions for IoT Hub client and @c NULL on failure.
AzureIoTClient 78:74a8d3068204 96 */
AzureIoTClient 78:74a8d3068204 97 MOCKABLE_FUNCTION(, IOTHUB_CLIENT_HANDLE, IoTHubClient_CreateFromDeviceAuth, const char*, iothub_uri, const char*, device_id, IOTHUB_CLIENT_TRANSPORT_PROVIDER, protocol);
AzureIoTClient 78:74a8d3068204 98
AzureIoTClient 78:74a8d3068204 99 /**
AzureIoTClient 53:1e5a1ca1f274 100 * @brief Disposes of resources allocated by the IoT Hub client. This is a
AzureIoTClient 53:1e5a1ca1f274 101 * blocking call.
AzureIoTClient 53:1e5a1ca1f274 102 *
AzureIoTClient 53:1e5a1ca1f274 103 * @param iotHubClientHandle The handle created by a call to the create function.
AzureIoTClient 53:1e5a1ca1f274 104 */
AzureIoTClient 53:1e5a1ca1f274 105 MOCKABLE_FUNCTION(, void, IoTHubClient_Destroy, IOTHUB_CLIENT_HANDLE, iotHubClientHandle);
AzureIoTClient 16:deba40344375 106
AzureIoTClient 53:1e5a1ca1f274 107 /**
AzureIoTClient 53:1e5a1ca1f274 108 * @brief Asynchronous call to send the message specified by @p eventMessageHandle.
AzureIoTClient 53:1e5a1ca1f274 109 *
AzureIoTClient 53:1e5a1ca1f274 110 * @param iotHubClientHandle The handle created by a call to the create function.
AzureIoTClient 53:1e5a1ca1f274 111 * @param eventMessageHandle The handle to an IoT Hub message.
AzureIoTClient 53:1e5a1ca1f274 112 * @param eventConfirmationCallback The callback specified by the device for receiving
AzureIoTClient 53:1e5a1ca1f274 113 * confirmation of the delivery of the IoT Hub message.
AzureIoTClient 53:1e5a1ca1f274 114 * This callback can be expected to invoke the
AzureIoTClient 53:1e5a1ca1f274 115 * ::IoTHubClient_SendEventAsync function for the
AzureIoTClient 53:1e5a1ca1f274 116 * same message in an attempt to retry sending a failing
AzureIoTClient 53:1e5a1ca1f274 117 * message. The user can specify a @c NULL value here to
AzureIoTClient 53:1e5a1ca1f274 118 * indicate that no callback is required.
AzureIoTClient 53:1e5a1ca1f274 119 * @param userContextCallback User specified context that will be provided to the
AzureIoTClient 53:1e5a1ca1f274 120 * callback. This can be @c NULL.
AzureIoTClient 53:1e5a1ca1f274 121 *
AzureIoTClient 53:1e5a1ca1f274 122 * @b NOTE: The application behavior is undefined if the user calls
AzureIoTClient 53:1e5a1ca1f274 123 * the ::IoTHubClient_Destroy function from within any callback.
AzureIoTClient 53:1e5a1ca1f274 124 *
AzureIoTClient 53:1e5a1ca1f274 125 * @return IOTHUB_CLIENT_OK upon success or an error code upon failure.
AzureIoTClient 53:1e5a1ca1f274 126 */
AzureIoTClient 53:1e5a1ca1f274 127 MOCKABLE_FUNCTION(, IOTHUB_CLIENT_RESULT, IoTHubClient_SendEventAsync, IOTHUB_CLIENT_HANDLE, iotHubClientHandle, IOTHUB_MESSAGE_HANDLE, eventMessageHandle, IOTHUB_CLIENT_EVENT_CONFIRMATION_CALLBACK, eventConfirmationCallback, void*, userContextCallback);
AzureIoTClient 16:deba40344375 128
AzureIoTClient 53:1e5a1ca1f274 129 /**
AzureIoTClient 53:1e5a1ca1f274 130 * @brief This function returns the current sending status for IoTHubClient.
AzureIoTClient 53:1e5a1ca1f274 131 *
AzureIoTClient 53:1e5a1ca1f274 132 * @param iotHubClientHandle The handle created by a call to the create function.
AzureIoTClient 53:1e5a1ca1f274 133 * @param iotHubClientStatus The sending state is populated at the address pointed
AzureIoTClient 53:1e5a1ca1f274 134 * at by this parameter. The value will be set to
AzureIoTClient 53:1e5a1ca1f274 135 * @c IOTHUBCLIENT_SENDSTATUS_IDLE if there is currently
AzureIoTClient 53:1e5a1ca1f274 136 * no item to be sent and @c IOTHUBCLIENT_SENDSTATUS_BUSY
AzureIoTClient 53:1e5a1ca1f274 137 * if there are.
AzureIoTClient 53:1e5a1ca1f274 138 *
AzureIoTClient 53:1e5a1ca1f274 139 * @return IOTHUB_CLIENT_OK upon success or an error code upon failure.
AzureIoTClient 53:1e5a1ca1f274 140 */
AzureIoTClient 53:1e5a1ca1f274 141 MOCKABLE_FUNCTION(, IOTHUB_CLIENT_RESULT, IoTHubClient_GetSendStatus, IOTHUB_CLIENT_HANDLE, iotHubClientHandle, IOTHUB_CLIENT_STATUS*, iotHubClientStatus);
AzureIoTClient 16:deba40344375 142
AzureIoTClient 53:1e5a1ca1f274 143 /**
AzureIoTClient 53:1e5a1ca1f274 144 * @brief Sets up the message callback to be invoked when IoT Hub issues a
AzureIoTClient 53:1e5a1ca1f274 145 * message to the device. This is a blocking call.
AzureIoTClient 53:1e5a1ca1f274 146 *
AzureIoTClient 53:1e5a1ca1f274 147 * @param iotHubClientHandle The handle created by a call to the create function.
AzureIoTClient 53:1e5a1ca1f274 148 * @param messageCallback The callback specified by the device for receiving
AzureIoTClient 53:1e5a1ca1f274 149 * messages from IoT Hub.
AzureIoTClient 53:1e5a1ca1f274 150 * @param userContextCallback User specified context that will be provided to the
AzureIoTClient 53:1e5a1ca1f274 151 * callback. This can be @c NULL.
AzureIoTClient 53:1e5a1ca1f274 152 *
AzureIoTClient 53:1e5a1ca1f274 153 * @b NOTE: The application behavior is undefined if the user calls
AzureIoTClient 53:1e5a1ca1f274 154 * the ::IoTHubClient_Destroy function from within any callback.
AzureIoTClient 53:1e5a1ca1f274 155 *
AzureIoTClient 53:1e5a1ca1f274 156 * @return IOTHUB_CLIENT_OK upon success or an error code upon failure.
AzureIoTClient 53:1e5a1ca1f274 157 */
AzureIoTClient 53:1e5a1ca1f274 158 MOCKABLE_FUNCTION(, IOTHUB_CLIENT_RESULT, IoTHubClient_SetMessageCallback, IOTHUB_CLIENT_HANDLE, iotHubClientHandle, IOTHUB_CLIENT_MESSAGE_CALLBACK_ASYNC, messageCallback, void*, userContextCallback);
AzureIoTClient 16:deba40344375 159
AzureIoTClient 52:1cc3c6d07cad 160 /**
AzureIoTClient 52:1cc3c6d07cad 161 * @brief Sets up the connection status callback to be invoked representing the status of
AzureIoTClient 52:1cc3c6d07cad 162 * the connection to IOT Hub. This is a blocking call.
AzureIoTClient 52:1cc3c6d07cad 163 *
AzureIoTClient 52:1cc3c6d07cad 164 * @param iotHubClientHandle The handle created by a call to the create function.
AzureIoTClient 52:1cc3c6d07cad 165 * @param connectionStatusCallback The callback specified by the device for receiving
AzureIoTClient 52:1cc3c6d07cad 166 * updates about the status of the connection to IoT Hub.
AzureIoTClient 52:1cc3c6d07cad 167 * @param userContextCallback User specified context that will be provided to the
AzureIoTClient 52:1cc3c6d07cad 168 * callback. This can be @c NULL.
AzureIoTClient 52:1cc3c6d07cad 169 *
AzureIoTClient 52:1cc3c6d07cad 170 * @b NOTE: The application behavior is undefined if the user calls
AzureIoTClient 52:1cc3c6d07cad 171 * the ::IoTHubClient_LL_Destroy function from within any callback.
AzureIoTClient 52:1cc3c6d07cad 172 *
AzureIoTClient 52:1cc3c6d07cad 173 * @return IOTHUB_CLIENT_OK upon success or an error code upon failure.
AzureIoTClient 52:1cc3c6d07cad 174 */
AzureIoTClient 53:1e5a1ca1f274 175 MOCKABLE_FUNCTION(, IOTHUB_CLIENT_RESULT, IoTHubClient_SetConnectionStatusCallback, IOTHUB_CLIENT_HANDLE, iotHubClientHandle, IOTHUB_CLIENT_CONNECTION_STATUS_CALLBACK, connectionStatusCallback, void*, userContextCallback);
AzureIoTClient 52:1cc3c6d07cad 176
AzureIoTClient 52:1cc3c6d07cad 177 /**
AzureIoTClient 52:1cc3c6d07cad 178 * @brief Sets up the connection status callback to be invoked representing the status of
AzureIoTClient 52:1cc3c6d07cad 179 * the connection to IOT Hub. This is a blocking call.
AzureIoTClient 52:1cc3c6d07cad 180 *
AzureIoTClient 52:1cc3c6d07cad 181 * @param iotHubClientHandle The handle created by a call to the create function.
AzureIoTClient 52:1cc3c6d07cad 182 * @param retryPolicy The policy to use to reconnect to IoT Hub when a
AzureIoTClient 52:1cc3c6d07cad 183 * connection drops.
AzureIoTClient 53:1e5a1ca1f274 184 * @param retryTimeoutLimitInSeconds Maximum amount of time(seconds) to attempt reconnection when a
AzureIoTClient 52:1cc3c6d07cad 185 * connection drops to IOT Hub.
AzureIoTClient 52:1cc3c6d07cad 186 *
AzureIoTClient 52:1cc3c6d07cad 187 * @b NOTE: The application behavior is undefined if the user calls
AzureIoTClient 52:1cc3c6d07cad 188 * the ::IoTHubClient_LL_Destroy function from within any callback.
AzureIoTClient 52:1cc3c6d07cad 189 *
AzureIoTClient 52:1cc3c6d07cad 190 * @return IOTHUB_CLIENT_OK upon success or an error code upon failure.
AzureIoTClient 52:1cc3c6d07cad 191 */
AzureIoTClient 53:1e5a1ca1f274 192 MOCKABLE_FUNCTION(, IOTHUB_CLIENT_RESULT, IoTHubClient_SetRetryPolicy, IOTHUB_CLIENT_HANDLE, iotHubClientHandle, IOTHUB_CLIENT_RETRY_POLICY, retryPolicy, size_t, retryTimeoutLimitInSeconds);
AzureIoTClient 52:1cc3c6d07cad 193
AzureIoTClient 52:1cc3c6d07cad 194 /**
AzureIoTClient 52:1cc3c6d07cad 195 * @brief Sets up the connection status callback to be invoked representing the status of
AzureIoTClient 52:1cc3c6d07cad 196 * the connection to IOT Hub. This is a blocking call.
AzureIoTClient 52:1cc3c6d07cad 197 *
AzureIoTClient 52:1cc3c6d07cad 198 * @param iotHubClientHandle The handle created by a call to the create function.
AzureIoTClient 52:1cc3c6d07cad 199 * @param retryPolicy Out parameter containing the policy to use to reconnect to IoT Hub.
AzureIoTClient 53:1e5a1ca1f274 200 * @param retryTimeoutLimitInSeconds Out parameter containing maximum amount of time in seconds to attempt reconnection
AzureIoTClient 52:1cc3c6d07cad 201 to IOT Hub.
AzureIoTClient 52:1cc3c6d07cad 202 *
AzureIoTClient 52:1cc3c6d07cad 203 * @b NOTE: The application behavior is undefined if the user calls
AzureIoTClient 52:1cc3c6d07cad 204 * the ::IoTHubClient_LL_Destroy function from within any callback.
AzureIoTClient 52:1cc3c6d07cad 205 *
AzureIoTClient 52:1cc3c6d07cad 206 * @return IOTHUB_CLIENT_OK upon success or an error code upon failure.
AzureIoTClient 52:1cc3c6d07cad 207 */
AzureIoTClient 53:1e5a1ca1f274 208 MOCKABLE_FUNCTION(, IOTHUB_CLIENT_RESULT, IoTHubClient_GetRetryPolicy, IOTHUB_CLIENT_HANDLE, iotHubClientHandle, IOTHUB_CLIENT_RETRY_POLICY*, retryPolicy, size_t*, retryTimeoutLimitInSeconds);
AzureIoTClient 52:1cc3c6d07cad 209
AzureIoTClient 53:1e5a1ca1f274 210 /**
AzureIoTClient 53:1e5a1ca1f274 211 * @brief This function returns in the out parameter @p lastMessageReceiveTime
AzureIoTClient 53:1e5a1ca1f274 212 * what was the value of the @c time function when the last message was
AzureIoTClient 53:1e5a1ca1f274 213 * received at the client.
AzureIoTClient 53:1e5a1ca1f274 214 *
AzureIoTClient 53:1e5a1ca1f274 215 * @param iotHubClientHandle The handle created by a call to the create function.
AzureIoTClient 53:1e5a1ca1f274 216 * @param lastMessageReceiveTime Out parameter containing the value of @c time function
AzureIoTClient 53:1e5a1ca1f274 217 * when the last message was received.
AzureIoTClient 53:1e5a1ca1f274 218 *
AzureIoTClient 53:1e5a1ca1f274 219 * @return IOTHUB_CLIENT_OK upon success or an error code upon failure.
AzureIoTClient 53:1e5a1ca1f274 220 */
AzureIoTClient 53:1e5a1ca1f274 221 MOCKABLE_FUNCTION(, IOTHUB_CLIENT_RESULT, IoTHubClient_GetLastMessageReceiveTime, IOTHUB_CLIENT_HANDLE, iotHubClientHandle, time_t*, lastMessageReceiveTime);
AzureIoTClient 16:deba40344375 222
AzureIoTClient 53:1e5a1ca1f274 223 /**
AzureIoTClient 53:1e5a1ca1f274 224 * @brief This API sets a runtime option identified by parameter @p optionName
AzureIoTClient 53:1e5a1ca1f274 225 * to a value pointed to by @p value. @p optionName and the data type
AzureIoTClient 53:1e5a1ca1f274 226 * @p value is pointing to are specific for every option.
AzureIoTClient 53:1e5a1ca1f274 227 *
AzureIoTClient 53:1e5a1ca1f274 228 * @param iotHubClientHandle The handle created by a call to the create function.
AzureIoTClient 53:1e5a1ca1f274 229 * @param optionName Name of the option.
AzureIoTClient 53:1e5a1ca1f274 230 * @param value The value.
AzureIoTClient 53:1e5a1ca1f274 231 *
AzureIoTClient 53:1e5a1ca1f274 232 * The options that can be set via this API are:
AzureIoTClient 53:1e5a1ca1f274 233 * - @b timeout - the maximum time in milliseconds a communication is
AzureIoTClient 53:1e5a1ca1f274 234 * allowed to use. @p value is a pointer to an @c unsigned @c int with
AzureIoTClient 53:1e5a1ca1f274 235 * the timeout value in milliseconds. This is only supported for the HTTP
AzureIoTClient 53:1e5a1ca1f274 236 * protocol as of now. When the HTTP protocol uses CURL, the meaning of
AzureIoTClient 53:1e5a1ca1f274 237 * the parameter is <em>total request time</em>. When the HTTP protocol uses
AzureIoTClient 53:1e5a1ca1f274 238 * winhttp, the meaning is the same as the @c dwSendTimeout and
AzureIoTClient 53:1e5a1ca1f274 239 * @c dwReceiveTimeout parameters of the
AzureIoTClient 53:1e5a1ca1f274 240 * <a href="https://msdn.microsoft.com/en-us/library/windows/desktop/aa384116(v=vs.85).aspx">
AzureIoTClient 53:1e5a1ca1f274 241 * WinHttpSetTimeouts</a> API.
AzureIoTClient 53:1e5a1ca1f274 242 * - @b CURLOPT_LOW_SPEED_LIMIT - only available for HTTP protocol and only
AzureIoTClient 53:1e5a1ca1f274 243 * when CURL is used. It has the same meaning as CURL's option with the same
AzureIoTClient 53:1e5a1ca1f274 244 * name. @p value is pointer to a long.
AzureIoTClient 53:1e5a1ca1f274 245 * - @b CURLOPT_LOW_SPEED_TIME - only available for HTTP protocol and only
AzureIoTClient 53:1e5a1ca1f274 246 * when CURL is used. It has the same meaning as CURL's option with the same
AzureIoTClient 53:1e5a1ca1f274 247 * name. @p value is pointer to a long.
AzureIoTClient 53:1e5a1ca1f274 248 * - @b CURLOPT_FORBID_REUSE - only available for HTTP protocol and only
AzureIoTClient 53:1e5a1ca1f274 249 * when CURL is used. It has the same meaning as CURL's option with the same
AzureIoTClient 53:1e5a1ca1f274 250 * name. @p value is pointer to a long.
AzureIoTClient 53:1e5a1ca1f274 251 * - @b CURLOPT_FRESH_CONNECT - only available for HTTP protocol and only
AzureIoTClient 53:1e5a1ca1f274 252 * when CURL is used. It has the same meaning as CURL's option with the same
AzureIoTClient 53:1e5a1ca1f274 253 * name. @p value is pointer to a long.
AzureIoTClient 53:1e5a1ca1f274 254 * - @b CURLOPT_VERBOSE - only available for HTTP protocol and only
AzureIoTClient 53:1e5a1ca1f274 255 * when CURL is used. It has the same meaning as CURL's option with the same
AzureIoTClient 53:1e5a1ca1f274 256 * name. @p value is pointer to a long.
AzureIoTClient 53:1e5a1ca1f274 257 * - @b messageTimeout - the maximum time in milliseconds until a message
AzureIoTClient 53:1e5a1ca1f274 258 * is timeouted. The time starts at IoTHubClient_SendEventAsync. By default,
AzureIoTClient 53:1e5a1ca1f274 259 * messages do not expire. @p is a pointer to a uint64_t
AzureIoTClient 81:8de701563187 260 * - @b svc2cl_keep_alive_timeout_secs - the AMQP service side keep alive interval in seconds.
AzureIoTClient 72:c737b53d7689 261 * After the connection established the client requests the server to set the
AzureIoTClient 72:c737b53d7689 262 * keep alive interval for given time.
AzureIoTClient 72:c737b53d7689 263 * If it is not set then the default 240 sec applies.
AzureIoTClient 72:c737b53d7689 264 * If it is set to zero the server will not send keep alive messages to the client.
AzureIoTClient 88:248736be106e 265 * - @b cl2svc_keep_alive_send_ratio - the AMQP client side keep alive interval in seconds.
AzureIoTClient 88:248736be106e 266 * After the connection established the server requests the client to set the
AzureIoTClient 88:248736be106e 267 * keep alive interval for given time.
AzureIoTClient 88:248736be106e 268 * If it is not set then the default ratio of 1/2 is applied.
AzureIoTClient 88:248736be106e 269 * The ratio has to be greater than 0.0 and equal to or less than 0.9
AzureIoTClient 81:8de701563187 270
AzureIoTClient 53:1e5a1ca1f274 271 * @return IOTHUB_CLIENT_OK upon success or an error code upon failure.
AzureIoTClient 53:1e5a1ca1f274 272 */
AzureIoTClient 53:1e5a1ca1f274 273 MOCKABLE_FUNCTION(, IOTHUB_CLIENT_RESULT, IoTHubClient_SetOption, IOTHUB_CLIENT_HANDLE, iotHubClientHandle, const char*, optionName, const void*, value);
AzureIoTClient 53:1e5a1ca1f274 274
AzureIoTClient 53:1e5a1ca1f274 275 /**
AzureIoTClient 53:1e5a1ca1f274 276 * @brief This API specifies a call back to be used when the device receives a state update.
AzureIoTClient 53:1e5a1ca1f274 277 *
AzureIoTClient 53:1e5a1ca1f274 278 * @param iotHubClientHandle The handle created by a call to the create function.
AzureIoTClient 53:1e5a1ca1f274 279 * @param deviceTwinCallback The callback specified by the device client to be used for updating
AzureIoTClient 53:1e5a1ca1f274 280 * the desired state. The callback will be called in response to a
AzureIoTClient 53:1e5a1ca1f274 281 * request send by the IoTHub services. The payload will be passed to the
AzureIoTClient 53:1e5a1ca1f274 282 * callback, along with two version numbers:
AzureIoTClient 53:1e5a1ca1f274 283 * - Desired:
AzureIoTClient 53:1e5a1ca1f274 284 * - LastSeenReported:
AzureIoTClient 53:1e5a1ca1f274 285 * @param userContextCallback User specified context that will be provided to the
AzureIoTClient 53:1e5a1ca1f274 286 * callback. This can be @c NULL.
AzureIoTClient 53:1e5a1ca1f274 287 *
AzureIoTClient 53:1e5a1ca1f274 288 * @b NOTE: The application behavior is undefined if the user calls
AzureIoTClient 53:1e5a1ca1f274 289 * the ::IoTHubClient_Destroy function from within any callback.
AzureIoTClient 53:1e5a1ca1f274 290 *
AzureIoTClient 53:1e5a1ca1f274 291 * @return IOTHUB_CLIENT_OK upon success or an error code upon failure.
AzureIoTClient 53:1e5a1ca1f274 292 */
AzureIoTClient 53:1e5a1ca1f274 293 MOCKABLE_FUNCTION(, IOTHUB_CLIENT_RESULT, IoTHubClient_SetDeviceTwinCallback, IOTHUB_CLIENT_HANDLE, iotHubClientHandle, IOTHUB_CLIENT_DEVICE_TWIN_CALLBACK, deviceTwinCallback, void*, userContextCallback);
AzureIoTClient 53:1e5a1ca1f274 294
AzureIoTClient 53:1e5a1ca1f274 295 /**
AzureIoTClient 53:1e5a1ca1f274 296 * @brief This API sends a report of the device's properties and their current values.
AzureIoTClient 53:1e5a1ca1f274 297 *
AzureIoTClient 53:1e5a1ca1f274 298 * @param iotHubClientHandle The handle created by a call to the create function.
AzureIoTClient 53:1e5a1ca1f274 299 * @param reportedState The current device property values to be 'reported' to the IoTHub.
AzureIoTClient 53:1e5a1ca1f274 300 * @param reportedStateCallback The callback specified by the device client to be called with the
AzureIoTClient 53:1e5a1ca1f274 301 * result of the transaction.
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_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_SendReportedState, IOTHUB_CLIENT_HANDLE, iotHubClientHandle, const unsigned char*, reportedState, size_t, size, IOTHUB_CLIENT_REPORTED_STATE_CALLBACK, reportedStateCallback, void*, userContextCallback);
AzureIoTClient 53:1e5a1ca1f274 311
AzureIoTClient 53:1e5a1ca1f274 312 /**
AzureIoTClient 53:1e5a1ca1f274 313 * @brief This API sets callback for cloud to device method call.
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 deviceMethodCallback The callback which will be called by IoTHub.
AzureIoTClient 53:1e5a1ca1f274 317 * @param userContextCallback User specified context that will be provided to the
AzureIoTClient 53:1e5a1ca1f274 318 * callback. This can be @c NULL.
AzureIoTClient 53:1e5a1ca1f274 319 *
AzureIoTClient 53:1e5a1ca1f274 320 * @return IOTHUB_CLIENT_OK upon success or an error code upon failure.
AzureIoTClient 53:1e5a1ca1f274 321 */
AzureIoTClient 53:1e5a1ca1f274 322 MOCKABLE_FUNCTION(, IOTHUB_CLIENT_RESULT, IoTHubClient_SetDeviceMethodCallback, IOTHUB_CLIENT_HANDLE, iotHubClientHandle, IOTHUB_CLIENT_DEVICE_METHOD_CALLBACK_ASYNC, deviceMethodCallback, void*, userContextCallback);
AzureIoTClient 43:038d8511e817 323
AzureIoTClient 55:59b527ab3452 324 /**
AzureIoTClient 55:59b527ab3452 325 * @brief This API sets callback for async cloud to device method call.
AzureIoTClient 55:59b527ab3452 326 *
AzureIoTClient 55:59b527ab3452 327 * @param iotHubClientHandle The handle created by a call to the create function.
AzureIoTClient 55:59b527ab3452 328 * @param inboundDeviceMethodCallback The callback which will be called by IoTHub.
AzureIoTClient 55:59b527ab3452 329 * @param userContextCallback User specified context that will be provided to the
AzureIoTClient 55:59b527ab3452 330 * callback. This can be @c NULL.
AzureIoTClient 55:59b527ab3452 331 *
AzureIoTClient 55:59b527ab3452 332 * @return IOTHUB_CLIENT_OK upon success or an error code upon failure.
AzureIoTClient 55:59b527ab3452 333 */
AzureIoTClient 55:59b527ab3452 334 MOCKABLE_FUNCTION(, IOTHUB_CLIENT_RESULT, IoTHubClient_SetDeviceMethodCallback_Ex, IOTHUB_CLIENT_HANDLE, iotHubClientHandle, IOTHUB_CLIENT_INBOUND_DEVICE_METHOD_CALLBACK, inboundDeviceMethodCallback, void*, userContextCallback);
AzureIoTClient 55:59b527ab3452 335
AzureIoTClient 55:59b527ab3452 336 /**
AzureIoTClient 55:59b527ab3452 337 * @brief This API responses to a asnyc method callback identified the methodId.
AzureIoTClient 55:59b527ab3452 338 *
AzureIoTClient 55:59b527ab3452 339 * @param iotHubClientHandle The handle created by a call to the create function.
AzureIoTClient 55:59b527ab3452 340 * @param methodId The methodId of the Device Method callback.
AzureIoTClient 55:59b527ab3452 341 * @param response The response data for the method callback.
AzureIoTClient 55:59b527ab3452 342 * @param response_size The size of the response data buffer.
AzureIoTClient 55:59b527ab3452 343 * @param status_response The status response of the method callback.
AzureIoTClient 55:59b527ab3452 344 *
AzureIoTClient 55:59b527ab3452 345 * @return IOTHUB_CLIENT_OK upon success or an error code upon failure.
AzureIoTClient 55:59b527ab3452 346 */
AzureIoTClient 55:59b527ab3452 347 MOCKABLE_FUNCTION(, IOTHUB_CLIENT_RESULT, IoTHubClient_DeviceMethodResponse, IOTHUB_CLIENT_HANDLE, iotHubClientHandle, METHOD_HANDLE, methodId, const unsigned char*, response, size_t, response_size, int, statusCode);
AzureIoTClient 55:59b527ab3452 348
AzureIoTClient 44:33dd78697616 349 #ifndef DONT_USE_UPLOADTOBLOB
AzureIoTClient 42:448eecc3676e 350 /**
AzureIoTClient 42:448eecc3676e 351 * @brief IoTHubClient_UploadToBlobAsync uploads data from memory to a file in Azure Blob Storage.
AzureIoTClient 42:448eecc3676e 352 *
AzureIoTClient 42:448eecc3676e 353 * @param iotHubClientHandle The handle created by a call to the IoTHubClient_Create function.
AzureIoTClient 42:448eecc3676e 354 * @param destinationFileName The name of the file to be created in Azure Blob Storage.
AzureIoTClient 42:448eecc3676e 355 * @param source The source of data.
AzureIoTClient 42:448eecc3676e 356 * @param size The size of data.
AzureIoTClient 42:448eecc3676e 357 * @param iotHubClientFileUploadCallback A callback to be invoked when the file upload operation has finished.
AzureIoTClient 42:448eecc3676e 358 * @param context A user-provided context to be passed to the file upload callback.
AzureIoTClient 42:448eecc3676e 359 *
AzureIoTClient 42:448eecc3676e 360 * @return IOTHUB_CLIENT_OK upon success or an error code upon failure.
AzureIoTClient 42:448eecc3676e 361 */
AzureIoTClient 53:1e5a1ca1f274 362 MOCKABLE_FUNCTION(, IOTHUB_CLIENT_RESULT, IoTHubClient_UploadToBlobAsync, IOTHUB_CLIENT_HANDLE, iotHubClientHandle, const char*, destinationFileName, const unsigned char*, source, size_t, size, IOTHUB_CLIENT_FILE_UPLOAD_CALLBACK, iotHubClientFileUploadCallback, void*, context);
AzureIoTClient 80:db5f5237bc95 363
AzureIoTClient 82:f94e6bed4495 364 /**
AzureIoTClient 82:f94e6bed4495 365 ** DEPRECATED: Use IoTHubClient_UploadMultipleBlocksToBlobAsyncEx instead **
AzureIoTClient 80:db5f5237bc95 366 * @brief Uploads a file to a Blob storage in chunks, fed through the callback function provided by the user.
AzureIoTClient 80:db5f5237bc95 367 * @remarks This function allows users to upload large files in chunks, not requiring the whole file content to be passed in memory.
AzureIoTClient 80:db5f5237bc95 368 * @param iotHubClientHandle The handle created by a call to the IoTHubClient_Create function.
AzureIoTClient 80:db5f5237bc95 369 * @param destinationFileName The name of the file to be created in Azure Blob Storage.
AzureIoTClient 80:db5f5237bc95 370 * @param getDataCallback A callback to be invoked to acquire the file chunks to be uploaded, as well as to indicate the status of the upload of the previous block.
AzureIoTClient 80:db5f5237bc95 371 * @param context Any data provided by the user to serve as context on getDataCallback.
AzureIoTClient 82:f94e6bed4495 372 * @returns An IOTHUB_CLIENT_RESULT value indicating the success or failure of the API call.
AzureIoTClient 82:f94e6bed4495 373 ** DEPRECATED: Use IoTHubClient_UploadMultipleBlocksToBlobAsyncEx instead **
AzureIoTClient 82:f94e6bed4495 374 */
AzureIoTClient 82:f94e6bed4495 375 MOCKABLE_FUNCTION(, IOTHUB_CLIENT_RESULT, IoTHubClient_UploadMultipleBlocksToBlobAsync, IOTHUB_CLIENT_HANDLE, iotHubClientHandle, const char*, destinationFileName, IOTHUB_CLIENT_FILE_UPLOAD_GET_DATA_CALLBACK, getDataCallback, void*, context);
AzureIoTClient 82:f94e6bed4495 376
AzureIoTClient 82:f94e6bed4495 377 /**
AzureIoTClient 82:f94e6bed4495 378 * @brief Uploads a file to a Blob storage in chunks, fed through the callback function provided by the user.
AzureIoTClient 82:f94e6bed4495 379 * @remarks This function allows users to upload large files in chunks, not requiring the whole file content to be passed in memory.
AzureIoTClient 82:f94e6bed4495 380 * @param iotHubClientHandle The handle created by a call to the IoTHubClient_Create function.
AzureIoTClient 82:f94e6bed4495 381 * @param destinationFileName The name of the file to be created in Azure Blob Storage.
AzureIoTClient 82:f94e6bed4495 382 * @param getDataCallbackEx A callback to be invoked to acquire the file chunks to be uploaded, as well as to indicate the status of the upload of the previous block.
AzureIoTClient 82:f94e6bed4495 383 * @param context Any data provided by the user to serve as context on getDataCallback.
AzureIoTClient 80:db5f5237bc95 384 * @returns An IOTHUB_CLIENT_RESULT value indicating the success or failure of the API call.*/
AzureIoTClient 82:f94e6bed4495 385 MOCKABLE_FUNCTION(, IOTHUB_CLIENT_RESULT, IoTHubClient_UploadMultipleBlocksToBlobAsyncEx, IOTHUB_CLIENT_HANDLE, iotHubClientHandle, const char*, destinationFileName, IOTHUB_CLIENT_FILE_UPLOAD_GET_DATA_CALLBACK_EX, getDataCallbackEx, void*, context);
AzureIoTClient 82:f94e6bed4495 386
AzureIoTClient 80:db5f5237bc95 387 #endif /* DONT_USE_UPLOADTOBLOB */
AzureIoTClient 80:db5f5237bc95 388
AzureIoTClient 16:deba40344375 389 #ifdef __cplusplus
AzureIoTClient 16:deba40344375 390 }
AzureIoTClient 16:deba40344375 391 #endif
AzureIoTClient 16:deba40344375 392
AzureIoTClient 16:deba40344375 393 #endif /* IOTHUB_CLIENT_H */