6966eb5d161a3681f45533f65e9cd8b2b9f296cb
[yaz-moved-to-github.git] / include / backend.h
1 #ifndef BACKEND_H
2 #define BACKEND_H
3
4 #include <proto.h>
5
6 typedef struct bend_initrequest
7 {
8     char *configname;
9 } bend_initrequest;
10
11 typedef struct bend_initresult
12 {
13     int errcode;               /* 0==OK */
14     char *errstring;           /* system error string or NULL */
15     void *handle;              /* private handle to the backend module */
16 } bend_initresult;
17
18 typedef struct bend_searchrequest
19 {
20     char *setname;             /* name to give to this set */
21     int replace_set;           /* replace set, if it already exists */
22     int num_bases;             /* number of databases in list */
23     char **basenames;          /* databases to search */
24     Z_Query *query;            /* query structure */
25 } bend_searchrequest;
26
27 typedef struct bend_searchresult
28 {
29     int hits;                  /* number of hits */
30     int errcode;               /* 0==OK */
31     char *errstring;           /* system error string or NULL */
32 } bend_searchresult;
33
34 typedef struct bend_fetchrequest
35 {
36     char *setname;             /* set name */
37     int number;                /* record number */
38 } bend_fetchrequest;
39
40 typedef struct bend_fetchresult
41 {
42     char *basename;            /* name of database that provided record */
43     int len;                   /* length of record */
44     char *record;              /* record */
45     int last_in_set;           /* is it?  */
46     int errcode;               /* 0==success */
47     char *errstring;           /* system error string or NULL */
48 } bend_fetchresult;
49
50 typedef struct bend_deleterequest
51 {
52     char *setname;
53 } bend_deleterequest;
54
55 typedef struct bend_deleteresult
56 {
57     int errcode;               /* 0==success */
58     char *errstring;           /* system error string or NULL */
59 } bend_deleteresult;
60
61 bend_initresult *bend_init(bend_initrequest *r);
62
63 bend_searchresult *bend_search(void *handle, bend_searchrequest *r, int *fd);
64 bend_searchresult *bend_searchresponse(void *handle);
65
66 bend_fetchresult *bend_fetch(void *handle, bend_fetchrequest *r, int *fd);
67 bend_fetchresult *bend_fetchresponse(void *handle);
68
69 bend_deleteresult *bend_delete(void *handle, bend_deleterequest *r, int *fd);
70 bend_deleteresult *bend_deleteresponse(void *handle);
71
72 void bend_close(void *handle);
73
74 #endif