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 |
|
---|
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.h.
|
---|
9 | //
|
---|
10 | //**********************************************************************
|
---|
11 |
|
---|
12 | /** @file iothub_client.h
|
---|
13 | * @brief Extends the IoTHubClient_LL with additional features.
|
---|
14 | *
|
---|
15 | * @note DEPRECATED. New users use iothub_device_client.h for IoTHubClient APIs.
|
---|
16 | * @details IoTHubClient is a module that extends the IoTHubCLient_LL
|
---|
17 | * module with 2 features:
|
---|
18 | * - scheduling the work for the IoTHubCLient from a
|
---|
19 | * thread, so that the user does not need to create their
|
---|
20 | * own thread
|
---|
21 | * - thread-safe APIs
|
---|
22 | */
|
---|
23 |
|
---|
24 | #ifndef IOTHUB_CLIENT_H
|
---|
25 | #define IOTHUB_CLIENT_H
|
---|
26 |
|
---|
27 | #include <stddef.h>
|
---|
28 | #include <stdint.h>
|
---|
29 |
|
---|
30 | #include "umock_c/umock_c_prod.h"
|
---|
31 | #include "iothub_transport_ll.h"
|
---|
32 | #include "iothub_client_core_ll.h"
|
---|
33 | #include "iothub_client_core.h"
|
---|
34 | #include "iothub_client_ll.h"
|
---|
35 |
|
---|
36 | #ifndef IOTHUB_CLIENT_INSTANCE_TYPE
|
---|
37 | typedef IOTHUB_CLIENT_CORE_HANDLE IOTHUB_CLIENT_HANDLE;
|
---|
38 | #define IOTHUB_CLIENT_INSTANCE_TYPE
|
---|
39 | #endif // IOTHUB_CLIENT_INSTANCE
|
---|
40 |
|
---|
41 |
|
---|
42 | #ifdef __cplusplus
|
---|
43 | extern "C"
|
---|
44 | {
|
---|
45 | #endif
|
---|
46 |
|
---|
47 | /**
|
---|
48 | * @deprecated IoTHubClient_CreateFromConnectionString is deprecated. Use IoTHubDeviceClient_CreateFromConnectionString instead.
|
---|
49 | */
|
---|
50 | MOCKABLE_FUNCTION(, IOTHUB_CLIENT_HANDLE, IoTHubClient_CreateFromConnectionString, const char*, connectionString, IOTHUB_CLIENT_TRANSPORT_PROVIDER, protocol);
|
---|
51 |
|
---|
52 | /**
|
---|
53 | * @deprecated IoTHubClient_Create is deprecated. Use IoTHubDeviceClient_Create instead.
|
---|
54 | */
|
---|
55 | MOCKABLE_FUNCTION(, IOTHUB_CLIENT_HANDLE, IoTHubClient_Create, const IOTHUB_CLIENT_CONFIG*, config);
|
---|
56 |
|
---|
57 | /**
|
---|
58 | * @deprecated IoTHubClient_CreateWithTransport is deprecated. Use IoTHubDeviceClient_CreateWithTransport instead.
|
---|
59 | */
|
---|
60 | MOCKABLE_FUNCTION(, IOTHUB_CLIENT_HANDLE, IoTHubClient_CreateWithTransport, TRANSPORT_HANDLE, transportHandle, const IOTHUB_CLIENT_CONFIG*, config);
|
---|
61 |
|
---|
62 | /**
|
---|
63 | * @deprecated IoTHubClient_CreateFromDeviceAuth is deprecated. Use IoTHubDeviceClient_CreateFromDeviceAuth instead.
|
---|
64 | */
|
---|
65 | MOCKABLE_FUNCTION(, IOTHUB_CLIENT_HANDLE, IoTHubClient_CreateFromDeviceAuth, const char*, iothub_uri, const char*, device_id, IOTHUB_CLIENT_TRANSPORT_PROVIDER, protocol);
|
---|
66 |
|
---|
67 | /**
|
---|
68 | * @deprecated IoTHubClient_Destroy is deprecated. Use IoTHubDeviceClient_Destroy instead.
|
---|
69 | */
|
---|
70 | MOCKABLE_FUNCTION(, void, IoTHubClient_Destroy, IOTHUB_CLIENT_HANDLE, iotHubClientHandle);
|
---|
71 |
|
---|
72 | /**
|
---|
73 | * @deprecated IoTHubClient_SendEventAsync is deprecated. Use IoTHubDeviceClient_SendEventAsync instead.
|
---|
74 | */
|
---|
75 | MOCKABLE_FUNCTION(, IOTHUB_CLIENT_RESULT, IoTHubClient_SendEventAsync, IOTHUB_CLIENT_HANDLE, iotHubClientHandle, IOTHUB_MESSAGE_HANDLE, eventMessageHandle, IOTHUB_CLIENT_EVENT_CONFIRMATION_CALLBACK, eventConfirmationCallback, void*, userContextCallback);
|
---|
76 |
|
---|
77 | /**
|
---|
78 | * @deprecated IoTHubClient_GetSendStatus is deprecated. Use IoTHubDeviceClient_GetSendStatus instead.
|
---|
79 | */
|
---|
80 | MOCKABLE_FUNCTION(, IOTHUB_CLIENT_RESULT, IoTHubClient_GetSendStatus, IOTHUB_CLIENT_HANDLE, iotHubClientHandle, IOTHUB_CLIENT_STATUS*, iotHubClientStatus);
|
---|
81 |
|
---|
82 | /**
|
---|
83 | * @deprecated IoTHubClient_SetMessageCallback is deprecated. Use IoTHubDeviceClient_SetMessageCallback instead.
|
---|
84 | */
|
---|
85 | MOCKABLE_FUNCTION(, IOTHUB_CLIENT_RESULT, IoTHubClient_SetMessageCallback, IOTHUB_CLIENT_HANDLE, iotHubClientHandle, IOTHUB_CLIENT_MESSAGE_CALLBACK_ASYNC, messageCallback, void*, userContextCallback);
|
---|
86 |
|
---|
87 | /**
|
---|
88 | * @deprecated IoTHubClient_SetConnectionStatusCallback is deprecated. Use IoTHubDeviceClient_SetConnectionStatusCallback instead.
|
---|
89 | */
|
---|
90 | MOCKABLE_FUNCTION(, IOTHUB_CLIENT_RESULT, IoTHubClient_SetConnectionStatusCallback, IOTHUB_CLIENT_HANDLE, iotHubClientHandle, IOTHUB_CLIENT_CONNECTION_STATUS_CALLBACK, connectionStatusCallback, void*, userContextCallback);
|
---|
91 |
|
---|
92 | /**
|
---|
93 | * @deprecated IoTHubClient_SetRetryPolicy is deprecated. Use IoTHubDeviceClient_SetRetryPolicy instead.
|
---|
94 | */
|
---|
95 | MOCKABLE_FUNCTION(, IOTHUB_CLIENT_RESULT, IoTHubClient_SetRetryPolicy, IOTHUB_CLIENT_HANDLE, iotHubClientHandle, IOTHUB_CLIENT_RETRY_POLICY, retryPolicy, size_t, retryTimeoutLimitInSeconds);
|
---|
96 |
|
---|
97 | /**
|
---|
98 | * @deprecated IoTHubClient_GetRetryPolicy is deprecated. Use IoTHubDeviceClient_GetRetryPolicy instead.
|
---|
99 | */
|
---|
100 | MOCKABLE_FUNCTION(, IOTHUB_CLIENT_RESULT, IoTHubClient_GetRetryPolicy, IOTHUB_CLIENT_HANDLE, iotHubClientHandle, IOTHUB_CLIENT_RETRY_POLICY*, retryPolicy, size_t*, retryTimeoutLimitInSeconds);
|
---|
101 |
|
---|
102 | /**
|
---|
103 | * @deprecated IoTHubClient_GetLastMessageReceiveTime is deprecated. Use IoTHubDeviceClient_GetLastMessageReceiveTime instead.
|
---|
104 | */
|
---|
105 | MOCKABLE_FUNCTION(, IOTHUB_CLIENT_RESULT, IoTHubClient_GetLastMessageReceiveTime, IOTHUB_CLIENT_HANDLE, iotHubClientHandle, time_t*, lastMessageReceiveTime);
|
---|
106 |
|
---|
107 | /**
|
---|
108 | * @deprecated IoTHubClient_SetOption is deprecated. Use IoTHubDeviceClient_SetOption instead.
|
---|
109 | */
|
---|
110 | MOCKABLE_FUNCTION(, IOTHUB_CLIENT_RESULT, IoTHubClient_SetOption, IOTHUB_CLIENT_HANDLE, iotHubClientHandle, const char*, optionName, const void*, value);
|
---|
111 |
|
---|
112 | /**
|
---|
113 | * @deprecated IoTHubClient_SetDeviceTwinCallback is deprecated. Use IoTHubDeviceClient_SetDeviceTwinCallback instead.
|
---|
114 | */
|
---|
115 | MOCKABLE_FUNCTION(, IOTHUB_CLIENT_RESULT, IoTHubClient_SetDeviceTwinCallback, IOTHUB_CLIENT_HANDLE, iotHubClientHandle, IOTHUB_CLIENT_DEVICE_TWIN_CALLBACK, deviceTwinCallback, void*, userContextCallback);
|
---|
116 |
|
---|
117 | /**
|
---|
118 | * @deprecated IoTHubClient_SendReportedState is deprecated. Use IoTHubDeviceClient_SendReportedState instead.
|
---|
119 | */
|
---|
120 | MOCKABLE_FUNCTION(, IOTHUB_CLIENT_RESULT, IoTHubClient_SendReportedState, IOTHUB_CLIENT_HANDLE, iotHubClientHandle, const unsigned char*, reportedState, size_t, size, IOTHUB_CLIENT_REPORTED_STATE_CALLBACK, reportedStateCallback, void*, userContextCallback);
|
---|
121 |
|
---|
122 | /**
|
---|
123 | * @deprecated IoTHubClient_SetDeviceMethodCallback is deprecated. Use IoTHubDeviceClient_SetDeviceMethodCallback instead.
|
---|
124 | */
|
---|
125 | MOCKABLE_FUNCTION(, IOTHUB_CLIENT_RESULT, IoTHubClient_SetDeviceMethodCallback, IOTHUB_CLIENT_HANDLE, iotHubClientHandle, IOTHUB_CLIENT_DEVICE_METHOD_CALLBACK_ASYNC, deviceMethodCallback, void*, userContextCallback);
|
---|
126 |
|
---|
127 | /**
|
---|
128 | * @deprecated IoTHubClient_SetDeviceMethodCallback_Ex is deprecated. Use IoTHubDeviceClient_SetDeviceMethodCallback instead.
|
---|
129 | */
|
---|
130 | MOCKABLE_FUNCTION(, IOTHUB_CLIENT_RESULT, IoTHubClient_SetDeviceMethodCallback_Ex, IOTHUB_CLIENT_HANDLE, iotHubClientHandle, IOTHUB_CLIENT_INBOUND_DEVICE_METHOD_CALLBACK, inboundDeviceMethodCallback, void*, userContextCallback);
|
---|
131 |
|
---|
132 | /**
|
---|
133 | * @deprecated IoTHubClient_DeviceMethodResponse is deprecated. Use IoTHubDeviceClient_SetDeviceMethodCallback instead.
|
---|
134 | */
|
---|
135 | MOCKABLE_FUNCTION(, IOTHUB_CLIENT_RESULT, IoTHubClient_DeviceMethodResponse, IOTHUB_CLIENT_HANDLE, iotHubClientHandle, METHOD_HANDLE, methodId, const unsigned char*, response, size_t, response_size, int, statusCode);
|
---|
136 |
|
---|
137 | #ifndef DONT_USE_UPLOADTOBLOB
|
---|
138 | /**
|
---|
139 | * @deprecated IoTHubClient_UploadToBlobAsync is deprecated. Use IoTHubDeviceClient_UploadToBlobAsync instead.
|
---|
140 | */
|
---|
141 | MOCKABLE_FUNCTION(, IOTHUB_CLIENT_RESULT, IoTHubClient_UploadToBlobAsync, IOTHUB_CLIENT_HANDLE, iotHubClientHandle, const char*, destinationFileName, const unsigned char*, source, size_t, size, IOTHUB_CLIENT_FILE_UPLOAD_CALLBACK, iotHubClientFileUploadCallback, void*, context);
|
---|
142 |
|
---|
143 | /**
|
---|
144 | * @deprecated IoTHubClient_UploadMultipleBlocksToBlobAsync is deprecated. Use IoTHubDeviceClient_UploadMultipleBlocksToBlobAsync instead.
|
---|
145 | */
|
---|
146 | MOCKABLE_FUNCTION(, IOTHUB_CLIENT_RESULT, IoTHubClient_UploadMultipleBlocksToBlobAsync, IOTHUB_CLIENT_HANDLE, iotHubClientHandle, const char*, destinationFileName, IOTHUB_CLIENT_FILE_UPLOAD_GET_DATA_CALLBACK, getDataCallback, void*, context);
|
---|
147 |
|
---|
148 | /**
|
---|
149 | * @deprecated IoTHubClient_UploadMultipleBlocksToBlobAsyncEx is deprecated. Use IoTHubDeviceClient_UploadMultipleBlocksToBlobAsync instead.
|
---|
150 | */
|
---|
151 | MOCKABLE_FUNCTION(, IOTHUB_CLIENT_RESULT, IoTHubClient_UploadMultipleBlocksToBlobAsyncEx, IOTHUB_CLIENT_HANDLE, iotHubClientHandle, const char*, destinationFileName, IOTHUB_CLIENT_FILE_UPLOAD_GET_DATA_CALLBACK_EX, getDataCallbackEx, void*, context);
|
---|
152 |
|
---|
153 | #endif /* DONT_USE_UPLOADTOBLOB */
|
---|
154 |
|
---|
155 | #ifdef __cplusplus
|
---|
156 | }
|
---|
157 | #endif
|
---|
158 |
|
---|
159 | #endif /* IOTHUB_CLIENT_H */
|
---|