2 * Copyright (c) 1995, Index Data.
4 * Permission to use, copy, modify, distribute, and sell this software and
5 * its documentation, in whole or in part, for any purpose, is hereby granted,
8 * 1. This copyright and permission notice appear in all copies of the
9 * software and its documentation. Notices of copyright or attribution
10 * which appear at the beginning of any file must remain unchanged.
12 * 2. The name of Index Data or the individual authors may not be used to
13 * endorse or promote products derived from this software without specific
14 * prior written permission.
16 * THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT WARRANTY OF ANY KIND,
17 * EXPRESS, IMPLIED, OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY
18 * WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
19 * IN NO EVENT SHALL INDEX DATA BE LIABLE FOR ANY SPECIAL, INCIDENTAL,
20 * INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, OR ANY DAMAGES
21 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER OR
22 * NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF
23 * LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
34 typedef struct bend_initrequest
37 Z_IdAuthentication *auth;
40 typedef struct bend_initresult
42 int errcode; /* 0==OK */
43 char *errstring; /* system error string or NULL */
44 void *handle; /* private handle to the backend module */
47 bend_initresult *bend_init(bend_initrequest *r);
49 typedef struct bend_searchrequest
51 char *setname; /* name to give to this set */
52 int replace_set; /* replace set, if it already exists */
53 int num_bases; /* number of databases in list */
54 char **basenames; /* databases to search */
55 Z_Query *query; /* query structure */
58 typedef struct bend_searchresult
60 int hits; /* number of hits */
61 int errcode; /* 0==OK */
62 char *errstring; /* system error string or NULL */
65 bend_searchresult *bend_search(void *handle, bend_searchrequest *r, int *fd);
66 bend_searchresult *bend_searchresponse(void *handle);
68 typedef struct bend_fetchrequest
70 char *setname; /* set name */
71 int number; /* record number */
72 oid_value format; /* One of the CLASS_RECSYN members */
75 typedef struct bend_fetchresult
77 char *basename; /* name of database that provided record */
78 int len; /* length of record */
79 char *record; /* record */
80 int last_in_set; /* is it? */
81 oid_value format; /* format */
82 int errcode; /* 0==success */
83 char *errstring; /* system error string or NULL */
86 bend_fetchresult *bend_fetch(void *handle, bend_fetchrequest *r, int *fd);
87 bend_fetchresult *bend_fetchresponse(void *handle);
89 typedef struct bend_scanrequest
91 int num_bases; /* number of elements in databaselist */
92 char **basenames; /* databases to search */
93 Z_AttributesPlusTerm *term;
94 int term_position; /* desired index of term in result list */
95 int num_entries; /* number of entries requested */
98 typedef struct bend_scanresult
109 BEND_SCAN_SUCCESS, /* ok */
110 BEND_SCAN_PARTIAL /* not all entries could be found */
116 bend_scanresult *bend_scan(void *handle, bend_scanrequest *r, int *fd);
117 bend_scanresult *bend_scanresponse(void *handle);
119 typedef struct bend_deleterequest
122 } bend_deleterequest;
124 typedef struct bend_deleteresult
126 int errcode; /* 0==success */
127 char *errstring; /* system error string or NULL */
130 bend_deleteresult *bend_delete(void *handle, bend_deleterequest *r, int *fd);
131 bend_deleteresult *bend_deleteresponse(void *handle);
133 void bend_close(void *handle);