- docs updated
[strongswan.git] / Source / charon / queues / send_queue.h
index 072d2f9..6dc5867 100644 (file)
@@ -1,7 +1,7 @@
 /**
  * @file send_queue.h
  *
- * @brief Send-Queue based on linked_list_t
+ * @brief Interface of send_queue_t.
  *
  */
 
 #ifndef SEND_QUEUE_H_
 #define SEND_QUEUE_H_
 
-#include "../types.h"
-#include "../packet.h"
+#include <types.h>
+#include <network/packet.h>
+
+
+typedef struct send_queue_t send_queue_t;
 
 /**
- * @brief Send-Queue
- *
+ * @brief The send queue stores packet for the sender_t instance.
+ * 
+ * The sender_t will send them consequently over the wire.
  * Although the send-queue is based on a linked_list_t
- * all access functions are thread-save implemented
+ * all access functions are thread-save implemented.
+ * 
+ * @b Constructors:
+ * - send_queue_create()
+ * 
+ * @ingroup queues
  */
-typedef struct send_queue_s send_queue_t;
-
-struct send_queue_s {
+struct send_queue_t {
 
        /**
         * @brief returns number of packets in queue
         *
-        * @param send_queue_t calling object
-        * @param[out] count integer pointer to store the count in
-        * @returns number of items in queue
+        * @param send_queue_t  calling object
+        * @param[out]                  count integer pointer to store the count in
+        * @returns                     number of items in queue
         */
        int (*get_count) (send_queue_t *send_queue);
 
        /**
-        * @brief get the next packet from the queue
+        * @brief get the next packet from the queue.
         *
         * If the queue is empty, this function blocks until a packet can be returned.
         *
         * After using, the returned packet has to get destroyed by the caller.
         *
-        * @param send_queue_t calling object
-        * @param[out] packet pointer to a packet_t pointer where to packet is returned to
-        * @returns SUCCESS if succeeded, FAILED otherwise
+        * @param send_queue_t  calling object
+        * @return                              next packet from the queue
         */
-       status_t (*get) (send_queue_t *send_queue, packet_t **packet);
+       packet_t *(*get) (send_queue_t *send_queue);
 
        /**
-        * @brief adds a packet to the queue
+        * @brief adds a packet to the queue.
         *
         * This function is non blocking and adds a packet_t to the list.
         * The specific packet object has to get destroyed by the thread which
         * removes the packet.
         *
-        * @param send_queue_t calling object
-        * @param[in] packet packet_t to add to the queue (packet is not copied)
-        * @returns SUCCESS if succeeded, FAILED otherwise
+        * @param send_queue_t  calling object
+        * @param packet                packet_t to add to the queue (packet is not copied)
         */
-       status_t (*add) (send_queue_t *send_queue, packet_t *packet);
+       void (*add) (send_queue_t *send_queue, packet_t *packet);
 
        /**
-        * @brief destroys a send_queue object
+        * @brief destroys a send_queue object.
         *
         * @warning The caller of this function has to make sure
         * that no thread is going to add or get a packet from the send_queue
         * after calling this function.
         *
-        * @param send_queue_t calling object
-        * @returns SUCCESS if succeeded, FAILED otherwise
+        * @param send_queue_t  calling object
         */
-       status_t (*destroy) (send_queue_t *send_queue);
+       void (*destroy) (send_queue_t *send_queue);
 };
 
 /**
- * @brief Creates an empty send_queue_t
+ * @brief Creates an empty send_queue_t.
  *
- * @return send_queue_t empty send_queue_t
+ * @return send_queue_t object
+ * 
+ * @ingroup queues
  */
 send_queue_t *send_queue_create();