X-Git-Url: https://git.tokkee.org/?a=blobdiff_plain;f=src%2Finclude%2Fcore%2Fplugin.h;h=a4217ac814aa35c632f334aaae8d22e13f79a46d;hb=23760ca65713cd9b8338f09bf45ec20ff4c3ef8d;hp=ac8656ab3b36c8a76a10c1abac91feb96fe15d92;hpb=8d86f8d17b71234e55633fbbdbcaee6f3d365d36;p=sysdb.git

diff --git a/src/include/core/plugin.h b/src/include/core/plugin.h
index ac8656a..a4217ac 100644
--- a/src/include/core/plugin.h
+++ b/src/include/core/plugin.h
@@ -34,6 +34,8 @@
 
 #include "liboconfig/oconfig.h"
 
+#include <stdarg.h>
+
 #ifdef __cplusplus
 extern "C" {
 #endif
@@ -61,10 +63,11 @@ typedef struct {
 /*
  * sdb_plugin_load:
  * Load (any type of) plugin by loading the shared object file and calling the
- * sdb_module_init function.
+ * sdb_module_init function. If specified, 'plugin_ctx' fine-tunes the
+ * behavior of the plugin.
  */
 int
-sdb_plugin_load(const char *name);
+sdb_plugin_load(const char *name, const sdb_plugin_ctx_t *plugin_ctx);
 
 /*
  * sdb_plugin_set_info:
@@ -85,13 +88,19 @@ int
 sdb_plugin_set_info(sdb_plugin_info_t *info, int type, ...);
 
 /*
- * plugin callback functions
+ * plugin callback functions:
+ * See the description of the respective register function for what arguments
+ * the callbacks expect.
  */
 
 typedef int (*sdb_plugin_config_cb)(oconfig_item_t *ci);
 typedef int (*sdb_plugin_init_cb)(sdb_object_t *user_data);
 typedef int (*sdb_plugin_collector_cb)(sdb_object_t *user_data);
+typedef char *(*sdb_plugin_cname_cb)(const char *name,
+		sdb_object_t *user_data);
 typedef int (*sdb_plugin_shutdown_cb)(sdb_object_t *user_data);
+typedef int (*sdb_plugin_log_cb)(int prio, const char *msg,
+		sdb_object_t *user_data);
 
 /*
  * sdb_plugin_register_config:
@@ -157,6 +166,25 @@ sdb_plugin_register_collector(const char *name,
 		sdb_plugin_collector_cb callback,
 		const sdb_time_t *interval, sdb_object_t *user_data);
 
+/*
+ * sdb_plugin_register_cname:
+ * Register a "cname" (canonicalize name) function. This type of function is
+ * called whenever a host is stored. It accepts the hostname and returns a
+ * canonicalized hostname which will then be used to actually store the host.
+ * If multiple such callbacks are registered, each one of them will be called
+ * in the order they have been registered, each one receiving the result of
+ * the previous callback. If the function returns NULL, the original hostname
+ * is not changed. Any other value has to be dynamically allocated. It will be
+ * freed later on by the core.
+ *
+ * Returns:
+ *  - 0 on success
+ *  - a negative value else
+ */
+int
+sdb_plugin_register_cname(const char *name, sdb_plugin_cname_cb callback,
+		sdb_object_t *user_data);
+
 /*
  * sdb_plugin_register_shutdown:
  * Register a "shutdown" function to be called after stopping all update
@@ -173,17 +201,34 @@ sdb_plugin_register_shutdown(const char *name,
 		sdb_plugin_shutdown_cb callback,
 		sdb_object_t *user_data);
 
+/*
+ * sdb_plugin_register_log:
+ * Register a "log" function to be called whenever logging is to be done.
+ *
+ * Arguments:
+ *  - user_data: If specified, this will be passed on to each call of the
+ *    callback. The function will take ownership of the object, that is,
+ *    increment the reference count by one. In case the caller does not longer
+ *    use the object for other purposes, it should thus deref it.
+ */
+int
+sdb_plugin_register_log(const char *name, sdb_plugin_log_cb callback,
+		sdb_object_t *user_data);
+
 /*
  * sdb_plugin_get_ctx, sdb_plugin_set_ctx:
  * The plugin context defines a set of settings that are available whenever a
  * plugin has been called. It may be used to pass around various information
  * between the different component of the library without having each and
  * every plugin care about it.
+ *
+ * If non-NULL, sdb_plugin_set_ctx stores the previous context in the location
+ * pointed to be 'old'.
  */
 sdb_plugin_ctx_t
 sdb_plugin_get_ctx(void);
-sdb_plugin_ctx_t
-sdb_plugin_set_ctx(sdb_plugin_ctx_t ctx);
+int
+sdb_plugin_set_ctx(sdb_plugin_ctx_t ctx, sdb_plugin_ctx_t *old);
 
 /*
  * sdb_plugin_configure:
@@ -200,6 +245,9 @@ sdb_plugin_configure(const char *name, oconfig_item_t *ci);
 /*
  * sdb_plugin_init_all:
  * Initialize all plugins using their registered "init" function.
+ *
+ * Returns:
+ * The number of failed initializations.
  */
 int
 sdb_plugin_init_all(void);
@@ -216,6 +264,33 @@ sdb_plugin_init_all(void);
 int
 sdb_plugin_collector_loop(sdb_plugin_loop_t *loop);
 
+/*
+ * sdb_plugin_cname:
+ * Returns the canonicalized hostname. The given hostname argument has to
+ * point to dynamically allocated memory and might be freed by the function.
+ * The return value will also be dynamically allocated (but it might be
+ * unchanged) and has to be freed by the caller.
+ */
+char *
+sdb_plugin_cname(char *hostname);
+
+/*
+ * sdb_plugin_log:
+ * Log the specified message using all registered log callbacks. The message
+ * will be logged with the specified priority.
+ */
+int
+sdb_plugin_log(int prio, const char *msg);
+
+/*
+ * sdb_plugin_logf:
+ * Log a formatted message. See sdb_plugin_log for more information.
+ */
+int
+sdb_plugin_vlogf(int prio, const char *fmt, va_list ap);
+int
+sdb_plugin_logf(int prio, const char *fmt, ...);
+
 #ifdef __cplusplus
 } /* extern "C" */
 #endif