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
48 typedef uint64_t counter_t;
49 typedef double gauge_t;
56 typedef union value_u value_t;
58 struct lcc_identifier_s
60 char host[LCC_NAME_LEN];
61 char plugin[LCC_NAME_LEN];
62 char plugin_instance[LCC_NAME_LEN];
63 char type[LCC_NAME_LEN];
64 char type_instance[LCC_NAME_LEN];
66 typedef struct lcc_identifier_s lcc_identifier_t;
67 #define LCC_IDENTIFIER_INIT { "localhost", "", "", "", "" }
69 struct lcc_value_list_s
76 lcc_identifier_t identifier;
78 typedef struct lcc_value_list_s lcc_value_list_t;
79 #define LCC_VALUE_LIST_INIT { NULL, 0, 0, 0, LCC_IDENTIFIER_INIT }
81 struct lcc_connection_s;
82 typedef struct lcc_connection_s lcc_connection_t;
87 int lcc_connect (const char *address, lcc_connection_t **ret_con);
88 int lcc_disconnect (lcc_connection_t *c);
89 #define LCC_DESTROY(c) do { lcc_disconnect (c); (c) = NULL; } while (0)
91 int lcc_getval (lcc_connection_t *c, lcc_identifier_t *ident,
92 size_t *ret_values_num, gauge_t **ret_values, char ***ret_values_names);
94 int lcc_putval (lcc_connection_t *c, const lcc_value_list_t *vl);
96 int lcc_flush (lcc_connection_t *c, const char *plugin,
97 lcc_identifier_t *ident, int timeout);
99 int lcc_listval (lcc_connection_t *c,
100 lcc_identifier_t **ret_ident, size_t *ret_ident_num);
104 const char *lcc_strerror (lcc_connection_t *c);
106 int lcc_identifier_to_string (lcc_connection_t *c,
107 char *string, size_t string_size, const lcc_identifier_t *ident);
108 int lcc_string_to_identifier (lcc_connection_t *c,
109 lcc_identifier_t *ident, const char *string);
113 /* vim: set sw=2 sts=2 et : */
114 #endif /* LIBCOLLECTD_COLLECTDCLIENT_H */