Microsoft Azure IoTHub client libraries
Dependents: sht15_remote_monitoring RobotArmDemo iothub_client_sample_amqp f767zi_mqtt ... more
This library implements the Microsoft Azure IoTHub client library. The code is replicated from https://github.com/Azure/azure-iot-sdks
iothub_message.h
- Committer:
- AzureIoTClient
- Date:
- 2016-09-22
- Revision:
- 51:2550e3ad7bb0
- Parent:
- 50:bbc71457b0ea
- Child:
- 53:1e5a1ca1f274
File content as of revision 51:2550e3ad7bb0:
// Copyright (c) Microsoft. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. /** @file iothub_message.h * @brief The @c IoTHub_Message component encapsulates one message that * can be transferred by an IoT hub client. */ #ifndef IOTHUB_MESSAGE_H #define IOTHUB_MESSAGE_H #include "azure_c_shared_utility/macro_utils.h" #include "azure_c_shared_utility/map.h" #ifdef __cplusplus #include <cstddef> extern "C" { #else #include <stddef.h> #endif #define IOTHUB_MESSAGE_RESULT_VALUES \ IOTHUB_MESSAGE_OK, \ IOTHUB_MESSAGE_INVALID_ARG, \ IOTHUB_MESSAGE_INVALID_TYPE, \ IOTHUB_MESSAGE_ERROR \ /** @brief Enumeration specifying the status of calls to various * APIs in this module. */ DEFINE_ENUM(IOTHUB_MESSAGE_RESULT, IOTHUB_MESSAGE_RESULT_VALUES); #define IOTHUBMESSAGE_CONTENT_TYPE_VALUES \ IOTHUBMESSAGE_BYTEARRAY, \ IOTHUBMESSAGE_STRING, \ IOTHUBMESSAGE_UNKNOWN \ /** @brief Enumeration specifying the content type of the a given * message. */ DEFINE_ENUM(IOTHUBMESSAGE_CONTENT_TYPE, IOTHUBMESSAGE_CONTENT_TYPE_VALUES); typedef struct IOTHUB_MESSAGE_HANDLE_DATA_TAG* IOTHUB_MESSAGE_HANDLE; /** * @brief Creates a new IoT hub message from a byte array. The type of the * message will be set to @c IOTHUBMESSAGE_BYTEARRAY. * * @param byteArray The byte array from which the message is to be created. * @param size The size of the byte array. * * @return A valid @c IOTHUB_MESSAGE_HANDLE if the message was successfully * created or @c NULL in case an error occurs. */ MOCKABLE_FUNCTION(, IOTHUB_MESSAGE_HANDLE, IoTHubMessage_CreateFromByteArray, const unsigned char*, byteArray, size_t, size); /** * @brief Creates a new IoT hub message from a null terminated string. The * type of the message will be set to @c IOTHUBMESSAGE_STRING. * * @param source The null terminated string from which the message is to be * created. * * @return A valid @c IOTHUB_MESSAGE_HANDLE if the message was successfully * created or @c NULL in case an error occurs. */ MOCKABLE_FUNCTION(, IOTHUB_MESSAGE_HANDLE, IoTHubMessage_CreateFromString, const char*, source); /** * @brief Creates a new IoT hub message with the content identical to that * of the @p iotHubMessageHandle parameter. * * @param iotHubMessageHandle Handle to the message that is to be cloned. * * @return A valid @c IOTHUB_MESSAGE_HANDLE if the message was successfully * cloned or @c NULL in case an error occurs. */ MOCKABLE_FUNCTION(, IOTHUB_MESSAGE_HANDLE, IoTHubMessage_Clone, IOTHUB_MESSAGE_HANDLE, iotHubMessageHandle); /** * @brief Fetches a pointer and size for the data associated with the IoT * hub message handle. If the content type of the message is not * @c IOTHUBMESSAGE_BYTEARRAY then the function returns * @c IOTHUB_MESSAGE_INVALID_ARG. * * @param iotHubMessageHandle Handle to the message. * @param buffer Pointer to the memory location where the * pointer to the buffer will be written. * @param size The size of the buffer will be written to * this address. * * @return Returns IOTHUB_MESSAGE_OK if the byte array was fetched successfully * or an error code otherwise. */ MOCKABLE_FUNCTION(, IOTHUB_MESSAGE_RESULT, IoTHubMessage_GetByteArray, IOTHUB_MESSAGE_HANDLE, iotHubMessageHandle, const unsigned char**, buffer, size_t*, size); /** * @brief Returns the null terminated string stored in the message. * If the content type of the message is not @c IOTHUBMESSAGE_STRING * then the function returns @c NULL. * * @param iotHubMessageHandle Handle to the message. * * @return @c NULL if an error occurs or a pointer to the stored null * terminated string otherwise. */ MOCKABLE_FUNCTION(, const char*, IoTHubMessage_GetString, IOTHUB_MESSAGE_HANDLE, iotHubMessageHandle); /** * @brief Returns the content type of the message given by parameter * @c iotHubMessageHandle. * * @param iotHubMessageHandle Handle to the message. * * @return An @c IOTHUBMESSAGE_CONTENT_TYPE value. */ MOCKABLE_FUNCTION(, IOTHUBMESSAGE_CONTENT_TYPE, IoTHubMessage_GetContentType, IOTHUB_MESSAGE_HANDLE, iotHubMessageHandle); /** * @brief Gets a handle to the message's properties map. * * @param iotHubMessageHandle Handle to the message. * * @return A @c MAP_HANDLE pointing to the properties map for this message. */ MOCKABLE_FUNCTION(, MAP_HANDLE, IoTHubMessage_Properties, IOTHUB_MESSAGE_HANDLE, iotHubMessageHandle); /** * @brief Gets the MessageId from the IOTHUB_MESSAGE_HANDLE. * * @param iotHubMessageHandle Handle to the message. * * @return A const char* pointing to the Message Id. */ MOCKABLE_FUNCTION(, const char*, IoTHubMessage_GetMessageId, IOTHUB_MESSAGE_HANDLE, iotHubMessageHandle); /** * @brief Sets the MessageId for the IOTHUB_MESSAGE_HANDLE. * * @param iotHubMessageHandle Handle to the message. * @param messageId Pointer to the memory location of the messageId * * @return Returns IOTHUB_MESSAGE_OK if the messageId was set successfully * or an error code otherwise. */ MOCKABLE_FUNCTION(, IOTHUB_MESSAGE_RESULT, IoTHubMessage_SetMessageId, IOTHUB_MESSAGE_HANDLE, iotHubMessageHandle, const char*, messageId); /** * @brief Gets the CorrelationId from the IOTHUB_MESSAGE_HANDLE. * * @param iotHubMessageHandle Handle to the message. * * @return A const char* pointing to the Correlation Id. */ MOCKABLE_FUNCTION(, const char*, IoTHubMessage_GetCorrelationId, IOTHUB_MESSAGE_HANDLE, iotHubMessageHandle); /** * @brief Sets the CorrelationId for the IOTHUB_MESSAGE_HANDLE. * * @param iotHubMessageHandle Handle to the message. * @param correlationId Pointer to the memory location of the messageId * * @return Returns IOTHUB_MESSAGE_OK if the messageId was set successfully * or an error code otherwise. */ MOCKABLE_FUNCTION(, IOTHUB_MESSAGE_RESULT, IoTHubMessage_SetCorrelationId, IOTHUB_MESSAGE_HANDLE, iotHubMessageHandle, const char*, correlationId); /** * @brief Frees all resources associated with the given message handle. * * @param iotHubMessageHandle Handle to the message. */ MOCKABLE_FUNCTION(, void, IoTHubMessage_Destroy, IOTHUB_MESSAGE_HANDLE, iotHubMessageHandle); #ifdef __cplusplus } #endif #endif /* IOTHUB_MESSAGE_H */