util.h is a system header in Android < 2.x.
[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 #include "../utils.h"
25
26 typedef struct plugin_t plugin_t;
27
28 /**
29 * Interface definition of a plugin.
30 */
31 struct plugin_t {
32
33 /**
34 * Get the name of the plugin.
35 *
36 * @return plugin name
37 */
38 char* (*get_name)(plugin_t *this);
39
40 /**
41 * Try to reload plugin configuration.
42 *
43 * @return TRUE if reloaded, FALSE if reloading not supporty by plugin
44 */
45 bool (*reload)(plugin_t *this);
46
47 /**
48 * Destroy a plugin instance.
49 */
50 void (*destroy)(plugin_t *this);
51 };
52
53
54 /**
55 * Plugin constructor function definition.
56 *
57 * Each plugin has a constructor function. This function is called on daemon
58 * startup to initialize each plugin.
59 * The plugin function is named plugin_name_plugin_create().
60 *
61 * @return plugin_t instance
62 */
63 typedef plugin_t *(*plugin_constructor_t)(void);
64
65 #endif /** PLUGIN_H_ @}*/