Xin Zhang / azure-iot-c-sdk-f767zi

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependents:   samplemqtt

iothub_service_client/inc/iothub_registrymanager.h@0:f7f1f0d76dd6, 2018-08-23 (annotated)

Committer:
XinZhangMS
Date:
Thu Aug 23 06:52:14 2018 +0000
Revision:
0:f7f1f0d76dd6
azure-c-sdk for mbed os supporting NUCLEO_F767ZI

Who changed what in which revision?

UserRevisionLine numberNew contents of line
XinZhangMS 0:f7f1f0d76dd6 1 // Copyright (c) Microsoft. All rights reserved.
XinZhangMS 0:f7f1f0d76dd6 2 // Licensed under the MIT license. See LICENSE file in the project root for full license information.
XinZhangMS 0:f7f1f0d76dd6 3
XinZhangMS 0:f7f1f0d76dd6 4 // This file is under development and it is subject to change
XinZhangMS 0:f7f1f0d76dd6 5
XinZhangMS 0:f7f1f0d76dd6 6 #ifndef IOTHUB_REGISTRYMANAGER_H
XinZhangMS 0:f7f1f0d76dd6 7 #define IOTHUB_REGISTRYMANAGER_H
XinZhangMS 0:f7f1f0d76dd6 8
XinZhangMS 0:f7f1f0d76dd6 9 #include "azure_c_shared_utility/macro_utils.h"
XinZhangMS 0:f7f1f0d76dd6 10 #include "azure_c_shared_utility/umock_c_prod.h"
XinZhangMS 0:f7f1f0d76dd6 11 #include "azure_c_shared_utility/crt_abstractions.h"
XinZhangMS 0:f7f1f0d76dd6 12 #include "azure_c_shared_utility/singlylinkedlist.h"
XinZhangMS 0:f7f1f0d76dd6 13 #include "azure_c_shared_utility/map.h"
XinZhangMS 0:f7f1f0d76dd6 14 #include "iothub_service_client_auth.h"
XinZhangMS 0:f7f1f0d76dd6 15
XinZhangMS 0:f7f1f0d76dd6 16 #ifdef __cplusplus
XinZhangMS 0:f7f1f0d76dd6 17 extern "C"
XinZhangMS 0:f7f1f0d76dd6 18 {
XinZhangMS 0:f7f1f0d76dd6 19 #endif
XinZhangMS 0:f7f1f0d76dd6 20
XinZhangMS 0:f7f1f0d76dd6 21 #define IOTHUB_REGISTRYMANAGER_RESULT_VALUES \
XinZhangMS 0:f7f1f0d76dd6 22 IOTHUB_REGISTRYMANAGER_OK, \
XinZhangMS 0:f7f1f0d76dd6 23 IOTHUB_REGISTRYMANAGER_INVALID_ARG, \
XinZhangMS 0:f7f1f0d76dd6 24 IOTHUB_REGISTRYMANAGER_ERROR, \
XinZhangMS 0:f7f1f0d76dd6 25 IOTHUB_REGISTRYMANAGER_JSON_ERROR, \
XinZhangMS 0:f7f1f0d76dd6 26 IOTHUB_REGISTRYMANAGER_HTTPAPI_ERROR, \
XinZhangMS 0:f7f1f0d76dd6 27 IOTHUB_REGISTRYMANAGER_HTTP_STATUS_ERROR, \
XinZhangMS 0:f7f1f0d76dd6 28 IOTHUB_REGISTRYMANAGER_DEVICE_EXIST, \
XinZhangMS 0:f7f1f0d76dd6 29 IOTHUB_REGISTRYMANAGER_DEVICE_NOT_EXIST, \
XinZhangMS 0:f7f1f0d76dd6 30 IOTHUB_REGISTRYMANAGER_CALLBACK_NOT_SET, \
XinZhangMS 0:f7f1f0d76dd6 31 IOTHUB_REGISTRYMANAGER_INVALID_VERSION \
XinZhangMS 0:f7f1f0d76dd6 32
XinZhangMS 0:f7f1f0d76dd6 33 DEFINE_ENUM(IOTHUB_REGISTRYMANAGER_RESULT, IOTHUB_REGISTRYMANAGER_RESULT_VALUES);
XinZhangMS 0:f7f1f0d76dd6 34
XinZhangMS 0:f7f1f0d76dd6 35 #define IOTHUB_REGISTRYMANAGER_AUTH_METHOD_VALUES \
XinZhangMS 0:f7f1f0d76dd6 36 IOTHUB_REGISTRYMANAGER_AUTH_SPK, \
XinZhangMS 0:f7f1f0d76dd6 37 IOTHUB_REGISTRYMANAGER_AUTH_X509_THUMBPRINT, \
XinZhangMS 0:f7f1f0d76dd6 38 IOTHUB_REGISTRYMANAGER_AUTH_X509_CERTIFICATE_AUTHORITY, \
XinZhangMS 0:f7f1f0d76dd6 39 IOTHUB_REGISTRYMANAGER_AUTH_NONE, \
XinZhangMS 0:f7f1f0d76dd6 40 IOTHUB_REGISTRYMANAGER_AUTH_UNKNOWN \
XinZhangMS 0:f7f1f0d76dd6 41
XinZhangMS 0:f7f1f0d76dd6 42
XinZhangMS 0:f7f1f0d76dd6 43 DEFINE_ENUM(IOTHUB_REGISTRYMANAGER_AUTH_METHOD, IOTHUB_REGISTRYMANAGER_AUTH_METHOD_VALUES);
XinZhangMS 0:f7f1f0d76dd6 44
XinZhangMS 0:f7f1f0d76dd6 45 #define IOTHUB_DEVICE_EX_VERSION_1 1
XinZhangMS 0:f7f1f0d76dd6 46 typedef struct IOTHUB_DEVICE_EX_TAG
XinZhangMS 0:f7f1f0d76dd6 47 {
XinZhangMS 0:f7f1f0d76dd6 48 int version;
XinZhangMS 0:f7f1f0d76dd6 49 const char* deviceId; //version 1+
XinZhangMS 0:f7f1f0d76dd6 50 const char* primaryKey; //version 1+
XinZhangMS 0:f7f1f0d76dd6 51 const char* secondaryKey; //version 1+
XinZhangMS 0:f7f1f0d76dd6 52 const char* generationId; //version 1+
XinZhangMS 0:f7f1f0d76dd6 53 const char* eTag; //version 1+
XinZhangMS 0:f7f1f0d76dd6 54 IOTHUB_DEVICE_CONNECTION_STATE connectionState; //version 1+
XinZhangMS 0:f7f1f0d76dd6 55 const char* connectionStateUpdatedTime; //version 1+
XinZhangMS 0:f7f1f0d76dd6 56 IOTHUB_DEVICE_STATUS status; //version 1+
XinZhangMS 0:f7f1f0d76dd6 57 const char* statusReason; //version 1+
XinZhangMS 0:f7f1f0d76dd6 58 const char* statusUpdatedTime; //version 1+
XinZhangMS 0:f7f1f0d76dd6 59 const char* lastActivityTime; //version 1+
XinZhangMS 0:f7f1f0d76dd6 60 size_t cloudToDeviceMessageCount; //version 1+
XinZhangMS 0:f7f1f0d76dd6 61
XinZhangMS 0:f7f1f0d76dd6 62 bool isManaged; //version 1+
XinZhangMS 0:f7f1f0d76dd6 63 const char* configuration; //version 1+
XinZhangMS 0:f7f1f0d76dd6 64 const char* deviceProperties; //version 1+
XinZhangMS 0:f7f1f0d76dd6 65 const char* serviceProperties; //version 1+
XinZhangMS 0:f7f1f0d76dd6 66 IOTHUB_REGISTRYMANAGER_AUTH_METHOD authMethod; //version 1+
XinZhangMS 0:f7f1f0d76dd6 67
XinZhangMS 0:f7f1f0d76dd6 68 bool iotEdge_capable; //version 1+
XinZhangMS 0:f7f1f0d76dd6 69 } IOTHUB_DEVICE_EX;
XinZhangMS 0:f7f1f0d76dd6 70
XinZhangMS 0:f7f1f0d76dd6 71 /**
XinZhangMS 0:f7f1f0d76dd6 72 * @brief Free members of the IOTHUB_DEVICE_EX structure (NOT the structure itself)
XinZhangMS 0:f7f1f0d76dd6 73 *
XinZhangMS 0:f7f1f0d76dd6 74 * @param deviceInfo The structure to have its members freed.
XinZhangMS 0:f7f1f0d76dd6 75 */
XinZhangMS 0:f7f1f0d76dd6 76 extern void IoTHubRegistryManager_FreeDeviceExMembers(IOTHUB_DEVICE_EX* deviceInfo);
XinZhangMS 0:f7f1f0d76dd6 77
XinZhangMS 0:f7f1f0d76dd6 78 #define IOTHUB_REGISTRY_DEVICE_CREATE_EX_VERSION_1 1
XinZhangMS 0:f7f1f0d76dd6 79 typedef struct IOTHUB_REGISTRY_DEVICE_CREATE_EX_TAG
XinZhangMS 0:f7f1f0d76dd6 80 {
XinZhangMS 0:f7f1f0d76dd6 81 int version;
XinZhangMS 0:f7f1f0d76dd6 82 const char* deviceId; //version 1+
XinZhangMS 0:f7f1f0d76dd6 83 const char* primaryKey; //version 1+
XinZhangMS 0:f7f1f0d76dd6 84 const char* secondaryKey; //version 1+
XinZhangMS 0:f7f1f0d76dd6 85 IOTHUB_REGISTRYMANAGER_AUTH_METHOD authMethod; //version 1+
XinZhangMS 0:f7f1f0d76dd6 86 bool iotEdge_capable; //version 1+
XinZhangMS 0:f7f1f0d76dd6 87 } IOTHUB_REGISTRY_DEVICE_CREATE_EX;
XinZhangMS 0:f7f1f0d76dd6 88
XinZhangMS 0:f7f1f0d76dd6 89 #define IOTHUB_REGISTRY_DEVICE_UPDATE_EX_VERSION_1 1
XinZhangMS 0:f7f1f0d76dd6 90 typedef struct IOTHUB_REGISTRY_DEVICE_UPDATE_EX_TAG
XinZhangMS 0:f7f1f0d76dd6 91 {
XinZhangMS 0:f7f1f0d76dd6 92 int version;
XinZhangMS 0:f7f1f0d76dd6 93 const char* deviceId; //version 1+
XinZhangMS 0:f7f1f0d76dd6 94 const char* primaryKey; //version 1+
XinZhangMS 0:f7f1f0d76dd6 95 const char* secondaryKey; //version 1+
XinZhangMS 0:f7f1f0d76dd6 96 IOTHUB_DEVICE_STATUS status; //version 1+
XinZhangMS 0:f7f1f0d76dd6 97 IOTHUB_REGISTRYMANAGER_AUTH_METHOD authMethod; //version 1+
XinZhangMS 0:f7f1f0d76dd6 98 bool iotEdge_capable; //version 1+
XinZhangMS 0:f7f1f0d76dd6 99 } IOTHUB_REGISTRY_DEVICE_UPDATE_EX;
XinZhangMS 0:f7f1f0d76dd6 100
XinZhangMS 0:f7f1f0d76dd6 101 typedef struct IOTHUB_REGISTRY_STATISTIC_TAG
XinZhangMS 0:f7f1f0d76dd6 102 {
XinZhangMS 0:f7f1f0d76dd6 103 size_t totalDeviceCount;
XinZhangMS 0:f7f1f0d76dd6 104 size_t enabledDeviceCount;
XinZhangMS 0:f7f1f0d76dd6 105 size_t disabledDeviceCount;
XinZhangMS 0:f7f1f0d76dd6 106 } IOTHUB_REGISTRY_STATISTICS;
XinZhangMS 0:f7f1f0d76dd6 107
XinZhangMS 0:f7f1f0d76dd6 108 #define IOTHUB_MODULE_VERSION_1 1
XinZhangMS 0:f7f1f0d76dd6 109 typedef struct IOTHUB_MODULE_TAG
XinZhangMS 0:f7f1f0d76dd6 110 {
XinZhangMS 0:f7f1f0d76dd6 111 int version;
XinZhangMS 0:f7f1f0d76dd6 112 const char* deviceId; //version 1+
XinZhangMS 0:f7f1f0d76dd6 113 const char* primaryKey; //version 1+
XinZhangMS 0:f7f1f0d76dd6 114 const char* secondaryKey; //version 1+
XinZhangMS 0:f7f1f0d76dd6 115 const char* generationId; //version 1+
XinZhangMS 0:f7f1f0d76dd6 116 const char* eTag; //version 1+
XinZhangMS 0:f7f1f0d76dd6 117 IOTHUB_DEVICE_CONNECTION_STATE connectionState; //version 1+
XinZhangMS 0:f7f1f0d76dd6 118 const char* connectionStateUpdatedTime; //version 1+
XinZhangMS 0:f7f1f0d76dd6 119 IOTHUB_DEVICE_STATUS status; //version 1+
XinZhangMS 0:f7f1f0d76dd6 120 const char* statusReason; //version 1+
XinZhangMS 0:f7f1f0d76dd6 121 const char* statusUpdatedTime; //version 1+
XinZhangMS 0:f7f1f0d76dd6 122 const char* lastActivityTime; //version 1+
XinZhangMS 0:f7f1f0d76dd6 123 size_t cloudToDeviceMessageCount; //version 1+
XinZhangMS 0:f7f1f0d76dd6 124
XinZhangMS 0:f7f1f0d76dd6 125 bool isManaged; //version 1+
XinZhangMS 0:f7f1f0d76dd6 126 const char* configuration; //version 1+
XinZhangMS 0:f7f1f0d76dd6 127 const char* deviceProperties; //version 1+
XinZhangMS 0:f7f1f0d76dd6 128 const char* serviceProperties; //version 1+
XinZhangMS 0:f7f1f0d76dd6 129 IOTHUB_REGISTRYMANAGER_AUTH_METHOD authMethod; //version 1+
XinZhangMS 0:f7f1f0d76dd6 130
XinZhangMS 0:f7f1f0d76dd6 131 const char* moduleId; //version 1+
XinZhangMS 0:f7f1f0d76dd6 132 const char* managedBy; //version 1+
XinZhangMS 0:f7f1f0d76dd6 133 } IOTHUB_MODULE;
XinZhangMS 0:f7f1f0d76dd6 134
XinZhangMS 0:f7f1f0d76dd6 135 /**
XinZhangMS 0:f7f1f0d76dd6 136 * @brief Free members of the IOTHUB_MODULE structure (NOT the structure itself)
XinZhangMS 0:f7f1f0d76dd6 137 *
XinZhangMS 0:f7f1f0d76dd6 138 * @param moduleInfo The structure to have its members freed.
XinZhangMS 0:f7f1f0d76dd6 139 */
XinZhangMS 0:f7f1f0d76dd6 140 extern void IoTHubRegistryManager_FreeModuleMembers(IOTHUB_MODULE* moduleInfo);
XinZhangMS 0:f7f1f0d76dd6 141
XinZhangMS 0:f7f1f0d76dd6 142
XinZhangMS 0:f7f1f0d76dd6 143 #define IOTHUB_REGISTRY_MODULE_CREATE_VERSION_1 1
XinZhangMS 0:f7f1f0d76dd6 144 typedef struct IOTHUB_REGISTRY_MODULE_CREATE_TAG
XinZhangMS 0:f7f1f0d76dd6 145 {
XinZhangMS 0:f7f1f0d76dd6 146 int version;
XinZhangMS 0:f7f1f0d76dd6 147 const char* deviceId; //version 1+
XinZhangMS 0:f7f1f0d76dd6 148 const char* primaryKey; //version 1+
XinZhangMS 0:f7f1f0d76dd6 149 const char* secondaryKey; //version 1+
XinZhangMS 0:f7f1f0d76dd6 150 IOTHUB_REGISTRYMANAGER_AUTH_METHOD authMethod; //version 1+
XinZhangMS 0:f7f1f0d76dd6 151 const char* moduleId; //version 1+
XinZhangMS 0:f7f1f0d76dd6 152 const char* managedBy; //version 1+
XinZhangMS 0:f7f1f0d76dd6 153 } IOTHUB_REGISTRY_MODULE_CREATE;
XinZhangMS 0:f7f1f0d76dd6 154
XinZhangMS 0:f7f1f0d76dd6 155 #define IOTHUB_REGISTRY_MODULE_UPDATE_VERSION_1 1
XinZhangMS 0:f7f1f0d76dd6 156 typedef struct IOTHUB_REGISTRY_MODULE_UPDATE_TAG
XinZhangMS 0:f7f1f0d76dd6 157 {
XinZhangMS 0:f7f1f0d76dd6 158 int version;
XinZhangMS 0:f7f1f0d76dd6 159 const char* deviceId; //version 1+
XinZhangMS 0:f7f1f0d76dd6 160 const char* primaryKey; //version 1+
XinZhangMS 0:f7f1f0d76dd6 161 const char* secondaryKey; //version 1+
XinZhangMS 0:f7f1f0d76dd6 162 IOTHUB_DEVICE_STATUS status; //version 1+
XinZhangMS 0:f7f1f0d76dd6 163 IOTHUB_REGISTRYMANAGER_AUTH_METHOD authMethod; //version 1+
XinZhangMS 0:f7f1f0d76dd6 164 const char* moduleId; //version 1+
XinZhangMS 0:f7f1f0d76dd6 165 const char* managedBy; //version 1+
XinZhangMS 0:f7f1f0d76dd6 166 } IOTHUB_REGISTRY_MODULE_UPDATE;
XinZhangMS 0:f7f1f0d76dd6 167
XinZhangMS 0:f7f1f0d76dd6 168 /** @brief Structure to store IoTHub authentication information
XinZhangMS 0:f7f1f0d76dd6 169 */
XinZhangMS 0:f7f1f0d76dd6 170 typedef struct IOTHUB_REGISTRYMANAGER_TAG
XinZhangMS 0:f7f1f0d76dd6 171 {
XinZhangMS 0:f7f1f0d76dd6 172 char* hostname;
XinZhangMS 0:f7f1f0d76dd6 173 char* iothubName;
XinZhangMS 0:f7f1f0d76dd6 174 char* iothubSuffix;
XinZhangMS 0:f7f1f0d76dd6 175 char* sharedAccessKey;
XinZhangMS 0:f7f1f0d76dd6 176 char* keyName;
XinZhangMS 0:f7f1f0d76dd6 177 char* deviceId;
XinZhangMS 0:f7f1f0d76dd6 178 } IOTHUB_REGISTRYMANAGER;
XinZhangMS 0:f7f1f0d76dd6 179
XinZhangMS 0:f7f1f0d76dd6 180 /** @brief Handle to hide struct and use it in consequent APIs
XinZhangMS 0:f7f1f0d76dd6 181 */
XinZhangMS 0:f7f1f0d76dd6 182 typedef struct IOTHUB_REGISTRYMANAGER_TAG* IOTHUB_REGISTRYMANAGER_HANDLE;
XinZhangMS 0:f7f1f0d76dd6 183
XinZhangMS 0:f7f1f0d76dd6 184 /**
XinZhangMS 0:f7f1f0d76dd6 185 * @brief Creates a IoT Hub Registry Manager handle for use it
XinZhangMS 0:f7f1f0d76dd6 186 * in consequent APIs.
XinZhangMS 0:f7f1f0d76dd6 187 *
XinZhangMS 0:f7f1f0d76dd6 188 * @param serviceClientHandle Service client handle.
XinZhangMS 0:f7f1f0d76dd6 189 *
XinZhangMS 0:f7f1f0d76dd6 190 * @return A non-NULL @c IOTHUB_REGISTRYMANAGER_HANDLE value that is used when
XinZhangMS 0:f7f1f0d76dd6 191 * invoking other functions for IoT Hub REgistry Manager and @c NULL on failure.
XinZhangMS 0:f7f1f0d76dd6 192 */
XinZhangMS 0:f7f1f0d76dd6 193 extern IOTHUB_REGISTRYMANAGER_HANDLE IoTHubRegistryManager_Create(IOTHUB_SERVICE_CLIENT_AUTH_HANDLE serviceClientHandle);
XinZhangMS 0:f7f1f0d76dd6 194
XinZhangMS 0:f7f1f0d76dd6 195 /**
XinZhangMS 0:f7f1f0d76dd6 196 * @brief Disposes of resources allocated by the IoT Hub Registry Manager.
XinZhangMS 0:f7f1f0d76dd6 197 *
XinZhangMS 0:f7f1f0d76dd6 198 * @param registryManagerHandle The handle created by a call to the create function.
XinZhangMS 0:f7f1f0d76dd6 199 */
XinZhangMS 0:f7f1f0d76dd6 200 extern void IoTHubRegistryManager_Destroy(IOTHUB_REGISTRYMANAGER_HANDLE registryManagerHandle);
XinZhangMS 0:f7f1f0d76dd6 201
XinZhangMS 0:f7f1f0d76dd6 202 /**
XinZhangMS 0:f7f1f0d76dd6 203 * @brief Creates a device on IoT Hub.
XinZhangMS 0:f7f1f0d76dd6 204 *
XinZhangMS 0:f7f1f0d76dd6 205 * @param registryManagerHandle The handle created by a call to the create function.
XinZhangMS 0:f7f1f0d76dd6 206 * @param deviceCreate IOTHUB_REGISTRY_DEVICE_CREATE_EX structure containing
XinZhangMS 0:f7f1f0d76dd6 207 * the new device Id, primaryKey (optional) and secondaryKey (optional)
XinZhangMS 0:f7f1f0d76dd6 208 * @param device Input parameter, if it is not NULL will contain the created device info structure
XinZhangMS 0:f7f1f0d76dd6 209 *
XinZhangMS 0:f7f1f0d76dd6 210 * @return IOTHUB_REGISTRYMANAGER_RESULT_OK upon success or an error code upon failure.
XinZhangMS 0:f7f1f0d76dd6 211 */
XinZhangMS 0:f7f1f0d76dd6 212 extern IOTHUB_REGISTRYMANAGER_RESULT IoTHubRegistryManager_CreateDevice_Ex(IOTHUB_REGISTRYMANAGER_HANDLE registryManagerHandle, const IOTHUB_REGISTRY_DEVICE_CREATE_EX* deviceCreate, IOTHUB_DEVICE_EX* device);
XinZhangMS 0:f7f1f0d76dd6 213
XinZhangMS 0:f7f1f0d76dd6 214 /**
XinZhangMS 0:f7f1f0d76dd6 215 * @brief Gets device info for a given device.
XinZhangMS 0:f7f1f0d76dd6 216 *
XinZhangMS 0:f7f1f0d76dd6 217 * @param registryManagerHandle The handle created by a call to the create function.
XinZhangMS 0:f7f1f0d76dd6 218 * @param deviceId The Id of the requested device.
XinZhangMS 0:f7f1f0d76dd6 219 * @param device Input parameter, if it is not NULL will contain the requested device info structure
XinZhangMS 0:f7f1f0d76dd6 220 *
XinZhangMS 0:f7f1f0d76dd6 221 * @return IOTHUB_REGISTRYMANAGER_RESULT_OK upon success or an error code upon failure.
XinZhangMS 0:f7f1f0d76dd6 222 */
XinZhangMS 0:f7f1f0d76dd6 223 extern IOTHUB_REGISTRYMANAGER_RESULT IoTHubRegistryManager_GetDevice_Ex(IOTHUB_REGISTRYMANAGER_HANDLE registryManagerHandle, const char* deviceId, IOTHUB_DEVICE_EX* device);
XinZhangMS 0:f7f1f0d76dd6 224
XinZhangMS 0:f7f1f0d76dd6 225 /**
XinZhangMS 0:f7f1f0d76dd6 226 * @brief Updates a device on IoT Hub.
XinZhangMS 0:f7f1f0d76dd6 227 *
XinZhangMS 0:f7f1f0d76dd6 228 * @param registryManagerHandle The handle created by a call to the create function.
XinZhangMS 0:f7f1f0d76dd6 229 * @param deviceUpdate IOTHUB_REGISTRY_DEVICE_UPDATE_EX structure containing
XinZhangMS 0:f7f1f0d76dd6 230 * the new device Id, primaryKey (optional), secondaryKey (optional),
XinZhangMS 0:f7f1f0d76dd6 231 * authentication method, and status
XinZhangMS 0:f7f1f0d76dd6 232 *
XinZhangMS 0:f7f1f0d76dd6 233 * @return IOTHUB_REGISTRYMANAGER_RESULT_OK upon success or an error code upon failure.
XinZhangMS 0:f7f1f0d76dd6 234 */
XinZhangMS 0:f7f1f0d76dd6 235 extern IOTHUB_REGISTRYMANAGER_RESULT IoTHubRegistryManager_UpdateDevice_Ex(IOTHUB_REGISTRYMANAGER_HANDLE registryManagerHandle, IOTHUB_REGISTRY_DEVICE_UPDATE_EX* deviceUpdate);
XinZhangMS 0:f7f1f0d76dd6 236
XinZhangMS 0:f7f1f0d76dd6 237 /**
XinZhangMS 0:f7f1f0d76dd6 238 * @brief Deletes a given device.
XinZhangMS 0:f7f1f0d76dd6 239 *
XinZhangMS 0:f7f1f0d76dd6 240 * @param registryManagerHandle The handle created by a call to the create function.
XinZhangMS 0:f7f1f0d76dd6 241 * @param deviceId The Id of the device to delete.
XinZhangMS 0:f7f1f0d76dd6 242 *
XinZhangMS 0:f7f1f0d76dd6 243 * @return IOTHUB_REGISTRYMANAGER_RESULT_OK upon success or an error code upon failure.
XinZhangMS 0:f7f1f0d76dd6 244 */
XinZhangMS 0:f7f1f0d76dd6 245 extern IOTHUB_REGISTRYMANAGER_RESULT IoTHubRegistryManager_DeleteDevice(IOTHUB_REGISTRYMANAGER_HANDLE registryManagerHandle, const char* deviceId);
XinZhangMS 0:f7f1f0d76dd6 246
XinZhangMS 0:f7f1f0d76dd6 247 /**
XinZhangMS 0:f7f1f0d76dd6 248 * @brief Gets the registry statistic info.
XinZhangMS 0:f7f1f0d76dd6 249 *
XinZhangMS 0:f7f1f0d76dd6 250 * @param registryManagerHandle The handle created by a call to the create function.
XinZhangMS 0:f7f1f0d76dd6 251 * @param registryStatistics Input parameter, if it is not NULL will contain the requested registry info.
XinZhangMS 0:f7f1f0d76dd6 252 *
XinZhangMS 0:f7f1f0d76dd6 253 * @return IOTHUB_REGISTRYMANAGER_RESULT_OK upon success or an error code upon failure.
XinZhangMS 0:f7f1f0d76dd6 254 */
XinZhangMS 0:f7f1f0d76dd6 255 extern IOTHUB_REGISTRYMANAGER_RESULT IoTHubRegistryManager_GetStatistics(IOTHUB_REGISTRYMANAGER_HANDLE registryManagerHandle, IOTHUB_REGISTRY_STATISTICS* registryStatistics);
XinZhangMS 0:f7f1f0d76dd6 256
XinZhangMS 0:f7f1f0d76dd6 257 /**
XinZhangMS 0:f7f1f0d76dd6 258 * @brief Creates a module on IoT Hub.
XinZhangMS 0:f7f1f0d76dd6 259 *
XinZhangMS 0:f7f1f0d76dd6 260 * @param registryManagerHandle The handle created by a call to the create function.
XinZhangMS 0:f7f1f0d76dd6 261 * @param moduleCreate IOTHUB_REGISTRY_MODULE_CREATE structure containing
XinZhangMS 0:f7f1f0d76dd6 262 * the existing deviceID, new module Id, primaryKey (optional) and secondaryKey (optional)
XinZhangMS 0:f7f1f0d76dd6 263 * @param module Input parameter, if it is not NULL will contain the created module info structure
XinZhangMS 0:f7f1f0d76dd6 264 *
XinZhangMS 0:f7f1f0d76dd6 265 * @return IOTHUB_REGISTRYMANAGER_RESULT_OK upon success or an error code upon failure.
XinZhangMS 0:f7f1f0d76dd6 266 */
XinZhangMS 0:f7f1f0d76dd6 267 extern IOTHUB_REGISTRYMANAGER_RESULT IoTHubRegistryManager_CreateModule(IOTHUB_REGISTRYMANAGER_HANDLE registryManagerHandle, const IOTHUB_REGISTRY_MODULE_CREATE* moduleCreate, IOTHUB_MODULE* module);
XinZhangMS 0:f7f1f0d76dd6 268
XinZhangMS 0:f7f1f0d76dd6 269 /**
XinZhangMS 0:f7f1f0d76dd6 270 * @brief Gets module info for a given module.
XinZhangMS 0:f7f1f0d76dd6 271 *
XinZhangMS 0:f7f1f0d76dd6 272 * @param registryManagerHandle The handle created by a call to the create function.
XinZhangMS 0:f7f1f0d76dd6 273 * @param deviceId The Id of the requested device.
XinZhangMS 0:f7f1f0d76dd6 274 * @param moduleId The Id of the requested module.
XinZhangMS 0:f7f1f0d76dd6 275 * @param module Input parameter, if it is not NULL will contain the requested module info structure
XinZhangMS 0:f7f1f0d76dd6 276 *
XinZhangMS 0:f7f1f0d76dd6 277 * @return IOTHUB_REGISTRYMANAGER_RESULT_OK upon success or an error code upon failure.
XinZhangMS 0:f7f1f0d76dd6 278 */
XinZhangMS 0:f7f1f0d76dd6 279 extern IOTHUB_REGISTRYMANAGER_RESULT IoTHubRegistryManager_GetModule(IOTHUB_REGISTRYMANAGER_HANDLE registryManagerHandle, const char* deviceId, const char* moduleId, IOTHUB_MODULE* module);
XinZhangMS 0:f7f1f0d76dd6 280
XinZhangMS 0:f7f1f0d76dd6 281 /**
XinZhangMS 0:f7f1f0d76dd6 282 * @brief Updates a module on IoT Hub.
XinZhangMS 0:f7f1f0d76dd6 283 *
XinZhangMS 0:f7f1f0d76dd6 284 * @param registryManagerHandle The handle created by a call to the create function.
XinZhangMS 0:f7f1f0d76dd6 285 * @param moduleUpdate IOTHUB_REGISTRY_MODULE_UPDATE structure containing
XinZhangMS 0:f7f1f0d76dd6 286 * the new module Id, primaryKey (optional), secondaryKey (optional),
XinZhangMS 0:f7f1f0d76dd6 287 * authentication method, and status
XinZhangMS 0:f7f1f0d76dd6 288 *
XinZhangMS 0:f7f1f0d76dd6 289 * @return IOTHUB_REGISTRYMANAGER_RESULT_OK upon success or an error code upon failure.
XinZhangMS 0:f7f1f0d76dd6 290 */
XinZhangMS 0:f7f1f0d76dd6 291 extern IOTHUB_REGISTRYMANAGER_RESULT IoTHubRegistryManager_UpdateModule(IOTHUB_REGISTRYMANAGER_HANDLE registryManagerHandle, IOTHUB_REGISTRY_MODULE_UPDATE* moduleUpdate);
XinZhangMS 0:f7f1f0d76dd6 292
XinZhangMS 0:f7f1f0d76dd6 293 /**
XinZhangMS 0:f7f1f0d76dd6 294 * @brief Deletes a given module.
XinZhangMS 0:f7f1f0d76dd6 295 *
XinZhangMS 0:f7f1f0d76dd6 296 * @param registryManagerHandle The handle created by a call to the create function.
XinZhangMS 0:f7f1f0d76dd6 297 * @param deviceId The Id of the device containing module to delete.
XinZhangMS 0:f7f1f0d76dd6 298 * @param moduleId The Id of the module to delete.
XinZhangMS 0:f7f1f0d76dd6 299 *
XinZhangMS 0:f7f1f0d76dd6 300 * @return IOTHUB_REGISTRYMANAGER_RESULT_OK upon success or an error code upon failure.
XinZhangMS 0:f7f1f0d76dd6 301 */
XinZhangMS 0:f7f1f0d76dd6 302 extern IOTHUB_REGISTRYMANAGER_RESULT IoTHubRegistryManager_DeleteModule(IOTHUB_REGISTRYMANAGER_HANDLE registryManagerHandle, const char* deviceId, const char* moduleId);
XinZhangMS 0:f7f1f0d76dd6 303
XinZhangMS 0:f7f1f0d76dd6 304 /**
XinZhangMS 0:f7f1f0d76dd6 305 * @brief Gets a list of modules registered on the specified device.
XinZhangMS 0:f7f1f0d76dd6 306 *
XinZhangMS 0:f7f1f0d76dd6 307 * @param registryManagerHandle The handle created by a call to the create function.
XinZhangMS 0:f7f1f0d76dd6 308 * @param deviceId The device to get a list of modules from
XinZhangMS 0:f7f1f0d76dd6 309 * @param moduleList The linked list structure to hold the returned modules
XinZhangMS 0:f7f1f0d76dd6 310 * @param module_version The version of the module structure to return
XinZhangMS 0:f7f1f0d76dd6 311 *
XinZhangMS 0:f7f1f0d76dd6 312 * @return IOTHUB_REGISTRYMANAGER_RESULT_OK upon success or an error code upon failure.
XinZhangMS 0:f7f1f0d76dd6 313 */
XinZhangMS 0:f7f1f0d76dd6 314 extern IOTHUB_REGISTRYMANAGER_RESULT IoTHubRegistryManager_GetModuleList(IOTHUB_REGISTRYMANAGER_HANDLE registryManagerHandle, const char* deviceId, SINGLYLINKEDLIST_HANDLE moduleList, int module_version);
XinZhangMS 0:f7f1f0d76dd6 315
XinZhangMS 0:f7f1f0d76dd6 316
XinZhangMS 0:f7f1f0d76dd6 317 /* DEPRECATED: THE FOLLOWING APIS ARE DEPRECATED, AND ARE ONLY BEING KEPT FOR BACK COMPAT. PLEASE USE _EX EQUIVALENT ABOVE */
XinZhangMS 0:f7f1f0d76dd6 318 /* DEPRECATED: THE FOLLOWING APIS ARE DEPRECATED, AND ARE ONLY BEING KEPT FOR BACK COMPAT. PLEASE USE _EX EQUIVALENT ABOVE */
XinZhangMS 0:f7f1f0d76dd6 319 /* DEPRECATED: THE FOLLOWING APIS ARE DEPRECATED, AND ARE ONLY BEING KEPT FOR BACK COMPAT. PLEASE USE _EX EQUIVALENT ABOVE */
XinZhangMS 0:f7f1f0d76dd6 320
XinZhangMS 0:f7f1f0d76dd6 321 /* Please use IOTHUB_DEVICE_EX instead */
XinZhangMS 0:f7f1f0d76dd6 322 typedef struct IOTHUB_DEVICE_TAG
XinZhangMS 0:f7f1f0d76dd6 323 {
XinZhangMS 0:f7f1f0d76dd6 324 const char* deviceId;
XinZhangMS 0:f7f1f0d76dd6 325 const char* primaryKey;
XinZhangMS 0:f7f1f0d76dd6 326 const char* secondaryKey;
XinZhangMS 0:f7f1f0d76dd6 327 const char* generationId;
XinZhangMS 0:f7f1f0d76dd6 328 const char* eTag;
XinZhangMS 0:f7f1f0d76dd6 329 IOTHUB_DEVICE_CONNECTION_STATE connectionState;
XinZhangMS 0:f7f1f0d76dd6 330 const char* connectionStateUpdatedTime;
XinZhangMS 0:f7f1f0d76dd6 331 IOTHUB_DEVICE_STATUS status;
XinZhangMS 0:f7f1f0d76dd6 332 const char* statusReason;
XinZhangMS 0:f7f1f0d76dd6 333 const char* statusUpdatedTime;
XinZhangMS 0:f7f1f0d76dd6 334 const char* lastActivityTime;
XinZhangMS 0:f7f1f0d76dd6 335 size_t cloudToDeviceMessageCount;
XinZhangMS 0:f7f1f0d76dd6 336
XinZhangMS 0:f7f1f0d76dd6 337 bool isManaged;
XinZhangMS 0:f7f1f0d76dd6 338 const char* configuration;
XinZhangMS 0:f7f1f0d76dd6 339 const char* deviceProperties;
XinZhangMS 0:f7f1f0d76dd6 340 const char* serviceProperties;
XinZhangMS 0:f7f1f0d76dd6 341 IOTHUB_REGISTRYMANAGER_AUTH_METHOD authMethod;
XinZhangMS 0:f7f1f0d76dd6 342 } IOTHUB_DEVICE;
XinZhangMS 0:f7f1f0d76dd6 343
XinZhangMS 0:f7f1f0d76dd6 344 /* Please use IOTHUB_REGISTRY_DEVICE_CREATE_EX instead */
XinZhangMS 0:f7f1f0d76dd6 345 typedef struct IOTHUB_REGISTRY_DEVICE_CREATE_TAG
XinZhangMS 0:f7f1f0d76dd6 346 {
XinZhangMS 0:f7f1f0d76dd6 347 const char* deviceId;
XinZhangMS 0:f7f1f0d76dd6 348 const char* primaryKey;
XinZhangMS 0:f7f1f0d76dd6 349 const char* secondaryKey;
XinZhangMS 0:f7f1f0d76dd6 350 IOTHUB_REGISTRYMANAGER_AUTH_METHOD authMethod;
XinZhangMS 0:f7f1f0d76dd6 351 } IOTHUB_REGISTRY_DEVICE_CREATE;
XinZhangMS 0:f7f1f0d76dd6 352
XinZhangMS 0:f7f1f0d76dd6 353 /* Please use IOTHUB_REGISTRY_DEVICE_UPDATED_EX instead */
XinZhangMS 0:f7f1f0d76dd6 354 typedef struct IOTHUB_REGISTRY_DEVICE_UPDATE_TAG
XinZhangMS 0:f7f1f0d76dd6 355 {
XinZhangMS 0:f7f1f0d76dd6 356 const char* deviceId;
XinZhangMS 0:f7f1f0d76dd6 357 const char* primaryKey;
XinZhangMS 0:f7f1f0d76dd6 358 const char* secondaryKey;
XinZhangMS 0:f7f1f0d76dd6 359 IOTHUB_DEVICE_STATUS status;
XinZhangMS 0:f7f1f0d76dd6 360 IOTHUB_REGISTRYMANAGER_AUTH_METHOD authMethod;
XinZhangMS 0:f7f1f0d76dd6 361 } IOTHUB_REGISTRY_DEVICE_UPDATE;
XinZhangMS 0:f7f1f0d76dd6 362
XinZhangMS 0:f7f1f0d76dd6 363 /** DEPRECATED:: Use IoTHubRegistryManager_CreateDevice_Ex instead
XinZhangMS 0:f7f1f0d76dd6 364 * @brief Creates a device on IoT Hub.
XinZhangMS 0:f7f1f0d76dd6 365 *
XinZhangMS 0:f7f1f0d76dd6 366 * @param registryManagerHandle The handle created by a call to the create function.
XinZhangMS 0:f7f1f0d76dd6 367 * @param deviceCreate IOTHUB_REGISTRY_DEVICE_CREATE structure containing
XinZhangMS 0:f7f1f0d76dd6 368 * the new device Id, primaryKey (optional) and secondaryKey (optional)
XinZhangMS 0:f7f1f0d76dd6 369 * @param device Input parameter, if it is not NULL will contain the created device info structure
XinZhangMS 0:f7f1f0d76dd6 370 *
XinZhangMS 0:f7f1f0d76dd6 371 * @return IOTHUB_REGISTRYMANAGER_RESULT_OK upon success or an error code upon failure.
XinZhangMS 0:f7f1f0d76dd6 372 */
XinZhangMS 0:f7f1f0d76dd6 373 extern IOTHUB_REGISTRYMANAGER_RESULT IoTHubRegistryManager_CreateDevice(IOTHUB_REGISTRYMANAGER_HANDLE registryManagerHandle, const IOTHUB_REGISTRY_DEVICE_CREATE* deviceCreate, IOTHUB_DEVICE* device);
XinZhangMS 0:f7f1f0d76dd6 374
XinZhangMS 0:f7f1f0d76dd6 375 /** DEPRECATED:: Use IoTHubRegistryManager_GetDevice_Ex instead
XinZhangMS 0:f7f1f0d76dd6 376 * @brief Gets device info for a given device.
XinZhangMS 0:f7f1f0d76dd6 377 *
XinZhangMS 0:f7f1f0d76dd6 378 * @param registryManagerHandle The handle created by a call to the create function.
XinZhangMS 0:f7f1f0d76dd6 379 * @param deviceId The Id of the requested device.
XinZhangMS 0:f7f1f0d76dd6 380 * @param device Input parameter, if it is not NULL will contain the requested device info structure
XinZhangMS 0:f7f1f0d76dd6 381 *
XinZhangMS 0:f7f1f0d76dd6 382 * @return IOTHUB_REGISTRYMANAGER_RESULT_OK upon success or an error code upon failure.
XinZhangMS 0:f7f1f0d76dd6 383 */
XinZhangMS 0:f7f1f0d76dd6 384 extern IOTHUB_REGISTRYMANAGER_RESULT IoTHubRegistryManager_GetDevice(IOTHUB_REGISTRYMANAGER_HANDLE registryManagerHandle, const char* deviceId, IOTHUB_DEVICE* device);
XinZhangMS 0:f7f1f0d76dd6 385
XinZhangMS 0:f7f1f0d76dd6 386 /** DEPRECATED:: Use IoTHubRegistryManager_UpdateDevice_Ex instead
XinZhangMS 0:f7f1f0d76dd6 387 * @brief Updates a device on IoT Hub.
XinZhangMS 0:f7f1f0d76dd6 388 *
XinZhangMS 0:f7f1f0d76dd6 389 * @param registryManagerHandle The handle created by a call to the create function.
XinZhangMS 0:f7f1f0d76dd6 390 * @param deviceUpdate IOTHUB_REGISTRY_DEVICE_UPDATE structure containing
XinZhangMS 0:f7f1f0d76dd6 391 * the new device Id, primaryKey (optional), secondaryKey (optional),
XinZhangMS 0:f7f1f0d76dd6 392 * authentication method, and status
XinZhangMS 0:f7f1f0d76dd6 393 *
XinZhangMS 0:f7f1f0d76dd6 394 * @return IOTHUB_REGISTRYMANAGER_RESULT_OK upon success or an error code upon failure.
XinZhangMS 0:f7f1f0d76dd6 395 */
XinZhangMS 0:f7f1f0d76dd6 396 extern IOTHUB_REGISTRYMANAGER_RESULT IoTHubRegistryManager_UpdateDevice(IOTHUB_REGISTRYMANAGER_HANDLE registryManagerHandle, IOTHUB_REGISTRY_DEVICE_UPDATE* deviceUpdate);
XinZhangMS 0:f7f1f0d76dd6 397
XinZhangMS 0:f7f1f0d76dd6 398 /* *DEPRECATED:: IoTHubRegistryManager_GetDeviceList is deprecated and may be removed from a future release.
XinZhangMS 0:f7f1f0d76dd6 399 * @brief Gets device a list of devices registered on the IoTHUb.
XinZhangMS 0:f7f1f0d76dd6 400 *
XinZhangMS 0:f7f1f0d76dd6 401 * @param registryManagerHandle The handle created by a call to the create function.
XinZhangMS 0:f7f1f0d76dd6 402 * @param numberOfDevices Number of devices requested.
XinZhangMS 0:f7f1f0d76dd6 403 * @param deviceList Input parameter, if it is not NULL will contain the requested list of devices.
XinZhangMS 0:f7f1f0d76dd6 404 *
XinZhangMS 0:f7f1f0d76dd6 405 * @return IOTHUB_REGISTRYMANAGER_RESULT_OK upon success or an error code upon failure.
XinZhangMS 0:f7f1f0d76dd6 406 */
XinZhangMS 0:f7f1f0d76dd6 407 extern IOTHUB_REGISTRYMANAGER_RESULT IoTHubRegistryManager_GetDeviceList(IOTHUB_REGISTRYMANAGER_HANDLE registryManagerHandle, size_t numberOfDevices, SINGLYLINKEDLIST_HANDLE deviceList);
XinZhangMS 0:f7f1f0d76dd6 408
XinZhangMS 0:f7f1f0d76dd6 409 #ifdef __cplusplus
XinZhangMS 0:f7f1f0d76dd6 410 }
XinZhangMS 0:f7f1f0d76dd6 411 #endif
XinZhangMS 0:f7f1f0d76dd6 412
XinZhangMS 0:f7f1f0d76dd6 413 #endif // IOTHUB_REGISTRYMANAGER_H