collectd.conf(5): Finish documenting the AMQP plugin.
[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 /*
28  * Defines
29  */
30 #define MD_TYPE_STRING       1
31 #define MD_TYPE_SIGNED_INT   2
32 #define MD_TYPE_UNSIGNED_INT 3
33 #define MD_TYPE_DOUBLE       4
34 #define MD_TYPE_BOOLEAN      5
35
36 struct meta_data_s;
37 typedef struct meta_data_s meta_data_t;
38
39 meta_data_t *meta_data_create (void);
40 void meta_data_destroy (meta_data_t *md);
41
42 int meta_data_exists (meta_data_t *md, const char *key);
43 int meta_data_type (meta_data_t *md, const char *key);
44 int meta_data_toc (meta_data_t *md, char ***toc);
45 int meta_data_delete (meta_data_t *md, const char *key);
46
47 int meta_data_add_string (meta_data_t *md,
48     const char *key,
49     const char *value);
50 int meta_data_add_signed_int (meta_data_t *md,
51     const char *key,
52     int64_t value);
53 int meta_data_add_unsigned_int (meta_data_t *md,
54     const char *key,
55     uint64_t value);
56 int meta_data_add_double (meta_data_t *md,
57     const char *key,
58     double value);
59 int meta_data_add_boolean (meta_data_t *md,
60     const char *key,
61     _Bool value);
62
63 int meta_data_get_string (meta_data_t *md,
64     const char *key,
65     char **value);
66 int meta_data_get_signed_int (meta_data_t *md,
67     const char *key,
68     int64_t *value);
69 int meta_data_get_unsigned_int (meta_data_t *md,
70     const char *key,
71     uint64_t *value);
72 int meta_data_get_double (meta_data_t *md,
73     const char *key,
74     double *value);
75 int meta_data_get_boolean (meta_data_t *md,
76     const char *key,
77     _Bool *value);
78
79 #endif /* META_DATA_H */
80 /* vim: set sw=2 sts=2 et : */