src/libcollectdclient/client.h

   1 /**
   2  * libcollectdclient - src/libcollectdclient/client.h
   3  * Copyright (C) 2008  Florian octo Forster
   4  *
   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.
   8  *
   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.
  13  *
  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
  17  *
  18  * Authors:
  19  *   Florian octo Forster <octo at verplant.org>
  20  **/
  21
  22 #ifndef LIBCOLLECTD_COLLECTDCLIENT_H
  23 #define LIBCOLLECTD_COLLECTDCLIENT_H 1
  24
  25 /*
  26  * Includes (for data types)
  27  */
  28 #include <stdint.h>
  29 #include <inttypes.h>
  30 #include <time.h>
  31
  32 /*
  33  * Defines
  34  */
  35 #define LCC_VERSION 0
  36 #define LCC_NAME_LEN 64
  37 #define LCC_DEFAULT_PORT "25826"
  38
  39 /*
  40  * Types
  41  */
  42 typedef uint64_t counter_t;
  43 typedef double gauge_t;
  44
  45 union value_u
  46 {
  47   counter_t counter;
  48   gauge_t   gauge;
  49 };
  50 typedef union value_u value_t;
  51
  52 struct lcc_identifier_s
  53 {
  54   char host[LCC_NAME_LEN];
  55   char plugin[LCC_NAME_LEN];
  56   char plugin_instance[LCC_NAME_LEN];
  57   char type[LCC_NAME_LEN];
  58   char type_instance[LCC_NAME_LEN];
  59 };
  60 typedef struct lcc_identifier_s lcc_identifier_t;
  61 #define LCC_IDENTIFIER_INIT { "localhost", "", "", "", "" }
  62
  63 struct lcc_value_list_s
  64 {
  65   value_t *values;
  66   size_t   values_len;
  67   time_t   time;
  68   int      interval;
  69   lcc_identifier_t identifier;
  70 };
  71 typedef struct lcc_value_list_s lcc_value_list_t;
  72 #define LCC_VALUE_LIST_INIT { NULL, 0, 0, 0, LCC_IDENTIFIER_INIT }
  73
  74 struct lcc_connection_s;
  75 typedef struct lcc_connection_s lcc_connection_t;
  76
  77 /*
  78  * Functions
  79  */
  80 int lcc_connect (const char *address, lcc_connection_t **ret_con);
  81 int lcc_disconnect (lcc_connection_t *c);
  82 #define LCC_DESTROY(c) do { lcc_disconnect (c); (c) = NULL; } while (0)
  83
  84 int lcc_getval (lcc_connection_t *c, lcc_identifier_t *ident,
  85     size_t *ret_values_num, gauge_t **ret_values, char ***ret_values_names);
  86
  87 int lcc_putval (lcc_connection_t *c, const lcc_value_list_t *vl);
  88
  89 int lcc_flush (lcc_connection_t *c, lcc_identifier_t *ident, int timeout);
  90
  91 int lcc_listval (lcc_connection_t *c,
  92     lcc_identifier_t **ret_ident, size_t *ret_ident_num);
  93
  94 /* TODO: putnotif */
  95
  96 const char *lcc_strerror (lcc_connection_t *c);
  97
  98 int lcc_identifier_to_string (lcc_connection_t *c,
  99     char *string, size_t string_size, const lcc_identifier_t *ident);
 100 int lcc_string_to_identifier (lcc_connection_t *c,
 101     lcc_identifier_t *ident, const char *string);
 102
 103 /* vim: set sw=2 sts=2 et : */
 104 #endif /* LIBCOLLECTD_COLLECTDCLIENT_H */