chunk_to_hex() function declaration deleted
[strongswan.git] / src / charon / threads / sender.h
1 /**
2 * @file sender.h
3 *
4 * @brief Interface of sender_t.
5 *
6 */
7
8 /*
9 * Copyright (C) 2005-2006 Martin Willi
10 * Copyright (C) 2005 Jan Hutter
11 * Hochschule fuer Technik Rapperswil
12 *
13 * This program is free software; you can redistribute it and/or modify it
14 * under the terms of the GNU General Public License as published by the
15 * Free Software Foundation; either version 2 of the License, or (at your
16 * option) any later version. See <http://www.fsf.org/copyleft/gpl.txt>.
17 *
18 * This program is distributed in the hope that it will be useful, but
19 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
20 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21 * for more details.
22 */
23
24 #ifndef SENDER_H_
25 #define SENDER_H_
26
27 #include <types.h>
28
29 typedef struct sender_t sender_t;
30
31 /**
32 * @brief Thread responsible for sending packets over the socket.
33 *
34 * @b Constructors:
35 * - sender_create()
36 *
37 * @ingroup threads
38 */
39 struct sender_t {
40
41 /**
42 * @brief Destroys a sender object.
43 *
44 * @param sender calling object
45 */
46 void (*destroy) (sender_t *sender);
47 };
48
49
50 /**
51 * @brief Create the sender thread.
52 *
53 * The thread will start to work, getting packets
54 * from the send queue and sends them out.
55 *
56 * @return
57 * - sender_t object
58 * - NULL of thread could not be started
59 *
60 * @ingroup threads
61 */
62 sender_t * sender_create(void);
63
64 #endif /*SENDER_H_*/