Code

31f0e95ef47f14968cb13bbca6255b34cfdcf2b0
[rrdtool-all.git] / program / src / rrd_client.h
1 /**
2  * RRDTool - src/rrd_client.h
3  * Copyright (C) 2008-2010  Florian octo Forster
4  *
5  * Permission is hereby granted, free of charge, to any person obtaining a copy
6  * of this software and associated documentation files (the "Software"), to
7  * deal in the Software without restriction, including without limitation the
8  * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
9  * sell copies of the Software, and to permit persons to whom the Software is
10  * 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 DEALINGS
21  * IN THE SOFTWARE.
22  *
23  * Authors:
24  *   Florian octo Forster <octo at verplant.org>
25  **/
27 #ifndef __RRD_CLIENT_H
28 #define __RRD_CLIENT_H 1
30 #ifndef WIN32
31 # ifdef HAVE_STDINT_H
32 #  include <stdint.h>
33 # else
34 #   ifdef HAVE_INTTYPES_H
35 #      include <inttypes.h>
36 #   else
37 #      error "you should have stdint.h or inttypes.h to compile this"
38 #   endif
39 # endif
40 #else
41 #       include <stdlib.h>
42         typedef signed char     int8_t;
43         typedef unsigned char   uint8_t;
44         typedef signed int      int16_t;
45         typedef unsigned int    uint16_t;
46         typedef signed long int         int32_t;
47         typedef unsigned long int       uint32_t;
48         typedef signed long long int    int64_t;
49         typedef unsigned long long int  uint64_t;
50 #endif
53 #ifndef RRDCACHED_DEFAULT_ADDRESS
54 # define RRDCACHED_DEFAULT_ADDRESS "unix:/tmp/rrdcached.sock"
55 #endif
57 #define RRDCACHED_DEFAULT_PORT "42217"
58 #define ENV_RRDCACHED_ADDRESS "RRDCACHED_ADDRESS"
61 // Windows version has no daemon/client support
63 #ifndef WIN32
64 int rrdc_connect (const char *addr);
65 int rrdc_is_connected(const char *daemon_addr);
66 int rrdc_disconnect (void);
68 int rrdc_update (const char *filename, int values_num,
69         const char * const *values);
71 int rrdc_flush (const char *filename);
72 int rrdc_flush_if_daemon (const char *opt_daemon, const char *filename);
74 int rrdc_fetch (const char *filename,
75     const char *cf,
76     time_t *ret_start, time_t *ret_end,
77     unsigned long *ret_step,
78     unsigned long *ret_ds_num,
79     char ***ret_ds_names,
80     rrd_value_t **ret_data);
82 #else
83 #       define rrdc_flush_if_daemon(a,b) 0
84 #       define rrdc_connect(a) 0
85 #       define rrdc_is_connected(a) 0
86 #       define rrdc_flush(a) 0
87 #       define rrdc_update(a,b,c) 0
88 #endif
90 struct rrdc_stats_s
91 {
92   const char *name;
93   uint16_t type;
94 #define RRDC_STATS_TYPE_GAUGE   0x0001
95 #define RRDC_STATS_TYPE_COUNTER 0x0002
96   uint16_t flags;
97   union
98   {
99     uint64_t counter;
100     double   gauge;
101   } value;
102   struct rrdc_stats_s *next;
103 };
104 typedef struct rrdc_stats_s rrdc_stats_t;
106 int rrdc_stats_get (rrdc_stats_t **ret_stats);
107 void rrdc_stats_free (rrdc_stats_t *ret_stats);
109 #endif /* __RRD_CLIENT_H */
110 /*
111  * vim: set sw=2 sts=2 ts=8 et fdm=marker :
112  */