2 * libcollectdclient - src/libcollectdclient/collectd/client.h
3 * Copyright (C) 2008-2012 Florian octo Forster
5 * Permission is hereby granted, free of charge, to any person obtaining a
6 * copy of this software and associated documentation files (the "Software"),
7 * to deal in the Software without restriction, including without limitation
8 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
9 * and/or sell copies of the Software, and to permit persons to whom the
10 * Software is furnished to do so, subject to the following conditions:
12 * The above copyright notice and this permission notice shall be included in
13 * all copies or substantial portions of the Software.
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
21 * DEALINGS IN THE SOFTWARE.
24 * Florian octo Forster <octo at collectd.org>
27 #ifndef LIBCOLLECTD_COLLECTDCLIENT_H
28 #define LIBCOLLECTD_COLLECTDCLIENT_H 1
30 #include "lcc_features.h"
32 /* COLLECTD_TRACE is the environment variable used to control trace output. When
33 * set to something non-zero, all lines sent to / received from the daemon are
34 * printed to STDOUT. */
36 #define LCC_TRACE_ENV "COLLECTD_TRACE"
40 * Includes (for data types)
51 #define LCC_NAME_LEN 64
52 #define LCC_DEFAULT_PORT "25826"
57 #define LCC_TYPE_COUNTER 0
58 #define LCC_TYPE_GAUGE 1
59 #define LCC_TYPE_DERIVE 2
60 #define LCC_TYPE_ABSOLUTE 3
64 typedef uint64_t counter_t;
65 typedef double gauge_t;
66 typedef uint64_t derive_t;
67 typedef uint64_t absolute_t;
75 typedef union value_u value_t;
77 struct lcc_identifier_s {
78 char host[LCC_NAME_LEN];
79 char plugin[LCC_NAME_LEN];
80 char plugin_instance[LCC_NAME_LEN];
81 char type[LCC_NAME_LEN];
82 char type_instance[LCC_NAME_LEN];
84 typedef struct lcc_identifier_s lcc_identifier_t;
85 #define LCC_IDENTIFIER_INIT \
86 { "localhost", "", "", "", "" }
88 struct lcc_value_list_s {
94 lcc_identifier_t identifier;
96 typedef struct lcc_value_list_s lcc_value_list_t;
97 #define LCC_VALUE_LIST_INIT \
98 { NULL, NULL, 0, 0, 0, LCC_IDENTIFIER_INIT }
100 struct lcc_connection_s;
101 typedef struct lcc_connection_s lcc_connection_t;
106 int lcc_connect(const char *address, lcc_connection_t **ret_con);
107 int lcc_disconnect(lcc_connection_t *c);
108 #define LCC_DESTROY(c) \
114 int lcc_getval(lcc_connection_t *c, lcc_identifier_t *ident,
115 size_t *ret_values_num, gauge_t **ret_values,
116 char ***ret_values_names);
118 int lcc_putval(lcc_connection_t *c, const lcc_value_list_t *vl);
120 int lcc_flush(lcc_connection_t *c, const char *plugin, lcc_identifier_t *ident,
123 int lcc_listval(lcc_connection_t *c, lcc_identifier_t **ret_ident,
124 size_t *ret_ident_num);
128 const char *lcc_strerror(lcc_connection_t *c);
130 int lcc_identifier_to_string(lcc_connection_t *c, char *string,
131 size_t string_size, const lcc_identifier_t *ident);
132 int lcc_string_to_identifier(lcc_connection_t *c, lcc_identifier_t *ident,
135 /* Compares the identifiers "i0" and "i1" and returns less than zero or greater
136 * than zero if "i0" is smaller than or greater than "i1", respectively. If
137 * "i0" and "i1" are identical, zero is returned. */
138 int lcc_identifier_compare(const void *i0, const void *i1);
139 int lcc_sort_identifiers(lcc_connection_t *c, lcc_identifier_t *idents,
144 /* vim: set sw=2 sts=2 et : */
145 #endif /* LIBCOLLECTD_COLLECTDCLIENT_H */