include/bfile.h

   1 /* $Id: bfile.h,v 1.22 2004-08-04 08:35:23 adam Exp $
   2    Copyright (C) 1995,1996,1997,1998,1999,2000,2001,2002,2003,2004
   3    Index Data Aps
   4
   5 This file is part of the Zebra server.
   6
   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
  10 version.
  11
  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
  15 for more details.
  16
  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
  20 02111-1307, USA.
  21 */
  22
  23 #ifndef BFILE_H
  24 #define BFILE_H
  25
  26 #include <mfile.h>
  27
  28 YAZ_BEGIN_CDECL
  29
  30 #define bf_blocksize(bf) mf_blocksize(bf->mf)
  31
  32 typedef struct BFiles_struct *BFiles;
  33
  34 BFiles bfs_create (const char *spec, const char *base);
  35 void bfs_destroy (BFiles bfiles);
  36
  37 typedef struct BFile_struct
  38 {
  39     MFile mf;
  40     Zebra_lock_rdwr rdwr_lock;
  41     struct CFile_struct *cf;
  42 } *BFile, BFile_struct;
  43
  44 /* bf_close: closes bfile.
  45    returns 0 if successful; non-zero otherwise
  46  */
  47 int bf_close (BFile);
  48
  49 /* bf_open: opens bfile.
  50    opens bfile with name 'name' and with 'block_size' as block size.
  51    returns bfile handle is successful; NULL otherwise
  52  */
  53 BFile bf_open (BFiles bfs, const char *name, int block_size, int wflag);
  54
  55 /* bf_read: reads bytes from bfile 'bf'.
  56    reads 'nbytes' bytes (or whole block if 0) from offset 'offset' from
  57    block 'no'. stores contents in buffer 'buf'.
  58    returns 1 if whole block could be read; 0 otherwise.
  59  */
  60 int bf_read (BFile bf, zint no, int offset, int nbytes, void *buf);
  61
  62 /* bf_write: writes bytes to bfile 'bf'.
  63    writes 'nbytes' bytes (or whole block if 0) at offset 'offset' to
  64    block 'no'. retrieves contents from buffer 'buf'.
  65    returns 0 if successful; non-zero otherwise.
  66  */
  67 int bf_write (BFile bf, zint no, int offset, int nbytes, const void *buf);
  68
  69 /* bf_cache: enables bfile cache if spec is not NULL */
  70 void bf_cache (BFiles bfs, const char *spec);
  71
  72 /* bf_commitExists: returns 1 if commit is pending; 0 otherwise */
  73 int bf_commitExists (BFiles bfs);
  74
  75 /* bf_commitExec: executes commit */
  76 void bf_commitExec (BFiles bfs);
  77
  78 /* bf_commitClean: cleans commit files, etc */
  79 void bf_commitClean (BFiles bfs, const char *spec);
  80
  81 /* bf_reset: delete register and shadow completely */
  82 void bf_reset (BFiles bfs);
  83
  84 YAZ_END_CDECL
  85
  86 #endif