- began to clean code documentation
[strongswan.git] / Source / charon / threads / receiver.h
1 /**
2 * @file receiver.h
3 *
4 * @brief Implements the Receiver Thread encapsulated in the receiver_t object
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 RECEIVER_H_
24 #define RECEIVER_H_
25
26 #include <types.h>
27
28 typedef struct receiver_t receiver_t;
29
30 /**
31 * @brief A Receiver object which receives packets on the socket and adds them to the job-queue
32 */
33 struct receiver_t {
34
35 /**
36 * @brief Destroys a receiver object
37 *
38 * @param receiver receiver object
39 * @return SUCCESSFUL if succeeded, FAILED otherwise
40 */
41 status_t (*destroy) (receiver_t *receiver);
42 };
43
44
45 receiver_t * receiver_create();
46
47 #endif /*RECEIVER_H_*/