prov_device_client.h File Reference

Extends the Prov_Device_LL module with additional features. More...

#include <stddef.h>
#include <stdint.h>
#include "prov_device_ll_client.h"
#include "umock_c/umock_c_prod.h"
#include "azure_macro_utils/macro_utils.h"
#include "azure_c_shared_utility/const_defines.h"
#include "azure_prov_client/prov_transport.h"

Go to the source code of this file.

Typedefs
typedef struct PROV_DEVICE_INSTANCE_TAG *	PROV_DEVICE_HANDLE

Functions
PROV_DEVICE_HANDLE	Prov_Device_Create (const char *uri, const char *scope_id, PROV_DEVICE_TRANSPORT_PROVIDER_FUNCTION protocol)
void	Prov_Device_Destroy (PROV_DEVICE_HANDLE prov_device_handle)
PROV_DEVICE_RESULT	Prov_Device_Register_Device (PROV_DEVICE_HANDLE prov_device_handle, PROV_DEVICE_CLIENT_REGISTER_DEVICE_CALLBACK register_callback, void *user_context, PROV_DEVICE_CLIENT_REGISTER_STATUS_CALLBACK register_status_callback, void *status_user_context)
PROV_DEVICE_RESULT	Prov_Device_SetOption (PROV_DEVICE_HANDLE prov_device_handle, const char *optionName, const void *value)
const char *	Prov_Device_GetVersionString ()
PROV_DEVICE_RESULT	Prov_Device_Set_Provisioning_Payload (PROV_DEVICE_HANDLE handle, const char *json)
	Sets the Provisioning Data that is sent to the Provisioning service. More...
const char *	Prov_Device_Get_Provisioning_Payload (PROV_DEVICE_HANDLE handle)
	Retrieves the Provisioning Data that is sent from the Provisioning service. More...

Detailed Description

Extends the Prov_Device_LL module with additional features.

Prov_Device is a module that extends the Prov_Device_LL module with 2 features:

• scheduling the work for the IoTHubCLient from a thread, so that the user does not need to create their own thread
• thread-safe APIs

Function Documentation

Prov_Device_Get_Provisioning_Payload()

const char* Prov_Device_Get_Provisioning_Payload

(

PROV_DEVICE_HANDLE

handle

)

Retrieves the Provisioning Data that is sent from the Provisioning service.

Parameters

handle

The handle created by a call to the create function.

Returns

The data that was specified by the service

Prov_Device_Set_Provisioning_Payload()

PROV_DEVICE_RESULT Prov_Device_Set_Provisioning_Payload	(	PROV_DEVICE_HANDLE	handle,
		const char *	json
	)

Sets the Provisioning Data that is sent to the Provisioning service.

Parameters

handle	The handle created by a call to the create function.
json	The json payload field that is sent to the service. Setting json to NULL will unset the value previously set

Returns

PROV_DEVICE_RESULT_OK upon success or an error code upon failure