src/libcollectdclient/collectd/client.h

   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  **/
  26
  27 #ifndef LIBCOLLECTD_COLLECTDCLIENT_H
  28 #define LIBCOLLECTD_COLLECTDCLIENT_H 1
  29
  30 #include "lcc_features.h"
  31
  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
  38
  39 /*
  40  * Includes (for data types)
  41  */
  42 #include <stdint.h>
  43 #include <inttypes.h>
  44 #include <time.h>
  45
  46 /*
  47  * Defines
  48  */
  49 #define LCC_NAME_LEN 64
  50 #define LCC_DEFAULT_PORT "25826"
  51
  52 /*
  53  * Types
  54  */
  55 #define LCC_TYPE_COUNTER 0
  56 #define LCC_TYPE_GAUGE 1
  57 #define LCC_TYPE_DERIVE 2
  58 #define LCC_TYPE_ABSOLUTE 3
  59
  60 LCC_BEGIN_DECLS
  61
  62 typedef uint64_t counter_t;
  63 typedef double gauge_t;
  64 typedef uint64_t derive_t;
  65 typedef uint64_t absolute_t;
  66
  67 union value_u {
  68   counter_t counter;
  69   gauge_t gauge;
  70   derive_t derive;
  71   absolute_t absolute;
  72 };
  73 typedef union value_u value_t;
  74
  75 struct lcc_identifier_s {
  76   char host[LCC_NAME_LEN];
  77   char plugin[LCC_NAME_LEN];
  78   char plugin_instance[LCC_NAME_LEN];
  79   char type[LCC_NAME_LEN];
  80   char type_instance[LCC_NAME_LEN];
  81 };
  82 typedef struct lcc_identifier_s lcc_identifier_t;
  83 #define LCC_IDENTIFIER_INIT                                                    \
  84   { "localhost", "", "", "", "" }
  85
  86 struct lcc_value_list_s {
  87   value_t *values;
  88   int *values_types;
  89   size_t values_len;
  90   double time;
  91   double interval;
  92   lcc_identifier_t identifier;
  93 };
  94 typedef struct lcc_value_list_s lcc_value_list_t;
  95 #define LCC_VALUE_LIST_INIT                                                    \
  96   { NULL, NULL, 0, 0, 0, LCC_IDENTIFIER_INIT }
  97
  98 struct lcc_connection_s;
  99 typedef struct lcc_connection_s lcc_connection_t;
 100
 101 /*
 102  * Functions
 103  */
 104 int lcc_connect(const char *address, lcc_connection_t **ret_con);
 105 int lcc_disconnect(lcc_connection_t *c);
 106 #define LCC_DESTROY(c)                                                         \
 107   do {                                                                         \
 108     lcc_disconnect(c);                                                         \
 109     (c) = NULL;                                                                \
 110   } while (0)
 111
 112 int lcc_getval(lcc_connection_t *c, lcc_identifier_t *ident,
 113                size_t *ret_values_num, gauge_t **ret_values,
 114                char ***ret_values_names);
 115
 116 int lcc_putval(lcc_connection_t *c, const lcc_value_list_t *vl);
 117
 118 int lcc_flush(lcc_connection_t *c, const char *plugin, lcc_identifier_t *ident,
 119               int timeout);
 120
 121 int lcc_listval(lcc_connection_t *c, lcc_identifier_t **ret_ident,
 122                 size_t *ret_ident_num);
 123
 124 /* TODO: putnotif */
 125
 126 const char *lcc_strerror(lcc_connection_t *c);
 127
 128 int lcc_identifier_to_string(lcc_connection_t *c, char *string,
 129                              size_t string_size, const lcc_identifier_t *ident);
 130 int lcc_string_to_identifier(lcc_connection_t *c, lcc_identifier_t *ident,
 131                              const char *string);
 132
 133 /* Compares the identifiers "i0" and "i1" and returns less than zero or greater
 134  * than zero if "i0" is smaller than or greater than "i1", respectively. If
 135  * "i0" and "i1" are identical, zero is returned. */
 136 int lcc_identifier_compare(const void *i0, const void *i1);
 137 int lcc_sort_identifiers(lcc_connection_t *c, lcc_identifier_t *idents,
 138                          size_t idents_num);
 139
 140 LCC_END_DECLS
 141
 142 #endif /* LIBCOLLECTD_COLLECTDCLIENT_H */