iothub_client_properties.h

Go to the documentation of this file.

// Copyright (c) Microsoft. All rights reserved.
// Licensed under the MIT license. See LICENSE file in the project root for full license information.
 
#ifndef IOTHUB_CLIENT_PROPERTIES_H
#define IOTHUB_CLIENT_PROPERTIES_H
 
#include "umock_c/umock_c_prod.h"
 
#include <stddef.h>
 
#include "iothub_client_core_common.h"
 
#ifdef __cplusplus
extern "C"
{
#endif
 
#define IOTHUB_CLIENT_PROPERTY_REPORTED_STRUCT_VERSION_1 1
 
typedef struct IOTHUB_CLIENT_PROPERTY_REPORTED_TAG {
    int structVersion;
    const char* name;
    const char* value;
} IOTHUB_CLIENT_PROPERTY_REPORTED;
 
#define IOTHUB_CLIENT_PROPERTY_WRITABLE_RESPONSE_STRUCT_VERSION_1 1
 
typedef struct IOTHUB_CLIENT_PROPERTY_WRITABLE_RESPONSE_TAG {
    int structVersion;
    const char* name;
    const char* value;
    int result;
    int ackVersion;
    const char* description;
} IOTHUB_CLIENT_PROPERTY_WRITABLE_RESPONSE;
 
typedef enum { IOTHUB_CLIENT_PROPERTY_TYPE_REPORTED_FROM_CLIENT, IOTHUB_CLIENT_PROPERTY_TYPE_WRITABLE } IOTHUB_CLIENT_PROPERTY_TYPE;
/* @brief Enumeration that indicates whether the JSON value of a deserialized property 
*         is a null-terminated string or binary.  Currently only STRING values are supported.
*/
typedef enum { IOTHUB_CLIENT_PROPERTY_VALUE_STRING } IOTHUB_CLIENT_PROPERTY_TYPE;
#define IOTHUB_CLIENT_PROPERTY_PARSED_STRUCT_VERSION_1 1
 
typedef struct IOTHUB_CLIENT_PROPERTY_PARSED_TAG {
    int structVersion;
    IOTHUB_CLIENT_PROPERTY_TYPE propertyType;
    const char* componentName;
    const char* name;
    IOTHUB_CLIENT_PROPERTY_VALUE_TYPE valueType;
    union {
        const char* str;
    } value;
    size_t valueLength;
} IOTHUB_CLIENT_PROPERTY_PARSED;
 
 IOTHUB_CLIENT_RESULT IoTHubClient_Properties_Serializer_CreateReported( const IOTHUB_CLIENT_PROPERTY_REPORTED* properties, size_t numProperties, const char* componentName, unsigned char** serializedProperties, size_t* serializedPropertiesLength);
 IOTHUB_CLIENT_RESULT IoTHubClient_Properties_Serializer_CreateWritableResponse( const IOTHUB_CLIENT_PROPERTY_WRITABLE_RESPONSE* properties, size_t numProperties, const char* componentName, unsigned char** serializedProperties, size_t* serializedPropertiesLength);
 void IoTHubClient_Properties_Serializer_Destroy( unsigned char* serializedProperties);
typedef struct IOTHUB_CLIENT_PROPERTIES_DESERIALIZER_TAG* IOTHUB_CLIENT_PROPERTIES_DESERIALIZER_HANDLE;
 
 IOTHUB_CLIENT_RESULT IoTHubClient_Properties_Deserializer_Create(  IOTHUB_CLIENT_PROPERTY_PAYLOAD_TYPE payloadType, const unsigned char* payload, size_t payloadLength, IOTHUB_CLIENT_PROPERTIES_DESERIALIZER_HANDLE* propertiesDeserializerHandle);
 IOTHUB_CLIENT_RESULT IoTHubClient_Properties_Deserializer_GetVersion( IOTHUB_CLIENT_PROPERTIES_DESERIALIZER_HANDLE propertiesDeserializerHandle, int* propertiesVersion);
 IOTHUB_CLIENT_RESULT IoTHubClient_Properties_Deserializer_GetNext( IOTHUB_CLIENT_PROPERTIES_DESERIALIZER_HANDLE propertiesDeserializerHandle, IOTHUB_CLIENT_PROPERTY_PARSED* property, bool* propertySpecified);
 void IoTHubClient_Properties_DeserializerProperty_Destroy(  IOTHUB_CLIENT_PROPERTY_PARSED* property);
 void IoTHubClient_Properties_Deserializer_Destroy( IOTHUB_CLIENT_PROPERTIES_DESERIALIZER_HANDLE propertiesDeserializerHandle);
#ifdef __cplusplus
}
#endif
 
#endif /* IOTHUB_CLIENT_PROPERTIES_H */