1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
|
/*
* Copyright (C) 2012 Tobias Brunner
* Copyright (C) 2007 Martin Willi
* Hochschule fuer Technik Rapperswil
*
* This program is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License as published by the
* Free Software Foundation; either version 2 of the License, or (at your
* option) any later version. See <http://www.fsf.org/copyleft/gpl.txt>.
*
* This program is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
* or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* for more details.
*/
/**
* @defgroup plugin_loader plugin_loader
* @{ @ingroup plugins
*/
#ifndef PLUGIN_LOADER_H_
#define PLUGIN_LOADER_H_
typedef struct plugin_loader_t plugin_loader_t;
#include <utils/enumerator.h>
/* to avoid circular references we can't include plugin_feature.h */
struct plugin_feature_t;
/**
* The plugin_loader loads plugins from a directory and initializes them
*/
struct plugin_loader_t {
/**
* Add static plugin features, not loaded via plugins.
*
* Similar to features provided by plugins they are evaluated during load(),
* and unloaded when unload() is called.
*
* If critical is TRUE load() will fail if any of the added features could
* not be loaded.
*
* @note The name should be unique otherwise a plugin with the same name is
* not loaded.
*
* @param name name of the component adding the features
* @param features array of plugin features
* @param count number of features in the array
* @param critical TRUE if the features are critical
*/
void (*add_static_features) (plugin_loader_t *this, const char *name,
struct plugin_feature_t *features, int count,
bool critical);
/**
* Load a list of plugins from a directory.
*
* Each plugin in list may have a ending exclamation mark (!) to mark it
* as a critical plugin. If loading a critical plugin fails, plugin loading
* is aborted and FALSE is returned.
*
* @param path path containing loadable plugins, NULL for default
* @param list space separated list of plugins to load
* @return TRUE if all critical plugins loaded successfully
*/
bool (*load)(plugin_loader_t *this, char *path, char *list);
/**
* Reload the configuration of one or multiple plugins.
*
* @param space separated plugin names to reload, NULL for all
* @return number of plugins that did support reloading
*/
u_int (*reload)(plugin_loader_t *this, char *list);
/**
* Unload all loaded plugins.
*/
void (*unload)(plugin_loader_t *this);
/**
* Create an enumerator over all loaded plugins.
*
* In addition to the plugin, the enumerator returns a list of pointers to
* plugin features currently loaded (if the argument is not NULL).
* This list is to be read only.
*
* @return enumerator over plugin_t*, linked_list_t*
*/
enumerator_t* (*create_plugin_enumerator)(plugin_loader_t *this);
/**
* Get a simple list the names of all loaded plugins.
*
* The function returns internal data, do not free.
*
* @return list of the names of all loaded plugins
*/
char* (*loaded_plugins)(plugin_loader_t *this);
/**
* Unload loaded plugins, destroy plugin_loader instance.
*/
void (*destroy)(plugin_loader_t *this);
};
/**
* Create a plugin_loader instance.
*
* @return plugin loader instance
*/
plugin_loader_t *plugin_loader_create();
#endif /** PLUGIN_LOADER_H_ @}*/
|
