regarding #183:

[rrdtool.git] / src / rrd.h

diff --git a/src/rrd.h b/src/rrd.h
index e705c5f..a428370 100644 (file)
--- a/src/rrd.h
+++ b/src/rrd.h
@@ -1,5 +1,5 @@
 /*****************************************************************************
- * RRDtool 1.3rc9  Copyright by Tobi Oetiker, 1997-2008
+ * RRDtool 1.3.2  Copyright by Tobi Oetiker, 1997-2008
  *****************************************************************************
  * rrdlib.h   Public header file for librrd
  *****************************************************************************
@@ -299,39 +299,76 @@ extern    "C" {
 /* int    rrd_test_error_r (rrd_context_t *); */
 /* char  *rrd_get_error_r  (rrd_context_t *); */
 
-/* low level file access */
+/*
+ * The following functions are _internal_ functions needed to read the raw RRD
+ * files. Since they are _internal_ they may change with the file format and
+ * will be replaced with a more general interface in RRDTool 1.4. Don't use
+ * these functions unless you have good reasons to do so. If you do use these
+ * functions you will have to adapt your code for RRDTool 1.4!
+ *
+ * To enable the deprecated functions define `RRD_EXPORT_DEPRECATED' before
+ * including <rrd_test.h>. You have been warned! If you come back to the
+ * RRDTool mailing list and whine about your broken application, you will get
+ * hit with something smelly!
+ */
+#if defined(_RRD_TOOL_H) || defined(RRD_EXPORT_DEPRECATED)
+
+# if defined(_RRD_TOOL_H)
+#  include "rrd_format.h"
+# else
+#  include <rrd_format.h>
+# endif
+
+#if defined(__GNUC__) && defined (RRD_EXPORT_DEPRECATED)
+# define RRD_DEPRECATED __attribute__((deprecated))
+#else
+# define RRD_DEPRECATED          /**/
+#endif
+     void     rrd_free(
+    rrd_t *rrd)
+              RRD_DEPRECATED;
     void      rrd_init(
-    rrd_t *rrd);
-    void      rrd_free(
-    rrd_t *rrd);
+    rrd_t *rrd)
+              RRD_DEPRECATED;
 
     rrd_file_t *rrd_open(
     const char *const file_name,
     rrd_t *rrd,
-    unsigned rdwr);
+    unsigned rdwr)
+              RRD_DEPRECATED;
+
     void      rrd_dontneed(
     rrd_file_t *rrd_file,
-    rrd_t *rrd);
+    rrd_t *rrd)
+              RRD_DEPRECATED;
     int       rrd_close(
-    rrd_file_t *rrd_file);
+    rrd_file_t *rrd_file)
+              RRD_DEPRECATED;
     ssize_t   rrd_read(
     rrd_file_t *rrd_file,
     void *buf,
-    size_t count);
+    size_t count)
+              RRD_DEPRECATED;
     ssize_t   rrd_write(
     rrd_file_t *rrd_file,
     const void *buf,
-    size_t count);
+    size_t count)
+              RRD_DEPRECATED;
     void      rrd_flush(
-    rrd_file_t *rrd_file);
+    rrd_file_t *rrd_file)
+              RRD_DEPRECATED;
     off_t     rrd_seek(
     rrd_file_t *rrd_file,
     off_t off,
-    int whence);
+    int whence)
+              RRD_DEPRECATED;
     off_t     rrd_tell(
-    rrd_file_t *rrd_file);
+    rrd_file_t *rrd_file)
+              RRD_DEPRECATED;
     int       rrd_lock(
-    rrd_file_t *file);
+    rrd_file_t *file)
+              RRD_DEPRECATED;
+#endif                  /* defined(_RRD_TOOL_H) || defined(RRD_EXPORT_DEPRECATED) */
 
 #endif                  /* _RRDLIB_H */