Go to the documentation of this file.
10 #ifndef _az_IOT_HUB_CLIENT_PROPERTIES_H
11 #define _az_IOT_HUB_CLIENT_PROPERTIES_H
22 #include <azure/core/_az_cfg_prefix.h>
209 int32_t* out_version);
306 #include <azure/core/_az_cfg_suffix.h>
308 #endif //_az_IOT_HUB_CLIENT_PROPERTIES_H
Definition of az_result and helper functions.
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
Property was originally reported from the device.
Definition: az_iot_hub_client_properties.h:218
Returns the JSON tokens contained within a JSON buffer, one at a time.
Definition: az_json.h:664
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.
Provides forward-only, non-cached writing of UTF-8 encoded JSON text into the provided buffer.
Definition: az_json.h:305
int32_t az_result
The type represents the various success and error conditions.
Definition: az_result.h:46
@ AZ_IOT_HUB_CLIENT_PROPERTY_WRITABLE
Property was received from the service.
Definition: az_iot_hub_client_properties.h:220
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.
An az_span represents a contiguous byte buffer and is used for string manipulations,...
az_iot_hub_client_property_type
Property type.
Definition: az_iot_hub_client_properties.h:216
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.
This header defines the types and functions your application uses to read or write JSON objects.
Definition for the Azure IoT Hub client.
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.
Azure IoT Hub Client.
Definition: az_iot_hub_client.h:78
az_iot_hub_client_properties_message_type
Properties message type.
Definition: az_iot_hub_client.h:715
Represents a "view" over a byte buffer that represents a contiguous region of memory....
Definition: az_span.h:33
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.