2 * libcollectdclient - src/libcollectdclient/client.h
3 * Copyright (C) 2008 Florian octo Forster
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.
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.
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
19 * Florian octo Forster <octo at verplant.org>
22 #ifndef LIBCOLLECTD_COLLECTDCLIENT_H
23 #define LIBCOLLECTD_COLLECTDCLIENT_H 1
25 #include "lcc_features.h"
28 * Includes (for data types)
37 #define LCC_NAME_LEN 64
38 #define LCC_DEFAULT_PORT "25826"
43 #define LCC_TYPE_COUNTER 0
44 #define LCC_TYPE_GAUGE 1
45 #define LCC_TYPE_DERIVE 2
46 #define LCC_TYPE_ABSOLUTE 3
50 typedef uint64_t counter_t;
51 typedef double gauge_t;
52 typedef uint64_t derive_t;
53 typedef uint64_t absolute_t;
62 typedef union value_u value_t;
64 struct lcc_identifier_s
66 char host[LCC_NAME_LEN];
67 char plugin[LCC_NAME_LEN];
68 char plugin_instance[LCC_NAME_LEN];
69 char type[LCC_NAME_LEN];
70 char type_instance[LCC_NAME_LEN];
72 typedef struct lcc_identifier_s lcc_identifier_t;
73 #define LCC_IDENTIFIER_INIT { "localhost", "", "", "", "" }
75 struct lcc_value_list_s
82 lcc_identifier_t identifier;
84 typedef struct lcc_value_list_s lcc_value_list_t;
85 #define LCC_VALUE_LIST_INIT { NULL, 0, 0, 0, LCC_IDENTIFIER_INIT }
87 struct lcc_connection_s;
88 typedef struct lcc_connection_s lcc_connection_t;
93 int lcc_connect (const char *address, lcc_connection_t **ret_con);
94 int lcc_disconnect (lcc_connection_t *c);
95 #define LCC_DESTROY(c) do { lcc_disconnect (c); (c) = NULL; } while (0)
97 int lcc_getval (lcc_connection_t *c, lcc_identifier_t *ident,
98 size_t *ret_values_num, gauge_t **ret_values, char ***ret_values_names);
100 int lcc_putval (lcc_connection_t *c, const lcc_value_list_t *vl);
102 int lcc_flush (lcc_connection_t *c, const char *plugin,
103 lcc_identifier_t *ident, int timeout);
105 int lcc_listval (lcc_connection_t *c,
106 lcc_identifier_t **ret_ident, size_t *ret_ident_num);
110 const char *lcc_strerror (lcc_connection_t *c);
112 int lcc_identifier_to_string (lcc_connection_t *c,
113 char *string, size_t string_size, const lcc_identifier_t *ident);
114 int lcc_string_to_identifier (lcc_connection_t *c,
115 lcc_identifier_t *ident, const char *string);
119 /* vim: set sw=2 sts=2 et : */
120 #endif /* LIBCOLLECTD_COLLECTDCLIENT_H */