netapp plugin: Document the graceful return if statistics are not wanted.
[collectd.git] / src / meta_data.h
1 /**
2  * collectd - src/meta_data.h
3  * Copyright (C) 2008,2009  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  * Authors:
19  *   Florian octo Forster <octo at verplant.org>
20  **/
21
22 #ifndef META_DATA_H
23 #define META_DATA_H
24
25 #include "collectd.h"
26
27 struct meta_data_s;
28 typedef struct meta_data_s meta_data_t;
29
30 meta_data_t *meta_data_create (void);
31 void meta_data_destroy (meta_data_t *md);
32
33 int meta_data_exists (meta_data_t *md, const char *key);
34 int meta_data_delete (meta_data_t *md, const char *key);
35
36 int meta_data_add_string (meta_data_t *md,
37     const char *key,
38     const char *value);
39 int meta_data_add_signed_int (meta_data_t *md,
40     const char *key,
41     int64_t value);
42 int meta_data_add_unsigned_int (meta_data_t *md,
43     const char *key,
44     uint64_t value);
45 int meta_data_add_double (meta_data_t *md,
46     const char *key,
47     double value);
48 int meta_data_add_boolean (meta_data_t *md,
49     const char *key,
50     _Bool value);
51
52 int meta_data_get_string (meta_data_t *md,
53     const char *key,
54     char **value);
55 int meta_data_get_signed_int (meta_data_t *md,
56     const char *key,
57     int64_t *value);
58 int meta_data_get_unsigned_int (meta_data_t *md,
59     const char *key,
60     uint64_t *value);
61 int meta_data_get_double (meta_data_t *md,
62     const char *key,
63     double *value);
64 int meta_data_get_boolean (meta_data_t *md,
65     const char *key,
66     _Bool *value);
67
68 #endif /* META_DATA_H */
69 /* vim: set sw=2 sts=2 et : */