iothub_client_ll.h File Reference

APIs that allow a user (usually a device) to communicate with an Azure IoT Hub. More...

#include <stddef.h>
#include <stdint.h>
#include <time.h>
#include "umock_c/umock_c_prod.h"
#include "iothub_client_core_common.h"

Go to the source code of this file.

Typedefs
typedef struct IOTHUB_CLIENT_CORE_LL_HANDLE_DATA_TAG *	IOTHUB_CLIENT_LL_HANDLE

Functions
IOTHUB_CLIENT_LL_HANDLE	IoTHubClient_LL_CreateFromConnectionString (const char *connectionString, IOTHUB_CLIENT_TRANSPORT_PROVIDER protocol)
IOTHUB_CLIENT_LL_HANDLE	IoTHubClient_LL_Create (const IOTHUB_CLIENT_CONFIG *config)
IOTHUB_CLIENT_LL_HANDLE	IoTHubClient_LL_CreateWithTransport (const IOTHUB_CLIENT_DEVICE_CONFIG *config)
IOTHUB_CLIENT_LL_HANDLE	IoTHubClient_LL_CreateFromDeviceAuth (const char *iothub_uri, const char *device_id, IOTHUB_CLIENT_TRANSPORT_PROVIDER protocol)
void	IoTHubClient_LL_Destroy (IOTHUB_CLIENT_LL_HANDLE iotHubClientHandle)
IOTHUB_CLIENT_RESULT	IoTHubClient_LL_SendEventAsync (IOTHUB_CLIENT_LL_HANDLE iotHubClientHandle, IOTHUB_MESSAGE_HANDLE eventMessageHandle, IOTHUB_CLIENT_EVENT_CONFIRMATION_CALLBACK eventConfirmationCallback, void *userContextCallback)
IOTHUB_CLIENT_RESULT	IoTHubClient_LL_GetSendStatus (IOTHUB_CLIENT_LL_HANDLE iotHubClientHandle, IOTHUB_CLIENT_STATUS *iotHubClientStatus)
IOTHUB_CLIENT_RESULT	IoTHubClient_LL_SetMessageCallback (IOTHUB_CLIENT_LL_HANDLE iotHubClientHandle, IOTHUB_CLIENT_MESSAGE_CALLBACK_ASYNC messageCallback, void *userContextCallback)
IOTHUB_CLIENT_RESULT	IoTHubClient_LL_SetConnectionStatusCallback (IOTHUB_CLIENT_LL_HANDLE iotHubClientHandle, IOTHUB_CLIENT_CONNECTION_STATUS_CALLBACK connectionStatusCallback, void *userContextCallback)
IOTHUB_CLIENT_RESULT	IoTHubClient_LL_SetRetryPolicy (IOTHUB_CLIENT_LL_HANDLE iotHubClientHandle, IOTHUB_CLIENT_RETRY_POLICY retryPolicy, size_t retryTimeoutLimitInSeconds)
IOTHUB_CLIENT_RESULT	IoTHubClient_LL_GetRetryPolicy (IOTHUB_CLIENT_LL_HANDLE iotHubClientHandle, IOTHUB_CLIENT_RETRY_POLICY *retryPolicy, size_t *retryTimeoutLimitInSeconds)
IOTHUB_CLIENT_RESULT	IoTHubClient_LL_GetLastMessageReceiveTime (IOTHUB_CLIENT_LL_HANDLE iotHubClientHandle, time_t *lastMessageReceiveTime)
void	IoTHubClient_LL_DoWork (IOTHUB_CLIENT_LL_HANDLE iotHubClientHandle)
IOTHUB_CLIENT_RESULT	IoTHubClient_LL_SetOption (IOTHUB_CLIENT_LL_HANDLE iotHubClientHandle, const char *optionName, const void *value)
IOTHUB_CLIENT_RESULT	IoTHubClient_LL_SetDeviceTwinCallback (IOTHUB_CLIENT_LL_HANDLE iotHubClientHandle, IOTHUB_CLIENT_DEVICE_TWIN_CALLBACK deviceTwinCallback, void *userContextCallback)
IOTHUB_CLIENT_RESULT	IoTHubClient_LL_SendReportedState (IOTHUB_CLIENT_LL_HANDLE iotHubClientHandle, const unsigned char *reportedState, size_t size, IOTHUB_CLIENT_REPORTED_STATE_CALLBACK reportedStateCallback, void *userContextCallback)
IOTHUB_CLIENT_RESULT	IoTHubClient_LL_SetDeviceMethodCallback (IOTHUB_CLIENT_LL_HANDLE iotHubClientHandle, IOTHUB_CLIENT_DEVICE_METHOD_CALLBACK_ASYNC deviceMethodCallback, void *userContextCallback)
IOTHUB_CLIENT_RESULT	IoTHubClient_LL_SetDeviceMethodCallback_Ex (IOTHUB_CLIENT_LL_HANDLE iotHubClientHandle, IOTHUB_CLIENT_INBOUND_DEVICE_METHOD_CALLBACK inboundDeviceMethodCallback, void *userContextCallback)
IOTHUB_CLIENT_RESULT	IoTHubClient_LL_DeviceMethodResponse (IOTHUB_CLIENT_LL_HANDLE iotHubClientHandle, METHOD_HANDLE methodId, const unsigned char *response, size_t respSize, int statusCode)
IOTHUB_CLIENT_RESULT	IoTHubClient_LL_UploadToBlob (IOTHUB_CLIENT_LL_HANDLE iotHubClientHandle, const char *destinationFileName, const unsigned char *source, size_t size)
IOTHUB_CLIENT_RESULT	IoTHubClient_LL_UploadMultipleBlocksToBlob (IOTHUB_CLIENT_LL_HANDLE iotHubClientHandle, const char *destinationFileName, IOTHUB_CLIENT_FILE_UPLOAD_GET_DATA_CALLBACK getDataCallback, void *context)
IOTHUB_CLIENT_RESULT	IoTHubClient_LL_UploadMultipleBlocksToBlobEx (IOTHUB_CLIENT_LL_HANDLE iotHubClientHandle, const char *destinationFileName, IOTHUB_CLIENT_FILE_UPLOAD_GET_DATA_CALLBACK_EX getDataCallbackEx, void *context)

Detailed Description

APIs that allow a user (usually a device) to communicate with an Azure IoT Hub.

IoTHubClient_LL allows a user (usually a device) to communicate with an Azure IoT Hub. It can send events and receive messages. At any given moment in time there can only be at most 1 message callback function.

This API surface contains a set of APIs that allows the user to interact with the lower layer portion of the IoTHubClient. These APIs contain LL in their name, but retain the same functionality like the IoTHubClient_... APIs, with one difference. If the LL APIs are used then the user is responsible for scheduling when the actual work done by the IoTHubClient happens (when the data is sent/received on/from the wire). This is useful for constrained devices where spinning a separate thread is often not desired.

Typedef Documentation

IOTHUB_CLIENT_LL_HANDLE

typedef struct IOTHUB_CLIENT_CORE_LL_HANDLE_DATA_TAG* IOTHUB_CLIENT_LL_HANDLE

Deprecated:

IOTHUB_CLIENT_LL_HANDLE is deprecated. Use IOTHUB_DEVICE_CLIENT_LL_HANDLE instead.

Function Documentation

IoTHubClient_LL_Create()

IOTHUB_CLIENT_LL_HANDLE IoTHubClient_LL_Create

(

const IOTHUB_CLIENT_CONFIG *

config

)

Deprecated:

IoTHubClient_LL_Create is deprecated. Use IoTHubDeviceClient_LL_Create() instead.

IoTHubClient_LL_CreateFromConnectionString()

IOTHUB_CLIENT_LL_HANDLE IoTHubClient_LL_CreateFromConnectionString	(	const char *	connectionString,
		IOTHUB_CLIENT_TRANSPORT_PROVIDER	protocol
	)

Deprecated:

IoTHubClient_LL_CreateFromConnectionString is deprecated. Use IoTHubDeviceClient_LL_CreateFromConnectionString() instead.

IoTHubClient_LL_CreateFromDeviceAuth()

IOTHUB_CLIENT_LL_HANDLE IoTHubClient_LL_CreateFromDeviceAuth	(	const char *	iothub_uri,
		const char *	device_id,
		IOTHUB_CLIENT_TRANSPORT_PROVIDER	protocol
	)

Deprecated:

IoTHubClient_LL_CreateFromDeviceAuth is deprecated. Use IoTHubDeviceClient_LL_CreateFromDeviceAuth() instead.

IoTHubClient_LL_CreateWithTransport()

IOTHUB_CLIENT_LL_HANDLE IoTHubClient_LL_CreateWithTransport

(

const IOTHUB_CLIENT_DEVICE_CONFIG *

config

)

Deprecated:

IoTHubClient_LL_CreateWithTransport is deprecated. Use IoTHubDeviceClient_LL_CreateWithTransport() instead.

IoTHubClient_LL_Destroy()

void IoTHubClient_LL_Destroy

(

IOTHUB_CLIENT_LL_HANDLE

iotHubClientHandle

)

Deprecated:

IoTHubClient_LL_Destroy is deprecatedDevice. Use IoTHubClient_LL_Destroy() instead.

IoTHubClient_LL_DeviceMethodResponse()

IOTHUB_CLIENT_RESULT IoTHubClient_LL_DeviceMethodResponse	(	IOTHUB_CLIENT_LL_HANDLE	iotHubClientHandle,
		METHOD_HANDLE	methodId,
		const unsigned char *	response,
		size_t	respSize,
		int	statusCode
	)

Deprecated:

IoTHubClient_LL_DeviceMethodResponse is deprecated. Use IoTHubDeviceClient_LL_SetDeviceMethodCallback() instead.

IoTHubClient_LL_DoWork()

void IoTHubClient_LL_DoWork

(

IOTHUB_CLIENT_LL_HANDLE

iotHubClientHandle

)

Deprecated:

IoTHubClient_LL_DoWork is deprecateDeviced. Use IoTHubDeviceClient_LL_DoWork() instead.

IoTHubClient_LL_GetLastMessageReceiveTime()

IOTHUB_CLIENT_RESULT IoTHubClient_LL_GetLastMessageReceiveTime	(	IOTHUB_CLIENT_LL_HANDLE	iotHubClientHandle,
		time_t *	lastMessageReceiveTime
	)

Deprecated:

IoTHubClient_LL_GetLastMessageReceiveTime is deprecated. Use IoTHubDeviceClient_LL_GetLastMessageReceiveTime() instead.

IoTHubClient_LL_GetRetryPolicy()

IOTHUB_CLIENT_RESULT IoTHubClient_LL_GetRetryPolicy	(	IOTHUB_CLIENT_LL_HANDLE	iotHubClientHandle,
		IOTHUB_CLIENT_RETRY_POLICY *	retryPolicy,
		size_t *	retryTimeoutLimitInSeconds
	)

Deprecated:

IoTHubClient_LL_GetRetryPolicy is deprecated. Use IoTHubDeviceClient_LL_GetRetryPolicy() instead.

IoTHubClient_LL_GetSendStatus()

IOTHUB_CLIENT_RESULT IoTHubClient_LL_GetSendStatus	(	IOTHUB_CLIENT_LL_HANDLE	iotHubClientHandle,
		IOTHUB_CLIENT_STATUS *	iotHubClientStatus
	)

Deprecated:

IoTHubClient_LL_GetSendStatus is deprecated. UseDevice IoTHubClient_LL_GetSendStatus() instead.

IoTHubClient_LL_SendEventAsync()

IOTHUB_CLIENT_RESULT IoTHubClient_LL_SendEventAsync	(	IOTHUB_CLIENT_LL_HANDLE	iotHubClientHandle,
		IOTHUB_MESSAGE_HANDLE	eventMessageHandle,
		IOTHUB_CLIENT_EVENT_CONFIRMATION_CALLBACK	eventConfirmationCallback,
		void *	userContextCallback
	)

Deprecated:

IoTHubClient_LL_SendEventAsync is deprecated. Use IoTHubDeviceClient_LL_SendEventAsync() instead.

IoTHubClient_LL_SendReportedState()

IOTHUB_CLIENT_RESULT IoTHubClient_LL_SendReportedState	(	IOTHUB_CLIENT_LL_HANDLE	iotHubClientHandle,
		const unsigned char *	reportedState,
		size_t	size,
		IOTHUB_CLIENT_REPORTED_STATE_CALLBACK	reportedStateCallback,
		void *	userContextCallback
	)

Deprecated:

IoTHubClient_LL_SendReportedState is deprecated. Use IoTHubDeviceClient_LL_SendReportedState() instead.

IoTHubClient_LL_SetConnectionStatusCallback()

IOTHUB_CLIENT_RESULT IoTHubClient_LL_SetConnectionStatusCallback	(	IOTHUB_CLIENT_LL_HANDLE	iotHubClientHandle,
		IOTHUB_CLIENT_CONNECTION_STATUS_CALLBACK	connectionStatusCallback,
		void *	userContextCallback
	)

Deprecated:

IoTHubClient_LL_SetConnectionStatusCallback is deprecated. Use IoTHubDeviceClient_LL_SetConnectionStatusCallback() instead.

IoTHubClient_LL_SetDeviceMethodCallback()

IOTHUB_CLIENT_RESULT IoTHubClient_LL_SetDeviceMethodCallback	(	IOTHUB_CLIENT_LL_HANDLE	iotHubClientHandle,
		IOTHUB_CLIENT_DEVICE_METHOD_CALLBACK_ASYNC	deviceMethodCallback,
		void *	userContextCallback
	)

Deprecated:

IoTHubClient_LL_SetDeviceMethodCallback is deprecated. Use IoTHubDeviceClient_LL_SetDeviceMethodCallback() instead.

IoTHubClient_LL_SetDeviceMethodCallback_Ex()

IOTHUB_CLIENT_RESULT IoTHubClient_LL_SetDeviceMethodCallback_Ex	(	IOTHUB_CLIENT_LL_HANDLE	iotHubClientHandle,
		IOTHUB_CLIENT_INBOUND_DEVICE_METHOD_CALLBACK	inboundDeviceMethodCallback,
		void *	userContextCallback
	)

Deprecated:

IoTHubClient_LL_SetDeviceMethodCallback_Ex is deprecated. Use IoTHubDeviceClient_LL_SetDeviceMethodCallback() instead.

IoTHubClient_LL_SetDeviceTwinCallback()

IOTHUB_CLIENT_RESULT IoTHubClient_LL_SetDeviceTwinCallback	(	IOTHUB_CLIENT_LL_HANDLE	iotHubClientHandle,
		IOTHUB_CLIENT_DEVICE_TWIN_CALLBACK	deviceTwinCallback,
		void *	userContextCallback
	)

Deprecated:

IoTHubClient_LL_SetDeviceTwinCallback is deprecated. Use IoTHubDeviceClient_LL_SetDeviceTwinCallback() instead.

IoTHubClient_LL_SetMessageCallback()

IOTHUB_CLIENT_RESULT IoTHubClient_LL_SetMessageCallback	(	IOTHUB_CLIENT_LL_HANDLE	iotHubClientHandle,
		IOTHUB_CLIENT_MESSAGE_CALLBACK_ASYNC	messageCallback,
		void *	userContextCallback
	)

Deprecated:

IoTHubClient_LL_SetMessageCallback is deprecated. Use IoTHubDeviceClient_LL_SetMessageCallback() instead.

IoTHubClient_LL_SetOption()

IOTHUB_CLIENT_RESULT IoTHubClient_LL_SetOption	(	IOTHUB_CLIENT_LL_HANDLE	iotHubClientHandle,
		const char *	optionName,
		const void *	value
	)

Deprecated:

IoTHubClient_LL_SetOption is deprecated. Device Use IoTHubDeviceClient_LL_SetOption() instead.

IoTHubClient_LL_SetRetryPolicy()

IOTHUB_CLIENT_RESULT IoTHubClient_LL_SetRetryPolicy	(	IOTHUB_CLIENT_LL_HANDLE	iotHubClientHandle,
		IOTHUB_CLIENT_RETRY_POLICY	retryPolicy,
		size_t	retryTimeoutLimitInSeconds
	)

Deprecated:

IoTHubClient_LL_SetRetryPolicy is deprecated. Use IoTHubDeviceClient_LL_SetRetryPolicy() instead.

IoTHubClient_LL_UploadMultipleBlocksToBlob()

IOTHUB_CLIENT_RESULT IoTHubClient_LL_UploadMultipleBlocksToBlob	(	IOTHUB_CLIENT_LL_HANDLE	iotHubClientHandle,
		const char *	destinationFileName,
		IOTHUB_CLIENT_FILE_UPLOAD_GET_DATA_CALLBACK	getDataCallback,
		void *	context
	)

Deprecated:

IoTHubClient_LL_UploadMultipleBlocksToBlob is deprecated. Use IoTHubDeviceClient_LL_UploadMultipleBlocksToBlob() instead.

IoTHubClient_LL_UploadMultipleBlocksToBlobEx()

IOTHUB_CLIENT_RESULT IoTHubClient_LL_UploadMultipleBlocksToBlobEx	(	IOTHUB_CLIENT_LL_HANDLE	iotHubClientHandle,
		const char *	destinationFileName,
		IOTHUB_CLIENT_FILE_UPLOAD_GET_DATA_CALLBACK_EX	getDataCallbackEx,
		void *	context
	)

Deprecated:

IoTHubClient_LL_UploadMultipleBlocksToBlobEx is deprecated. Use IoTHubDeviceClient_LL_UploadMultipleBlocksToBlob() instead.

IoTHubClient_LL_UploadToBlob()

IOTHUB_CLIENT_RESULT IoTHubClient_LL_UploadToBlob	(	IOTHUB_CLIENT_LL_HANDLE	iotHubClientHandle,
		const char *	destinationFileName,
		const unsigned char *	source,
		size_t	size
	)

Deprecated:

IoTHubClient_LL_UploadToBlob is deprecated. UsDevicee IoTHubDeviceClient_LL_UploadToBlob() instead.