src/configfile.h

   1 #ifndef CONFIGFILE_H
   2 #define CONFIGFILE_H
   3 /**
   4  * collectd - src/configfile.h
   5  * Copyright (C) 2005-2011  Florian octo Forster
   6  *
   7  * This program is free software; you can redistribute it and/or modify it
   8  * under the terms of the GNU General Public License as published by the
   9  * Free Software Foundation; either version 2 of the License, or (at your
  10  * option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License along
  18  * with this program; if not, write to the Free Software Foundation, Inc.,
  19  * 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  20  *
  21  * Authors:
  22  *   Florian octo Forster <octo at collectd.org>
  23  **/
  24
  25 #include "collectd.h"
  26 #include "utils_time.h"
  27 #include "liboconfig/oconfig.h"
  28
  29 /*
  30  * DESCRIPTION
  31  *  Remove a registered plugin from the internal data structures.
  32  *
  33  * PARAMETERS
  34  *  `type'      Name of the plugin (must be the same as passed to
  35  *              `plugin_register'
  36  */
  37 void cf_unregister (const char *type);
  38 void cf_unregister_complex (const char *type);
  39
  40 /*
  41  * DESCRIPTION
  42  *  `cf_register' is called by plugins that wish to receive config keys. The
  43  *  plugin will then receive all keys it registered for if they're found in a
  44  *  `<Plugin $type>' section.
  45  *
  46  * PARAMETERS
  47  *  `type'      Name of the plugin (must be the same as passed to
  48  *              `plugin_register'
  49  *  `callback'  Pointer to the callback function. The callback must return zero
  50  *              upon success, a value smaller than zero if it doesn't know how
  51  *              to handle the `key' passed to it (the first argument) or a
  52  *              value greater than zero if it knows how to handle the key but
  53  *              failed.
  54  *  `keys'      Array of key values this plugin wished to receive. The last
  55  *              element must be a NULL-pointer.
  56  *  `keys_num'  Number of elements in the array (not counting the last NULL-
  57  *              pointer.
  58  *
  59  * NOTES
  60  *  `cf_unregister' will be called for `type' to make sure only one record
  61  *  exists for each `type' at any time. This means that `cf_register' may be
  62  *  called multiple times, but only the last call will have an effect.
  63  */
  64 void cf_register (const char *type,
  65                 int (*callback) (const char *, const char *),
  66                 const char **keys, int keys_num);
  67
  68 int cf_register_complex (const char *type, int (*callback) (oconfig_item_t *));
  69
  70 /*
  71  * DESCRIPTION
  72  *  `cf_read' reads the config file `filename' and dispatches the read
  73  *  information to functions/variables. Most important: Is calls `plugin_load'
  74  *  to load specific plugins, depending on the current mode of operation.
  75  *
  76  * PARAMETERS
  77  *  `filename'  An additional filename to look for. This function calls
  78  *              `lc_process' which already searches many standard locations..
  79  *              If set to NULL will use the `CONFIGFILE' define.
  80  *
  81  * RETURN VALUE
  82  *  Returns zero upon success and non-zero otherwise. A error-message will have
  83  *  been printed in this case.
  84  */
  85 int cf_read (char *filename);
  86
  87 int global_option_set (const char *option, const char *value);
  88 const char *global_option_get (const char *option);
  89 long global_option_get_long (const char *option, long default_value);
  90 long global_option_get_long_in_range (const char *option, long default_value, long min, long max);
  91
  92 cdtime_t cf_get_default_interval (void);
  93
  94 /* Assures the config option is a string, duplicates it and returns the copy in
  95  * "ret_string". If necessary "*ret_string" is freed first. Returns zero upon
  96  * success. */
  97 int cf_util_get_string (const oconfig_item_t *ci, char **ret_string);
  98
  99 /* Assures the config option is a string and copies it to the provided buffer.
 100  * Assures null-termination. */
 101 int cf_util_get_string_buffer (const oconfig_item_t *ci, char *buffer,
 102                 size_t buffer_size);
 103
 104 /* Assures the config option is a number and returns it as an int. */
 105 int cf_util_get_int (const oconfig_item_t *ci, int *ret_value);
 106
 107 /* Assures the config option is a number and returns it as a double. */
 108 int cf_util_get_double (const oconfig_item_t *ci, double *ret_value);
 109
 110 /* Assures the config option is a boolean and assignes it to `ret_bool'.
 111  * Otherwise, `ret_bool' is not changed and non-zero is returned. */
 112 int cf_util_get_boolean (const oconfig_item_t *ci, _Bool *ret_bool);
 113
 114 /* Assures the config option is a boolean and set or unset the given flag in
 115  * `ret_value' as appropriate. Returns non-zero on error. */
 116 int cf_util_get_flag (const oconfig_item_t *ci,
 117                 unsigned int *ret_value, unsigned int flag);
 118
 119 /* Assures that the config option is a string or a number if the correct range
 120  * of 1-65535. The string is then converted to a port number using
 121  * `service_name_to_port_number' and returned.
 122  * Returns the port number in the range [1-65535] or less than zero upon
 123  * failure. */
 124 int cf_util_get_port_number (const oconfig_item_t *ci);
 125
 126 /* Assures that the config option is either a service name (a string) or a port
 127  * number (an integer in the appropriate range) and returns a newly allocated
 128  * string. If ret_string points to a non-NULL pointer, it is freed before
 129  * assigning a new value. */
 130 int cf_util_get_service (const oconfig_item_t *ci, char **ret_string);
 131
 132 int cf_util_get_cdtime (const oconfig_item_t *ci, cdtime_t *ret_value);
 133
 134 #endif /* defined(CONFIGFILE_H) */