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
Diff: iothub_device_client.h
- Revision:
- 91:bbf806070c5f
- Parent:
- 89:a2ed767a532e
- Child:
- 92:97148cf9aa2a
diff -r ab8c7443822a -r bbf806070c5f iothub_device_client.h --- a/iothub_device_client.h Thu Jun 28 10:07:22 2018 -0700 +++ b/iothub_device_client.h Thu Jul 12 18:09:13 2018 -0700 @@ -2,14 +2,14 @@ // Licensed under the MIT license. See LICENSE file in the project root for full license information. /** @file iothub_client.h -* @brief Extends the IoTHubCLient_LL module with additional features. +* @brief Extends the IoTHubCLient_LL module with additional features. * -* @details IoTHubClient is a module that extends the IoTHubCLient_LL -* module with 2 features: -* - scheduling the work for the IoTHubCLient from a -* thread, so that the user does not need to create their -* own thread -* - thread-safe APIs +* @details IoTHubClient is a module that extends the IoTHubCLient_LL +* module with 2 features: +* - scheduling the work for the IoTHubCLient from a +* thread, so that the user does not need to create their +* own thread +* - thread-safe APIs */ #ifndef IOTHUB_DEVICE_CLIENT_H @@ -36,315 +36,315 @@ #endif /** - * @brief Creates a IoT Hub client for communication with an existing - * IoT Hub using the specified connection string parameter. + * @brief Creates a IoT Hub client for communication with an existing + * IoT Hub using the specified connection string parameter. * - * @param connectionString Pointer to a character string - * @param protocol Function pointer for protocol implementation + * @param connectionString Pointer to a character string + * @param protocol Function pointer for protocol implementation * - * Sample connection string: - * <blockquote> - * <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> + * Sample connection string: + * <blockquote> + * <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> * <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> - * </blockquote> + * </blockquote> * - * @return A non-NULL @c IOTHUB_DEVICE_CLIENT_HANDLE value that is used when - * invoking other functions for IoT Hub client and @c NULL on failure. + * @return A non-NULL @c IOTHUB_DEVICE_CLIENT_HANDLE value that is used when + * invoking other functions for IoT Hub client and @c NULL on failure. */ MOCKABLE_FUNCTION(, IOTHUB_DEVICE_CLIENT_HANDLE, IoTHubDeviceClient_CreateFromConnectionString, const char*, connectionString, IOTHUB_CLIENT_TRANSPORT_PROVIDER, protocol); /** - * @brief Creates a IoT Hub client for communication with an existing IoT - * Hub using the specified parameters. + * @brief Creates a IoT Hub client for communication with an existing IoT + * Hub using the specified parameters. * - * @param config Pointer to an @c IOTHUB_CLIENT_CONFIG structure + * @param config Pointer to an @c IOTHUB_CLIENT_CONFIG structure * - * The API does not allow sharing of a connection across multiple - * devices. This is a blocking call. + * The API does not allow sharing of a connection across multiple + * devices. This is a blocking call. * - * @return A non-NULL @c IOTHUB_DEVICE_CLIENT_HANDLE value that is used when - * invoking other functions for IoT Hub client and @c NULL on failure. + * @return A non-NULL @c IOTHUB_DEVICE_CLIENT_HANDLE value that is used when + * invoking other functions for IoT Hub client and @c NULL on failure. */ MOCKABLE_FUNCTION(, IOTHUB_DEVICE_CLIENT_HANDLE, IoTHubDeviceClient_Create, const IOTHUB_CLIENT_CONFIG*, config); /** - * @brief Creates a IoT Hub client for communication with an existing IoT - * Hub using the specified parameters. + * @brief Creates a IoT Hub client for communication with an existing IoT + * Hub using the specified parameters. * - * @param transportHandle TRANSPORT_HANDLE which represents a connection. - * @param config Pointer to an @c IOTHUB_CLIENT_CONFIG structure + * @param transportHandle TRANSPORT_HANDLE which represents a connection. + * @param config Pointer to an @c IOTHUB_CLIENT_CONFIG structure * - * The API allows sharing of a connection across multiple - * devices. This is a blocking call. + * The API allows sharing of a connection across multiple + * devices. This is a blocking call. * - * @return A non-NULL @c IOTHUB_DEVICE_CLIENT_HANDLE value that is used when - * invoking other functions for IoT Hub client and @c NULL on failure. + * @return A non-NULL @c IOTHUB_DEVICE_CLIENT_HANDLE value that is used when + * invoking other functions for IoT Hub client and @c NULL on failure. */ MOCKABLE_FUNCTION(, IOTHUB_DEVICE_CLIENT_HANDLE, IoTHubDeviceClient_CreateWithTransport, TRANSPORT_HANDLE, transportHandle, const IOTHUB_CLIENT_CONFIG*, config); /** - * @brief Creates a IoT Hub client for communication with an existing IoT - * Hub using the device auth module. + * @brief Creates a IoT Hub client for communication with an existing IoT + * Hub using the device auth module. * - * @param iothub_uri Pointer to an ioThub hostname received in the registration process - * @param device_id Pointer to the device Id of the device - * @param protocol Function pointer for protocol implementation + * @param iothub_uri Pointer to an ioThub hostname received in the registration process + * @param device_id Pointer to the device Id of the device + * @param protocol Function pointer for protocol implementation * - * @return A non-NULL @c IOTHUB_DEVICE_CLIENT_HANDLE value that is used when - * invoking other functions for IoT Hub client and @c NULL on failure. + * @return A non-NULL @c IOTHUB_DEVICE_CLIENT_HANDLE value that is used when + * invoking other functions for IoT Hub client and @c NULL on failure. */ MOCKABLE_FUNCTION(, IOTHUB_DEVICE_CLIENT_HANDLE, IoTHubDeviceClient_CreateFromDeviceAuth, const char*, iothub_uri, const char*, device_id, IOTHUB_CLIENT_TRANSPORT_PROVIDER, protocol); /** - * @brief Disposes of resources allocated by the IoT Hub client. This is a - * blocking call. + * @brief Disposes of resources allocated by the IoT Hub client. This is a + * blocking call. * - * @param iotHubClientHandle The handle created by a call to the create function. + * @param iotHubClientHandle The handle created by a call to the create function. */ MOCKABLE_FUNCTION(, void, IoTHubDeviceClient_Destroy, IOTHUB_DEVICE_CLIENT_HANDLE, iotHubClientHandle); /** - * @brief Asynchronous call to send the message specified by @p eventMessageHandle. + * @brief Asynchronous call to send the message specified by @p eventMessageHandle. * - * @param iotHubClientHandle The handle created by a call to the create function. - * @param eventMessageHandle The handle to an IoT Hub message. - * @param eventConfirmationCallback The callback specified by the device for receiving - * confirmation of the delivery of the IoT Hub message. - * This callback can be expected to invoke the - * ::IoTHubDeviceClient_SendEventAsync function for the - * same message in an attempt to retry sending a failing - * message. The user can specify a @c NULL value here to - * indicate that no callback is required. - * @param userContextCallback User specified context that will be provided to the - * callback. This can be @c NULL. + * @param iotHubClientHandle The handle created by a call to the create function. + * @param eventMessageHandle The handle to an IoT Hub message. + * @param eventConfirmationCallback The callback specified by the device for receiving + * confirmation of the delivery of the IoT Hub message. + * This callback can be expected to invoke the + * ::IoTHubDeviceClient_SendEventAsync function for the + * same message in an attempt to retry sending a failing + * message. The user can specify a @c NULL value here to + * indicate that no callback is required. + * @param userContextCallback User specified context that will be provided to the + * callback. This can be @c NULL. * - * @b NOTE: The application behavior is undefined if the user calls - * the ::IoTHubDeviceClient_Destroy function from within any callback. + * @b NOTE: The application behavior is undefined if the user calls + * the ::IoTHubDeviceClient_Destroy function from within any callback. * - * @return IOTHUB_CLIENT_OK upon success or an error code upon failure. + * @return IOTHUB_CLIENT_OK upon success or an error code upon failure. */ MOCKABLE_FUNCTION(, IOTHUB_CLIENT_RESULT, IoTHubDeviceClient_SendEventAsync, IOTHUB_DEVICE_CLIENT_HANDLE, iotHubClientHandle, IOTHUB_MESSAGE_HANDLE, eventMessageHandle, IOTHUB_CLIENT_EVENT_CONFIRMATION_CALLBACK, eventConfirmationCallback, void*, userContextCallback); /** - * @brief This function returns the current sending status for IoTHubClient. + * @brief This function returns the current sending status for IoTHubClient. * - * @param iotHubClientHandle The handle created by a call to the create function. - * @param iotHubClientStatus The sending state is populated at the address pointed - * at by this parameter. The value will be set to - * @c IOTHUBCLIENT_SENDSTATUS_IDLE if there is currently - * no item to be sent and @c IOTHUBCLIENT_SENDSTATUS_BUSY - * if there are. + * @param iotHubClientHandle The handle created by a call to the create function. + * @param iotHubClientStatus The sending state is populated at the address pointed + * at by this parameter. The value will be set to + * @c IOTHUBCLIENT_SENDSTATUS_IDLE if there is currently + * no item to be sent and @c IOTHUBCLIENT_SENDSTATUS_BUSY + * if there are. * - * @return IOTHUB_CLIENT_OK upon success or an error code upon failure. + * @return IOTHUB_CLIENT_OK upon success or an error code upon failure. */ MOCKABLE_FUNCTION(, IOTHUB_CLIENT_RESULT, IoTHubDeviceClient_GetSendStatus, IOTHUB_DEVICE_CLIENT_HANDLE, iotHubClientHandle, IOTHUB_CLIENT_STATUS*, iotHubClientStatus); /** - * @brief Sets up the message callback to be invoked when IoT Hub issues a - * message to the device. This is a blocking call. + * @brief Sets up the message callback to be invoked when IoT Hub issues a + * message to the device. This is a blocking call. * - * @param iotHubClientHandle The handle created by a call to the create function. - * @param messageCallback The callback specified by the device for receiving - * messages from IoT Hub. - * @param userContextCallback User specified context that will be provided to the - * callback. This can be @c NULL. + * @param iotHubClientHandle The handle created by a call to the create function. + * @param messageCallback The callback specified by the device for receiving + * messages from IoT Hub. + * @param userContextCallback User specified context that will be provided to the + * callback. This can be @c NULL. * - * @b NOTE: The application behavior is undefined if the user calls - * the ::IoTHubDeviceClient_Destroy function from within any callback. + * @b NOTE: The application behavior is undefined if the user calls + * the ::IoTHubDeviceClient_Destroy function from within any callback. * - * @return IOTHUB_CLIENT_OK upon success or an error code upon failure. + * @return IOTHUB_CLIENT_OK upon success or an error code upon failure. */ MOCKABLE_FUNCTION(, IOTHUB_CLIENT_RESULT, IoTHubDeviceClient_SetMessageCallback, IOTHUB_DEVICE_CLIENT_HANDLE, iotHubClientHandle, IOTHUB_CLIENT_MESSAGE_CALLBACK_ASYNC, messageCallback, void*, userContextCallback); /** - * @brief Sets up the connection status callback to be invoked representing the status of - * the connection to IOT Hub. This is a blocking call. + * @brief Sets up the connection status callback to be invoked representing the status of + * the connection to IOT Hub. This is a blocking call. * - * @param iotHubClientHandle The handle created by a call to the create function. - * @param connectionStatusCallback The callback specified by the device for receiving - * updates about the status of the connection to IoT Hub. - * @param userContextCallback User specified context that will be provided to the - * callback. This can be @c NULL. + * @param iotHubClientHandle The handle created by a call to the create function. + * @param connectionStatusCallback The callback specified by the device for receiving + * updates about the status of the connection to IoT Hub. + * @param userContextCallback User specified context that will be provided to the + * callback. This can be @c NULL. * - * @b NOTE: The application behavior is undefined if the user calls - * the ::IoTHubDeviceClient_LL_Destroy function from within any callback. + * @b NOTE: The application behavior is undefined if the user calls + * the ::IoTHubDeviceClient_LL_Destroy function from within any callback. * - * @return IOTHUB_CLIENT_OK upon success or an error code upon failure. + * @return IOTHUB_CLIENT_OK upon success or an error code upon failure. */ MOCKABLE_FUNCTION(, IOTHUB_CLIENT_RESULT, IoTHubDeviceClient_SetConnectionStatusCallback, IOTHUB_DEVICE_CLIENT_HANDLE, iotHubClientHandle, IOTHUB_CLIENT_CONNECTION_STATUS_CALLBACK, connectionStatusCallback, void*, userContextCallback); /** - * @brief Sets up the connection status callback to be invoked representing the status of - * the connection to IOT Hub. This is a blocking call. + * @brief Sets up the connection status callback to be invoked representing the status of + * the connection to IOT Hub. This is a blocking call. * - * @param iotHubClientHandle The handle created by a call to the create function. - * @param retryPolicy The policy to use to reconnect to IoT Hub when a - * connection drops. - * @param retryTimeoutLimitInSeconds Maximum amount of time(seconds) to attempt reconnection when a - * connection drops to IOT Hub. + * @param iotHubClientHandle The handle created by a call to the create function. + * @param retryPolicy The policy to use to reconnect to IoT Hub when a + * connection drops. + * @param retryTimeoutLimitInSeconds Maximum amount of time(seconds) to attempt reconnection when a + * connection drops to IOT Hub. * - * @b NOTE: The application behavior is undefined if the user calls - * the ::IoTHubDeviceClient_LL_Destroy function from within any callback. + * @b NOTE: The application behavior is undefined if the user calls + * the ::IoTHubDeviceClient_LL_Destroy function from within any callback. * - * @return IOTHUB_CLIENT_OK upon success or an error code upon failure. + * @return IOTHUB_CLIENT_OK upon success or an error code upon failure. */ MOCKABLE_FUNCTION(, IOTHUB_CLIENT_RESULT, IoTHubDeviceClient_SetRetryPolicy, IOTHUB_DEVICE_CLIENT_HANDLE, iotHubClientHandle, IOTHUB_CLIENT_RETRY_POLICY, retryPolicy, size_t, retryTimeoutLimitInSeconds); /** - * @brief Sets up the connection status callback to be invoked representing the status of + * @brief Sets up the connection status callback to be invoked representing the status of * the connection to IOT Hub. This is a blocking call. * - * @param iotHubClientHandle The handle created by a call to the create function. - * @param retryPolicy Out parameter containing the policy to use to reconnect to IoT Hub. - * @param retryTimeoutLimitInSeconds Out parameter containing maximum amount of time in seconds to attempt reconnection - to IOT Hub. + * @param iotHubClientHandle The handle created by a call to the create function. + * @param retryPolicy Out parameter containing the policy to use to reconnect to IoT Hub. + * @param retryTimeoutLimitInSeconds Out parameter containing maximum amount of time in seconds to attempt reconnection + * to IOT Hub. * - * @b NOTE: The application behavior is undefined if the user calls - * the ::IoTHubDeviceClient_LL_Destroy function from within any callback. + * @b NOTE: The application behavior is undefined if the user calls + * the ::IoTHubDeviceClient_LL_Destroy function from within any callback. * - * @return IOTHUB_CLIENT_OK upon success or an error code upon failure. + * @return IOTHUB_CLIENT_OK upon success or an error code upon failure. */ MOCKABLE_FUNCTION(, IOTHUB_CLIENT_RESULT, IoTHubDeviceClient_GetRetryPolicy, IOTHUB_DEVICE_CLIENT_HANDLE, iotHubClientHandle, IOTHUB_CLIENT_RETRY_POLICY*, retryPolicy, size_t*, retryTimeoutLimitInSeconds); /** - * @brief This function returns in the out parameter @p lastMessageReceiveTime - * what was the value of the @c time function when the last message was - * received at the client. + * @brief This function returns in the out parameter @p lastMessageReceiveTime + * what was the value of the @c time function when the last message was + * received at the client. * - * @param iotHubClientHandle The handle created by a call to the create function. - * @param lastMessageReceiveTime Out parameter containing the value of @c time function - * when the last message was received. + * @param iotHubClientHandle The handle created by a call to the create function. + * @param lastMessageReceiveTime Out parameter containing the value of @c time function + * when the last message was received. * - * @return IOTHUB_CLIENT_OK upon success or an error code upon failure. + * @return IOTHUB_CLIENT_OK upon success or an error code upon failure. */ MOCKABLE_FUNCTION(, IOTHUB_CLIENT_RESULT, IoTHubDeviceClient_GetLastMessageReceiveTime, IOTHUB_DEVICE_CLIENT_HANDLE, iotHubClientHandle, time_t*, lastMessageReceiveTime); /** - * @brief This API sets a runtime option identified by parameter @p optionName - * to a value pointed to by @p value. @p optionName and the data type - * @p value is pointing to are specific for every option. + * @brief This API sets a runtime option identified by parameter @p optionName + * to a value pointed to by @p value. @p optionName and the data type + * @p value is pointing to are specific for every option. * - * @param iotHubClientHandle The handle created by a call to the create function. - * @param optionName Name of the option. - * @param value The value. + * @param iotHubClientHandle The handle created by a call to the create function. + * @param optionName Name of the option. + * @param value The value. * - * The options that can be set via this API are: - * - @b timeout - the maximum time in milliseconds a communication is - * allowed to use. @p value is a pointer to an @c unsigned @c int with - * the timeout value in milliseconds. This is only supported for the HTTP - * protocol as of now. When the HTTP protocol uses CURL, the meaning of - * the parameter is <em>total request time</em>. When the HTTP protocol uses - * winhttp, the meaning is the same as the @c dwSendTimeout and - * @c dwReceiveTimeout parameters of the - * <a href="https://msdn.microsoft.com/en-us/library/windows/desktop/aa384116(v=vs.85).aspx"> - * WinHttpSetTimeouts</a> API. - * - @b CURLOPT_LOW_SPEED_LIMIT - only available for HTTP protocol and only - * when CURL is used. It has the same meaning as CURL's option with the same - * name. @p value is pointer to a long. - * - @b CURLOPT_LOW_SPEED_TIME - only available for HTTP protocol and only - * when CURL is used. It has the same meaning as CURL's option with the same - * name. @p value is pointer to a long. - * - @b CURLOPT_FORBID_REUSE - only available for HTTP protocol and only - * when CURL is used. It has the same meaning as CURL's option with the same - * name. @p value is pointer to a long. - * - @b CURLOPT_FRESH_CONNECT - only available for HTTP protocol and only - * when CURL is used. It has the same meaning as CURL's option with the same - * name. @p value is pointer to a long. - * - @b CURLOPT_VERBOSE - only available for HTTP protocol and only - * when CURL is used. It has the same meaning as CURL's option with the same - * name. @p value is pointer to a long. - * - @b messageTimeout - the maximum time in milliseconds until a message + * The options that can be set via this API are: + * - @b timeout - the maximum time in milliseconds a communication is + * allowed to use. @p value is a pointer to an @c unsigned @c int with + * the timeout value in milliseconds. This is only supported for the HTTP + * protocol as of now. When the HTTP protocol uses CURL, the meaning of + * the parameter is <em>total request time</em>. When the HTTP protocol uses + * winhttp, the meaning is the same as the @c dwSendTimeout and + * @c dwReceiveTimeout parameters of the + * <a href="https://msdn.microsoft.com/en-us/library/windows/desktop/aa384116(v=vs.85).aspx"> + * WinHttpSetTimeouts</a> API. + * - @b CURLOPT_LOW_SPEED_LIMIT - only available for HTTP protocol and only + * when CURL is used. It has the same meaning as CURL's option with the same + * name. @p value is pointer to a long. + * - @b CURLOPT_LOW_SPEED_TIME - only available for HTTP protocol and only + * when CURL is used. It has the same meaning as CURL's option with the same + * name. @p value is pointer to a long. + * - @b CURLOPT_FORBID_REUSE - only available for HTTP protocol and only + * when CURL is used. It has the same meaning as CURL's option with the same + * name. @p value is pointer to a long. + * - @b CURLOPT_FRESH_CONNECT - only available for HTTP protocol and only + * when CURL is used. It has the same meaning as CURL's option with the same + * name. @p value is pointer to a long. + * - @b CURLOPT_VERBOSE - only available for HTTP protocol and only + * when CURL is used. It has the same meaning as CURL's option with the same + * name. @p value is pointer to a long. + * - @b messageTimeout - the maximum time in milliseconds until a message * is timeouted. The time starts at IoTHubDeviceClient_SendEventAsync. By default, * messages do not expire. @p is a pointer to a uint64_t - * - @b svc2cl_keep_alive_timeout_secs - the AMQP service side keep alive interval in seconds. + * - @b svc2cl_keep_alive_timeout_secs - the AMQP service side keep alive interval in seconds. * After the connection established the client requests the server to set the * keep alive interval for given time. * If it is not set then the default 240 sec applies. * If it is set to zero the server will not send keep alive messages to the client. - * - @b cl2svc_keep_alive_send_ratio - the AMQP client side keep alive interval in seconds. + * - @b cl2svc_keep_alive_send_ratio - the AMQP client side keep alive interval in seconds. * After the connection established the server requests the client to set the * keep alive interval for given time. * If it is not set then the default ratio of 1/2 is applied. * The ratio has to be greater than 0.0 and equal to or less than 0.9 - * @return IOTHUB_CLIENT_OK upon success or an error code upon failure. + * @return IOTHUB_CLIENT_OK upon success or an error code upon failure. */ MOCKABLE_FUNCTION(, IOTHUB_CLIENT_RESULT, IoTHubDeviceClient_SetOption, IOTHUB_DEVICE_CLIENT_HANDLE, iotHubClientHandle, const char*, optionName, const void*, value); /** - * @brief This API specifies a call back to be used when the device receives a state update. + * @brief This API specifies a call back to be used when the device receives a state update. * - * @param iotHubClientHandle The handle created by a call to the create function. - * @param deviceTwinCallback The callback specified by the device client to be used for updating - * the desired state. The callback will be called in response to a - * request send by the IoTHub services. The payload will be passed to the - * callback, along with two version numbers: - * - Desired: - * - LastSeenReported: - * @param userContextCallback User specified context that will be provided to the - * callback. This can be @c NULL. + * @param iotHubClientHandle The handle created by a call to the create function. + * @param deviceTwinCallback The callback specified by the device client to be used for updating + * the desired state. The callback will be called in response to a + * request send by the IoTHub services. The payload will be passed to the + * callback, along with two version numbers: + * - Desired: + * - LastSeenReported: + * @param userContextCallback User specified context that will be provided to the + * callback. This can be @c NULL. * - * @b NOTE: The application behavior is undefined if the user calls - * the ::IoTHubDeviceClient_Destroy function from within any callback. + * @b NOTE: The application behavior is undefined if the user calls + * the ::IoTHubDeviceClient_Destroy function from within any callback. * - * @return IOTHUB_CLIENT_OK upon success or an error code upon failure. + * @return IOTHUB_CLIENT_OK upon success or an error code upon failure. */ MOCKABLE_FUNCTION(, IOTHUB_CLIENT_RESULT, IoTHubDeviceClient_SetDeviceTwinCallback, IOTHUB_DEVICE_CLIENT_HANDLE, iotHubClientHandle, IOTHUB_CLIENT_DEVICE_TWIN_CALLBACK, deviceTwinCallback, void*, userContextCallback); /** - * @brief This API sends a report of the device's properties and their current values. + * @brief This API sends a report of the device's properties and their current values. * - * @param iotHubClientHandle The handle created by a call to the create function. - * @param reportedState The current device property values to be 'reported' to the IoTHub. - * @param reportedStateCallback The callback specified by the device client to be called with the - * result of the transaction. - * @param userContextCallback User specified context that will be provided to the - * callback. This can be @c NULL. + * @param iotHubClientHandle The handle created by a call to the create function. + * @param reportedState The current device property values to be 'reported' to the IoTHub. + * @param reportedStateCallback The callback specified by the device client to be called with the + * result of the transaction. + * @param userContextCallback User specified context that will be provided to the + * callback. This can be @c NULL. * - * @b NOTE: The application behavior is undefined if the user calls - * the ::IoTHubDeviceClient_Destroy function from within any callback. + * @b NOTE: The application behavior is undefined if the user calls + * the ::IoTHubDeviceClient_Destroy function from within any callback. * - * @return IOTHUB_CLIENT_OK upon success or an error code upon failure. + * @return IOTHUB_CLIENT_OK upon success or an error code upon failure. */ MOCKABLE_FUNCTION(, IOTHUB_CLIENT_RESULT, IoTHubDeviceClient_SendReportedState, IOTHUB_DEVICE_CLIENT_HANDLE, iotHubClientHandle, const unsigned char*, reportedState, size_t, size, IOTHUB_CLIENT_REPORTED_STATE_CALLBACK, reportedStateCallback, void*, userContextCallback); /** - * @brief This API sets callback for async cloud to device method call. + * @brief This API sets callback for async cloud to device method call. * - * @param iotHubClientHandle The handle created by a call to the create function. - * @param inboundDeviceMethodCallback The callback which will be called by IoTHub. - * @param userContextCallback User specified context that will be provided to the - * callback. This can be @c NULL. + * @param iotHubClientHandle The handle created by a call to the create function. + * @param inboundDeviceMethodCallback The callback which will be called by IoTHub. + * @param userContextCallback User specified context that will be provided to the + * callback. This can be @c NULL. * - * @return IOTHUB_CLIENT_OK upon success or an error code upon failure. + * @return IOTHUB_CLIENT_OK upon success or an error code upon failure. */ MOCKABLE_FUNCTION(, IOTHUB_CLIENT_RESULT, IoTHubDeviceClient_SetDeviceMethodCallback, IOTHUB_DEVICE_CLIENT_HANDLE, iotHubClientHandle, IOTHUB_CLIENT_DEVICE_METHOD_CALLBACK_ASYNC, deviceMethodCallback, void*, userContextCallback); /** - * @brief This API responses to a asnyc method callback identified the methodId. + * @brief This API responses to a asnyc method callback identified the methodId. * - * @param iotHubClientHandle The handle created by a call to the create function. - * @param methodId The methodId of the Device Method callback. - * @param response The response data for the method callback. - * @param response_size The size of the response data buffer. - * @param status_response The status response of the method callback. + * @param iotHubClientHandle The handle created by a call to the create function. + * @param methodId The methodId of the Device Method callback. + * @param response The response data for the method callback. + * @param response_size The size of the response data buffer. + * @param status_response The status response of the method callback. * - * @return IOTHUB_CLIENT_OK upon success or an error code upon failure. + * @return IOTHUB_CLIENT_OK upon success or an error code upon failure. */ MOCKABLE_FUNCTION(, IOTHUB_CLIENT_RESULT, IoTHubDeviceClient_DeviceMethodResponse, IOTHUB_DEVICE_CLIENT_HANDLE, iotHubClientHandle, METHOD_HANDLE, methodId, const unsigned char*, response, size_t, response_size, int, statusCode); #ifndef DONT_USE_UPLOADTOBLOB /** - * @brief IoTHubDeviceClient_UploadToBlobAsync uploads data from memory to a file in Azure Blob Storage. + * @brief IoTHubDeviceClient_UploadToBlobAsync uploads data from memory to a file in Azure Blob Storage. * - * @param iotHubClientHandle The handle created by a call to the IoTHubDeviceClient_Create function. - * @param destinationFileName The name of the file to be created in Azure Blob Storage. - * @param source The source of data. - * @param size The size of data. + * @param iotHubClientHandle The handle created by a call to the IoTHubDeviceClient_Create function. + * @param destinationFileName The name of the file to be created in Azure Blob Storage. + * @param source The source of data. + * @param size The size of data. * @param iotHubClientFileUploadCallback A callback to be invoked when the file upload operation has finished. * @param context A user-provided context to be passed to the file upload callback. * - * @return IOTHUB_CLIENT_OK upon success or an error code upon failure. + * @return IOTHUB_CLIENT_OK upon success or an error code upon failure. */ MOCKABLE_FUNCTION(, IOTHUB_CLIENT_RESULT, IoTHubDeviceClient_UploadToBlobAsync, IOTHUB_DEVICE_CLIENT_HANDLE, iotHubClientHandle, const char*, destinationFileName, const unsigned char*, source, size_t, size, IOTHUB_CLIENT_FILE_UPLOAD_CALLBACK, iotHubClientFileUploadCallback, void*, context);