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:
- 92:97148cf9aa2a
- Parent:
- 91:bbf806070c5f
diff -r bbf806070c5f -r 97148cf9aa2a iothub_device_client.h --- a/iothub_device_client.h Thu Jul 12 18:09:13 2018 -0700 +++ b/iothub_device_client.h Tue Sep 11 11:13:11 2018 -0700 @@ -1,7 +1,7 @@ // Copyright (c) Microsoft. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. -/** @file iothub_client.h +/** @file iothub_device_client.h * @brief Extends the IoTHubCLient_LL module with additional features. * * @details IoTHubClient is a module that extends the IoTHubCLient_LL @@ -257,9 +257,9 @@ * 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. - * After the connection established the client requests the server to set the + * 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 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. * After the connection established the server requests the client to set the @@ -272,11 +272,11 @@ 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 callback 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 + * 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: @@ -309,7 +309,7 @@ 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 the callback for async cloud to device method calls. * * @param iotHubClientHandle The handle created by a call to the create function. * @param inboundDeviceMethodCallback The callback which will be called by IoTHub. @@ -321,7 +321,7 @@ 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 responds to an 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.