2 * Copyright (c) 1995-1999, 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
27 * Revision 1.24 1999-03-31 11:18:24 adam
28 * Implemented odr_strdup. Added Reference ID to backend server API.
30 * Revision 1.23 1998/10/13 16:12:23 adam
31 * Added support for Surrogate Diagnostics for Scan Term entries.
33 * Revision 1.22 1998/09/02 12:41:51 adam
34 * Added decode stream in bend search structures.
36 * Revision 1.21 1998/07/20 12:38:41 adam
37 * Implemented delete result set service to server API.
39 * Revision 1.20 1998/05/27 16:57:06 adam
40 * Support for surrogate diagnostic records added for bend_fetch.
42 * Revision 1.19 1998/03/31 11:07:45 adam
43 * Furhter work on UNIverse resource report.
44 * Added Extended Services handling in frontend server.
46 * Revision 1.18 1998/02/10 11:03:56 adam
47 * Added support for extended handlers in backend server interface.
49 * Revision 1.17 1998/01/29 13:15:35 adam
50 * Implemented sort for the backend interface.
52 * Revision 1.16 1997/09/17 12:10:31 adam
68 typedef struct request *bend_request;
69 typedef struct association *bend_association;
71 /* old search request input */
74 char *setname; /* name to give to this set */
75 int replace_set; /* replace set, if it already exists */
76 int num_bases; /* number of databases in list */
77 char **basenames; /* databases to search */
78 Z_ReferenceId *referenceId;/* reference ID */
79 Z_Query *query; /* query structure */
80 ODR stream; /* encoding stream */
81 ODR decode; /* decoding stream */
84 /* old search request output */
87 int hits; /* number of hits */
88 int errcode; /* 0==OK */
89 char *errstring; /* system error string or NULL */
92 /* extended search handler (rr = request response) */
94 char *setname; /* name to give to this set */
95 int replace_set; /* replace set, if it already exists */
96 int num_bases; /* number of databases in list */
97 char **basenames; /* databases to search */
98 Z_ReferenceId *referenceId;/* reference ID */
99 Z_Query *query; /* query structure */
100 ODR stream; /* encode stream */
101 ODR decode; /* decode stream */
103 bend_request request;
104 bend_association association;
106 int hits; /* number of hits */
107 int errcode; /* 0==OK */
108 char *errstring; /* system error string or NULL */
111 /* extended present handler. Does not replace bend_fetch. */
113 char *setname; /* set name */
115 int number; /* record number */
116 oid_value format; /* One of the CLASS_RECSYN members */
117 Z_ReferenceId *referenceId;/* reference ID */
118 Z_RecordComposition *comp; /* Formatting instructions */
119 ODR stream; /* encoding stream - memory source if required */
120 bend_request request;
121 bend_association association;
123 int hits; /* number of hits */
124 int errcode; /* 0==OK */
125 char *errstring; /* system error string or NULL */
128 YAZ_EXPORT bend_searchresult *bend_search(void *handle, bend_searchrequest *r,
130 YAZ_EXPORT int bend_searchresponse(void *handle, bend_search_rr *bsrr);
134 char *setname; /* set name */
135 int number; /* record number */
136 Z_ReferenceId *referenceId;/* reference ID */
137 oid_value format; /* One of the CLASS_RECSYN members */
138 Z_RecordComposition *comp; /* Formatting instructions */
139 ODR stream; /* encoding stream - memory source if req */
140 int surrogate_flag; /* surrogate diagnostic flag (rw) */
145 char *basename; /* name of database that provided record */
146 int len; /* length of record or -1 if structured */
147 char *record; /* record */
148 int last_in_set; /* is it? */
149 oid_value format; /* format */
150 int errcode; /* 0==success */
151 char *errstring; /* system error string or NULL */
154 YAZ_EXPORT bend_fetchresult *bend_fetch(void *handle, bend_fetchrequest *r,
156 YAZ_EXPORT bend_fetchresult *bend_fetchresponse(void *handle);
160 int num_bases; /* number of elements in databaselist */
161 char **basenames; /* databases to search */
162 oid_value attributeset;
163 Z_ReferenceId *referenceId; /* reference ID */
164 Z_AttributesPlusTerm *term;
165 int term_position; /* desired index of term in result list */
166 int num_entries; /* number of entries requested */
167 ODR stream; /* encoding stream - memory source if required */
171 char *term; /* the returned scan term */
172 int occurrences; /* no of occurrences or -1 if error (see below) */
173 int errcode; /* Bib-1 diagnostic code; only used when occur.= -1 */
174 char *errstring; /* Additional string */
178 BEND_SCAN_SUCCESS, /* ok */
179 BEND_SCAN_PARTIAL /* not all entries could be found */
182 typedef struct bend_scanresult
185 struct scan_entry *entries;
187 bend_scan_status status;
192 YAZ_EXPORT bend_scanresult *bend_scan(void *handle, bend_scanrequest *r,
194 YAZ_EXPORT bend_scanresult *bend_scanresponse(void *handle);
197 typedef struct bend_delete_rr {
201 Z_ReferenceId *referenceId;
207 YAZ_EXPORT void bend_close(void *handle);
210 typedef struct bend_sort_rr
212 int num_input_setnames;
213 char **input_setnames;
214 char *output_setname;
215 Z_SortKeySpecList *sort_sequence;
217 Z_ReferenceId *referenceId;/* reference ID */
224 /* extended services handler. Added in from DALI */
225 typedef struct bend_esrequest_rr
228 Z_ExtendedServicesRequest *esr;
230 ODR stream; /* encoding stream */
231 Z_ReferenceId *referenceId;/* reference ID */
232 bend_request request;
233 bend_association association;
234 int errcode; /* 0==success */
235 char *errstring; /* system error string or NULL */
238 typedef struct bend_initrequest
241 Z_IdAuthentication *auth;
242 ODR stream; /* encoding stream */
243 Z_ReferenceId *referenceId;/* reference ID */
245 int (*bend_sort) (void *handle, bend_sort_rr *rr);
246 int (*bend_search) (void *handle, bend_search_rr *rr);
247 int (*bend_present) (void *handle, bend_present_rr *rr);
248 int (*bend_esrequest) (void *handle, bend_esrequest_rr *rr);
249 int (*bend_delete)(void *handle, bend_delete_rr *rr);
252 typedef struct bend_initresult
254 int errcode; /* 0==OK */
255 char *errstring; /* system error string or NULL */
256 void *handle; /* private handle to the backend module */
259 YAZ_EXPORT bend_initresult *bend_init(bend_initrequest *r);
261 YAZ_EXPORT void bend_request_send (bend_association a, bend_request req,
264 YAZ_EXPORT bend_request bend_request_mk (bend_association a);
266 YAZ_EXPORT void bend_request_destroy (bend_request *req);
268 YAZ_EXPORT Z_ReferenceId *bend_request_getid (ODR odr, bend_request req);
269 YAZ_EXPORT int bend_backend_respond (bend_association a, bend_request req);
270 YAZ_EXPORT void bend_request_setdata(bend_request r, void *p);
271 YAZ_EXPORT void *bend_request_getdata(bend_request r);