X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=src%2Fconfigfile.h;h=519a6ff8668668b6f6c6deef72c60041de27a329;hb=6c6314c7ccca4dae0b9233061dbdf36040dadffe;hp=7d89fadbe18504ebc852f74a18da593e545ccfeb;hpb=0334d1bf754bf285668cdbc4243a972495f25dd7;p=collectd.git

diff --git a/src/configfile.h b/src/configfile.h
index 7d89fadb..519a6ff8 100644
--- a/src/configfile.h
+++ b/src/configfile.h
@@ -1,6 +1,8 @@
+#ifndef CONFIGFILE_H
+#define CONFIGFILE_H
 /**
  * collectd - src/configfile.h
- * Copyright (C) 2005  Florian octo Forster
+ * Copyright (C) 2005-2010  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
@@ -20,8 +22,8 @@
  *   Florian octo Forster <octo at verplant.org>
  **/
 
-#ifndef CONFIGFILE_H
-#define CONFIGFILE_H
+#include "collectd.h"
+#include "liboconfig/oconfig.h"
 
 /*
  * DESCRIPTION
@@ -31,7 +33,8 @@
  *  `type'      Name of the plugin (must be the same as passed to
  *              `plugin_register'
  */
-void cf_unregister (char *type);
+void cf_unregister (const char *type);
+void cf_unregister_complex (const char *type);
 
 /*
  * DESCRIPTION
@@ -57,23 +60,11 @@ void cf_unregister (char *type);
  *  exists for each `type' at any time. This means that `cf_register' may be
  *  called multiple times, but only the last call will have an effect.
  */
-void cf_register (char *type,
-		int (*callback) (char *, char *),
-		char **keys, int keys_num);
+void cf_register (const char *type,
+		int (*callback) (const char *, const char *),
+		const char **keys, int keys_num);
 
-/*
- * DESCRIPTION
- *  `cf_get_mode_option' returns options from the <Mode> section(s).
- *
- * PARAMETERS
- *  `key'       Name of the option to query.
- *
- * RETURN VALUE
- *  The pointer returned is part of an internal structure and may not be
- *  changed. If the option is not found for whatever reason (wrong key, option
- *  not allowed for currently selected mode, ...) `NULL' is returned.
- */
-char *cf_get_mode_option (const char *key);
+int cf_register_complex (const char *type, int (*callback) (oconfig_item_t *));
 
 /*
  * DESCRIPTION
@@ -82,8 +73,6 @@ char *cf_get_mode_option (const char *key);
  *  to load specific plugins, depending on the current mode of operation.
  *
  * PARAMETERS
- *  `argc'      Same as `argc' passed to `main'
- *  `argv'      Same as `argv' passed to `main'
  *  `filename'  An additional filename to look for. This function calls
  *              `lc_process' which already searches many standard locations..
  *              If set to NULL will use the `CONFIGFILE' define.
@@ -92,6 +81,36 @@ char *cf_get_mode_option (const char *key);
  *  Returns zero upon success and non-zero otherwise. A error-message will have
  *  been printed in this case.
  */
-int cf_read (int argc, char **argv, char *filename);
+int cf_read (char *filename);
+
+int global_option_set (const char *option, const char *value);
+const char *global_option_get (const char *option);
+
+/* Assures the config option is a string, duplicates it and returns the copy in
+ * "ret_string". If necessary "*ret_string" is freed first. Returns zero upon
+ * success. */
+int cf_util_get_string (const oconfig_item_t *ci, char **ret_string);
+
+/* Assures the config option is a string and copies it to the provided buffer.
+ * Assures null-termination. */
+int cf_util_get_string_buffer (const oconfig_item_t *ci, char *buffer,
+		size_t buffer_size);
+
+/* Assures the config option is a number and returns it as an int. */
+int cf_util_get_int (const oconfig_item_t *ci, int *ret_value);
+
+/* Assures the config option is a boolean and assignes it to `ret_bool'.
+ * Otherwise, `ret_bool' is not changed and non-zero is returned. */
+int cf_util_get_boolean (const oconfig_item_t *ci, _Bool *ret_bool);
+
+/* Assures the config option is a boolean and set or unset the given flag in
+ * `ret_value' as appropriate. Returns non-zero on error. */
+int cf_util_get_flag (const oconfig_item_t *ci,
+		unsigned int *ret_value, unsigned int flag);
+
+/* Assures that the config option is a string. The string is then converted to
+ * a port number using `service_name_to_port_number' and returned. Returns the
+ * port number in the range [1-65535] or less than zero upon failure. */
+int cf_util_get_port_number (const oconfig_item_t *ci);
 
 #endif /* defined(CONFIGFILE_H) */