1 /**
2 * libcollectdclient - src/libcollectdclient/collectd/client.h
3 * Copyright (C) 2008-2012 Florian octo Forster
4 *
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:
11 *
12 * The above copyright notice and this permission notice shall be included in
13 * all copies or substantial portions of the Software.
14 *
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.
22 *
23 * Authors:
24 * Florian octo Forster <octo at collectd.org>
25 **/
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. */
35 #ifndef LCC_TRACE_ENV
36 # define LCC_TRACE_ENV "COLLECTD_TRACE"
37 #endif
39 /*
40 * Includes (for data types)
41 */
42 #if HAVE_STDINT_H
43 # include <stdint.h>
44 #endif
45 #include <inttypes.h>
46 #include <time.h>
48 /*
49 * Defines
50 */
51 #define LCC_NAME_LEN 64
52 #define LCC_DEFAULT_PORT "25826"
54 /*
55 * Types
56 */
57 #define LCC_TYPE_COUNTER 0
58 #define LCC_TYPE_GAUGE 1
59 #define LCC_TYPE_DERIVE 2
60 #define LCC_TYPE_ABSOLUTE 3
62 LCC_BEGIN_DECLS
64 typedef uint64_t counter_t;
65 typedef double gauge_t;
66 typedef uint64_t derive_t;
67 typedef uint64_t absolute_t;
69 union value_u
70 {
71 counter_t counter;
72 gauge_t gauge;
73 derive_t derive;
74 absolute_t absolute;
75 };
76 typedef union value_u value_t;
78 struct lcc_identifier_s
79 {
80 char host[LCC_NAME_LEN];
81 char plugin[LCC_NAME_LEN];
82 char plugin_instance[LCC_NAME_LEN];
83 char type[LCC_NAME_LEN];
84 char type_instance[LCC_NAME_LEN];
85 };
86 typedef struct lcc_identifier_s lcc_identifier_t;
87 #define LCC_IDENTIFIER_INIT { "localhost", "", "", "", "" }
89 struct lcc_value_list_s
90 {
91 value_t *values;
92 int *values_types;
93 size_t values_len;
94 double time;
95 double interval;
96 lcc_identifier_t identifier;
97 };
98 typedef struct lcc_value_list_s lcc_value_list_t;
99 #define LCC_VALUE_LIST_INIT { NULL, NULL, 0, 0, 0, LCC_IDENTIFIER_INIT }
101 struct lcc_connection_s;
102 typedef struct lcc_connection_s lcc_connection_t;
104 /*
105 * Functions
106 */
107 int lcc_connect (const char *address, lcc_connection_t **ret_con);
108 int lcc_disconnect (lcc_connection_t *c);
109 #define LCC_DESTROY(c) do { lcc_disconnect (c); (c) = NULL; } while (0)
111 int lcc_getval (lcc_connection_t *c, lcc_identifier_t *ident,
112 size_t *ret_values_num, gauge_t **ret_values, char ***ret_values_names);
114 int lcc_putval (lcc_connection_t *c, const lcc_value_list_t *vl);
116 int lcc_flush (lcc_connection_t *c, const char *plugin,
117 lcc_identifier_t *ident, int timeout);
119 int lcc_listval (lcc_connection_t *c,
120 lcc_identifier_t **ret_ident, size_t *ret_ident_num);
122 /* TODO: putnotif */
124 const char *lcc_strerror (lcc_connection_t *c);
126 int lcc_identifier_to_string (lcc_connection_t *c,
127 char *string, size_t string_size, const lcc_identifier_t *ident);
128 int lcc_string_to_identifier (lcc_connection_t *c,
129 lcc_identifier_t *ident, const char *string);
131 /* Compares the identifiers "i0" and "i1" and returns less than zero or greater
132 * than zero if "i0" is smaller than or greater than "i1", respectively. If
133 * "i0" and "i1" are identical, zero is returned. */
134 int lcc_identifier_compare (const void *i0,
135 const void *i1);
136 int lcc_sort_identifiers (lcc_connection_t *c,
137 lcc_identifier_t *idents, size_t idents_num);
139 LCC_END_DECLS
141 /* vim: set sw=2 sts=2 et : */
142 #endif /* LIBCOLLECTD_COLLECTDCLIENT_H */