Source/charon/queues/send_queue.h

   1 /**
   2  * @file send_queue.h
   3  *
   4  * @brief Interface of send_queue_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 typedef struct send_queue_t send_queue_t;
  31
  32 /**
  33  * @brief The send queue stores packet for the sender_t instance.
  34  *
  35  * The sender_t will send them consequently over the wire.
  36  * Although the send-queue is based on a linked_list_t
  37  * all access functions are thread-save implemented.
  38  *
  39  * @b Constructors:
  40  * - send_queue_create()
  41  *
  42  * @ingroup queues
  43  */
  44 struct send_queue_t {
  45
  46         /**
  47          * @brief returns number of packets in queue
  48          *
  49          * @param send_queue_t  calling object
  50          * @param[out]                  count integer pointer to store the count in
  51          * @returns                     number of items in queue
  52          */
  53         int (*get_count) (send_queue_t *send_queue);
  54
  55         /**
  56          * @brief get the next packet from the queue.
  57          *
  58          * If the queue is empty, this function blocks until a packet can be returned.
  59          *
  60          * After using, the returned packet has to get destroyed by the caller.
  61          *
  62          * @param send_queue_t  calling object
  63          * @return                              next packet from the queue
  64          */
  65         packet_t *(*get) (send_queue_t *send_queue);
  66
  67         /**
  68          * @brief adds a packet to the queue.
  69          *
  70          * This function is non blocking and adds a packet_t to the list.
  71          * The specific packet object has to get destroyed by the thread which
  72          * removes the packet.
  73          *
  74          * @param send_queue_t  calling object
  75          * @param packet                packet_t to add to the queue (packet is not copied)
  76          */
  77         void (*add) (send_queue_t *send_queue, packet_t *packet);
  78
  79         /**
  80          * @brief destroys a send_queue object.
  81          *
  82          * @warning The caller of this function has to make sure
  83          * that no thread is going to add or get a packet from the send_queue
  84          * after calling this function.
  85          *
  86          * @param send_queue_t  calling object
  87          */
  88         void (*destroy) (send_queue_t *send_queue);
  89 };
  90
  91 /**
  92  * @brief Creates an empty send_queue_t.
  93  *
  94  * @return send_queue_t object
  95  *
  96  * @ingroup queues
  97  */
  98 send_queue_t *send_queue_create();
  99
 100 #endif /*SEND_QUEUE_H_*/