iothub_device_client.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_DEVICE_CLIENT_H
#define IOTHUB_DEVICE_CLIENT_H
 
#include <stddef.h>
#include <stdint.h>
 
#include "umock_c/umock_c_prod.h"
#include "iothub_transport_ll.h"
#include "iothub_client_core_ll.h"
#include "iothub_client_core.h"
#include "iothub_device_client_ll.h"
 
#ifndef IOTHUB_DEVICE_CLIENT_INSTANCE_TYPE
typedef IOTHUB_CLIENT_CORE_HANDLE IOTHUB_DEVICE_CLIENT_HANDLE;
#define IOTHUB_DEVICE_CLIENT_INSTANCE_TYPE
#endif // IOTHUB_CLIENT_INSTANCE
 
#ifndef DONT_USE_UPLOADTOBLOB
typedef IOTHUB_CLIENT_LL_UPLOADTOBLOB_CONTEXT_HANDLE IOTHUB_CLIENT_AZURE_STORAGE_CLIENT_HANDLE;
#endif // DONT_USE_UPLOADTOBLOB
 
#ifdef __cplusplus
extern "C"
{
#endif
 
 IOTHUB_DEVICE_CLIENT_HANDLE IoTHubDeviceClient_CreateFromConnectionString( const char* connectionString, IOTHUB_CLIENT_TRANSPORT_PROVIDER protocol);
 IOTHUB_DEVICE_CLIENT_HANDLE IoTHubDeviceClient_Create( const IOTHUB_CLIENT_CONFIG* config);
 IOTHUB_DEVICE_CLIENT_HANDLE IoTHubDeviceClient_CreateWithTransport( TRANSPORT_HANDLE transportHandle, const IOTHUB_CLIENT_CONFIG* config);
 IOTHUB_DEVICE_CLIENT_HANDLE IoTHubDeviceClient_CreateFromDeviceAuth( const char* iothub_uri, const char* device_id, IOTHUB_CLIENT_TRANSPORT_PROVIDER protocol);
 void IoTHubDeviceClient_Destroy( IOTHUB_DEVICE_CLIENT_HANDLE iotHubClientHandle);
 IOTHUB_CLIENT_RESULT IoTHubDeviceClient_SendEventAsync( IOTHUB_DEVICE_CLIENT_HANDLE iotHubClientHandle, IOTHUB_MESSAGE_HANDLE eventMessageHandle, IOTHUB_CLIENT_EVENT_CONFIRMATION_CALLBACK eventConfirmationCallback, void* userContextCallback);
 IOTHUB_CLIENT_RESULT IoTHubDeviceClient_GetSendStatus( IOTHUB_DEVICE_CLIENT_HANDLE iotHubClientHandle, IOTHUB_CLIENT_STATUS* iotHubClientStatus);
 IOTHUB_CLIENT_RESULT IoTHubDeviceClient_SetMessageCallback( IOTHUB_DEVICE_CLIENT_HANDLE iotHubClientHandle, IOTHUB_CLIENT_MESSAGE_CALLBACK_ASYNC messageCallback, void* userContextCallback);
 IOTHUB_CLIENT_RESULT IoTHubDeviceClient_SetConnectionStatusCallback( IOTHUB_DEVICE_CLIENT_HANDLE iotHubClientHandle, IOTHUB_CLIENT_CONNECTION_STATUS_CALLBACK connectionStatusCallback, void* userContextCallback);
 IOTHUB_CLIENT_RESULT IoTHubDeviceClient_SetRetryPolicy( IOTHUB_DEVICE_CLIENT_HANDLE iotHubClientHandle, IOTHUB_CLIENT_RETRY_POLICY retryPolicy, size_t retryTimeoutLimitInSeconds);
 IOTHUB_CLIENT_RESULT IoTHubDeviceClient_GetRetryPolicy( IOTHUB_DEVICE_CLIENT_HANDLE iotHubClientHandle, IOTHUB_CLIENT_RETRY_POLICY* retryPolicy, size_t* retryTimeoutLimitInSeconds);
 IOTHUB_CLIENT_RESULT IoTHubDeviceClient_GetLastMessageReceiveTime( IOTHUB_DEVICE_CLIENT_HANDLE iotHubClientHandle, time_t* lastMessageReceiveTime);
 IOTHUB_CLIENT_RESULT IoTHubDeviceClient_SetOption( IOTHUB_DEVICE_CLIENT_HANDLE iotHubClientHandle, const char* optionName, const void* value);
 IOTHUB_CLIENT_RESULT IoTHubDeviceClient_SetDeviceTwinCallback( IOTHUB_DEVICE_CLIENT_HANDLE iotHubClientHandle, IOTHUB_CLIENT_DEVICE_TWIN_CALLBACK deviceTwinCallback, void* userContextCallback);
 IOTHUB_CLIENT_RESULT IoTHubDeviceClient_SendReportedState( IOTHUB_DEVICE_CLIENT_HANDLE iotHubClientHandle, const unsigned char* reportedState, size_t size, IOTHUB_CLIENT_REPORTED_STATE_CALLBACK reportedStateCallback, void* userContextCallback);
 IOTHUB_CLIENT_RESULT IoTHubDeviceClient_GetTwinAsync( IOTHUB_DEVICE_CLIENT_HANDLE iotHubClientHandle, IOTHUB_CLIENT_DEVICE_TWIN_CALLBACK deviceTwinCallback, void* userContextCallback);
 IOTHUB_CLIENT_RESULT IoTHubDeviceClient_SetDeviceMethodCallback( IOTHUB_DEVICE_CLIENT_HANDLE iotHubClientHandle, IOTHUB_CLIENT_DEVICE_METHOD_CALLBACK_ASYNC deviceMethodCallback, void* userContextCallback);
 IOTHUB_CLIENT_RESULT IoTHubDeviceClient_DeviceMethodResponse( IOTHUB_DEVICE_CLIENT_HANDLE iotHubClientHandle, METHOD_HANDLE methodId, const unsigned char* response, size_t response_size, int statusCode);
#ifndef DONT_USE_UPLOADTOBLOB
 IOTHUB_CLIENT_RESULT IoTHubDeviceClient_UploadToBlobAsync( IOTHUB_DEVICE_CLIENT_HANDLE iotHubClientHandle, const char* destinationFileName, const unsigned char* source, size_t size, IOTHUB_CLIENT_FILE_UPLOAD_CALLBACK iotHubClientFileUploadCallback, void* context);
 IOTHUB_CLIENT_RESULT IoTHubDeviceClient_UploadMultipleBlocksToBlobAsync( IOTHUB_DEVICE_CLIENT_HANDLE iotHubClientHandle, const char* destinationFileName, IOTHUB_CLIENT_FILE_UPLOAD_GET_DATA_CALLBACK_EX getDataCallbackEx, void* context);
 IOTHUB_CLIENT_RESULT IoTHubDeviceClient_AzureStorageInitializeBlobUpload( IOTHUB_DEVICE_CLIENT_HANDLE iotHubClientHandle, const char* destinationFileName, char** uploadCorrelationId, char** azureBlobSasUri);
 IOTHUB_CLIENT_AZURE_STORAGE_CLIENT_HANDLE IoTHubDeviceClient_AzureStorageCreateClient( IOTHUB_DEVICE_CLIENT_HANDLE iotHubClientHandle, const char* azureBlobSasUri);
 IOTHUB_CLIENT_RESULT IoTHubDeviceClient_AzureStoragePutBlock( IOTHUB_CLIENT_AZURE_STORAGE_CLIENT_HANDLE azureStorageClientHandle, uint32_t blockNumber, const uint8_t* dataPtr, size_t dataSize);
 IOTHUB_CLIENT_RESULT IoTHubDeviceClient_AzureStoragePutBlockList( IOTHUB_CLIENT_AZURE_STORAGE_CLIENT_HANDLE azureStorageClientHandle);
 void IoTHubDeviceClient_AzureStorageDestroyClient( IOTHUB_CLIENT_AZURE_STORAGE_CLIENT_HANDLE azureStorageClientHandle);
 IOTHUB_CLIENT_RESULT IoTHubDeviceClient_AzureStorageNotifyBlobUploadCompletion( IOTHUB_DEVICE_CLIENT_HANDLE iotHubClientHandle, const char* uploadCorrelationId, bool isSuccess, int responseCode, const char* responseMessage);#endif /* DONT_USE_UPLOADTOBLOB */
 
 IOTHUB_CLIENT_RESULT IoTHubDeviceClient_SendMessageDisposition( IOTHUB_DEVICE_CLIENT_HANDLE iotHubClientHandle, IOTHUB_MESSAGE_HANDLE message, IOTHUBMESSAGE_DISPOSITION_RESULT disposition);
 IOTHUB_CLIENT_RESULT IoTHubDeviceClient_SendTelemetryAsync( IOTHUB_DEVICE_CLIENT_HANDLE iotHubClientHandle, IOTHUB_MESSAGE_HANDLE telemetryMessageHandle, IOTHUB_CLIENT_TELEMETRY_CALLBACK telemetryConfirmationCallback, void* userContextCallback);    
 IOTHUB_CLIENT_RESULT IoTHubDeviceClient_SubscribeToCommands( IOTHUB_DEVICE_CLIENT_HANDLE iotHubClientHandle, IOTHUB_CLIENT_COMMAND_CALLBACK_ASYNC commandCallback,  void* userContextCallback);
 IOTHUB_CLIENT_RESULT IoTHubDeviceClient_SendPropertiesAsync( IOTHUB_DEVICE_CLIENT_HANDLE iotHubClientHandle,  const unsigned char* properties, size_t propertiesLength, IOTHUB_CLIENT_PROPERTY_ACKNOWLEDGED_CALLBACK propertyAcknowledgedCallback, void* userContextCallback);
 IOTHUB_CLIENT_RESULT IoTHubDeviceClient_GetPropertiesAsync( IOTHUB_DEVICE_CLIENT_HANDLE iotHubClientHandle,  IOTHUB_CLIENT_PROPERTIES_RECEIVED_CALLBACK propertyCallback, void* userContextCallback);    
 IOTHUB_CLIENT_RESULT IoTHubDeviceClient_GetPropertiesAndSubscribeToUpdatesAsync( IOTHUB_DEVICE_CLIENT_HANDLE iotHubClientHandle, IOTHUB_CLIENT_PROPERTIES_RECEIVED_CALLBACK propertyUpdateCallback, void* userContextCallback);
#ifdef __cplusplus
}
#endif
 
#endif /* IOTHUB_DEVICE_CLIENT_H */