azure_iot_provisioning_client.h

Go to the documentation of this file.

/* Copyright (c) Microsoft Corporation.
 * Licensed under the MIT License. */
 
#ifndef AZURE_IOT_PROVISIONING_CLIENT_H
#define AZURE_IOT_PROVISIONING_CLIENT_H
 
#include "FreeRTOS.h"
 
#include "azure_iot.h"
 
#include "azure_iot_result.h"
#include "azure_iot_mqtt_port.h"
#include "azure_iot_transport_interface.h"
 
/* Azure SDK for Embedded C includes */
#include "azure/iot/az_iot_common.h"
#include "azure/iot/az_iot_provisioning_client.h"
#include "azure/core/_az_cfg_prefix.h"
 
#define azureiotprovisioningRESPONSE_MAX    ( azureiotconfigTOPIC_MAX + azureiotconfigPROVISIONING_REQUEST_PAYLOAD_MAX )
 
#define azureiotprovisioningNO_WAIT         ( 0 )                       
#define azureiotprovisioningWAIT_FOREVER    ( ( uint32_t ) 0xFFFFFFFF ) 
typedef struct AzureIoTProvisioningClientOptions
{
    const uint8_t * pucUserAgent; 
    uint32_t ulUserAgentLength;   
} AzureIoTProvisioningClientOptions_t;
 
typedef struct AzureIoTProvisioningClient
{
    struct
    {
        AzureIoTMQTT_t xMQTTContext;
 
        const uint8_t * pucRegistrationID;
        uint32_t ulRegistrationIDLength;
        const uint8_t * pucEndpoint;
        uint32_t ulEndpointLength;
        const uint8_t * pucIDScope;
        uint32_t ulIDScopeLength;
        const uint8_t * pucSymmetricKey;
        uint32_t ulSymmetricKeyLength;
        const uint8_t * pucRegistrationPayload;
        uint32_t ulRegistrationPayloadLength;
 
        uint32_t ( * pxTokenRefresh )( struct AzureIoTProvisioningClient * pxAzureIoTProvisioningClient,
                                       uint64_t ullExpiryTimeSecs,
                                       const uint8_t * ucKey,
                                       uint32_t ulKeyLen,
                                       uint8_t * pucSASBuffer,
                                       uint32_t ulSasBufferLen,
                                       uint32_t * pulSaSLength );
        AzureIoTGetHMACFunc_t xHMACFunction;
        AzureIoTGetCurrentTimeFunc_t xGetTimeFunction;
 
        az_iot_provisioning_client xProvisioningClientCore;
 
        uint32_t ulWorkflowState;
        uint32_t ulLastOperationResult;
        uint64_t ullRetryAfter;
 
        uint8_t * pucScratchBuffer;
        uint32_t ulScratchBufferLength;
        uint8_t ucProvisioningLastResponse[ azureiotprovisioningRESPONSE_MAX ];
        size_t xLastResponsePayloadLength;
        uint16_t usLastResponseTopicLength;
        az_iot_provisioning_client_register_response xRegisterResponse;
    } _internal; 
} AzureIoTProvisioningClient_t;
 
AzureIoTResult_t AzureIoTProvisioningClient_OptionsInit( AzureIoTProvisioningClientOptions_t * pxProvisioningClientOptions );
 
AzureIoTResult_t AzureIoTProvisioningClient_Init( AzureIoTProvisioningClient_t * pxAzureProvClient,
                                                  const uint8_t * pucEndpoint,
                                                  uint32_t ulEndpointLength,
                                                  const uint8_t * pucIDScope,
                                                  uint32_t ulIDScopeLength,
                                                  const uint8_t * pucRegistrationID,
                                                  uint32_t ulRegistrationIDLength,
                                                  AzureIoTProvisioningClientOptions_t * pxProvisioningClientOptions,
                                                  uint8_t * pucBuffer,
                                                  uint32_t ulBufferLength,
                                                  AzureIoTGetCurrentTimeFunc_t xGetTimeFunction,
                                                  const AzureIoTTransportInterface_t * pxTransportInterface );
 
void AzureIoTProvisioningClient_Deinit( AzureIoTProvisioningClient_t * pxAzureProvClient );
 
AzureIoTResult_t AzureIoTProvisioningClient_SetSymmetricKey( AzureIoTProvisioningClient_t * pxAzureProvClient,
                                                             const uint8_t * pucSymmetricKey,
                                                             uint32_t ulSymmetricKeyLength,
                                                             AzureIoTGetHMACFunc_t xHmacFunction );
 
AzureIoTResult_t AzureIoTProvisioningClient_Register( AzureIoTProvisioningClient_t * pxAzureProvClient,
                                                      uint32_t ulTimeoutMilliseconds );
 
AzureIoTResult_t AzureIoTProvisioningClient_GetDeviceAndHub( AzureIoTProvisioningClient_t * pxAzureProvClient,
                                                             uint8_t * pucHubHostname,
                                                             uint32_t * pulHostnameLength,
                                                             uint8_t * pucDeviceID,
                                                             uint32_t * pulDeviceIDLength );
 
AzureIoTResult_t AzureIoTProvisioningClient_GetExtendedCode( AzureIoTProvisioningClient_t * pxAzureProvClient,
                                                             uint32_t * pulExtendedErrorCode );
 
AzureIoTResult_t AzureIoTProvisioningClient_SetRegistrationPayload( AzureIoTProvisioningClient_t * pxAzureProvClient,
                                                                    const uint8_t * pucPayload,
                                                                    uint32_t ulPayloadLength );
 
#include "azure/core/_az_cfg_suffix.h"
 
#endif /* AZURE_IOT_PROVISIONING_CLIENT_H */