replace : iotivity -> iotivity-sec

[platform/upstream/iotivity.git] / resource / csdk / connectivity / common / inc / uqueue.h

diff --git a/resource/csdk/connectivity/common/inc/uqueue.h b/resource/csdk/connectivity/common/inc/uqueue.h
index e8694fa..4079b40 100644 (file)
--- a/resource/csdk/connectivity/common/inc/uqueue.h
+++ b/resource/csdk/connectivity/common/inc/uqueue.h
@@ -24,8 +24,8 @@
  * This file contains the APIs for queue to be implemented.
  */
 
-#ifndef __U_QUEUE_H_
-#define __U_QUEUE_H_
+#ifndef U_QUEUE_H_
+#define U_QUEUE_H_
 
 #include "cacommon.h"
 
@@ -35,115 +35,114 @@ extern "C"
 #endif /* __cplusplus */
 
 /**
- * @struct u_queue_message
- * @brief Queue message format
+ * Queue message format.
  */
 typedef struct u_queue_message_t
 {
-    /* Pointer to message*/
+    /** Pointer to message. */
     void *msg;
-    /* message size */
+    /** message size. */
     uint32_t size;
 } u_queue_message_t;
 
 typedef struct u_queue_element_t u_queue_element;
 
 /**
- * @struct u_queue_element
- * @brief Queue element format
+ * Queue element format.
  */
 struct u_queue_element_t
 {
-    /* pointer to queue message */
+    /** pointer to queue message. */
     u_queue_message_t *message;
-    /* Pointer to next queue element*/
+    /** Pointer to next queue element. */
     u_queue_element *next;
 };
 
 /**
- * @struct u_queue_t
- * @brief Queue structure
+ * Queue structure.
  */
 typedef struct u_queue_t
 {
-    /* Head of the queue */
+    /** Head of the queue. */
     u_queue_element *element;
-    /* Number of messages in Queue*/
+    /** Number of messages in Queue. */
     uint32_t count;
 } u_queue_t;
 
 /**
- * @brief API to creates queue and initializes the elements.
- * @return  u_queue_t pointer if Success, NULL otherwise
+ * API to creates queue and initializes the elements.
+ * @return  u_queue_t pointer if Success, NULL otherwise.
  */
 u_queue_t *u_queue_create();
 
 /**
- * @fn u_queue_delete
- * @brief Resets and deletes the queue
- * @param queue- queue pointer
- * @return CAResult_t - CA_STATUS_OK, if Success
- * @return            CA_STATUS_FAILED - otherwise
+ * Resets and deletes the queue.
+ * @param queue- queue pointer.
+ * @return ::CA_STATUS_OK if Success, ::CA_STATUS_FAILED otherwise.
  */
 CAResult_t u_queue_delete(u_queue_t *queue);
 
 /**
- * @fn u_queue_add_element
- * @brief Adds message at the end of the queue
- * @param queue - pointer to queue
- * @param message - Pointer to message
- * @return CAResult_t - CA_STATUS_OK, if Success
- * @return            CA_STATUS_FAILED - otherwise
+ * Adds message at the end of the queue.
+ * @param queue pointer to queue.
+ * @param message Pointer to message.
+ * @return ::CA_STATUS_OK if Success, ::CA_STATUS_FAILED otherwise.
  */
 CAResult_t u_queue_add_element(u_queue_t *queue, u_queue_message_t *message);
 
 /**
- * @fn u_queue_get_element
- * @brief Returns the first message in the queue and removes queue element.
+ * Returns the first message in the queue and removes queue element.
  * Head is moved to next element.
- * @param queue - pointer to queue
- * @return pointer to Message, if Success
- * @return NULL - otherwise
+ * @param queue pointer to queue.
+ * @return pointer to Message if Success, NULL otherwise.
  */
 u_queue_message_t *u_queue_get_element(u_queue_t *queue);
 
 /**
- * @fn u_queueRemoveElement
- * @brief Removes head element of the queue
- * @param queue - pointer to queue
- * @return CAResult_t - CA_STATUS_OK, if Success
- * @return            CA_STATUS_FAILED - otherwise
+ * Removes head element of the queue.
+ * @param queue pointer to queue.
+ * @return ::CA_STATUS_OK if Success, ::CA_STATUS_FAILED otherwise.
  */
 CAResult_t u_queue_remove_element(u_queue_t *queue);
 
 /**
- * @fn u_queue_get_size
- * @param queue - pointer to queue
- * @return number of elements in queue
+ * @param queue pointer to queue.
+ * @return number of elements in queue.
  */
 uint32_t u_queue_get_size(u_queue_t *queue);
 
 /**
- * @fn u_queue_reset
- * @brief Removes all the messages from Queue and reset message count
- * @param queue - pointer to queue
- * @return CAResult_t - CA_STATUS_OK, if Success
- * @return            CA_STATUS_FAILED - otherwise
+ * Removes all the messages from Queue and reset message count.
+ * @param queue pointer to queue.
+ * @return ::CA_STATUS_OK if Success, ::CA_STATUS_FAILED otherwise.
  */
 CAResult_t u_queue_reset(u_queue_t *queue);
 
 /**
- * @fn u_queue_get_head
- * @brief Returns the first message in queue, but not remove the element
- * @param queue - pointer to queue
- * @return pointer to Message, if Success
- * @return NULL - otherwise
+ * Returns the first message in queue, but not remove the element.
+ * @param queue pointer to queue.
+ * @return pointer to Message if Success, NULL otherwise.
  */
 u_queue_message_t *u_queue_get_head(u_queue_t *queue);
 
+/** Data destroy function. **/
+typedef void (*QueueDataDestroyFunction)(void *data, uint32_t size);
+typedef bool (*QueueContextDataDestroy)(void *data, uint32_t size, void *ctx);
+
+/**
+ * Removes messages from anywhere in the queue
+ * @param queue     pointer to queue
+ * @param callback  Function returns true if element is to be destroyed
+ * @param ctx       data that should be passed to callback
+ * @param destroy   Function to destroy the data, if NULL OICFree will be used
+ * @return ::CA_STATUS_OK if Success, ::CA_STATUS_FAILED otherwise
+ */
+CAResult_t u_queue_remove_req_elements(u_queue_t *queue,
+                                       QueueContextDataDestroy callback, void *ctx,
+                                       QueueDataDestroyFunction destroy);
+
 #ifdef __cplusplus
 } /* extern "C" */
 #endif /* __cplusplus */
 
-#endif /* _U_QUEUE_H_ */
-
+#endif /* U_QUEUE_H_ */