iothub_client_core_common.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_CORE_COMMON_H
#define IOTHUB_CLIENT_CORE_COMMON_H
 
#include "azure_macro_utils/macro_utils.h"
#include "umock_c/umock_c_prod.h"
 
#include "iothub_transport_ll.h"
#include "iothub_message.h"
 
#ifdef __cplusplus
extern "C"
{
#endif
 
typedef enum { FILE_UPLOAD_OK, FILE_UPLOAD_ERROR } IOTHUB_CLIENT_FILE_UPLOAD_RESULT;
    typedef void(*IOTHUB_CLIENT_FILE_UPLOAD_CALLBACK)(IOTHUB_CLIENT_FILE_UPLOAD_RESULT result, void* userContextCallback);
 
typedef struct IOTHUB_CLIENT_LL_UPLOADTOBLOB_CONTEXT_STRUCT* IOTHUB_CLIENT_LL_UPLOADTOBLOB_CONTEXT_HANDLE;
 
typedef enum { IOTHUB_CLIENT_OK, IOTHUB_CLIENT_INVALID_ARG, IOTHUB_CLIENT_ERROR, IOTHUB_CLIENT_INVALID_SIZE, IOTHUB_CLIENT_INDEFINITE_TIME } IOTHUB_CLIENT_RESULT;
    typedef void(*IOTHUB_METHOD_INVOKE_CALLBACK)(IOTHUB_CLIENT_RESULT result, int responseStatus, unsigned char* responsePayload, size_t responsePayloadSize, void* context);
 
typedef enum { IOTHUB_CLIENT_RETRY_NONE, IOTHUB_CLIENT_RETRY_IMMEDIATE, IOTHUB_CLIENT_RETRY_INTERVAL, IOTHUB_CLIENT_RETRY_LINEAR_BACKOFF, IOTHUB_CLIENT_RETRY_EXPONENTIAL_BACKOFF, IOTHUB_CLIENT_RETRY_EXPONENTIAL_BACKOFF_WITH_JITTER, IOTHUB_CLIENT_RETRY_RANDOM } IOTHUB_CLIENT_RETRY_POLICY;
    /* IOTHUBTRANSPORT_CONFIG_TAG is internal only and should not be documented. */
    struct IOTHUBTRANSPORT_CONFIG_TAG;
    typedef struct IOTHUBTRANSPORT_CONFIG_TAG IOTHUBTRANSPORT_CONFIG;
typedef enum { IOTHUB_CLIENT_SEND_STATUS_IDLE, IOTHUB_CLIENT_SEND_STATUS_BUSY } IOTHUB_CLIENT_STATUS;
    /* IOTHUB_IDENTITY_TYPE and IOTHUB_IDENTITY_TYPE are internal only and should not be documented. */
typedef enum { IOTHUB_TYPE_TELEMETRY, IOTHUB_TYPE_DEVICE_TWIN, IOTHUB_TYPE_DEVICE_METHODS, IOTHUB_TYPE_EVENT_QUEUE } IOTHUB_IDENTITY_TYPE;
typedef enum { IOTHUB_PROCESS_OK, IOTHUB_PROCESS_ERROR, IOTHUB_PROCESS_NOT_CONNECTED, IOTHUB_PROCESS_CONTINUE } IOTHUB_PROCESS_ITEM_RESULT;    
typedef enum { IOTHUBMESSAGE_ACCEPTED, IOTHUBMESSAGE_REJECTED, IOTHUBMESSAGE_ABANDONED, IOTHUBMESSAGE_ASYNC_ACK } IOTHUBMESSAGE_DISPOSITION_RESULT;
    /* IOTHUB_CLIENT_IOTHUB_METHOD_STATUS is not used by IoT Hub client and should not be documented. */
typedef enum { IOTHUB_CLIENT_IOTHUB_METHOD_STATUS_SUCCESS, IOTHUB_CLIENT_IOTHUB_METHOD_STATUS_ERROR } IOTHUB_CLIENT_IOTHUB_METHOD_STATUS;    
typedef enum { IOTHUB_CLIENT_CONFIRMATION_OK, IOTHUB_CLIENT_CONFIRMATION_BECAUSE_DESTROY, IOTHUB_CLIENT_CONFIRMATION_MESSAGE_TIMEOUT, IOTHUB_CLIENT_CONFIRMATION_ERROR } IOTHUB_CLIENT_CONFIRMATION_RESULT;
typedef enum { IOTHUB_CLIENT_CONNECTION_AUTHENTICATED, IOTHUB_CLIENT_CONNECTION_UNAUTHENTICATED } IOTHUB_CLIENT_CONNECTION_STATUS;
typedef enum { IOTHUB_CLIENT_CONNECTION_EXPIRED_SAS_TOKEN, IOTHUB_CLIENT_CONNECTION_DEVICE_DISABLED, IOTHUB_CLIENT_CONNECTION_BAD_CREDENTIAL, IOTHUB_CLIENT_CONNECTION_RETRY_EXPIRED, IOTHUB_CLIENT_CONNECTION_NO_NETWORK, IOTHUB_CLIENT_CONNECTION_COMMUNICATION_ERROR, IOTHUB_CLIENT_CONNECTION_OK, IOTHUB_CLIENT_CONNECTION_NO_PING_RESPONSE, IOTHUB_CLIENT_CONNECTION_QUOTA_EXCEEDED } IOTHUB_CLIENT_CONNECTION_STATUS_REASON;
typedef enum { IOTHUB_CLIENT_PROPERTY_PAYLOAD_ALL, IOTHUB_CLIENT_PROPERTY_PAYLOAD_WRITABLE_UPDATES } IOTHUB_CLIENT_PROPERTY_PAYLOAD_TYPE;
    /* TRANSPORT_TYPE is internal only and should not be documented. */
typedef enum { TRANSPORT_LL /*LL comes from "LowLevel" */, TRANSPORT_THREADED } TRANSPORT_TYPE;    
typedef enum { DEVICE_TWIN_UPDATE_COMPLETE, DEVICE_TWIN_UPDATE_PARTIAL } DEVICE_TWIN_UPDATE_STATE;
    typedef void(*IOTHUB_CLIENT_EVENT_CONFIRMATION_CALLBACK)(IOTHUB_CLIENT_CONFIRMATION_RESULT result, void* userContextCallback);
 
    typedef void(*IOTHUB_CLIENT_CONNECTION_STATUS_CALLBACK)(IOTHUB_CLIENT_CONNECTION_STATUS result, IOTHUB_CLIENT_CONNECTION_STATUS_REASON reason, void* userContextCallback);
 
    typedef IOTHUBMESSAGE_DISPOSITION_RESULT (*IOTHUB_CLIENT_MESSAGE_CALLBACK_ASYNC)(IOTHUB_MESSAGE_HANDLE message, void* userContextCallback);
 
    typedef void(*IOTHUB_CLIENT_DEVICE_TWIN_CALLBACK)(DEVICE_TWIN_UPDATE_STATE update_state, const unsigned char* payLoad, size_t size, void* userContextCallback);
 
    typedef void(*IOTHUB_CLIENT_REPORTED_STATE_CALLBACK)(int status_code, void* userContextCallback);
 
    typedef int(*IOTHUB_CLIENT_DEVICE_METHOD_CALLBACK_ASYNC)(const char* method_name, const unsigned char* payload, size_t size, unsigned char** response, size_t* response_size, void* userContextCallback);
 
    /* IOTHUB_CLIENT_INBOUND_DEVICE_METHOD_CALLBACK is internal only and should not be documented. */
    typedef int(*IOTHUB_CLIENT_INBOUND_DEVICE_METHOD_CALLBACK)(const char* method_name, const unsigned char* payload, size_t size, METHOD_HANDLE method_id, void* userContextCallback);
typedef enum { IOTHUB_CLIENT_FILE_UPLOAD_GET_DATA_OK, IOTHUB_CLIENT_FILE_UPLOAD_GET_DATA_ABORT } IOTHUB_CLIENT_FILE_UPLOAD_GET_DATA_RESULT;
    typedef void(*IOTHUB_CLIENT_FILE_UPLOAD_GET_DATA_CALLBACK)(IOTHUB_CLIENT_FILE_UPLOAD_RESULT result, unsigned char const ** data, size_t* size, void* context);
 
    typedef IOTHUB_CLIENT_FILE_UPLOAD_GET_DATA_RESULT(*IOTHUB_CLIENT_FILE_UPLOAD_GET_DATA_CALLBACK_EX)(IOTHUB_CLIENT_FILE_UPLOAD_RESULT result, unsigned char const ** data, size_t* size, void* context);
 
    typedef struct IOTHUB_CLIENT_CONFIG_TAG
    {
        IOTHUB_CLIENT_TRANSPORT_PROVIDER protocol;
 
        const char* deviceId;
 
        const char* deviceKey;
 
        const char* deviceSasToken;
 
        const char* iotHubName;
 
        const char* iotHubSuffix;
 
        const char* protocolGatewayHostName;
    } IOTHUB_CLIENT_CONFIG;
 
    typedef struct IOTHUB_CLIENT_DEVICE_CONFIG_TAG
    {
        IOTHUB_CLIENT_TRANSPORT_PROVIDER protocol;
 
        void * transportHandle;
 
        const char* deviceId;
 
        const char* deviceKey;
 
        const char* deviceSasToken;
    } IOTHUB_CLIENT_DEVICE_CONFIG;
 
    #define IOTHUB_CLIENT_COMMAND_REQUEST_STRUCT_VERSION_1 1
 
    typedef struct IOTHUB_CLIENT_COMMAND_REQUEST_TAG
    {
        int structVersion;
        const char* componentName;
        const char* commandName;
        const unsigned char* payload;
        size_t payloadLength;
    } IOTHUB_CLIENT_COMMAND_REQUEST;
 
    #define IOTHUB_CLIENT_COMMAND_RESPONSE_STRUCT_VERSION_1 1
 
    typedef struct IOTHUB_CLIENT_COMMAND_RESPONSE_TAG
    {
        int structVersion;
        unsigned char* payload;
        size_t payloadLength;
        int statusCode;
    } IOTHUB_CLIENT_COMMAND_RESPONSE;
 
    typedef void(*IOTHUB_CLIENT_COMMAND_CALLBACK_ASYNC)(
                const IOTHUB_CLIENT_COMMAND_REQUEST* commandRequest,
                IOTHUB_CLIENT_COMMAND_RESPONSE* commandResponse,    
                void* userContextCallback);
 
    typedef void(*IOTHUB_CLIENT_TELEMETRY_CALLBACK)(IOTHUB_CLIENT_CONFIRMATION_RESULT result, void* userContextCallback);
    
    typedef void(*IOTHUB_CLIENT_PROPERTY_ACKNOWLEDGED_CALLBACK)(int statusCode, void* userContextCallback);
 
    typedef void(*IOTHUB_CLIENT_PROPERTIES_RECEIVED_CALLBACK)(
                     IOTHUB_CLIENT_PROPERTY_PAYLOAD_TYPE payloadType, 
                     const unsigned char* payload,
                     size_t payloadLength,
                     void* userContextCallback);
 
#ifdef __cplusplus
}
#endif
 
#endif /* IOTHUB_CLIENT_CORE_COMMON_H */