added more API documentation to backends/interfaces
[strongswan.git] / src / charon / control / interfaces / interface.h
1 /**
2 * @file interface.h
3 *
4 * @brief Interface of interface_t.
5 *
6 */
7
8 /*
9 * Copyright (C) 2007 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 INTERFACE_H_
24 #define INTERFACE_H_
25
26 typedef struct interface_t interface_t;
27
28 /**
29 * @brief Interface for a controller.
30 *
31 * An interface controls the daemon by calling functions on the
32 * interface_manager. All interfaces are manager by the interface_manager
33 * in a generic way, so they need their own class.
34 *
35 * @b Constructors:
36 * - interface_create() of one of the modules
37 *
38 * @ingroup interfaces
39 */
40 struct interface_t {
41
42 /**
43 * @brief Destroy all interfaces
44 *
45 * @param this stroke_t objec to destroy
46 */
47 void (*destroy) (interface_t *this);
48 };
49
50
51 /**
52 * Constructor in a control interface module to create the interface.
53 *
54 * @ingroup interfaces
55 */
56 typedef interface_t*(*interface_constructor_t)(void);
57
58 #endif /* INTERFACE_H_ */
59