src/utils_cache.h

   1 /**
   2  * collectd - src/utils_cache.h
   3  * Copyright (C) 2007  Florian octo Forster
   4  *
   5  * This program is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License as published by the
   7  * Free Software Foundation; only version 2 of the License is applicable.
   8  *
   9  * This program is distributed in the hope that it will be useful, but
  10  * WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License along
  15  * with this program; if not, write to the Free Software Foundation, Inc.,
  16  * 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  17  *
  18  * Author:
  19  *   Florian octo Forster <octo at verplant.org>
  20  **/
  21
  22 #ifndef UTILS_CACHE_H
  23 #define UTILS_CACHE_H 1
  24
  25 #include "plugin.h"
  26
  27 #define STATE_OKAY     0
  28 #define STATE_WARNING  1
  29 #define STATE_ERROR    2
  30 #define STATE_MISSING 15
  31
  32 int uc_init (void);
  33 int uc_check_timeout (void);
  34 int uc_update (const data_set_t *ds, const value_list_t *vl);
  35 int uc_get_rate_by_name (const char *name, gauge_t **ret_values, size_t *ret_values_num);
  36 gauge_t *uc_get_rate (const data_set_t *ds, const value_list_t *vl);
  37
  38 int uc_get_names (char ***ret_names, cdtime_t **ret_times, size_t *ret_number);
  39
  40 int uc_get_state (const data_set_t *ds, const value_list_t *vl);
  41 int uc_set_state (const data_set_t *ds, const value_list_t *vl, int state);
  42 int uc_get_hits (const data_set_t *ds, const value_list_t *vl);
  43 int uc_set_hits (const data_set_t *ds, const value_list_t *vl, int hits);
  44 int uc_inc_hits (const data_set_t *ds, const value_list_t *vl, int step);
  45
  46 int uc_get_history (const data_set_t *ds, const value_list_t *vl,
  47     gauge_t *ret_history, size_t num_steps, size_t num_ds);
  48 int uc_get_history_by_name (const char *name,
  49     gauge_t *ret_history, size_t num_steps, size_t num_ds);
  50
  51 /*
  52  * Meta data interface
  53  */
  54 int uc_meta_data_exists (const value_list_t *vl, const char *key);
  55 int uc_meta_data_delete (const value_list_t *vl, const char *key);
  56
  57 int uc_meta_data_add_string (const value_list_t *vl,
  58     const char *key,
  59     const char *value);
  60 int uc_meta_data_add_signed_int (const value_list_t *vl,
  61     const char *key,
  62     int64_t value);
  63 int uc_meta_data_add_unsigned_int (const value_list_t *vl,
  64     const char *key,
  65     uint64_t value);
  66 int uc_meta_data_add_double (const value_list_t *vl,
  67     const char *key,
  68     double value);
  69 int uc_meta_data_add_boolean (const value_list_t *vl,
  70     const char *key,
  71     _Bool value);
  72
  73 int uc_meta_data_get_string (const value_list_t *vl,
  74     const char *key,
  75     char **value);
  76 int uc_meta_data_get_signed_int (const value_list_t *vl,
  77     const char *key,
  78     int64_t *value);
  79 int uc_meta_data_get_unsigned_int (const value_list_t *vl,
  80     const char *key,
  81     uint64_t *value);
  82 int uc_meta_data_get_double (const value_list_t *vl,
  83     const char *key,
  84     double *value);
  85 int uc_meta_data_get_boolean (const value_list_t *vl,
  86     const char *key,
  87     _Bool *value);
  88
  89 /* vim: set shiftwidth=2 softtabstop=2 tabstop=8 : */
  90 #endif /* !UTILS_CACHE_H */