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@10:38383e246675, 2015-09-26 (annotated)

Committer:
AzureIoTClient
Date:
Sat Sep 26 00:18:01 2015 -0700
Revision:
10:38383e246675
Parent:
9:3ec7e2695f98 
v1.0.0-preview.3

Who changed what in which revision?

UserRevisionLine numberNew contents of line
AzureIoTClient 0:e393db310d89 1 // Copyright (c) Microsoft. All rights reserved.
AzureIoTClient 0:e393db310d89 2 // Licensed under the MIT license. See LICENSE file in the project root for full license information.
AzureIoTClient 0:e393db310d89 3
AzureIoTClient 9:3ec7e2695f98 4 /** @file iothub_client_ll.h
AzureIoTClient 9:3ec7e2695f98 5 * @brief APIs that allow a user (usually a device) to communicate
AzureIoTClient 9:3ec7e2695f98 6 * with an Azure IoTHub.
AzureIoTClient 9:3ec7e2695f98 7 *
AzureIoTClient 9:3ec7e2695f98 8 * @details IoTHubClient_LL is a module that allows a user (usually a
AzureIoTClient 9:3ec7e2695f98 9 * device) to communicate with an Azure IoTHub. It can send events
AzureIoTClient 9:3ec7e2695f98 10 * and receive messages. At any given moment in time there can only
AzureIoTClient 9:3ec7e2695f98 11 * be at most 1 message callback function.
AzureIoTClient 9:3ec7e2695f98 12 *
AzureIoTClient 9:3ec7e2695f98 13 * This API surface contains a set of APIs that allows the user to
AzureIoTClient 9:3ec7e2695f98 14 * interact with the lower layer portion of the IoTHubClient. These APIs
AzureIoTClient 9:3ec7e2695f98 15 * contain @c _LL_ in their name, but retain the same functionality like the
AzureIoTClient 9:3ec7e2695f98 16 * @c IoTHubClient_... APIs, with one difference. If the @c _LL_ APIs are
AzureIoTClient 9:3ec7e2695f98 17 * used then the user is responsible for scheduling when the actual work done
AzureIoTClient 9:3ec7e2695f98 18 * by the IoTHubClient happens (when the data is sent/received on/from the wire).
AzureIoTClient 9:3ec7e2695f98 19 * This is useful for constrained devices where spinning a separate thread is
AzureIoTClient 9:3ec7e2695f98 20 * often not desired.
AzureIoTClient 9:3ec7e2695f98 21 */
AzureIoTClient 9:3ec7e2695f98 22
AzureIoTClient 0:e393db310d89 23 #ifndef IOTHUB_CLIENT_LL_H
AzureIoTClient 0:e393db310d89 24 #define IOTHUB_CLIENT_LL_H
AzureIoTClient 0:e393db310d89 25
AzureIoTClient 0:e393db310d89 26 #include "agenttime.h"
AzureIoTClient 0:e393db310d89 27
AzureIoTClient 0:e393db310d89 28 #include "macro_utils.h"
AzureIoTClient 0:e393db310d89 29
AzureIoTClient 0:e393db310d89 30 #include "iothub_message.h"
AzureIoTClient 0:e393db310d89 31
AzureIoTClient 0:e393db310d89 32 #ifdef __cplusplus
AzureIoTClient 0:e393db310d89 33 extern "C"
AzureIoTClient 0:e393db310d89 34 {
AzureIoTClient 0:e393db310d89 35 #endif
AzureIoTClient 0:e393db310d89 36
AzureIoTClient 0:e393db310d89 37 #define IOTHUB_CLIENT_RESULT_VALUES \
AzureIoTClient 0:e393db310d89 38 IOTHUB_CLIENT_OK, \
AzureIoTClient 0:e393db310d89 39 IOTHUB_CLIENT_INVALID_ARG, \
AzureIoTClient 0:e393db310d89 40 IOTHUB_CLIENT_ERROR, \
AzureIoTClient 0:e393db310d89 41 IOTHUB_CLIENT_INVALID_SIZE, \
AzureIoTClient 0:e393db310d89 42 IOTHUB_CLIENT_INDEFINITE_TIME \
AzureIoTClient 0:e393db310d89 43
AzureIoTClient 9:3ec7e2695f98 44 /** @brief Enumeration specifying the status of calls to various APIs in this module.
AzureIoTClient 9:3ec7e2695f98 45 */
AzureIoTClient 0:e393db310d89 46 DEFINE_ENUM(IOTHUB_CLIENT_RESULT, IOTHUB_CLIENT_RESULT_VALUES);
AzureIoTClient 0:e393db310d89 47
AzureIoTClient 0:e393db310d89 48 #define IOTHUB_CLIENT_CONFIRMATION_RESULT_VALUES \
AzureIoTClient 0:e393db310d89 49 IOTHUB_CLIENT_CONFIRMATION_OK, \
AzureIoTClient 0:e393db310d89 50 IOTHUB_CLIENT_CONFIRMATION_BECAUSE_DESTROY, \
AzureIoTClient 0:e393db310d89 51 IOTHUB_CLIENT_CONFIRMATION_ERROR \
AzureIoTClient 0:e393db310d89 52
AzureIoTClient 9:3ec7e2695f98 53 /** @brief Enumeration passed in by the IoT Hub when the event confirmation
AzureIoTClient 9:3ec7e2695f98 54 * callback is invoked to indicate status of the event processing in
AzureIoTClient 9:3ec7e2695f98 55 * the hub.
AzureIoTClient 9:3ec7e2695f98 56 */
AzureIoTClient 0:e393db310d89 57 DEFINE_ENUM(IOTHUB_CLIENT_CONFIRMATION_RESULT, IOTHUB_CLIENT_CONFIRMATION_RESULT_VALUES);
AzureIoTClient 0:e393db310d89 58
AzureIoTClient 0:e393db310d89 59 #define IOTHUB_CLIENT_STATUS_VALUES \
AzureIoTClient 0:e393db310d89 60 IOTHUB_CLIENT_SEND_STATUS_IDLE, \
AzureIoTClient 0:e393db310d89 61 IOTHUB_CLIENT_SEND_STATUS_BUSY \
AzureIoTClient 0:e393db310d89 62
AzureIoTClient 9:3ec7e2695f98 63 /** @brief Enumeration returned by the ::IoTHubClient_LL_GetSendStatus
AzureIoTClient 9:3ec7e2695f98 64 * API to indicate the current sending status of the IoT Hub client.
AzureIoTClient 9:3ec7e2695f98 65 */
AzureIoTClient 0:e393db310d89 66 DEFINE_ENUM(IOTHUB_CLIENT_STATUS, IOTHUB_CLIENT_STATUS_VALUES);
AzureIoTClient 0:e393db310d89 67
AzureIoTClient 0:e393db310d89 68 #define TRANSPORT_TYPE_VALUES \
AzureIoTClient 0:e393db310d89 69 TRANSPORT_LL, /*LL comes from "LowLevel" */ \
AzureIoTClient 0:e393db310d89 70 TRANSPORT_THREADED
AzureIoTClient 0:e393db310d89 71
AzureIoTClient 0:e393db310d89 72 DEFINE_ENUM(TRANSPORT_TYPE, TRANSPORT_TYPE_VALUES);
AzureIoTClient 0:e393db310d89 73
AzureIoTClient 0:e393db310d89 74 #define IOTHUBMESSAGE_DISPOSITION_RESULT_VALUES \
AzureIoTClient 0:e393db310d89 75 IOTHUBMESSAGE_ACCEPTED, \
AzureIoTClient 0:e393db310d89 76 IOTHUBMESSAGE_REJECTED, \
AzureIoTClient 0:e393db310d89 77 IOTHUBMESSAGE_ABANDONED
AzureIoTClient 0:e393db310d89 78
AzureIoTClient 9:3ec7e2695f98 79 /** @brief Enumeration returned by the callback which is invoked whenever the
AzureIoTClient 9:3ec7e2695f98 80 * IoT Hub sends a message to the device.
AzureIoTClient 9:3ec7e2695f98 81 */
AzureIoTClient 0:e393db310d89 82 DEFINE_ENUM(IOTHUBMESSAGE_DISPOSITION_RESULT, IOTHUBMESSAGE_DISPOSITION_RESULT_VALUES);
AzureIoTClient 0:e393db310d89 83
AzureIoTClient 0:e393db310d89 84 typedef void* IOTHUB_CLIENT_LL_HANDLE;
AzureIoTClient 0:e393db310d89 85 typedef void(*IOTHUB_CLIENT_EVENT_CONFIRMATION_CALLBACK)(IOTHUB_CLIENT_CONFIRMATION_RESULT result, void* userContextCallback);
AzureIoTClient 9:3ec7e2695f98 86 typedef IOTHUBMESSAGE_DISPOSITION_RESULT (*IOTHUB_CLIENT_MESSAGE_CALLBACK_ASYNC)(IOTHUB_MESSAGE_HANDLE message, void* userContextCallback);
AzureIoTClient 0:e393db310d89 87 typedef const void*(*IOTHUB_CLIENT_TRANSPORT_PROVIDER)(void);
AzureIoTClient 0:e393db310d89 88
AzureIoTClient 9:3ec7e2695f98 89 /** @brief This struct captures IoTHub client configuration. */
AzureIoTClient 0:e393db310d89 90 typedef struct IOTHUB_CLIENT_CONFIG_TAG
AzureIoTClient 0:e393db310d89 91 {
AzureIoTClient 9:3ec7e2695f98 92 /** @brief A function pointer that is passed into the @c IoTHubClientCreate.
AzureIoTClient 9:3ec7e2695f98 93 * A function definition for AMQP, @c DeviceClientProvideAmqpResources,
AzureIoTClient 9:3ec7e2695f98 94 * is defined in the include @c iothubtransportamqp.h. A function
AzureIoTClient 9:3ec7e2695f98 95 * definition for HTTP, @c DeviceClientProvideHttpResources, is defined
AzureIoTClient 9:3ec7e2695f98 96 * in the include @c iothubtransporthttp.h */
AzureIoTClient 0:e393db310d89 97 IOTHUB_CLIENT_TRANSPORT_PROVIDER protocol;
AzureIoTClient 9:3ec7e2695f98 98
AzureIoTClient 9:3ec7e2695f98 99 /** @brief A string that identifies the device. */
AzureIoTClient 0:e393db310d89 100 const char* deviceId;
AzureIoTClient 9:3ec7e2695f98 101
AzureIoTClient 9:3ec7e2695f98 102 /** @brief The device key used to authenticate the device. */
AzureIoTClient 0:e393db310d89 103 const char* deviceKey;
AzureIoTClient 9:3ec7e2695f98 104
AzureIoTClient 9:3ec7e2695f98 105 /** @brief The IoT Hub name to which the device is connecting. */
AzureIoTClient 0:e393db310d89 106 const char* iotHubName;
AzureIoTClient 9:3ec7e2695f98 107
AzureIoTClient 9:3ec7e2695f98 108 /** @brief IoT Hub suffix goes here, e.g., private.azure-devices-int.net. */
AzureIoTClient 0:e393db310d89 109 const char* iotHubSuffix;
AzureIoTClient 9:3ec7e2695f98 110
AzureIoTClient 0:e393db310d89 111 const char* protocolGatewayHostName;
AzureIoTClient 0:e393db310d89 112 } IOTHUB_CLIENT_CONFIG;
AzureIoTClient 0:e393db310d89 113
AzureIoTClient 9:3ec7e2695f98 114 /**
AzureIoTClient 9:3ec7e2695f98 115 * @brief Creates a IoT Hub client for communication with an existing
AzureIoTClient 9:3ec7e2695f98 116 * IoT Hub using the specified connection string parameter.
AzureIoTClient 9:3ec7e2695f98 117 *
AzureIoTClient 9:3ec7e2695f98 118 * @param connectionString Pointer to a character string
AzureIoTClient 9:3ec7e2695f98 119 * @param protocol Function pointer for protocol implementation
AzureIoTClient 9:3ec7e2695f98 120 *
AzureIoTClient 9:3ec7e2695f98 121 * Sample connection string:
AzureIoTClient 9:3ec7e2695f98 122 * <blockquote>
AzureIoTClient 10:38383e246675 123 * <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 9:3ec7e2695f98 124 * </blockquote>
AzureIoTClient 9:3ec7e2695f98 125 *
AzureIoTClient 9:3ec7e2695f98 126 * @return A non-NULL @c IOTHUB_CLIENT_LL_HANDLE value that is used when
AzureIoTClient 9:3ec7e2695f98 127 * invoking other functions for IoT Hub client and @c NULL on failure.
AzureIoTClient 9:3ec7e2695f98 128 */
AzureIoTClient 0:e393db310d89 129 extern IOTHUB_CLIENT_LL_HANDLE IoTHubClient_LL_CreateFromConnectionString(const char* connectionString, IOTHUB_CLIENT_TRANSPORT_PROVIDER protocol);
AzureIoTClient 9:3ec7e2695f98 130
AzureIoTClient 9:3ec7e2695f98 131 /**
AzureIoTClient 9:3ec7e2695f98 132 * @brief Creates a IoT Hub client for communication with an existing IoT
AzureIoTClient 9:3ec7e2695f98 133 * Hub using the specified parameters.
AzureIoTClient 9:3ec7e2695f98 134 *
AzureIoTClient 9:3ec7e2695f98 135 * @param config Pointer to an @c IOTHUB_CLIENT_CONFIG structure
AzureIoTClient 9:3ec7e2695f98 136 *
AzureIoTClient 9:3ec7e2695f98 137 * The API does not allow sharing of a connection across multiple
AzureIoTClient 9:3ec7e2695f98 138 * devices. This is a blocking call.
AzureIoTClient 9:3ec7e2695f98 139 *
AzureIoTClient 9:3ec7e2695f98 140 * @return A non-NULL @c IOTHUB_CLIENT_LL_HANDLE value that is used when
AzureIoTClient 9:3ec7e2695f98 141 * invoking other functions for IoT Hub client and @c NULL on failure.
AzureIoTClient 9:3ec7e2695f98 142 */
AzureIoTClient 0:e393db310d89 143 extern IOTHUB_CLIENT_LL_HANDLE IoTHubClient_LL_Create(const IOTHUB_CLIENT_CONFIG* config);
AzureIoTClient 9:3ec7e2695f98 144
AzureIoTClient 9:3ec7e2695f98 145 /**
AzureIoTClient 9:3ec7e2695f98 146 * @brief Disposes of resources allocated by the IoT Hub client. This is a
AzureIoTClient 9:3ec7e2695f98 147 * blocking call.
AzureIoTClient 9:3ec7e2695f98 148 *
AzureIoTClient 9:3ec7e2695f98 149 * @param iotHubClientHandle The handle created by a call to the create function.
AzureIoTClient 9:3ec7e2695f98 150 */
AzureIoTClient 0:e393db310d89 151 extern void IoTHubClient_LL_Destroy(IOTHUB_CLIENT_LL_HANDLE iotHubClientHandle);
AzureIoTClient 0:e393db310d89 152
AzureIoTClient 9:3ec7e2695f98 153 /**
AzureIoTClient 9:3ec7e2695f98 154 * @brief Asynchronous call to send the message specified by @p eventMessageHandle.
AzureIoTClient 9:3ec7e2695f98 155 *
AzureIoTClient 9:3ec7e2695f98 156 * @param iotHubClientHandle The handle created by a call to the create function.
AzureIoTClient 9:3ec7e2695f98 157 * @param eventMessageHandle The handle to an IoT Hub message.
AzureIoTClient 9:3ec7e2695f98 158 * @param eventConfirmationCallback The callback specified by the device for receiving
AzureIoTClient 9:3ec7e2695f98 159 * confirmation of the delivery of the IoT Hub message.
AzureIoTClient 9:3ec7e2695f98 160 * This callback can be expected to invoke the
AzureIoTClient 9:3ec7e2695f98 161 * ::IoTHubClient_LL_SendEventAsync function for the
AzureIoTClient 9:3ec7e2695f98 162 * same message in an attempt to retry sending a failing
AzureIoTClient 9:3ec7e2695f98 163 * message. The user can specify a @c NULL value here to
AzureIoTClient 9:3ec7e2695f98 164 * indicate that no callback is required.
AzureIoTClient 9:3ec7e2695f98 165 * @param userContextCallback User specified context that will be provided to the
AzureIoTClient 9:3ec7e2695f98 166 * callback. This can be @c NULL.
AzureIoTClient 9:3ec7e2695f98 167 *
AzureIoTClient 9:3ec7e2695f98 168 * @b NOTE: The application behavior is undefined if the user calls
AzureIoTClient 9:3ec7e2695f98 169 * the ::IoTHubClient_LL_Destroy function from within any callback.
AzureIoTClient 9:3ec7e2695f98 170 *
AzureIoTClient 9:3ec7e2695f98 171 * @return IOTHUB_CLIENT_OK upon success or an error code upon failure.
AzureIoTClient 9:3ec7e2695f98 172 */
AzureIoTClient 0:e393db310d89 173 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 9:3ec7e2695f98 174
AzureIoTClient 9:3ec7e2695f98 175 /**
AzureIoTClient 9:3ec7e2695f98 176 * @brief This function returns the current sending status for IoTHubClient.
AzureIoTClient 9:3ec7e2695f98 177 *
AzureIoTClient 9:3ec7e2695f98 178 * @param iotHubClientHandle The handle created by a call to the create function.
AzureIoTClient 9:3ec7e2695f98 179 * @param iotHubClientStatus The sending state is populated at the address pointed
AzureIoTClient 9:3ec7e2695f98 180 * at by this parameter. The value will be set to
AzureIoTClient 9:3ec7e2695f98 181 * @c IOTHUBCLIENT_SENDSTATUS_IDLE if there is currently
AzureIoTClient 9:3ec7e2695f98 182 * no item to be sent and @c IOTHUBCLIENT_SENDSTATUS_BUSY
AzureIoTClient 9:3ec7e2695f98 183 * if there are.
AzureIoTClient 9:3ec7e2695f98 184 *
AzureIoTClient 9:3ec7e2695f98 185 * @return IOTHUB_CLIENT_OK upon success or an error code upon failure.
AzureIoTClient 9:3ec7e2695f98 186 */
AzureIoTClient 0:e393db310d89 187 extern IOTHUB_CLIENT_RESULT IoTHubClient_LL_GetSendStatus(IOTHUB_CLIENT_LL_HANDLE iotHubClientHandle, IOTHUB_CLIENT_STATUS *iotHubClientStatus);
AzureIoTClient 9:3ec7e2695f98 188
AzureIoTClient 9:3ec7e2695f98 189 /**
AzureIoTClient 9:3ec7e2695f98 190 * @brief Sets up the message callback to be invoked when IoT Hub issues a
AzureIoTClient 9:3ec7e2695f98 191 * message to the device. This is a blocking call.
AzureIoTClient 9:3ec7e2695f98 192 *
AzureIoTClient 9:3ec7e2695f98 193 * @param iotHubClientHandle The handle created by a call to the create function.
AzureIoTClient 9:3ec7e2695f98 194 * @param messageCallback The callback specified by the device for receiving
AzureIoTClient 9:3ec7e2695f98 195 * messages from IoT Hub.
AzureIoTClient 9:3ec7e2695f98 196 * @param userContextCallback User specified context that will be provided to the
AzureIoTClient 9:3ec7e2695f98 197 * callback. This can be @c NULL.
AzureIoTClient 9:3ec7e2695f98 198 *
AzureIoTClient 9:3ec7e2695f98 199 * @b NOTE: The application behavior is undefined if the user calls
AzureIoTClient 9:3ec7e2695f98 200 * the ::IoTHubClient_LL_Destroy function from within any callback.
AzureIoTClient 9:3ec7e2695f98 201 *
AzureIoTClient 9:3ec7e2695f98 202 * @return IOTHUB_CLIENT_OK upon success or an error code upon failure.
AzureIoTClient 9:3ec7e2695f98 203 */
AzureIoTClient 9:3ec7e2695f98 204 extern IOTHUB_CLIENT_RESULT IoTHubClient_LL_SetMessageCallback(IOTHUB_CLIENT_LL_HANDLE iotHubClientHandle, IOTHUB_CLIENT_MESSAGE_CALLBACK_ASYNC messageCallback, void* userContextCallback);
AzureIoTClient 9:3ec7e2695f98 205
AzureIoTClient 9:3ec7e2695f98 206 /**
AzureIoTClient 9:3ec7e2695f98 207 * @brief This function returns in the out parameter @p lastMessageReceiveTime
AzureIoTClient 9:3ec7e2695f98 208 * what was the value of the @c time function when the last message was
AzureIoTClient 9:3ec7e2695f98 209 * received at the client.
AzureIoTClient 9:3ec7e2695f98 210 *
AzureIoTClient 9:3ec7e2695f98 211 * @param iotHubClientHandle The handle created by a call to the create function.
AzureIoTClient 9:3ec7e2695f98 212 * @param lastMessageReceiveTime Out parameter containing the value of @c time function
AzureIoTClient 9:3ec7e2695f98 213 * when the last message was received.
AzureIoTClient 9:3ec7e2695f98 214 *
AzureIoTClient 9:3ec7e2695f98 215 * @return IOTHUB_CLIENT_OK upon success or an error code upon failure.
AzureIoTClient 9:3ec7e2695f98 216 */
AzureIoTClient 9:3ec7e2695f98 217 extern IOTHUB_CLIENT_RESULT IoTHubClient_LL_GetLastMessageReceiveTime(IOTHUB_CLIENT_LL_HANDLE iotHubClientHandle, time_t* lastMessageReceiveTime);
AzureIoTClient 9:3ec7e2695f98 218
AzureIoTClient 9:3ec7e2695f98 219 /**
AzureIoTClient 9:3ec7e2695f98 220 * @brief This function is meant to be called by the user when work
AzureIoTClient 9:3ec7e2695f98 221 * (sending/receiving) can be done by the IoTHubClient.
AzureIoTClient 9:3ec7e2695f98 222 *
AzureIoTClient 9:3ec7e2695f98 223 * @param iotHubClientHandle The handle created by a call to the create function.
AzureIoTClient 9:3ec7e2695f98 224 *
AzureIoTClient 9:3ec7e2695f98 225 * All IoTHubClient interactions (in regards to network traffic
AzureIoTClient 9:3ec7e2695f98 226 * and/or user level callbacks) are the effect of calling this
AzureIoTClient 9:3ec7e2695f98 227 * function and they take place synchronously inside _DoWork.
AzureIoTClient 9:3ec7e2695f98 228 */
AzureIoTClient 0:e393db310d89 229 extern void IoTHubClient_LL_DoWork(IOTHUB_CLIENT_LL_HANDLE iotHubClientHandle);
AzureIoTClient 9:3ec7e2695f98 230
AzureIoTClient 9:3ec7e2695f98 231 /**
AzureIoTClient 9:3ec7e2695f98 232 * @brief This API sets a runtime option identified by parameter @p optionName
AzureIoTClient 9:3ec7e2695f98 233 * to a value pointed to by @p value. @p optionName and the data type
AzureIoTClient 9:3ec7e2695f98 234 * @p value is pointing to are specific for every option.
AzureIoTClient 9:3ec7e2695f98 235 *
AzureIoTClient 9:3ec7e2695f98 236 * @param iotHubClientHandle The handle created by a call to the create function.
AzureIoTClient 9:3ec7e2695f98 237 * @param optionName Name of the option.
AzureIoTClient 9:3ec7e2695f98 238 * @param value The value.
AzureIoTClient 9:3ec7e2695f98 239 *
AzureIoTClient 9:3ec7e2695f98 240 * The options that can be set via this API are:
AzureIoTClient 9:3ec7e2695f98 241 * - @b timeout - the maximum time in milliseconds a communication is
AzureIoTClient 9:3ec7e2695f98 242 * allowed to use. @p value is a pointer to an @c unsigned @c int with
AzureIoTClient 9:3ec7e2695f98 243 * the timeout value in milliseconds. This is only supported for the HTTP
AzureIoTClient 9:3ec7e2695f98 244 * protocol as of now. When the HTTP protocol uses CURL, the meaning of
AzureIoTClient 9:3ec7e2695f98 245 * the parameter is <em>total request time</em>. When the HTTP protocol uses
AzureIoTClient 9:3ec7e2695f98 246 * winhttp, the meaning is the same as the @c dwSendTimeout and
AzureIoTClient 9:3ec7e2695f98 247 * @c dwReceiveTimeout parameters of the
AzureIoTClient 9:3ec7e2695f98 248 * <a href="https://msdn.microsoft.com/en-us/library/windows/desktop/aa384116(v=vs.85).aspx">
AzureIoTClient 9:3ec7e2695f98 249 * WinHttpSetTimeouts</a> API.
AzureIoTClient 9:3ec7e2695f98 250 * - @b CURLOPT_LOW_SPEED_LIMIT - only available for HTTP protocol and only
AzureIoTClient 9:3ec7e2695f98 251 * when CURL is used. It has the same meaning as CURL's option with the same
AzureIoTClient 9:3ec7e2695f98 252 * name. @p value is pointer to a long.
AzureIoTClient 9:3ec7e2695f98 253 * - @b CURLOPT_LOW_SPEED_TIME - only available for HTTP protocol and only
AzureIoTClient 9:3ec7e2695f98 254 * when CURL is used. It has the same meaning as CURL's option with the same
AzureIoTClient 9:3ec7e2695f98 255 * name. @p value is pointer to a long.
AzureIoTClient 9:3ec7e2695f98 256 * - @b CURLOPT_FORBID_REUSE - only available for HTTP protocol and only
AzureIoTClient 9:3ec7e2695f98 257 * when CURL is used. It has the same meaning as CURL's option with the same
AzureIoTClient 9:3ec7e2695f98 258 * name. @p value is pointer to a long.
AzureIoTClient 9:3ec7e2695f98 259 * - @b CURLOPT_FRESH_CONNECT - only available for HTTP protocol and only
AzureIoTClient 9:3ec7e2695f98 260 * when CURL is used. It has the same meaning as CURL's option with the same
AzureIoTClient 9:3ec7e2695f98 261 * name. @p value is pointer to a long.
AzureIoTClient 9:3ec7e2695f98 262 * - @b CURLOPT_VERBOSE - only available for HTTP protocol and only
AzureIoTClient 9:3ec7e2695f98 263 * when CURL is used. It has the same meaning as CURL's option with the same
AzureIoTClient 9:3ec7e2695f98 264 * name. @p value is pointer to a long.
AzureIoTClient 9:3ec7e2695f98 265 *
AzureIoTClient 9:3ec7e2695f98 266 * @return IOTHUB_CLIENT_OK upon success or an error code upon failure.
AzureIoTClient 9:3ec7e2695f98 267 */
AzureIoTClient 0:e393db310d89 268 extern IOTHUB_CLIENT_RESULT IoTHubClient_LL_SetOption(IOTHUB_CLIENT_LL_HANDLE iotHubClientHandle, const char* optionName, const void* value);
AzureIoTClient 0:e393db310d89 269
AzureIoTClient 0:e393db310d89 270 #ifdef __cplusplus
AzureIoTClient 0:e393db310d89 271 }
AzureIoTClient 0:e393db310d89 272 #endif
AzureIoTClient 0:e393db310d89 273
AzureIoTClient 0:e393db310d89 274 #endif /* IOTHUB_CLIENT_LL_H */