1949556ccb4d47b0ea66bed7478683b3eda2fe8b
[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 * @b Constructors:
32 * - interface_create() of one of the modules
33 *
34 * @ingroup interfaces
35 */
36 struct interface_t {
37
38 /**
39 * @brief Destroy all interfaces
40 *
41 * @param this stroke_t objec to destroy
42 */
43 void (*destroy) (interface_t *this);
44 };
45
46
47 /**
48 * Constructor in a control interface module to create the interface.
49 *
50 * @ingroup interfaces
51 */
52 typedef interface_t*(*interface_constructor_t)(void);
53
54 #endif /* INTERFACE_H_ */
55