source: azure_iot_hub_riscv/trunk/azure_iot_sdk/iothub_client/inc/iothub_client_core_common.h@ 453

Last change on this file since 453 was 453, checked in by coas-nagasima, 4 years ago

ファイルを追加
  • Property svn:eol-style set to native
  • Property svn:mime-type set to text/x-chdr;charset=UTF-8
File size: 11.7 KB
Line 
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/* Shared structures and enums for iothub convenience layer and LL layer */
5
6#ifndef IOTHUB_CLIENT_CORE_COMMON_H
7#define IOTHUB_CLIENT_CORE_COMMON_H
8
9#include "azure_macro_utils/macro_utils.h"
10#include "umock_c/umock_c_prod.h"
11
12#include "iothub_transport_ll.h"
13#include "iothub_message.h"
14
15#ifdef __cplusplus
16extern "C"
17{
18#endif
19
20#define IOTHUB_CLIENT_FILE_UPLOAD_RESULT_VALUES \
21 FILE_UPLOAD_OK, \
22 FILE_UPLOAD_ERROR
23
24 MU_DEFINE_ENUM_WITHOUT_INVALID(IOTHUB_CLIENT_FILE_UPLOAD_RESULT, IOTHUB_CLIENT_FILE_UPLOAD_RESULT_VALUES)
25 typedef void(*IOTHUB_CLIENT_FILE_UPLOAD_CALLBACK)(IOTHUB_CLIENT_FILE_UPLOAD_RESULT result, void* userContextCallback);
26
27#define IOTHUB_CLIENT_RESULT_VALUES \
28 IOTHUB_CLIENT_OK, \
29 IOTHUB_CLIENT_INVALID_ARG, \
30 IOTHUB_CLIENT_ERROR, \
31 IOTHUB_CLIENT_INVALID_SIZE, \
32 IOTHUB_CLIENT_INDEFINITE_TIME
33
34 /** @brief Enumeration specifying the status of calls to various APIs in this module.
35 */
36
37 MU_DEFINE_ENUM_WITHOUT_INVALID(IOTHUB_CLIENT_RESULT, IOTHUB_CLIENT_RESULT_VALUES);
38
39 typedef void(*IOTHUB_METHOD_INVOKE_CALLBACK)(IOTHUB_CLIENT_RESULT result, int responseStatus, unsigned char* responsePayload, size_t responsePayloadSize, void* context);
40
41#define IOTHUB_CLIENT_RETRY_POLICY_VALUES \
42 IOTHUB_CLIENT_RETRY_NONE, \
43 IOTHUB_CLIENT_RETRY_IMMEDIATE, \
44 IOTHUB_CLIENT_RETRY_INTERVAL, \
45 IOTHUB_CLIENT_RETRY_LINEAR_BACKOFF, \
46 IOTHUB_CLIENT_RETRY_EXPONENTIAL_BACKOFF, \
47 IOTHUB_CLIENT_RETRY_EXPONENTIAL_BACKOFF_WITH_JITTER, \
48 IOTHUB_CLIENT_RETRY_RANDOM
49
50 /** @brief Enumeration passed in by the IoT Hub when the event confirmation
51 * callback is invoked to indicate status of the event processing in
52 * the hub.
53 */
54 MU_DEFINE_ENUM_WITHOUT_INVALID(IOTHUB_CLIENT_RETRY_POLICY, IOTHUB_CLIENT_RETRY_POLICY_VALUES);
55
56 struct IOTHUBTRANSPORT_CONFIG_TAG;
57 typedef struct IOTHUBTRANSPORT_CONFIG_TAG IOTHUBTRANSPORT_CONFIG;
58
59#define IOTHUB_CLIENT_STATUS_VALUES \
60 IOTHUB_CLIENT_SEND_STATUS_IDLE, \
61 IOTHUB_CLIENT_SEND_STATUS_BUSY
62
63 /** @brief Enumeration returned by the ::IoTHubClient_LL_GetSendStatus
64 * API to indicate the current sending status of the IoT Hub client.
65 */
66 MU_DEFINE_ENUM_WITHOUT_INVALID(IOTHUB_CLIENT_STATUS, IOTHUB_CLIENT_STATUS_VALUES);
67
68#define IOTHUB_IDENTITY_TYPE_VALUE \
69 IOTHUB_TYPE_TELEMETRY, \
70 IOTHUB_TYPE_DEVICE_TWIN, \
71 IOTHUB_TYPE_DEVICE_METHODS, \
72 IOTHUB_TYPE_EVENT_QUEUE
73 MU_DEFINE_ENUM_WITHOUT_INVALID(IOTHUB_IDENTITY_TYPE, IOTHUB_IDENTITY_TYPE_VALUE);
74
75#define IOTHUB_PROCESS_ITEM_RESULT_VALUE \
76 IOTHUB_PROCESS_OK, \
77 IOTHUB_PROCESS_ERROR, \
78 IOTHUB_PROCESS_NOT_CONNECTED, \
79 IOTHUB_PROCESS_CONTINUE
80 MU_DEFINE_ENUM_WITHOUT_INVALID(IOTHUB_PROCESS_ITEM_RESULT, IOTHUB_PROCESS_ITEM_RESULT_VALUE);
81
82#define IOTHUBMESSAGE_DISPOSITION_RESULT_VALUES \
83 IOTHUBMESSAGE_ACCEPTED, \
84 IOTHUBMESSAGE_REJECTED, \
85 IOTHUBMESSAGE_ABANDONED
86
87 /** @brief Enumeration returned by the callback which is invoked whenever the
88 * IoT Hub sends a message to the device.
89 */
90 MU_DEFINE_ENUM_WITHOUT_INVALID(IOTHUBMESSAGE_DISPOSITION_RESULT, IOTHUBMESSAGE_DISPOSITION_RESULT_VALUES);
91
92#define IOTHUB_CLIENT_IOTHUB_METHOD_STATUS_VALUES \
93 IOTHUB_CLIENT_IOTHUB_METHOD_STATUS_SUCCESS, \
94 IOTHUB_CLIENT_IOTHUB_METHOD_STATUS_ERROR \
95
96 /** @brief Enumeration returned by remotely executed functions
97 */
98 MU_DEFINE_ENUM_WITHOUT_INVALID(IOTHUB_CLIENT_IOTHUB_METHOD_STATUS, IOTHUB_CLIENT_IOTHUB_METHOD_STATUS_VALUES);
99
100
101#define IOTHUB_CLIENT_CONFIRMATION_RESULT_VALUES \
102 IOTHUB_CLIENT_CONFIRMATION_OK, \
103 IOTHUB_CLIENT_CONFIRMATION_BECAUSE_DESTROY, \
104 IOTHUB_CLIENT_CONFIRMATION_MESSAGE_TIMEOUT, \
105 IOTHUB_CLIENT_CONFIRMATION_ERROR \
106
107 /** @brief Enumeration passed in by the IoT Hub when the event confirmation
108 * callback is invoked to indicate status of the event processing in
109 * the hub.
110 */
111 MU_DEFINE_ENUM_WITHOUT_INVALID(IOTHUB_CLIENT_CONFIRMATION_RESULT, IOTHUB_CLIENT_CONFIRMATION_RESULT_VALUES);
112
113#define IOTHUB_CLIENT_CONNECTION_STATUS_VALUES \
114 IOTHUB_CLIENT_CONNECTION_AUTHENTICATED, \
115 IOTHUB_CLIENT_CONNECTION_UNAUTHENTICATED \
116
117
118 /** @brief Enumeration passed in by the IoT Hub when the connection status
119 * callback is invoked to indicate status of the connection in
120 * the hub.
121 */
122 MU_DEFINE_ENUM_WITHOUT_INVALID(IOTHUB_CLIENT_CONNECTION_STATUS, IOTHUB_CLIENT_CONNECTION_STATUS_VALUES);
123
124#define IOTHUB_CLIENT_CONNECTION_STATUS_REASON_VALUES \
125 IOTHUB_CLIENT_CONNECTION_EXPIRED_SAS_TOKEN, \
126 IOTHUB_CLIENT_CONNECTION_DEVICE_DISABLED, \
127 IOTHUB_CLIENT_CONNECTION_BAD_CREDENTIAL, \
128 IOTHUB_CLIENT_CONNECTION_RETRY_EXPIRED, \
129 IOTHUB_CLIENT_CONNECTION_NO_NETWORK, \
130 IOTHUB_CLIENT_CONNECTION_COMMUNICATION_ERROR, \
131 IOTHUB_CLIENT_CONNECTION_OK, \
132 IOTHUB_CLIENT_CONNECTION_NO_PING_RESPONSE \
133
134 /** @brief Enumeration passed in by the IoT Hub when the connection status
135 * callback is invoked to indicate status of the connection in
136 * the hub.
137 */
138 MU_DEFINE_ENUM_WITHOUT_INVALID(IOTHUB_CLIENT_CONNECTION_STATUS_REASON, IOTHUB_CLIENT_CONNECTION_STATUS_REASON_VALUES);
139
140#define TRANSPORT_TYPE_VALUES \
141 TRANSPORT_LL, /*LL comes from "LowLevel" */ \
142 TRANSPORT_THREADED
143
144 MU_DEFINE_ENUM_WITHOUT_INVALID(TRANSPORT_TYPE, TRANSPORT_TYPE_VALUES);
145
146#define DEVICE_TWIN_UPDATE_STATE_VALUES \
147 DEVICE_TWIN_UPDATE_COMPLETE, \
148 DEVICE_TWIN_UPDATE_PARTIAL
149
150 MU_DEFINE_ENUM_WITHOUT_INVALID(DEVICE_TWIN_UPDATE_STATE, DEVICE_TWIN_UPDATE_STATE_VALUES);
151
152 typedef void(*IOTHUB_CLIENT_EVENT_CONFIRMATION_CALLBACK)(IOTHUB_CLIENT_CONFIRMATION_RESULT result, void* userContextCallback);
153 typedef void(*IOTHUB_CLIENT_CONNECTION_STATUS_CALLBACK)(IOTHUB_CLIENT_CONNECTION_STATUS result, IOTHUB_CLIENT_CONNECTION_STATUS_REASON reason, void* userContextCallback);
154 typedef IOTHUBMESSAGE_DISPOSITION_RESULT (*IOTHUB_CLIENT_MESSAGE_CALLBACK_ASYNC)(IOTHUB_MESSAGE_HANDLE message, void* userContextCallback);
155
156 typedef void(*IOTHUB_CLIENT_DEVICE_TWIN_CALLBACK)(DEVICE_TWIN_UPDATE_STATE update_state, const unsigned char* payLoad, size_t size, void* userContextCallback);
157 typedef void(*IOTHUB_CLIENT_REPORTED_STATE_CALLBACK)(int status_code, void* userContextCallback);
158 typedef int(*IOTHUB_CLIENT_DEVICE_METHOD_CALLBACK_ASYNC)(const char* method_name, const unsigned char* payload, size_t size, unsigned char** response, size_t* response_size, void* userContextCallback);
159 typedef int(*IOTHUB_CLIENT_INBOUND_DEVICE_METHOD_CALLBACK)(const char* method_name, const unsigned char* payload, size_t size, METHOD_HANDLE method_id, void* userContextCallback);
160
161
162#define IOTHUB_CLIENT_FILE_UPLOAD_GET_DATA_RESULT_VALUES \
163 IOTHUB_CLIENT_FILE_UPLOAD_GET_DATA_OK, \
164 IOTHUB_CLIENT_FILE_UPLOAD_GET_DATA_ABORT
165
166 MU_DEFINE_ENUM_WITHOUT_INVALID(IOTHUB_CLIENT_FILE_UPLOAD_GET_DATA_RESULT, IOTHUB_CLIENT_FILE_UPLOAD_GET_DATA_RESULT_VALUES);
167
168 /**
169 * @brief Callback invoked by IoTHubClient_UploadMultipleBlocksToBlobAsync requesting the chunks of data to be uploaded.
170 * @param result The result of the upload of the previous block of data provided by the user (IOTHUB_CLIENT_FILE_UPLOAD_GET_DATA_CALLBACK_EX only)
171 * @param data Next block of data to be uploaded, to be provided by the user when this callback is invoked.
172 * @param size Size of the data parameter.
173 * @param context User context provided on the call to IoTHubClient_UploadMultipleBlocksToBlobAsync.
174 * @remarks If the user wants to abort the upload, the callback should return IOTHUB_CLIENT_FILE_UPLOAD_GET_DATA_ABORT
175 * It should return IOTHUB_CLIENT_FILE_UPLOAD_GET_DATA_OK otherwise.
176 * If a NULL is provided for parameter "data" and/or zero is provided for "size", the user indicates to the client that the complete file has been uploaded.
177 * In such case this callback will be invoked only once more to indicate the status of the final block upload.
178 * If result is not FILE_UPLOAD_OK, the upload is cancelled and this callback stops being invoked.
179 * When this callback is called for the last time, no data or size is expected, so data and size are NULL
180 */
181 typedef void(*IOTHUB_CLIENT_FILE_UPLOAD_GET_DATA_CALLBACK)(IOTHUB_CLIENT_FILE_UPLOAD_RESULT result, unsigned char const ** data, size_t* size, void* context);
182 typedef IOTHUB_CLIENT_FILE_UPLOAD_GET_DATA_RESULT(*IOTHUB_CLIENT_FILE_UPLOAD_GET_DATA_CALLBACK_EX)(IOTHUB_CLIENT_FILE_UPLOAD_RESULT result, unsigned char const ** data, size_t* size, void* context);
183
184 /** @brief This struct captures IoTHub client configuration. */
185 typedef struct IOTHUB_CLIENT_CONFIG_TAG
186 {
187 /** @brief A function pointer that is passed into the @c IoTHubClientCreate.
188 * A function definition for AMQP is defined in the include @c iothubtransportamqp.h.
189 * A function definition for HTTP is defined in the include @c iothubtransporthttp.h
190 * A function definition for MQTT is defined in the include @c iothubtransportmqtt.h */
191 IOTHUB_CLIENT_TRANSPORT_PROVIDER protocol;
192
193 /** @brief A string that identifies the device. */
194 const char* deviceId;
195
196 /** @brief The device key used to authenticate the device.
197 If neither deviceSasToken nor deviceKey is present then the authentication is assumed x509.*/
198 const char* deviceKey;
199
200 /** @brief The device SAS Token used to authenticate the device in place of device key.
201 If neither deviceSasToken nor deviceKey is present then the authentication is assumed x509.*/
202 const char* deviceSasToken;
203
204 /** @brief The IoT Hub name to which the device is connecting. */
205 const char* iotHubName;
206
207 /** @brief IoT Hub suffix goes here, e.g., private.azure-devices-int.net. */
208 const char* iotHubSuffix;
209
210 const char* protocolGatewayHostName;
211 } IOTHUB_CLIENT_CONFIG;
212
213 /** @brief This struct captures IoTHub client device configuration. */
214 typedef struct IOTHUB_CLIENT_DEVICE_CONFIG_TAG
215 {
216 /** @brief A function pointer that is passed into the @c IoTHubClientCreate.
217 * A function definition for AMQP is defined in the include @c iothubtransportamqp.h.
218 * A function definition for HTTP is defined in the include @c iothubtransporthttp.h
219 * A function definition for MQTT is defined in the include @c iothubtransportmqtt.h */
220 IOTHUB_CLIENT_TRANSPORT_PROVIDER protocol;
221
222 /** @brief a transport handle implementing the protocol */
223 void * transportHandle;
224
225 /** @brief A string that identifies the device. */
226 const char* deviceId;
227
228 /** @brief The device key used to authenticate the device.
229 x509 authentication is is not supported for multiplexed connections*/
230 const char* deviceKey;
231
232 /** @brief The device SAS Token used to authenticate the device in place of device key.
233 x509 authentication is is not supported for multiplexed connections.*/
234 const char* deviceSasToken;
235 } IOTHUB_CLIENT_DEVICE_CONFIG;
236
237#ifdef __cplusplus
238}
239#endif
240
241#endif /* IOTHUB_CLIENT_CORE_COMMON_H */
Note: See TracBrowser for help on using the repository browser.