Source/charon/queues/send_queue.h

   1 /**
   2  * @file send_queue.h
   3  *
   4  * @brief Send-Queue based on linked_list_t
   5  *
   6  */
   7
   8 /*
   9  * Copyright (C) 2005 Jan Hutter, Martin Willi
  10  * Hochschule fuer Technik Rapperswil
  11  *
  12  * This program is free software; you can redistribute it and/or modify it
  13  * under the terms of the GNU General Public License as published by the
  14  * Free Software Foundation; either version 2 of the License, or (at your
  15  * option) any later version.  See <http://www.fsf.org/copyleft/gpl.txt>.
  16  *
  17  * This program is distributed in the hope that it will be useful, but
  18  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  19  * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  20  * for more details.
  21  */
  22
  23 #ifndef SEND_QUEUE_H_
  24 #define SEND_QUEUE_H_
  25
  26 #include <types.h>
  27 #include <network/packet.h>
  28
  29 /**
  30  * @brief Send-Queue
  31  *
  32  * Although the send-queue is based on a linked_list_t
  33  * all access functions are thread-save implemented
  34  */
  35 typedef struct send_queue_s send_queue_t;
  36
  37 struct send_queue_s {
  38
  39         /**
  40          * @brief returns number of packets in queue
  41          *
  42          * @param send_queue_t calling object
  43          * @param[out] count integer pointer to store the count in
  44          * @returns number of items in queue
  45          */
  46         int (*get_count) (send_queue_t *send_queue);
  47
  48         /**
  49          * @brief get the next packet from the queue
  50          *
  51          * If the queue is empty, this function blocks until a packet can be returned.
  52          *
  53          * After using, the returned packet has to get destroyed by the caller.
  54          *
  55          * @param send_queue_t calling object
  56          * @param[out] packet pointer to a packet_t pointer where to packet is returned to
  57          * @returns SUCCESS if succeeded, FAILED otherwise
  58          */
  59         status_t (*get) (send_queue_t *send_queue, packet_t **packet);
  60
  61         /**
  62          * @brief adds a packet to the queue
  63          *
  64          * This function is non blocking and adds a packet_t to the list.
  65          * The specific packet object has to get destroyed by the thread which
  66          * removes the packet.
  67          *
  68          * @param send_queue_t calling object
  69          * @param[in] packet packet_t to add to the queue (packet is not copied)
  70          * @returns SUCCESS if succeeded, FAILED otherwise
  71          */
  72         status_t (*add) (send_queue_t *send_queue, packet_t *packet);
  73
  74         /**
  75          * @brief destroys a send_queue object
  76          *
  77          * @warning The caller of this function has to make sure
  78          * that no thread is going to add or get a packet from the send_queue
  79          * after calling this function.
  80          *
  81          * @param send_queue_t calling object
  82          * @returns SUCCESS if succeeded, FAILED otherwise
  83          */
  84         status_t (*destroy) (send_queue_t *send_queue);
  85 };
  86
  87 /**
  88  * @brief Creates an empty send_queue_t
  89  *
  90  * @return send_queue_t empty send_queue_t
  91  */
  92 send_queue_t *send_queue_create();
  93
  94 #endif /*SEND_QUEUE_H_*/