Azure SDK for Embedded C
az_iot_hub_client_properties.h
Go to the documentation of this file.
1 // Copyright (c) Microsoft Corporation. All rights reserved.
2 // SPDX-License-Identifier: MIT
3 
10 #ifndef _az_IOT_HUB_CLIENT_PROPERTIES_H
11 #define _az_IOT_HUB_CLIENT_PROPERTIES_H
12 
13 #include <stdbool.h>
14 #include <stdint.h>
15 
16 #include <azure/core/az_json.h>
17 #include <azure/core/az_result.h>
18 #include <azure/core/az_span.h>
19 
21 
22 #include <azure/core/_az_cfg_prefix.h>
23 
55  az_iot_hub_client const* client,
56  az_json_writer* ref_json_writer,
57  az_span component_name);
58 
77  az_iot_hub_client const* client,
78  az_json_writer* ref_json_writer);
79 
154  az_iot_hub_client const* client,
155  az_json_writer* ref_json_writer,
156  az_span property_name,
157  int32_t status_code,
158  int32_t version,
159  az_span description);
160 
177  az_iot_hub_client const* client,
178  az_json_writer* ref_json_writer);
179 
206  az_iot_hub_client const* client,
207  az_json_reader* ref_json_reader,
209  int32_t* out_version);
210 
215 typedef enum
216 {
222 
300  az_iot_hub_client const* client,
301  az_json_reader* ref_json_reader,
303  az_iot_hub_client_property_type property_type,
304  az_span* out_component_name);
305 
306 #include <azure/core/_az_cfg_suffix.h>
307 
308 #endif //_az_IOT_HUB_CLIENT_PROPERTIES_H
az_result.h
Definition of az_result and helper functions.
az_iot_hub_client_properties_get_next_component_property
AZ_NODISCARD az_result az_iot_hub_client_properties_get_next_component_property(az_iot_hub_client const *client, az_json_reader *ref_json_reader, az_iot_hub_client_properties_message_type message_type, az_iot_hub_client_property_type property_type, az_span *out_component_name)
Iteratively read the IoT Plug and Play component properties.
AZ_IOT_HUB_CLIENT_PROPERTY_REPORTED_FROM_DEVICE
@ AZ_IOT_HUB_CLIENT_PROPERTY_REPORTED_FROM_DEVICE
Property was originally reported from the device.
Definition: az_iot_hub_client_properties.h:218
az_json_reader
Returns the JSON tokens contained within a JSON buffer, one at a time.
Definition: az_json.h:664
az_iot_hub_client_properties_writer_begin_component
AZ_NODISCARD az_result az_iot_hub_client_properties_writer_begin_component(az_iot_hub_client const *client, az_json_writer *ref_json_writer, az_span component_name)
Append the necessary characters to a reported properties JSON payload belonging to a component.
az_json_writer
Provides forward-only, non-cached writing of UTF-8 encoded JSON text into the provided buffer.
Definition: az_json.h:305
az_result
int32_t az_result
The type represents the various success and error conditions.
Definition: az_result.h:46
AZ_IOT_HUB_CLIENT_PROPERTY_WRITABLE
@ AZ_IOT_HUB_CLIENT_PROPERTY_WRITABLE
Property was received from the service.
Definition: az_iot_hub_client_properties.h:220
az_iot_hub_client_properties_writer_end_response_status
AZ_NODISCARD az_result az_iot_hub_client_properties_writer_end_response_status(az_iot_hub_client const *client, az_json_writer *ref_json_writer)
End a properties response payload with confirmation status.
az_span.h
An az_span represents a contiguous byte buffer and is used for string manipulations,...
az_iot_hub_client_property_type
az_iot_hub_client_property_type
Property type.
Definition: az_iot_hub_client_properties.h:216
az_iot_hub_client_properties_writer_begin_response_status
AZ_NODISCARD az_result az_iot_hub_client_properties_writer_begin_response_status(az_iot_hub_client const *client, az_json_writer *ref_json_writer, az_span property_name, int32_t status_code, int32_t version, az_span description)
Begin a property response to a writable property request from the service.
az_json.h
This header defines the types and functions your application uses to read or write JSON objects.
az_iot_hub_client.h
Definition for the Azure IoT Hub client.
az_iot_hub_client_properties_writer_end_component
AZ_NODISCARD az_result az_iot_hub_client_properties_writer_end_component(az_iot_hub_client const *client, az_json_writer *ref_json_writer)
Append the necessary characters to end a reported properties JSON payload belonging to a component.
az_iot_hub_client
Azure IoT Hub Client.
Definition: az_iot_hub_client.h:78
az_iot_hub_client_properties_message_type
az_iot_hub_client_properties_message_type
Properties message type.
Definition: az_iot_hub_client.h:715
az_span
Represents a "view" over a byte buffer that represents a contiguous region of memory....
Definition: az_span.h:33
az_iot_hub_client_properties_get_properties_version
AZ_NODISCARD az_result az_iot_hub_client_properties_get_properties_version(az_iot_hub_client const *client, az_json_reader *ref_json_reader, az_iot_hub_client_properties_message_type message_type, int32_t *out_version)
Read the IoT Plug and Play property version.