902f72ad598f993e47e5e773811341aa1635c5ba
1 /*****************************************************************************
2 * RRDtool 1.0.33 Copyright Tobias Oetiker, 1997,1998, 1999
3 *****************************************************************************
4 * rrdlib.h Public header file for librrd
5 *****************************************************************************
6 * $Id$
7 * $Log$
8 * Revision 1.7 2003/11/12 22:14:26 oetiker
9 * allow to pass an open filehandle into rrd_graph as an extra argument
10 *
11 * Revision 1.6 2003/11/11 19:46:21 oetiker
12 * replaced time_value with rrd_time_value as MacOS X introduced a struct of that name in their standard headers
13 *
14 * Revision 1.5 2003/04/25 18:35:08 jake
15 * Alternate update interface, updatev. Returns info about CDPs written to disk as result of update. Output format is similar to rrd_info, a hash of key-values.
16 *
17 * Revision 1.4 2003/04/01 22:52:23 jake
18 * Fix Win32 build. VC++ 6.0 and 7.0 now use the thread-safe code.
19 *
20 * Revision 1.3 2003/02/13 07:05:27 oetiker
21 * Find attached the patch I promised to send to you. Please note that there
22 * are three new source files (src/rrd_is_thread_safe.h, src/rrd_thread_safe.c
23 * and src/rrd_not_thread_safe.c) and the introduction of librrd_th. This
24 * library is identical to librrd, but it contains support code for per-thread
25 * global variables currently used for error information only. This is similar
26 * to how errno per-thread variables are implemented. librrd_th must be linked
27 * alongside of libpthred
28 *
29 * There is also a new file "THREADS", holding some documentation.
30 *
31 * -- Peter Stamfest <peter@stamfest.at>
32 *
33 * Revision 1.2 2002/05/07 21:58:32 oetiker
34 * new command rrdtool xport integrated
35 * -- Wolfgang Schrimm <Wolfgang.Schrimm@urz.uni-heidelberg.de>
36 *
37 * Revision 1.1.1.1 2001/02/25 22:25:05 oetiker
38 * checkin
39 *
40 *****************************************************************************/
41 #ifdef __cplusplus
42 extern "C" {
43 #endif
45 #ifndef _RRDLIB_H
46 #define _RRDLIB_H
48 #include <time.h>
49 #include <stdio.h> /* for FILE */
51 /* Transplanted from rrd_format.h */
52 typedef double rrd_value_t; /* the data storage type is
53 * double */
54 /* END rrd_format.h */
56 /* main function blocks */
57 int rrd_create(int, char **);
58 int rrd_update(int, char **);
59 int rrd_graph(int, char **, char ***, int *, int *, FILE *);
60 int rrd_fetch(int, char **, time_t *, time_t *, unsigned long *,
61 unsigned long *, char ***, rrd_value_t **);
62 int rrd_restore(int, char **);
63 int rrd_dump(int, char **);
64 int rrd_tune(int, char **);
65 time_t rrd_last(int, char **);
66 int rrd_resize(int, char **);
67 int rrd_xport(int, char **, int *, time_t *, time_t *,
68 unsigned long *, unsigned long *,
69 char ***, rrd_value_t **);
71 /* thread-safe (hopefully) */
72 int rrd_create_r(char *filename,
73 unsigned long pdp_step, time_t last_up,
74 int argc, char **argv);
75 /* NOTE: rrd_update_r are only thread-safe if no at-style time
76 specifications get used!!! */
77 int rrd_update_r(char *filename, char *_template,
78 int argc, char **argv);
79 int rrd_dump_r(char *filename);
80 time_t rrd_last_r(char *filename);
82 /* Transplanted from parsetime.h */
83 typedef enum {
84 ABSOLUTE_TIME,
85 RELATIVE_TO_START_TIME,
86 RELATIVE_TO_END_TIME
87 } timetype;
89 #define TIME_OK NULL
91 struct rrd_time_value {
92 timetype type;
93 long offset;
94 struct tm tm;
95 };
97 struct rrd_context {
98 int len;
99 int errlen;
100 char *lib_errstr;
101 char *rrd_error;
102 };
104 /* returns the current per-thread rrd_context */
105 struct rrd_context *rrd_get_context(void);
107 char *parsetime(char *spec, struct rrd_time_value *ptv);
108 /* END parsetime.h */
110 int proc_start_end (struct rrd_time_value *, struct rrd_time_value *, time_t *, time_t *);
112 /* HELPER FUNCTIONS */
113 void rrd_set_error(char *,...);
114 void rrd_clear_error(void);
115 int rrd_test_error(void);
116 char *rrd_get_error(void);
118 /** MULTITHREADED HELPER FUNCTIONS */
119 struct rrd_context *rrd_new_context(void);
120 void rrd_free_context (struct rrd_context *buf);
122 /* void rrd_set_error_r (struct rrd_context *, char *, ...); */
123 /* void rrd_clear_error_r(struct rrd_context *); */
124 /* int rrd_test_error_r (struct rrd_context *); */
125 /* char *rrd_get_error_r (struct rrd_context *); */
127 int LockRRD(FILE *);
129 #endif /* _RRDLIB_H */
131 #ifdef __cplusplus
132 }
133 #endif