Link the `disk' plugin against `IOKitLib' when available..
[collectd.git] / src / plugin.h
index 8749327..e1303c7 100644 (file)
@@ -1,6 +1,6 @@
 /**
  * collectd - src/plugin.h
- * Copyright (C) 2005  Florian octo Forster
+ * Copyright (C) 2005,2006  Florian octo Forster
  *
  * 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
@@ -36,7 +36,7 @@
  * NOTES
  *  If `dir' is NULL the compiled in default `PLUGINDIR' is used.
  */
-void plugin_set_dir (char *dir);
+void plugin_set_dir (const char *dir);
 
 /*
  * NAME
@@ -97,9 +97,24 @@ void plugin_register (char *type,
                void (*read) (void),
                void (*write) (char *, char *, char *));
 
-#ifdef HAVE_LIBRRD
+/*
+ * NAME
+ *  plugin_write
+ *
+ * DESCRIPTION
+ *  Searches the plugin for `type' in the plugin-list. If found, and a `write'
+ *  function is registered, it's called. If either the plugin is not found or
+ *  the plugin doesn't provide a `write' function this function will return
+ *  without further notice.
+ *
+ * ARGUMENTS
+ *  `host'      Host(name) from which the data originates.
+ *  `type'      Name of the plugin.
+ *  `inst'      Instance (passed to the plugin's `write' function.
+ *  `val'       Values for the RRD files. Also passed to the plugin.
+ */
 void plugin_write    (char *host, char *type, char *inst, char *val);
-#endif /* HAVE_LIBRRD */
+
 void plugin_submit   (char *type, char *inst, char *val);
 
 #endif /* PLUGIN_H */