1 /* $Id: bfile.h,v 1.3 2005-01-15 19:38:24 adam Exp $
2 Copyright (C) 1995-2005
5 This file is part of the Zebra server.
7 Zebra is free software; you can redistribute it and/or modify it under
8 the terms of the GNU General Public License as published by the Free
9 Software Foundation; either version 2, or (at your option) any later
12 Zebra is distributed in the hope that it will be useful, but WITHOUT ANY
13 WARRANTY; without even the implied warranty of MERCHANTABILITY or
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
17 You should have received a copy of the GNU General Public License
18 along with Zebra; see the file LICENSE.zebra. If not, write to the
19 Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA
26 #include <yaz/yconfig.h>
27 #include <idzebra/version.h>
31 typedef struct BFiles_struct *BFiles;
32 typedef struct BFile_struct *BFile;
34 BFiles bfs_create (const char *spec, const char *base);
35 void bfs_destroy (BFiles bfiles);
37 /* bf_close: closes bfile.
38 returns 0 if successful; non-zero otherwise
43 /* bf_open: opens bfile.
44 opens bfile with name 'name' and with 'block_size' as block size.
45 returns bfile handle is successful; NULL otherwise
48 BFile bf_open (BFiles bfs, const char *name, int block_size, int wflag);
50 /* bf_read: reads bytes from bfile 'bf'.
51 reads 'nbytes' bytes (or whole block if 0) from offset 'offset' from
52 block 'no'. stores contents in buffer 'buf'.
53 returns 1 if whole block could be read; 0 otherwise.
56 int bf_read (BFile bf, zint no, int offset, int nbytes, void *buf);
58 /* bf_write: writes bytes to bfile 'bf'.
59 writes 'nbytes' bytes (or whole block if 0) at offset 'offset' to
60 block 'no'. retrieves contents from buffer 'buf'.
61 returns 0 if successful; non-zero otherwise.
64 int bf_write (BFile bf, zint no, int offset, int nbytes, const void *buf);
66 /* bf_cache: enables bfile cache if spec is not NULL */
68 void bf_cache (BFiles bfs, const char *spec);
70 /* bf_commitExists: returns 1 if commit is pending; 0 otherwise */
72 int bf_commitExists (BFiles bfs);
74 /* bf_commitExec: executes commit */
76 void bf_commitExec (BFiles bfs);
78 /* bf_commitClean: cleans commit files, etc */
80 void bf_commitClean (BFiles bfs, const char *spec);
82 /* bf_reset: delete register and shadow completely */
84 void bf_reset (BFiles bfs);