* Began (but did not finish) applying GPL3+ declarations to each source file. This...

[citadel.git] / citadel / database.h

diff --git a/citadel/database.h b/citadel/database.h
index 52d00de40e6ea513ddfd6cbaa48f1565ee41efb2..bdf04c7093ecdcabf92facc2e340105485c31a63 100644 (file)
--- a/citadel/database.h
+++ b/citadel/database.h
@@ -1,3 +1,62 @@
-struct cdbdata *cdb_fetch(int cdb, void *key, int keylen);
-int cdb_store(int cdb, void *key, int keylen, void *data, int datalen);
-int cdb_delete(int cdb, void *key, int keylen);
+/* $Id$
+ *
+ * Copyright (c) 1987-2009 by the citadel.org team
+ *
+ *  This program is free software; you can redistribute it and/or modify
+ *  it under the terms of the GNU General Public License as published by
+ *  the Free Software Foundation; either version 3 of the License, or
+ *  (at your option) any later version.
+ *
+ *  This program is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  GNU General Public License for more details.
+ *
+ *  You should have received a copy of the GNU General Public License
+ *  along with this program; if not, write to the Free Software
+ *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+ */
+
+#ifndef DATABASE_H
+#define DATABASE_H
+
+
+void open_databases (void);
+void close_databases (void);
+int cdb_store (int cdb, void *key, int keylen, void *data, int datalen);
+int cdb_delete (int cdb, void *key, int keylen);
+struct cdbdata *cdb_fetch (int cdb, void *key, int keylen);
+void cdb_free (struct cdbdata *cdb);
+void cdb_rewind (int cdb);
+struct cdbdata *cdb_next_item (int cdb);
+void cdb_close_cursor(int cdb);
+void cdb_begin_transaction(void);
+void cdb_end_transaction(void);
+void cdb_allocate_tsd(void);
+void cdb_free_tsd(void);
+void cdb_check_handles(void);
+void cdb_trunc(int cdb);
+void *checkpoint_thread(void *arg);
+void cdb_chmod_data(void);
+void cdb_checkpoint(void);
+void check_handles(void *arg);
+
+/*
+ * Database records beginning with this magic number are assumed to
+ * be compressed.  In the event that a database record actually begins with
+ * this magic number, we *must* compress it whether we want to or not,
+ * because the fetch function will try to uncompress it anyway.
+ * 
+ * (No need to #ifdef this stuff; it compiles ok even if zlib is not present
+ * and doesn't declare anything so it won't bloat the code)
+ */
+#define COMPRESS_MAGIC 0xc0ffeeee
+
+struct CtdlCompressHeader {
+       int magic;
+       size_t uncompressed_len;
+       size_t compressed_len;
+};
+
+#endif /* DATABASE_H */
+