prep for 1.2rc9 release

[rrdtool.git] / src / rrd.h

diff --git a/src/rrd.h b/src/rrd.h
index 8172c7f..d907d18 100644 (file)
--- a/src/rrd.h
+++ b/src/rrd.h
@@ -1,10 +1,42 @@
 /*****************************************************************************
- * RRDtool 1.0.33  Copyright Tobias Oetiker, 1997,1998, 1999
+ * RRDtool 1.2rc9  Copyright by Tobi Oetiker, 1997-2005
  *****************************************************************************
  * rrdlib.h   Public header file for librrd
  *****************************************************************************
  * $Id$
  * $Log$
+ * Revision 1.9  2005/02/13 16:13:33  oetiker
+ * let rrd_graph return the actual value range it picked ...
+ * -- Henrik Stoerner <henrik@hswn.dk>
+ *
+ * Revision 1.8  2004/05/26 22:11:12  oetiker
+ * reduce compiler warnings. Many small fixes. -- Mike Slifcak <slif@bellsouth.net>
+ *
+ * Revision 1.7  2003/11/12 22:14:26  oetiker
+ * allow to pass an open filehandle into rrd_graph as an extra argument
+ *
+ * Revision 1.6  2003/11/11 19:46:21  oetiker
+ * replaced time_value with rrd_time_value as MacOS X introduced a struct of that name in their standard headers
+ *
+ * Revision 1.5  2003/04/25 18:35:08  jake
+ * 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.
+ *
+ * Revision 1.4  2003/04/01 22:52:23  jake
+ * Fix Win32 build. VC++ 6.0 and 7.0 now use the thread-safe code.
+ *
+ * Revision 1.3  2003/02/13 07:05:27  oetiker
+ * Find attached the patch I promised to send to you. Please note that there
+ * are three new source files (src/rrd_is_thread_safe.h, src/rrd_thread_safe.c
+ * and src/rrd_not_thread_safe.c) and the introduction of librrd_th. This
+ * library is identical to librrd, but it contains support code for per-thread
+ * global variables currently used for error information only. This is similar
+ * to how errno per-thread variables are implemented.  librrd_th must be linked
+ * alongside of libpthred
+ *
+ * There is also a new file "THREADS", holding some documentation.
+ *
+ * -- Peter Stamfest <peter@stamfest.at>
+ *
  * Revision 1.2  2002/05/07 21:58:32  oetiker
  * new command rrdtool xport integrated
  * --  Wolfgang Schrimm <Wolfgang.Schrimm@urz.uni-heidelberg.de>
@@ -21,6 +53,7 @@ extern "C" {
 #define _RRDLIB_H
 
 #include <time.h>
+#include <stdio.h> /* for FILE */
 
 /* Transplanted from rrd_format.h */
 typedef double       rrd_value_t;         /* the data storage type is
@@ -30,18 +63,31 @@ typedef double       rrd_value_t;         /* the data storage type is
 /* main function blocks */
 int    rrd_create(int, char **);
 int    rrd_update(int, char **);
-int    rrd_graph(int, char **, char ***, int *, int *);
+int    rrd_graph(int, char **, char ***, int *, int *, FILE *, double *, double *);
 int    rrd_fetch(int, char **, time_t *, time_t *, unsigned long *,
                 unsigned long *, char ***, rrd_value_t **);
 int    rrd_restore(int, char **);
 int    rrd_dump(int, char **);
 int    rrd_tune(int, char **);
 time_t rrd_last(int, char **);
+time_t rrd_first(int, char **);
 int    rrd_resize(int, char **);
 int    rrd_xport(int, char **, int *, time_t *, time_t *,
                 unsigned long *, unsigned long *,
                 char ***, rrd_value_t **);
 
+/* thread-safe (hopefully) */
+int    rrd_create_r(char *filename,
+                   unsigned long pdp_step, time_t last_up,
+                   int argc, char **argv);
+/* NOTE: rrd_update_r are only thread-safe if no at-style time
+   specifications get used!!! */
+int    rrd_update_r(char *filename, char *_template,
+                   int argc, char **argv);
+int    rrd_dump_r(char *filename);
+time_t rrd_last_r(const char *filename);
+time_t rrd_first_r(const char *filename, int rraindex);
+
 /* Transplanted from parsetime.h */
 typedef enum {
         ABSOLUTE_TIME,
@@ -51,22 +97,42 @@ typedef enum {
 
 #define TIME_OK NULL
 
-struct time_value {
+struct rrd_time_value {
   timetype type;
   long offset;
   struct tm tm;
 };
 
-char *parsetime(char *spec, struct time_value *ptv);
+struct rrd_context {
+    int len;
+    int errlen;
+    char *lib_errstr;
+    char *rrd_error;
+};
+
+/* returns the current per-thread rrd_context */
+struct rrd_context *rrd_get_context(void);
+
+char *parsetime(const char *spec, struct rrd_time_value *ptv);
 /* END parsetime.h */
 
-int proc_start_end (struct time_value *,  struct time_value *, time_t *, time_t *);
+int proc_start_end (struct rrd_time_value *,  struct rrd_time_value *, time_t *, time_t *);
 
 /* HELPER FUNCTIONS */
 void rrd_set_error(char *,...);
 void rrd_clear_error(void);
 int  rrd_test_error(void);
 char *rrd_get_error(void);
+
+/** MULTITHREADED HELPER FUNCTIONS */
+struct rrd_context *rrd_new_context(void);
+void   rrd_free_context (struct rrd_context *buf);
+
+/* void   rrd_set_error_r  (struct rrd_context *, char *, ...); */
+/* void   rrd_clear_error_r(struct rrd_context *); */
+/* int    rrd_test_error_r (struct rrd_context *); */
+/* char  *rrd_get_error_r  (struct rrd_context *); */
+
 int  LockRRD(FILE *);
 
 #endif /* _RRDLIB_H */