Moved file locking utilities from index/lockutil.c to util/flock.c
[idzebra-moved-to-github.git] / include / idzebra / isamb.h
1 /* $Id: isamb.h,v 1.5 2005-04-13 13:03:47 adam Exp $
2    Copyright (C) 1995-2005
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 ISAMB_H
24 #define ISAMB_H
25
26 #include <idzebra/bfile.h>
27 #include <idzebra/isamc.h>
28
29 YAZ_BEGIN_CDECL
30
31 typedef struct ISAMB_s *ISAMB;
32 typedef struct ISAMB_PP_s *ISAMB_PP;
33
34 YAZ_EXPORT
35 ISAMB isamb_open(BFiles bfs, const char *name, int writeflag, ISAMC_M *method,
36                   int cache);
37
38 YAZ_EXPORT
39 void isamb_close(ISAMB isamb);
40
41 YAZ_EXPORT 
42 void isamb_merge(ISAMB b, ISAM_P *pos, ISAMC_I *data);
43
44 YAZ_EXPORT
45 ISAMB_PP isamb_pp_open(ISAMB isamb, ISAM_P pos, int scope);
46
47 YAZ_EXPORT
48 int isamb_pp_read(ISAMB_PP pp, void *buf);
49
50 YAZ_EXPORT
51 int isamb_pp_forward(ISAMB_PP pp, void *buf, const void *untilbuf);
52 YAZ_EXPORT
53 int isamb_pp_forward2(ISAMB_PP pp, void *buf, const void *untilbuf);
54
55 YAZ_EXPORT
56 void isamb_pp_pos(ISAMB_PP pp, double *current, double *total);
57
58 YAZ_EXPORT
59 void isamb_pp_close(ISAMB_PP pp);
60
61 YAZ_EXPORT
62 int isamb_unlink(ISAMB b, ISAM_P pos);
63
64 YAZ_EXPORT
65 ISAMB_PP isamb_pp_open_x(ISAMB isamb, ISAM_P pos, int *level, int scope);
66 YAZ_EXPORT
67 void isamb_pp_close_x(ISAMB_PP pp, zint *size, zint *blocks);
68
69 YAZ_EXPORT
70 int isamb_block_info(ISAMB isamb, int cat);
71
72 YAZ_EXPORT
73 void isamb_dump(ISAMB b, ISAM_P pos, void (*pr)(const char *str));
74
75 YAZ_END_CDECL
76
77 #endif