Source/charon/threads/sender.h

   1 /**
   2  * @file sender.h
   3  *
   4  * @brief Interface of sender_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 SENDER_H_
  24 #define SENDER_H_
  25
  26 #include <types.h>
  27
  28 typedef struct sender_t sender_t;
  29
  30 /**
  31  * @brief Thread responsible for sending packets over the socket.
  32  *
  33  * @b Constructors:
  34  *  - sender_create()
  35  *
  36  * @ingroup threads
  37  */
  38 struct sender_t {
  39
  40         /**
  41          * @brief Destroys a sender object.
  42          *
  43          * @param sender        calling object
  44          */
  45         void (*destroy) (sender_t *sender);
  46 };
  47
  48
  49 /**
  50  * @brief Create the sender thread.
  51  *
  52  * The thread will start to work, getting packets
  53  * from the send queue and sends them out.
  54  *
  55  * @return
  56  *                                      - sender_t object
  57  *                                      - NULL of thread could not be started
  58  *
  59  * @ingroup threads
  60  */
  61 sender_t * sender_create();
  62
  63 #endif /*SENDER_H_*/