bd24e755805f8de820729ae71e07872f9cc646ba
[strongswan.git] / src / libstrongswan / plugins / plugin_loader.h
1 /*
2 * Copyright (C) 2007 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_loader plugin_loader
18 * @{ @ingroup plugin
19 */
20
21 #ifndef PLUGIN_LOADER_H_
22 #define PLUGIN_LOADER_H_
23
24 typedef struct plugin_loader_t plugin_loader_t;
25
26 #include <utils/enumerator.h>
27
28 /**
29 * The plugin_loader loads plugins from a directory and initializes them
30 */
31 struct plugin_loader_t {
32
33 /**
34 * Load a list of plugins from a directory.
35 *
36 * @param path path containing loadable plugins
37 * @param list space separated list of plugins to load
38 * @return number of successfully loaded plugins
39 */
40 int (*load)(plugin_loader_t *this, char *path, char *list);
41
42 /**
43 * Unload all loaded plugins.
44 */
45 void (*unload)(plugin_loader_t *this);
46
47 /**
48 * Create an enumerator over all loaded plugin names.
49 *
50 * @return enumerator over char*
51 */
52 enumerator_t* (*create_plugin_enumerator)(plugin_loader_t *this);
53
54 /**
55 * Unload loaded plugins, destroy plugin_loader instance.
56 */
57 void (*destroy)(plugin_loader_t *this);
58 };
59
60 /**
61 * Create a plugin_loader instance.
62 *
63 * @return plugin loader instance
64 */
65 plugin_loader_t *plugin_loader_create();
66
67 #endif /* PLUGIN_LOADER_H_ @}*/