index 9701d603cbec0ce2a3026a84d06228627214ec5f..f75788ad2359a479c5be92d276366d41bf2fa21b 100644 (file)
} sdb_plugin_ctx_t;
#define SDB_PLUGIN_CTX_INIT { 0 }
-struct sdb_plugin_info;
-typedef struct sdb_plugin_info sdb_plugin_info_t;
+typedef struct {
+ char *plugin_name;
+ char *filename;
+
+ /* public attributes */
+ char *description;
+ char *copyright;
+ char *license;
+
+ int version;
+ int plugin_version;
+} sdb_plugin_info_t;
+#define SDB_PLUGIN_INFO_INIT { \
+ /* plugin_name */ NULL, /* filename */ NULL, /* desc */ NULL, \
+ /* copyright */ NULL, /* license */ NULL, \
+ /* version */ -1, /* plugin_version */ -1 }
/* this should be used in the header of a plugin to avoid
* missing prototype warnings/errors for the plugin init
* sdb_plugin_load:
* Load (any type of) plugin by loading the shared object file and calling the
* sdb_module_init function. If specified, 'plugin_ctx' fine-tunes the
- * behavior of the plugin.
+ * behavior of the plugin. If specified, the plugin will be looked up in
+ * 'basedir', else it defaults to the package libdir.
*/
int
-sdb_plugin_load(const char *name, const sdb_plugin_ctx_t *plugin_ctx);
+sdb_plugin_load(const char *basedir, const char *name,
+ const sdb_plugin_ctx_t *plugin_ctx);
/*
* sdb_plugin_set_info:
* and also to provide additional information to the user.
*/
enum {
- SDB_PLUGIN_INFO_NAME, /* plugin name: string */
SDB_PLUGIN_INFO_DESC, /* plugin description: string */
SDB_PLUGIN_INFO_COPYRIGHT, /* plugin copyright: string */
SDB_PLUGIN_INFO_LICENSE, /* plugin license: string */
* plugin callback functions:
* See the description of the respective register function for what arguments
* the callbacks expect.
+ *
+ * The specified name of callback functions is prepended with the plugin name
+ * before being registered with the core.
*/
typedef int (*sdb_plugin_config_cb)(oconfig_item_t *ci);
* - a negative value else
*/
int
-sdb_plugin_register_config(const char *name, sdb_plugin_config_cb callback);
+sdb_plugin_register_config(sdb_plugin_config_cb callback);
/*
* sdb_plugin_register_init:
* every plugin care about it.
*
* If non-NULL, sdb_plugin_set_ctx stores the previous context in the location
- * pointed to be 'old'.
+ * pointed to by 'old'.
*/
sdb_plugin_ctx_t
sdb_plugin_get_ctx(void);
int
sdb_plugin_set_ctx(sdb_plugin_ctx_t ctx, sdb_plugin_ctx_t *old);
+/*
+ * sdb_plugin_current:
+ * Retrieve information about the plugin (if any) from which the current call
+ * into the core originated. The return value may not be modified.
+ *
+ * Returns:
+ * - information about the current plugin if we were called from some
+ * plugin's callback function
+ * - NULL else
+ */
+const sdb_plugin_info_t *
+sdb_plugin_current(void);
+
/*
* sdb_plugin_configure:
- * Configure the plugin called 'name' (according to the registered config
- * callback) using the config tree 'ci'.
+ * Configure the plugin called 'name' using the config tree 'ci'. The plugin
+ * name is the same as the one used when loading the plugin.
*
* Returns:
* - 0 on success
int
sdb_plugin_init_all(void);
+/*
+ * sdb_plugin_shutdown_all:
+ * Shutdown all plugins using their registered "shutdown" function.
+ *
+ * Returns:
+ * The number of failed shutdowns.
+ */
+int
+sdb_plugin_shutdown_all(void);
+
/*
* sdb_plugin_collector_loop:
* Loop until loop->do_loop is false, calling the next collector function on