updated Doxyfile
[strongswan.git] / src / libstrongswan / plugins / plugin.h
1 /*
2 * Copyright (C) 2008 Martin Willi
3 * Hochschule fuer Technik Rapperswil
4 *
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License as published by the
7 * Free Software Foundation; either version 2 of the License, or (at your
8 * option) any later version. See <http://www.fsf.org/copyleft/gpl.txt>.
9 *
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
12 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
13 * for more details.
14 */
15
16 /**
17 * @defgroup plugin plugin
18 * @{ @ingroup plugins
19 */
20
21 #ifndef PLUGIN_H_
22 #define PLUGIN_H_
23
24 typedef struct plugin_t plugin_t;
25
26 /**
27 * Interface definition of a plugin.
28 */
29 struct plugin_t {
30
31 /**
32 * Destroy a plugin instance.
33 */
34 void (*destroy)(plugin_t *this);
35 };
36
37
38 /**
39 * Plugin constructor function definiton.
40 *
41 * Each plugin has a constructor functions. This function is called on daemon
42 * startup to initialize each plugin.
43 * The plugin function is named plugin_create().
44 *
45 * @return plugin_t instance
46 */
47 typedef plugin_t *(*plugin_constructor_t)(void);
48
49 #endif /** PLUGIN_H_ @}*/