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@48:cc5d91f2b06d, 2016-08-12 (annotated)

Committer:
AzureIoTClient
Date:
Fri Aug 12 10:04:01 2016 -0700
Revision:
48:cc5d91f2b06d
Parent:
45:54c11b1b1407
Child:
52:1cc3c6d07cad
1.0.10

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 16:deba40344375 27
AzureIoTClient 16:deba40344375 28 #define IOTHUB_CLIENT_RESULT_VALUES \
AzureIoTClient 16:deba40344375 29 IOTHUB_CLIENT_OK, \
AzureIoTClient 16:deba40344375 30 IOTHUB_CLIENT_INVALID_ARG, \
AzureIoTClient 16:deba40344375 31 IOTHUB_CLIENT_ERROR, \
AzureIoTClient 16:deba40344375 32 IOTHUB_CLIENT_INVALID_SIZE, \
AzureIoTClient 16:deba40344375 33 IOTHUB_CLIENT_INDEFINITE_TIME \
AzureIoTClient 16:deba40344375 34
AzureIoTClient 43:038d8511e817 35 /** @brief Enumeration specifying the status of calls to various APIs in this module.
AzureIoTClient 43:038d8511e817 36 */
AzureIoTClient 43:038d8511e817 37
AzureIoTClient 43:038d8511e817 38 DEFINE_ENUM(IOTHUB_CLIENT_RESULT, IOTHUB_CLIENT_RESULT_VALUES);
AzureIoTClient 43:038d8511e817 39
AzureIoTClient 48:cc5d91f2b06d 40 struct IOTHUBTRANSPORT_CONFIG_TAG;
AzureIoTClient 43:038d8511e817 41 typedef struct IOTHUBTRANSPORT_CONFIG_TAG IOTHUBTRANSPORT_CONFIG;
AzureIoTClient 43:038d8511e817 42
AzureIoTClient 43:038d8511e817 43 typedef struct IOTHUB_CLIENT_LL_HANDLE_DATA_TAG* IOTHUB_CLIENT_LL_HANDLE;
AzureIoTClient 43:038d8511e817 44
AzureIoTClient 43:038d8511e817 45 #define IOTHUB_CLIENT_STATUS_VALUES \
AzureIoTClient 43:038d8511e817 46 IOTHUB_CLIENT_SEND_STATUS_IDLE, \
AzureIoTClient 43:038d8511e817 47 IOTHUB_CLIENT_SEND_STATUS_BUSY \
AzureIoTClient 43:038d8511e817 48
AzureIoTClient 43:038d8511e817 49 /** @brief Enumeration returned by the ::IoTHubClient_LL_GetSendStatus
AzureIoTClient 43:038d8511e817 50 * API to indicate the current sending status of the IoT Hub client.
AzureIoTClient 43:038d8511e817 51 */
AzureIoTClient 43:038d8511e817 52 DEFINE_ENUM(IOTHUB_CLIENT_STATUS, IOTHUB_CLIENT_STATUS_VALUES);
AzureIoTClient 43:038d8511e817 53
AzureIoTClient 43:038d8511e817 54 #include "azure_c_shared_utility/agenttime.h"
AzureIoTClient 43:038d8511e817 55 #include "azure_c_shared_utility/xio.h"
AzureIoTClient 43:038d8511e817 56 #include "azure_c_shared_utility/doublylinkedlist.h"
AzureIoTClient 43:038d8511e817 57 #include "iothub_message.h"
AzureIoTClient 43:038d8511e817 58 #include "iothub_transport_ll.h"
AzureIoTClient 43:038d8511e817 59
AzureIoTClient 43:038d8511e817 60 #ifdef __cplusplus
AzureIoTClient 43:038d8511e817 61 extern "C"
AzureIoTClient 43:038d8511e817 62 {
AzureIoTClient 43:038d8511e817 63 #endif
AzureIoTClient 16:deba40344375 64
AzureIoTClient 16:deba40344375 65 #define IOTHUB_CLIENT_CONFIRMATION_RESULT_VALUES \
AzureIoTClient 16:deba40344375 66 IOTHUB_CLIENT_CONFIRMATION_OK, \
AzureIoTClient 16:deba40344375 67 IOTHUB_CLIENT_CONFIRMATION_BECAUSE_DESTROY, \
Azure.IoT Build 36:67300d5a4c1f 68 IOTHUB_CLIENT_CONFIRMATION_MESSAGE_TIMEOUT, \
AzureIoTClient 16:deba40344375 69 IOTHUB_CLIENT_CONFIRMATION_ERROR \
AzureIoTClient 16:deba40344375 70
AzureIoTClient 40:1a94db9139ea 71 /** @brief Enumeration passed in by the IoT Hub when the event confirmation
AzureIoTClient 40:1a94db9139ea 72 * callback is invoked to indicate status of the event processing in
AzureIoTClient 40:1a94db9139ea 73 * the hub.
AzureIoTClient 40:1a94db9139ea 74 */
AzureIoTClient 40:1a94db9139ea 75 DEFINE_ENUM(IOTHUB_CLIENT_CONFIRMATION_RESULT, IOTHUB_CLIENT_CONFIRMATION_RESULT_VALUES);
AzureIoTClient 16:deba40344375 76
AzureIoTClient 16:deba40344375 77 #define TRANSPORT_TYPE_VALUES \
AzureIoTClient 16:deba40344375 78 TRANSPORT_LL, /*LL comes from "LowLevel" */ \
AzureIoTClient 16:deba40344375 79 TRANSPORT_THREADED
AzureIoTClient 16:deba40344375 80
AzureIoTClient 40:1a94db9139ea 81 DEFINE_ENUM(TRANSPORT_TYPE, TRANSPORT_TYPE_VALUES);
AzureIoTClient 16:deba40344375 82
AzureIoTClient 16:deba40344375 83 #define IOTHUBMESSAGE_DISPOSITION_RESULT_VALUES \
AzureIoTClient 16:deba40344375 84 IOTHUBMESSAGE_ACCEPTED, \
AzureIoTClient 16:deba40344375 85 IOTHUBMESSAGE_REJECTED, \
AzureIoTClient 16:deba40344375 86 IOTHUBMESSAGE_ABANDONED
AzureIoTClient 16:deba40344375 87
AzureIoTClient 40:1a94db9139ea 88 /** @brief Enumeration returned by the callback which is invoked whenever the
AzureIoTClient 40:1a94db9139ea 89 * IoT Hub sends a message to the device.
AzureIoTClient 40:1a94db9139ea 90 */
AzureIoTClient 40:1a94db9139ea 91 DEFINE_ENUM(IOTHUBMESSAGE_DISPOSITION_RESULT, IOTHUBMESSAGE_DISPOSITION_RESULT_VALUES);
AzureIoTClient 16:deba40344375 92
AzureIoTClient 43:038d8511e817 93
AzureIoTClient 40:1a94db9139ea 94 typedef void(*IOTHUB_CLIENT_EVENT_CONFIRMATION_CALLBACK)(IOTHUB_CLIENT_CONFIRMATION_RESULT result, void* userContextCallback);
AzureIoTClient 40:1a94db9139ea 95 typedef IOTHUBMESSAGE_DISPOSITION_RESULT (*IOTHUB_CLIENT_MESSAGE_CALLBACK_ASYNC)(IOTHUB_MESSAGE_HANDLE message, void* userContextCallback);
AzureIoTClient 43:038d8511e817 96 typedef const TRANSPORT_PROVIDER*(*IOTHUB_CLIENT_TRANSPORT_PROVIDER)(void);
AzureIoTClient 16:deba40344375 97
AzureIoTClient 40:1a94db9139ea 98 /** @brief This struct captures IoTHub client configuration. */
AzureIoTClient 40:1a94db9139ea 99 typedef struct IOTHUB_CLIENT_CONFIG_TAG
AzureIoTClient 40:1a94db9139ea 100 {
AzureIoTClient 40:1a94db9139ea 101 /** @brief A function pointer that is passed into the @c IoTHubClientCreate.
AzureIoTClient 40:1a94db9139ea 102 * A function definition for AMQP is defined in the include @c iothubtransportamqp.h.
AzureIoTClient 40:1a94db9139ea 103 * A function definition for HTTP is defined in the include @c iothubtransporthttp.h
AzureIoTClient 40:1a94db9139ea 104 * A function definition for MQTT is defined in the include @c iothubtransportmqtt.h */
AzureIoTClient 40:1a94db9139ea 105 IOTHUB_CLIENT_TRANSPORT_PROVIDER protocol;
AzureIoTClient 16:deba40344375 106
AzureIoTClient 40:1a94db9139ea 107 /** @brief A string that identifies the device. */
AzureIoTClient 40:1a94db9139ea 108 const char* deviceId;
AzureIoTClient 40:1a94db9139ea 109
Azure.IoT Build 45:54c11b1b1407 110 /** @brief The device key used to authenticate the device.
Azure.IoT Build 45:54c11b1b1407 111 If neither deviceSasToken nor deviceKey is present then the authentication is assumed x509.*/
AzureIoTClient 40:1a94db9139ea 112 const char* deviceKey;
AzureIoTClient 40:1a94db9139ea 113
Azure.IoT Build 45:54c11b1b1407 114 /** @brief The device SAS Token used to authenticate the device in place of device key.
Azure.IoT Build 45:54c11b1b1407 115 If neither deviceSasToken nor deviceKey is present then the authentication is assumed x509.*/
AzureIoTClient 40:1a94db9139ea 116 const char* deviceSasToken;
AzureIoTClient 40:1a94db9139ea 117
AzureIoTClient 40:1a94db9139ea 118 /** @brief The IoT Hub name to which the device is connecting. */
AzureIoTClient 40:1a94db9139ea 119 const char* iotHubName;
AzureIoTClient 16:deba40344375 120
AzureIoTClient 40:1a94db9139ea 121 /** @brief IoT Hub suffix goes here, e.g., private.azure-devices-int.net. */
AzureIoTClient 40:1a94db9139ea 122 const char* iotHubSuffix;
AzureIoTClient 16:deba40344375 123
AzureIoTClient 40:1a94db9139ea 124 const char* protocolGatewayHostName;
AzureIoTClient 40:1a94db9139ea 125 } IOTHUB_CLIENT_CONFIG;
AzureIoTClient 16:deba40344375 126
AzureIoTClient 40:1a94db9139ea 127 /** @brief This struct captures IoTHub client device configuration. */
AzureIoTClient 40:1a94db9139ea 128 typedef struct IOTHUB_CLIENT_DEVICE_CONFIG_TAG
AzureIoTClient 40:1a94db9139ea 129 {
AzureIoTClient 40:1a94db9139ea 130 /** @brief A function pointer that is passed into the @c IoTHubClientCreate.
AzureIoTClient 40:1a94db9139ea 131 * A function definition for AMQP is defined in the include @c iothubtransportamqp.h.
AzureIoTClient 40:1a94db9139ea 132 * A function definition for HTTP is defined in the include @c iothubtransporthttp.h
AzureIoTClient 40:1a94db9139ea 133 * A function definition for MQTT is defined in the include @c iothubtransportmqtt.h */
AzureIoTClient 40:1a94db9139ea 134 IOTHUB_CLIENT_TRANSPORT_PROVIDER protocol;
Azure.IoT Build 36:67300d5a4c1f 135
AzureIoTClient 40:1a94db9139ea 136 /** @brief a transport handle implementing the protocol */
AzureIoTClient 40:1a94db9139ea 137 void * transportHandle;
Azure.IoT Build 36:67300d5a4c1f 138
AzureIoTClient 40:1a94db9139ea 139 /** @brief A string that identifies the device. */
AzureIoTClient 40:1a94db9139ea 140 const char* deviceId;
Azure.IoT Build 36:67300d5a4c1f 141
Azure.IoT Build 45:54c11b1b1407 142 /** @brief The device key used to authenticate the device.
Azure.IoT Build 45:54c11b1b1407 143 x509 authentication is is not supported for multiplexed connections*/
AzureIoTClient 40:1a94db9139ea 144 const char* deviceKey;
Azure.IoT Build 36:67300d5a4c1f 145
Azure.IoT Build 45:54c11b1b1407 146 /** @brief The device SAS Token used to authenticate the device in place of device key.
Azure.IoT Build 45:54c11b1b1407 147 x509 authentication is is not supported for multiplexed connections.*/
AzureIoTClient 40:1a94db9139ea 148 const char* deviceSasToken;
AzureIoTClient 40:1a94db9139ea 149 } IOTHUB_CLIENT_DEVICE_CONFIG;
Azure.IoT Build 36:67300d5a4c1f 150
AzureIoTClient 40:1a94db9139ea 151 /** @brief This struct captures IoTHub transport configuration. */
AzureIoTClient 48:cc5d91f2b06d 152 struct IOTHUBTRANSPORT_CONFIG_TAG
AzureIoTClient 40:1a94db9139ea 153 {
AzureIoTClient 40:1a94db9139ea 154 const IOTHUB_CLIENT_CONFIG* upperConfig;
AzureIoTClient 40:1a94db9139ea 155 PDLIST_ENTRY waitingToSend;
AzureIoTClient 48:cc5d91f2b06d 156 };
Azure.IoT Build 37:18310e4d888d 157
Azure.IoT Build 37:18310e4d888d 158
AzureIoTClient 40:1a94db9139ea 159 /**
AzureIoTClient 40:1a94db9139ea 160 * @brief Creates a IoT Hub client for communication with an existing
AzureIoTClient 40:1a94db9139ea 161 * IoT Hub using the specified connection string parameter.
AzureIoTClient 40:1a94db9139ea 162 *
AzureIoTClient 40:1a94db9139ea 163 * @param connectionString Pointer to a character string
AzureIoTClient 40:1a94db9139ea 164 * @param protocol Function pointer for protocol implementation
AzureIoTClient 40:1a94db9139ea 165 *
AzureIoTClient 40:1a94db9139ea 166 * Sample connection string:
AzureIoTClient 40:1a94db9139ea 167 * <blockquote>
AzureIoTClient 40:1a94db9139ea 168 * <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 40:1a94db9139ea 169 * </blockquote>
AzureIoTClient 40:1a94db9139ea 170 *
AzureIoTClient 40:1a94db9139ea 171 * @return A non-NULL @c IOTHUB_CLIENT_LL_HANDLE value that is used when
AzureIoTClient 40:1a94db9139ea 172 * invoking other functions for IoT Hub client and @c NULL on failure.
AzureIoTClient 40:1a94db9139ea 173 */
AzureIoTClient 40:1a94db9139ea 174 extern IOTHUB_CLIENT_LL_HANDLE IoTHubClient_LL_CreateFromConnectionString(const char* connectionString, IOTHUB_CLIENT_TRANSPORT_PROVIDER protocol);
AzureIoTClient 16:deba40344375 175
AzureIoTClient 40:1a94db9139ea 176 /**
AzureIoTClient 40:1a94db9139ea 177 * @brief Creates a IoT Hub client for communication with an existing IoT
AzureIoTClient 40:1a94db9139ea 178 * Hub using the specified parameters.
AzureIoTClient 40:1a94db9139ea 179 *
AzureIoTClient 40:1a94db9139ea 180 * @param config Pointer to an @c IOTHUB_CLIENT_CONFIG structure
AzureIoTClient 40:1a94db9139ea 181 *
AzureIoTClient 40:1a94db9139ea 182 * The API does not allow sharing of a connection across multiple
AzureIoTClient 40:1a94db9139ea 183 * devices. This is a blocking call.
AzureIoTClient 40:1a94db9139ea 184 *
AzureIoTClient 40:1a94db9139ea 185 * @return A non-NULL @c IOTHUB_CLIENT_LL_HANDLE value that is used when
AzureIoTClient 40:1a94db9139ea 186 * invoking other functions for IoT Hub client and @c NULL on failure.
AzureIoTClient 40:1a94db9139ea 187 */
AzureIoTClient 40:1a94db9139ea 188 extern IOTHUB_CLIENT_LL_HANDLE IoTHubClient_LL_Create(const IOTHUB_CLIENT_CONFIG* config);
AzureIoTClient 16:deba40344375 189
AzureIoTClient 40:1a94db9139ea 190 /**
AzureIoTClient 40:1a94db9139ea 191 * @brief Creates a IoT Hub client for communication with an existing IoT
AzureIoTClient 40:1a94db9139ea 192 * Hub using an existing transport.
AzureIoTClient 40:1a94db9139ea 193 *
AzureIoTClient 40:1a94db9139ea 194 * @param config Pointer to an @c IOTHUB_CLIENT_DEVICE_CONFIG structure
AzureIoTClient 40:1a94db9139ea 195 *
AzureIoTClient 40:1a94db9139ea 196 * The API *allows* sharing of a connection across multiple
AzureIoTClient 40:1a94db9139ea 197 * devices. This is a blocking call.
AzureIoTClient 40:1a94db9139ea 198 *
AzureIoTClient 40:1a94db9139ea 199 * @return A non-NULL @c IOTHUB_CLIENT_LL_HANDLE value that is used when
AzureIoTClient 40:1a94db9139ea 200 * invoking other functions for IoT Hub client and @c NULL on failure.
AzureIoTClient 40:1a94db9139ea 201 */
AzureIoTClient 40:1a94db9139ea 202 extern IOTHUB_CLIENT_LL_HANDLE IoTHubClient_LL_CreateWithTransport(const IOTHUB_CLIENT_DEVICE_CONFIG * config);
Azure.IoT Build 36:67300d5a4c1f 203
AzureIoTClient 40:1a94db9139ea 204 /**
AzureIoTClient 40:1a94db9139ea 205 * @brief Disposes of resources allocated by the IoT Hub client. This is a
AzureIoTClient 40:1a94db9139ea 206 * blocking call.
AzureIoTClient 40:1a94db9139ea 207 *
AzureIoTClient 40:1a94db9139ea 208 * @param iotHubClientHandle The handle created by a call to the create function.
AzureIoTClient 40:1a94db9139ea 209 */
AzureIoTClient 40:1a94db9139ea 210 extern void IoTHubClient_LL_Destroy(IOTHUB_CLIENT_LL_HANDLE iotHubClientHandle);
AzureIoTClient 16:deba40344375 211
AzureIoTClient 40:1a94db9139ea 212 /**
AzureIoTClient 40:1a94db9139ea 213 * @brief Asynchronous call to send the message specified by @p eventMessageHandle.
AzureIoTClient 40:1a94db9139ea 214 *
AzureIoTClient 40:1a94db9139ea 215 * @param iotHubClientHandle The handle created by a call to the create function.
AzureIoTClient 40:1a94db9139ea 216 * @param eventMessageHandle The handle to an IoT Hub message.
AzureIoTClient 40:1a94db9139ea 217 * @param eventConfirmationCallback The callback specified by the device for receiving
AzureIoTClient 40:1a94db9139ea 218 * confirmation of the delivery of the IoT Hub message.
AzureIoTClient 40:1a94db9139ea 219 * This callback can be expected to invoke the
AzureIoTClient 40:1a94db9139ea 220 * ::IoTHubClient_LL_SendEventAsync function for the
AzureIoTClient 40:1a94db9139ea 221 * same message in an attempt to retry sending a failing
AzureIoTClient 40:1a94db9139ea 222 * message. The user can specify a @c NULL value here to
AzureIoTClient 40:1a94db9139ea 223 * indicate that no callback is required.
AzureIoTClient 40:1a94db9139ea 224 * @param userContextCallback User specified context that will be provided to the
AzureIoTClient 40:1a94db9139ea 225 * callback. This can be @c NULL.
AzureIoTClient 40:1a94db9139ea 226 *
AzureIoTClient 40:1a94db9139ea 227 * @b NOTE: The application behavior is undefined if the user calls
AzureIoTClient 40:1a94db9139ea 228 * the ::IoTHubClient_LL_Destroy function from within any callback.
AzureIoTClient 40:1a94db9139ea 229 *
AzureIoTClient 40:1a94db9139ea 230 * @return IOTHUB_CLIENT_OK upon success or an error code upon failure.
AzureIoTClient 40:1a94db9139ea 231 */
AzureIoTClient 40:1a94db9139ea 232 extern 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 233
AzureIoTClient 40:1a94db9139ea 234 /**
AzureIoTClient 40:1a94db9139ea 235 * @brief This function returns the current sending status for IoTHubClient.
AzureIoTClient 40:1a94db9139ea 236 *
AzureIoTClient 40:1a94db9139ea 237 * @param iotHubClientHandle The handle created by a call to the create function.
AzureIoTClient 40:1a94db9139ea 238 * @param iotHubClientStatus The sending state is populated at the address pointed
AzureIoTClient 40:1a94db9139ea 239 * at by this parameter. The value will be set to
AzureIoTClient 40:1a94db9139ea 240 * @c IOTHUBCLIENT_SENDSTATUS_IDLE if there is currently
AzureIoTClient 40:1a94db9139ea 241 * no item to be sent and @c IOTHUBCLIENT_SENDSTATUS_BUSY
AzureIoTClient 40:1a94db9139ea 242 * if there are.
AzureIoTClient 40:1a94db9139ea 243 *
AzureIoTClient 40:1a94db9139ea 244 * @return IOTHUB_CLIENT_OK upon success or an error code upon failure.
AzureIoTClient 40:1a94db9139ea 245 */
AzureIoTClient 40:1a94db9139ea 246 extern IOTHUB_CLIENT_RESULT IoTHubClient_LL_GetSendStatus(IOTHUB_CLIENT_LL_HANDLE iotHubClientHandle, IOTHUB_CLIENT_STATUS *iotHubClientStatus);
AzureIoTClient 16:deba40344375 247
AzureIoTClient 40:1a94db9139ea 248 /**
AzureIoTClient 40:1a94db9139ea 249 * @brief Sets up the message callback to be invoked when IoT Hub issues a
AzureIoTClient 40:1a94db9139ea 250 * message to the device. This is a blocking call.
AzureIoTClient 40:1a94db9139ea 251 *
AzureIoTClient 40:1a94db9139ea 252 * @param iotHubClientHandle The handle created by a call to the create function.
AzureIoTClient 40:1a94db9139ea 253 * @param messageCallback The callback specified by the device for receiving
AzureIoTClient 40:1a94db9139ea 254 * messages from IoT Hub.
AzureIoTClient 40:1a94db9139ea 255 * @param userContextCallback User specified context that will be provided to the
AzureIoTClient 40:1a94db9139ea 256 * callback. This can be @c NULL.
AzureIoTClient 40:1a94db9139ea 257 *
AzureIoTClient 40:1a94db9139ea 258 * @b NOTE: The application behavior is undefined if the user calls
AzureIoTClient 40:1a94db9139ea 259 * the ::IoTHubClient_LL_Destroy function from within any callback.
AzureIoTClient 40:1a94db9139ea 260 *
AzureIoTClient 40:1a94db9139ea 261 * @return IOTHUB_CLIENT_OK upon success or an error code upon failure.
AzureIoTClient 40:1a94db9139ea 262 */
AzureIoTClient 40:1a94db9139ea 263 extern IOTHUB_CLIENT_RESULT IoTHubClient_LL_SetMessageCallback(IOTHUB_CLIENT_LL_HANDLE iotHubClientHandle, IOTHUB_CLIENT_MESSAGE_CALLBACK_ASYNC messageCallback, void* userContextCallback);
AzureIoTClient 16:deba40344375 264
AzureIoTClient 40:1a94db9139ea 265 /**
AzureIoTClient 40:1a94db9139ea 266 * @brief This function returns in the out parameter @p lastMessageReceiveTime
AzureIoTClient 40:1a94db9139ea 267 * what was the value of the @c time function when the last message was
AzureIoTClient 40:1a94db9139ea 268 * received at the client.
AzureIoTClient 40:1a94db9139ea 269 *
AzureIoTClient 40:1a94db9139ea 270 * @param iotHubClientHandle The handle created by a call to the create function.
AzureIoTClient 40:1a94db9139ea 271 * @param lastMessageReceiveTime Out parameter containing the value of @c time function
AzureIoTClient 40:1a94db9139ea 272 * when the last message was received.
AzureIoTClient 40:1a94db9139ea 273 *
AzureIoTClient 40:1a94db9139ea 274 * @return IOTHUB_CLIENT_OK upon success or an error code upon failure.
AzureIoTClient 40:1a94db9139ea 275 */
AzureIoTClient 40:1a94db9139ea 276 extern IOTHUB_CLIENT_RESULT IoTHubClient_LL_GetLastMessageReceiveTime(IOTHUB_CLIENT_LL_HANDLE iotHubClientHandle, time_t* lastMessageReceiveTime);
AzureIoTClient 16:deba40344375 277
AzureIoTClient 40:1a94db9139ea 278 /**
AzureIoTClient 40:1a94db9139ea 279 * @brief This function is meant to be called by the user when work
AzureIoTClient 40:1a94db9139ea 280 * (sending/receiving) can be done by the IoTHubClient.
AzureIoTClient 40:1a94db9139ea 281 *
AzureIoTClient 40:1a94db9139ea 282 * @param iotHubClientHandle The handle created by a call to the create function.
AzureIoTClient 40:1a94db9139ea 283 *
AzureIoTClient 40:1a94db9139ea 284 * All IoTHubClient interactions (in regards to network traffic
AzureIoTClient 40:1a94db9139ea 285 * and/or user level callbacks) are the effect of calling this
AzureIoTClient 40:1a94db9139ea 286 * function and they take place synchronously inside _DoWork.
AzureIoTClient 40:1a94db9139ea 287 */
AzureIoTClient 40:1a94db9139ea 288 extern void IoTHubClient_LL_DoWork(IOTHUB_CLIENT_LL_HANDLE iotHubClientHandle);
AzureIoTClient 16:deba40344375 289
AzureIoTClient 40:1a94db9139ea 290 /**
AzureIoTClient 40:1a94db9139ea 291 * @brief This API sets a runtime option identified by parameter @p optionName
AzureIoTClient 40:1a94db9139ea 292 * to a value pointed to by @p value. @p optionName and the data type
AzureIoTClient 40:1a94db9139ea 293 * @p value is pointing to are specific for every option.
AzureIoTClient 40:1a94db9139ea 294 *
AzureIoTClient 40:1a94db9139ea 295 * @param iotHubClientHandle The handle created by a call to the create function.
AzureIoTClient 40:1a94db9139ea 296 * @param optionName Name of the option.
AzureIoTClient 40:1a94db9139ea 297 * @param value The value.
AzureIoTClient 40:1a94db9139ea 298 *
AzureIoTClient 40:1a94db9139ea 299 * The options that can be set via this API are:
AzureIoTClient 40:1a94db9139ea 300 * - @b timeout - the maximum time in milliseconds a communication is
AzureIoTClient 40:1a94db9139ea 301 * allowed to use. @p value is a pointer to an @c unsigned @c int with
AzureIoTClient 40:1a94db9139ea 302 * the timeout value in milliseconds. This is only supported for the HTTP
AzureIoTClient 40:1a94db9139ea 303 * protocol as of now. When the HTTP protocol uses CURL, the meaning of
AzureIoTClient 40:1a94db9139ea 304 * the parameter is <em>total request time</em>. When the HTTP protocol uses
AzureIoTClient 40:1a94db9139ea 305 * winhttp, the meaning is the same as the @c dwSendTimeout and
AzureIoTClient 40:1a94db9139ea 306 * @c dwReceiveTimeout parameters of the
AzureIoTClient 40:1a94db9139ea 307 * <a href="https://msdn.microsoft.com/en-us/library/windows/desktop/aa384116(v=vs.85).aspx">
AzureIoTClient 40:1a94db9139ea 308 * WinHttpSetTimeouts</a> API.
AzureIoTClient 40:1a94db9139ea 309 * - @b CURLOPT_LOW_SPEED_LIMIT - only available for HTTP protocol and only
AzureIoTClient 40:1a94db9139ea 310 * when CURL is used. It has the same meaning as CURL's option with the same
AzureIoTClient 40:1a94db9139ea 311 * name. @p value is pointer to a long.
AzureIoTClient 40:1a94db9139ea 312 * - @b CURLOPT_LOW_SPEED_TIME - only available for HTTP protocol and only
AzureIoTClient 40:1a94db9139ea 313 * when CURL is used. It has the same meaning as CURL's option with the same
AzureIoTClient 40:1a94db9139ea 314 * name. @p value is pointer to a long.
AzureIoTClient 40:1a94db9139ea 315 * - @b CURLOPT_FORBID_REUSE - only available for HTTP protocol and only
AzureIoTClient 40:1a94db9139ea 316 * when CURL is used. It has the same meaning as CURL's option with the same
AzureIoTClient 40:1a94db9139ea 317 * name. @p value is pointer to a long.
AzureIoTClient 40:1a94db9139ea 318 * - @b CURLOPT_FRESH_CONNECT - only available for HTTP protocol and only
AzureIoTClient 40:1a94db9139ea 319 * when CURL is used. It has the same meaning as CURL's option with the same
AzureIoTClient 40:1a94db9139ea 320 * name. @p value is pointer to a long.
AzureIoTClient 40:1a94db9139ea 321 * - @b CURLOPT_VERBOSE - only available for HTTP protocol and only
AzureIoTClient 40:1a94db9139ea 322 * when CURL is used. It has the same meaning as CURL's option with the same
AzureIoTClient 40:1a94db9139ea 323 * name. @p value is pointer to a long.
AzureIoTClient 40:1a94db9139ea 324 * - @b keepalive - available for MQTT protocol. Integer value that sets the
AzureIoTClient 40:1a94db9139ea 325 * interval in seconds when pings are sent to the server.
AzureIoTClient 40:1a94db9139ea 326 * - @b logtrace - available for MQTT protocol. Boolean value that turns on and
AzureIoTClient 40:1a94db9139ea 327 * off the diagnostic logging.
AzureIoTClient 40:1a94db9139ea 328 *
AzureIoTClient 40:1a94db9139ea 329 * @return IOTHUB_CLIENT_OK upon success or an error code upon failure.
AzureIoTClient 40:1a94db9139ea 330 */
AzureIoTClient 40:1a94db9139ea 331 extern IOTHUB_CLIENT_RESULT IoTHubClient_LL_SetOption(IOTHUB_CLIENT_LL_HANDLE iotHubClientHandle, const char* optionName, const void* value);
AzureIoTClient 16:deba40344375 332
AzureIoTClient 44:33dd78697616 333 #ifndef DONT_USE_UPLOADTOBLOB
AzureIoTClient 43:038d8511e817 334 /**
AzureIoTClient 43:038d8511e817 335 * @brief This API uploads to Azure Storage the content pointed to by @p source having the size @p size
AzureIoTClient 43:038d8511e817 336 * under the blob name devicename/@pdestinationFileName
AzureIoTClient 43:038d8511e817 337 *
AzureIoTClient 43:038d8511e817 338 * @param iotHubClientHandle The handle created by a call to the create function.
AzureIoTClient 43:038d8511e817 339 * @param destinationFileName name of the file.
AzureIoTClient 43:038d8511e817 340 * @param source pointer to the source for file content (can be NULL)
AzureIoTClient 43:038d8511e817 341 * @param size the size of the source in memory (if @p source is NULL then size needs to be 0).
AzureIoTClient 43:038d8511e817 342 *
AzureIoTClient 43:038d8511e817 343 * @return IOTHUB_CLIENT_OK upon success or an error code upon failure.
AzureIoTClient 43:038d8511e817 344 */
AzureIoTClient 42:448eecc3676e 345 extern IOTHUB_CLIENT_RESULT IoTHubClient_LL_UploadToBlob(IOTHUB_CLIENT_LL_HANDLE iotHubClientHandle, const char* destinationFileName, const unsigned char* source, size_t size);
AzureIoTClient 42:448eecc3676e 346
AzureIoTClient 44:33dd78697616 347 #endif /*DONT_USE_UPLOADTOBLOB*/
AzureIoTClient 43:038d8511e817 348
AzureIoTClient 16:deba40344375 349 #ifdef __cplusplus
AzureIoTClient 16:deba40344375 350 }
AzureIoTClient 16:deba40344375 351 #endif
AzureIoTClient 16:deba40344375 352
AzureIoTClient 16:deba40344375 353 #endif /* IOTHUB_CLIENT_LL_H */