diff options
Diffstat (limited to 'Source/charon/send_queue.h')
| -rw-r--r-- | Source/charon/send_queue.h | 30 |
1 files changed, 15 insertions, 15 deletions
diff --git a/Source/charon/send_queue.h b/Source/charon/send_queue.h index 41ae1e3a8..5524c7870 100644 --- a/Source/charon/send_queue.h +++ b/Source/charon/send_queue.h @@ -1,8 +1,8 @@ /** * @file send_queue.h - * + * * @brief Send-Queue based on linked_list_t - * + * */ /* @@ -29,16 +29,16 @@ /** * @brief Send-Queue * - * Although the send-queue is based on a linked_list_t + * Although the send-queue is based on a linked_list_t * all access functions are thread-save implemented */ typedef struct send_queue_s send_queue_t; struct send_queue_s { - + /** * @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 @@ -47,24 +47,24 @@ struct send_queue_s { /** * @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 */ status_t (*get) (send_queue_t *send_queue, packet_t **packet); - + /** * @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 + * 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 @@ -73,11 +73,11 @@ struct send_queue_s { /** * @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 */ @@ -86,7 +86,7 @@ struct send_queue_s { /** * @brief Creates an empty send_queue_t - * + * * @return send_queue_t empty send_queue_t */ send_queue_t *send_queue_create(); |