Diff: iothub_message.h

Revision:

10:38383e246675

Parent:

0:e393db310d89

diff -r 3ec7e2695f98 -r 38383e246675 iothub_message.h
--- a/iothub_message.h	Tue Sep 22 20:36:48 2015 -0700
+++ b/iothub_message.h	Sat Sep 26 00:18:01 2015 -0700
@@ -1,6 +1,11 @@
 // 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
 
@@ -21,6 +26,9 @@
     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 \
@@ -28,20 +36,101 @@
 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 void* 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.
+ */
 extern 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.
+ */
 extern 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.
+ */
 extern 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.
+ */
 extern 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.
+ */
 extern 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.
+ */
 extern 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.
+ */
 extern MAP_HANDLE IoTHubMessage_Properties(IOTHUB_MESSAGE_HANDLE iotHubMessageHandle);
 
+/**
+ * @brief   Frees all resources associated with the given message handle.
+ *
+ * @param   iotHubMessageHandle Handle to the message.
+ */
 extern void IoTHubMessage_Destroy(IOTHUB_MESSAGE_HANDLE iotHubMessageHandle);
 
 #ifdef __cplusplus