[457] | 1 | // Copyright (c) Microsoft. All rights reserved.
|
---|
| 2 | // Licensed under the MIT license. See LICENSE file in the project root for full license information.
|
---|
| 3 |
|
---|
[464] | 4 | //**********************************************************************
|
---|
| 5 | // NOTE: THIS HEADER IS DEPRECATED
|
---|
| 6 | //
|
---|
| 7 | // Functions in this header will be maintained for backward compatability.
|
---|
| 8 | // New applications should use iothub_device_client_ll.h.
|
---|
| 9 | //
|
---|
| 10 | //**********************************************************************
|
---|
| 11 |
|
---|
| 12 |
|
---|
[457] | 13 | /** @file iothub_client_ll.h
|
---|
| 14 | * @brief APIs that allow a user (usually a device) to communicate
|
---|
| 15 | * with an Azure IoTHub.
|
---|
| 16 | *
|
---|
[464] | 17 | * @details IoTHubClient_LL allows a user (usually a
|
---|
[457] | 18 | * device) to communicate with an Azure IoTHub. It can send events
|
---|
| 19 | * and receive messages. At any given moment in time there can only
|
---|
| 20 | * be at most 1 message callback function.
|
---|
| 21 | *
|
---|
| 22 | * This API surface contains a set of APIs that allows the user to
|
---|
| 23 | * interact with the lower layer portion of the IoTHubClient. These APIs
|
---|
| 24 | * contain @c _LL_ in their name, but retain the same functionality like the
|
---|
| 25 | * @c IoTHubClient_... APIs, with one difference. If the @c _LL_ APIs are
|
---|
| 26 | * used then the user is responsible for scheduling when the actual work done
|
---|
| 27 | * by the IoTHubClient happens (when the data is sent/received on/from the wire).
|
---|
| 28 | * This is useful for constrained devices where spinning a separate thread is
|
---|
| 29 | * often not desired.
|
---|
| 30 | */
|
---|
| 31 |
|
---|
| 32 | #ifndef IOTHUB_CLIENT_LL_H
|
---|
| 33 | #define IOTHUB_CLIENT_LL_H
|
---|
| 34 |
|
---|
| 35 | #include <stddef.h>
|
---|
| 36 | #include <stdint.h>
|
---|
| 37 | #include <time.h>
|
---|
| 38 | #include "umock_c/umock_c_prod.h"
|
---|
| 39 |
|
---|
| 40 | #include "iothub_client_core_common.h"
|
---|
| 41 |
|
---|
| 42 | #ifdef __cplusplus
|
---|
| 43 | extern "C"
|
---|
| 44 | {
|
---|
| 45 | #endif
|
---|
| 46 |
|
---|
| 47 | typedef struct IOTHUB_CLIENT_CORE_LL_HANDLE_DATA_TAG* IOTHUB_CLIENT_LL_HANDLE;
|
---|
| 48 |
|
---|
[464] | 49 | /**
|
---|
| 50 | * @deprecated IoTHubClient_LL_CreateFromConnectionString is deprecated. Use IoTHubDeviceClient_LL_CreateFromConnectionString instead.
|
---|
| 51 | */
|
---|
| 52 | MOCKABLE_FUNCTION(, IOTHUB_CLIENT_LL_HANDLE, IoTHubClient_LL_CreateFromConnectionString, const char*, connectionString, IOTHUB_CLIENT_TRANSPORT_PROVIDER, protocol);
|
---|
[457] | 53 |
|
---|
| 54 | /**
|
---|
[464] | 55 | * @deprecated IoTHubClient_LL_Create is deprecated. Use IoTHubDeviceClient_LL_Create instead.
|
---|
[457] | 56 | */
|
---|
[464] | 57 | MOCKABLE_FUNCTION(, IOTHUB_CLIENT_LL_HANDLE, IoTHubClient_LL_Create, const IOTHUB_CLIENT_CONFIG*, config);
|
---|
[457] | 58 |
|
---|
| 59 | /**
|
---|
[464] | 60 | * @deprecated IoTHubClient_LL_CreateWithTransport is deprecated. Use IoTHubDeviceClient_LL_CreateWithTransport instead.
|
---|
[457] | 61 | */
|
---|
[464] | 62 | MOCKABLE_FUNCTION(, IOTHUB_CLIENT_LL_HANDLE, IoTHubClient_LL_CreateWithTransport, const IOTHUB_CLIENT_DEVICE_CONFIG*, config);
|
---|
[457] | 63 |
|
---|
| 64 | /**
|
---|
[464] | 65 | * @deprecated IoTHubClient_LL_CreateFromDeviceAuth is deprecated. Use IoTHubDeviceClient_LL_CreateFromDeviceAuth instead.
|
---|
[457] | 66 | */
|
---|
[464] | 67 | MOCKABLE_FUNCTION(, IOTHUB_CLIENT_LL_HANDLE, IoTHubClient_LL_CreateFromDeviceAuth, const char*, iothub_uri, const char*, device_id, IOTHUB_CLIENT_TRANSPORT_PROVIDER, protocol);
|
---|
[457] | 68 |
|
---|
[464] | 69 | /**
|
---|
| 70 | * @deprecated IoTHubClient_LL_Destroy is deprecatedDevice. Use IoTHubClient_LL_Destroy instead.
|
---|
| 71 | */
|
---|
| 72 | MOCKABLE_FUNCTION(, void, IoTHubClient_LL_Destroy, IOTHUB_CLIENT_LL_HANDLE, iotHubClientHandle);
|
---|
[457] | 73 |
|
---|
| 74 | /**
|
---|
[464] | 75 | * @deprecated IoTHubClient_LL_SendEventAsync is deprecated. Use IoTHubDeviceClient_LL_SendEventAsync instead.
|
---|
[457] | 76 | */
|
---|
[464] | 77 | MOCKABLE_FUNCTION(, IOTHUB_CLIENT_RESULT, IoTHubClient_LL_SendEventAsync, IOTHUB_CLIENT_LL_HANDLE, iotHubClientHandle, IOTHUB_MESSAGE_HANDLE, eventMessageHandle, IOTHUB_CLIENT_EVENT_CONFIRMATION_CALLBACK, eventConfirmationCallback, void*, userContextCallback);
|
---|
[457] | 78 |
|
---|
| 79 | /**
|
---|
[464] | 80 | * @deprecated IoTHubClient_LL_GetSendStatus is deprecated. UseDevice IoTHubClient_LL_GetSendStatus instead.
|
---|
[457] | 81 | */
|
---|
[464] | 82 | MOCKABLE_FUNCTION(, IOTHUB_CLIENT_RESULT, IoTHubClient_LL_GetSendStatus, IOTHUB_CLIENT_LL_HANDLE, iotHubClientHandle, IOTHUB_CLIENT_STATUS*, iotHubClientStatus);
|
---|
[457] | 83 |
|
---|
| 84 | /**
|
---|
[464] | 85 | * @deprecated IoTHubClient_LL_SetMessageCallback is deprecated. Use IoTHubDeviceClient_LL_SetMessageCallback instead.
|
---|
[457] | 86 | */
|
---|
[464] | 87 | MOCKABLE_FUNCTION(, IOTHUB_CLIENT_RESULT, IoTHubClient_LL_SetMessageCallback, IOTHUB_CLIENT_LL_HANDLE, iotHubClientHandle, IOTHUB_CLIENT_MESSAGE_CALLBACK_ASYNC, messageCallback, void*, userContextCallback);
|
---|
[457] | 88 |
|
---|
| 89 | /**
|
---|
[464] | 90 | * @deprecated IoTHubClient_LL_SetConnectionStatusCallback is deprecated. Use IoTHubDeviceClient_LL_SetConnectionStatusCallback instead.
|
---|
[457] | 91 | */
|
---|
[464] | 92 | MOCKABLE_FUNCTION(, IOTHUB_CLIENT_RESULT, IoTHubClient_LL_SetConnectionStatusCallback, IOTHUB_CLIENT_LL_HANDLE, iotHubClientHandle, IOTHUB_CLIENT_CONNECTION_STATUS_CALLBACK, connectionStatusCallback, void*, userContextCallback);
|
---|
[457] | 93 |
|
---|
| 94 | /**
|
---|
[464] | 95 | * @deprecated IoTHubClient_LL_SetRetryPolicy is deprecated. Use IoTHubDeviceClient_LL_SetRetryPolicy instead.
|
---|
[457] | 96 | */
|
---|
[464] | 97 | MOCKABLE_FUNCTION(, IOTHUB_CLIENT_RESULT, IoTHubClient_LL_SetRetryPolicy, IOTHUB_CLIENT_LL_HANDLE, iotHubClientHandle, IOTHUB_CLIENT_RETRY_POLICY, retryPolicy, size_t, retryTimeoutLimitInSeconds);
|
---|
[457] | 98 |
|
---|
| 99 | /**
|
---|
[464] | 100 | * @deprecated IoTHubClient_LL_GetRetryPolicy is deprecated. Use IoTHubDeviceClient_LL_GetRetryPolicy instead.
|
---|
[457] | 101 | */
|
---|
[464] | 102 | MOCKABLE_FUNCTION(, IOTHUB_CLIENT_RESULT, IoTHubClient_LL_GetRetryPolicy, IOTHUB_CLIENT_LL_HANDLE, iotHubClientHandle, IOTHUB_CLIENT_RETRY_POLICY*, retryPolicy, size_t*, retryTimeoutLimitInSeconds);
|
---|
[457] | 103 |
|
---|
[464] | 104 | /**
|
---|
| 105 | * @deprecated IoTHubClient_LL_GetLastMessageReceiveTime is deprecated. Use IoTHubDeviceClient_LL_GetLastMessageReceiveTime instead.
|
---|
| 106 | */
|
---|
| 107 | MOCKABLE_FUNCTION(, IOTHUB_CLIENT_RESULT, IoTHubClient_LL_GetLastMessageReceiveTime, IOTHUB_CLIENT_LL_HANDLE, iotHubClientHandle, time_t*, lastMessageReceiveTime);
|
---|
[457] | 108 |
|
---|
| 109 | /**
|
---|
[464] | 110 | * @deprecated IoTHubClient_LL_DoWork is deprecateDeviced. Use IoTHubDeviceClient_LL_DoWork instead.
|
---|
[457] | 111 | */
|
---|
[464] | 112 | MOCKABLE_FUNCTION(, void, IoTHubClient_LL_DoWork, IOTHUB_CLIENT_LL_HANDLE, iotHubClientHandle);
|
---|
[457] | 113 |
|
---|
| 114 | /**
|
---|
[464] | 115 | * @deprecated IoTHubClient_LL_SetOption is deprecated. Device Use IoTHubDeviceClient_LL_SetOption instead.
|
---|
[457] | 116 | */
|
---|
[464] | 117 | MOCKABLE_FUNCTION(, IOTHUB_CLIENT_RESULT, IoTHubClient_LL_SetOption, IOTHUB_CLIENT_LL_HANDLE, iotHubClientHandle, const char*, optionName, const void*, value);
|
---|
[457] | 118 |
|
---|
| 119 | /**
|
---|
[464] | 120 | * @deprecated IoTHubClient_LL_SetDeviceTwinCallback is deprecated. Use IoTHubDeviceClient_LL_SetDeviceTwinCallback instead.
|
---|
[457] | 121 | */
|
---|
[464] | 122 | MOCKABLE_FUNCTION(, IOTHUB_CLIENT_RESULT, IoTHubClient_LL_SetDeviceTwinCallback, IOTHUB_CLIENT_LL_HANDLE, iotHubClientHandle, IOTHUB_CLIENT_DEVICE_TWIN_CALLBACK, deviceTwinCallback, void*, userContextCallback);
|
---|
[457] | 123 |
|
---|
| 124 | /**
|
---|
[464] | 125 | * @deprecated IoTHubClient_LL_SendReportedState is deprecated. Use IoTHubDeviceClient_LL_SendReportedState instead.
|
---|
[457] | 126 | */
|
---|
[464] | 127 | MOCKABLE_FUNCTION(, IOTHUB_CLIENT_RESULT, IoTHubClient_LL_SendReportedState, IOTHUB_CLIENT_LL_HANDLE, iotHubClientHandle, const unsigned char*, reportedState, size_t, size, IOTHUB_CLIENT_REPORTED_STATE_CALLBACK, reportedStateCallback, void*, userContextCallback);
|
---|
[457] | 128 |
|
---|
| 129 | /**
|
---|
[464] | 130 | * @deprecated IoTHubClient_LL_SetDeviceMethodCallback is deprecated. Use IoTHubDeviceClient_LL_SetDeviceMethodCallback instead.
|
---|
[457] | 131 | */
|
---|
[464] | 132 | MOCKABLE_FUNCTION(, IOTHUB_CLIENT_RESULT, IoTHubClient_LL_SetDeviceMethodCallback, IOTHUB_CLIENT_LL_HANDLE, iotHubClientHandle, IOTHUB_CLIENT_DEVICE_METHOD_CALLBACK_ASYNC, deviceMethodCallback, void*, userContextCallback);
|
---|
[457] | 133 |
|
---|
| 134 | /**
|
---|
[464] | 135 | * @deprecated IoTHubClient_LL_SetDeviceMethodCallback_Ex is deprecated. Use IoTHubDeviceClient_LL_SetDeviceMethodCallback instead.
|
---|
[457] | 136 | */
|
---|
[464] | 137 | MOCKABLE_FUNCTION(, IOTHUB_CLIENT_RESULT, IoTHubClient_LL_SetDeviceMethodCallback_Ex, IOTHUB_CLIENT_LL_HANDLE, iotHubClientHandle, IOTHUB_CLIENT_INBOUND_DEVICE_METHOD_CALLBACK, inboundDeviceMethodCallback, void*, userContextCallback);
|
---|
[457] | 138 |
|
---|
[464] | 139 | /**
|
---|
| 140 | * @deprecated IoTHubClient_LL_DeviceMethodResponse is deprecated. Use IoTHubDeviceClient_LL_SetDeviceMethodCallback instead.
|
---|
| 141 | */
|
---|
| 142 | MOCKABLE_FUNCTION(, IOTHUB_CLIENT_RESULT, IoTHubClient_LL_DeviceMethodResponse, IOTHUB_CLIENT_LL_HANDLE, iotHubClientHandle, METHOD_HANDLE, methodId, const unsigned char*, response, size_t, respSize, int, statusCode);
|
---|
[457] | 143 |
|
---|
| 144 | #ifndef DONT_USE_UPLOADTOBLOB
|
---|
| 145 | /**
|
---|
[464] | 146 | * @deprecated IoTHubClient_LL_UploadToBlob is deprecated. UsDevicee IoTHubDeviceClient_LL_UploadToBlob instead.
|
---|
[457] | 147 | */
|
---|
[464] | 148 | MOCKABLE_FUNCTION(, IOTHUB_CLIENT_RESULT, IoTHubClient_LL_UploadToBlob, IOTHUB_CLIENT_LL_HANDLE, iotHubClientHandle, const char*, destinationFileName, const unsigned char*, source, size_t, size);
|
---|
[457] | 149 |
|
---|
[464] | 150 | /**
|
---|
| 151 | * @deprecated IoTHubClient_LL_UploadMultipleBlocksToBlob is deprecated. Use IoTHubDeviceClient_LL_UploadMultipleBlocksToBlob instead.
|
---|
| 152 | */
|
---|
| 153 | MOCKABLE_FUNCTION(, IOTHUB_CLIENT_RESULT, IoTHubClient_LL_UploadMultipleBlocksToBlob, IOTHUB_CLIENT_LL_HANDLE, iotHubClientHandle, const char*, destinationFileName, IOTHUB_CLIENT_FILE_UPLOAD_GET_DATA_CALLBACK, getDataCallback, void*, context);
|
---|
[457] | 154 |
|
---|
[464] | 155 | /**
|
---|
| 156 | * @deprecated IoTHubClient_LL_UploadMultipleBlocksToBlobEx is deprecated. Use IoTHubDeviceClient_LL_UploadMultipleBlocksToBlob instead.
|
---|
| 157 | */
|
---|
| 158 | MOCKABLE_FUNCTION(, IOTHUB_CLIENT_RESULT, IoTHubClient_LL_UploadMultipleBlocksToBlobEx, IOTHUB_CLIENT_LL_HANDLE, iotHubClientHandle, const char*, destinationFileName, IOTHUB_CLIENT_FILE_UPLOAD_GET_DATA_CALLBACK_EX, getDataCallbackEx, void*, context);
|
---|
[457] | 159 |
|
---|
| 160 | #endif /*DONT_USE_UPLOADTOBLOB*/
|
---|
| 161 |
|
---|
| 162 | #ifdef __cplusplus
|
---|
| 163 | }
|
---|
| 164 | #endif
|
---|
| 165 |
|
---|
| 166 | #endif /* IOTHUB_CLIENT_LL_H */
|
---|