X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=include%2Fbfile.h;h=af8c209ef2462cb2cababe20ffd45d2b5488e52d;hb=8e5f17591325078343ec4dff4708a12c78863f78;hp=ae8d2f44176ea23fe951201b40c1dbae55cee0c0;hpb=ed679affe3ae7402b38418f6b98fb8744915e19b;p=idzebra-moved-to-github.git

diff --git a/include/bfile.h b/include/bfile.h
index ae8d2f4..af8c209 100644
--- a/include/bfile.h
+++ b/include/bfile.h
@@ -1,51 +1,75 @@
 /*
- * Copyright (C) 1994-1995, Index Data I/S 
+ * Copyright (C) 1994-1999, Index Data
  * All rights reserved.
  * Sebastian Hammer, Adam Dickmeiss
  *
- * $Log: bfile.h,v $
- * Revision 1.9  1995-12-01 11:37:46  adam
- * Cached/commit files implemented as meta-files.
- *
- * Revision 1.8  1995/11/30  08:33:29  adam
- * Started work on commit facility.
- *
- * Revision 1.7  1995/09/04  12:33:35  adam
- * Various cleanup. YAZ util used instead.
- *
- * Revision 1.6  1994/09/14  13:10:35  quinn
- * Small changes
- *
- * Revision 1.5  1994/08/24  08:45:52  quinn
- * Using mfile.
- *
- * Revision 1.4  1994/08/17  15:38:28  adam
- * Include of util.h.
- *
- * Revision 1.3  1994/08/17  14:09:47  quinn
- * Small changes
- *
+ * $Id: bfile.h,v 1.17 1999-05-12 13:08:06 adam Exp $
  */
 
 #ifndef BFILE_H
 #define BFILE_H
 
-#include <alexutil.h>
 #include <mfile.h>
 
+#ifdef __cplusplus
+extern "C" {
+#endif
+
 #define bf_blocksize(bf) mf_blocksize(bf->mf)
 
+typedef struct BFiles_struct *BFiles;
+
+BFiles bfs_create (const char *spec);
+void bfs_destroy (BFiles bfiles);
+
 typedef struct BFile_struct
 {
     MFile mf;
     struct CFile_struct *cf;
 } *BFile, BFile_struct;
 
+/* bf_close: closes bfile.
+   returns 0 if successful; non-zero otherwise 
+ */
 int bf_close (BFile);
-BFile bf_open (const char *name, int block_size, int wflag);
-int bf_read (BFile bf, int no, int offset, int num, void *buf);
-int bf_write (BFile bf, int no, int offset, int num, const void *buf);
-void bf_cache ();
-void bf_commit ();
+
+/* bf_open: opens bfile.
+   opens bfile with name 'name' and with 'block_size' as block size.
+   returns bfile handle is successful; NULL otherwise 
+ */
+BFile bf_open (BFiles bfs, const char *name, int block_size, int wflag);
+
+/* bf_read: reads bytes from bfile 'bf'.
+   reads 'nbytes' bytes (or whole block if 0) from offset 'offset' from
+   block 'no'. stores contents in buffer 'buf'.
+   returns 1 if whole block could be read; 0 otherwise.
+ */
+int bf_read (BFile bf, int no, int offset, int nbytes, void *buf);
+
+/* bf_write: writes bytes to bfile 'bf'.
+   writes 'nbytes' bytes (or whole block if 0) at offset 'offset' to
+   block 'no'. retrieves contents from buffer 'buf'.
+   returns 0 if successful; non-zero otherwise.
+ */
+int bf_write (BFile bf, int no, int offset, int nbytes, const void *buf);
+
+/* bf_cache: enables bfile cache if spec is not NULL */
+void bf_cache (BFiles bfs, const char *spec);
+
+/* bf_lockDir: specifies locking directory for the cache system */
+void bf_lockDir (BFiles bfs, const char *lockDir);
+
+/* bf_commitExists: returns 1 if commit is pending; 0 otherwise */
+int bf_commitExists (BFiles bfs);
+
+/* bf_commitExec: executes commit */
+void bf_commitExec (BFiles bfs);
+
+/* bf_commitClean: cleans commit files, etc */
+void bf_commitClean (BFiles bfs, const char *spec);
+
+#ifdef __cplusplus
+}
+#endif
 
 #endif