Improve documentation:

[citadel.git] / citadel / database.h

diff --git a/citadel/database.h b/citadel/database.h
index 88129b49d423e4d09ac725fb4b5d5c87f17877f8..e7acb31fbd9b44398a930a4c4a12fa069c1780f0 100644 (file)
--- a/citadel/database.h
+++ b/citadel/database.h
@@ -33,6 +33,8 @@ void *checkpoint_thread(void *arg);
 void cdb_chmod_data(void);
 void cdb_checkpoint(void);
 void check_handles(void *arg);
+void cdb_cull_logs(void);
+
 
 /*
  * Database records beginning with this magic number are assumed to
@@ -52,10 +54,10 @@ struct CtdlCompressHeader {
 };
 
 typedef enum __eCheckType {
-       eCheckExist,
-       eCheckUpdate,
-       eUpdate,
-       eWrite
+       eCheckExist,   /* look up the item, return the timestamp if its there, 0 if not. */
+       eCheckUpdate,  /* if it exists, refresh in db timestamp. return the timstamp if its there, 0 if not. */
+       eUpdate,       /* insert/update the new value, return the old if its there, 0 if not. */
+       eWrite         /* write this to DB, unconditional. */
 }eCheckType;
 
 time_t CheckIfAlreadySeen(const char *Facility,