Using zebra_rec_keys for per-record key store
[idzebra-moved-to-github.git] / index / reckeys.h
1 /* $Id: reckeys.h,v 1.1 2005-10-28 09:22:50 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 RECKEYS_H
24 #define RECKEYS_H
25
26 typedef struct zebra_rec_keys_t_ *zebra_rec_keys_t;
27
28 zebra_rec_keys_t zebra_rec_keys_open();
29
30 void zebra_rec_keys_close(zebra_rec_keys_t p);
31
32 void zebra_rec_keys_write(zebra_rec_keys_t keys, 
33                           int reg_type,
34                           const char *str, size_t slen,
35                           const struct it_key *key);
36 void zebra_rec_keys_reset(zebra_rec_keys_t keys);
37
38 int zebra_rec_keys_read(zebra_rec_keys_t keys,
39                         const char **str, size_t *slen,
40                         struct it_key *key);
41 int zebra_rec_keys_rewind(zebra_rec_keys_t keys);
42
43 int zebra_rec_keys_empty(zebra_rec_keys_t keys);
44
45 void zebra_rec_keys_get_buf(zebra_rec_keys_t p, char **buf, size_t *sz);
46
47 void zebra_rec_keys_set_buf(zebra_rec_keys_t p, char *buf, size_t sz,
48                             int owner);
49
50 #endif