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@37:18310e4d888d, 2016-03-25 (annotated)

Committer:
Azure.IoT Build
Date:
Fri Mar 25 16:00:25 2016 -0700
Revision:
37:18310e4d888d
Parent:
36:67300d5a4c1f
Child:
38:a05929a75111
Release 1.0.3

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