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.27 1999-10-11 10:01:24 adam
28 * Implemented bend_sort_rr handler for frontend server.
30 * Revision 1.26 1999/06/17 10:54:44 adam
31 * Added facility to specify implementation version - and name
34 * Revision 1.25 1999/06/01 14:29:12 adam
35 * Work on Extended Services.
37 * Revision 1.24 1999/03/31 11:18:24 adam
38 * Implemented odr_strdup. Added Reference ID to backend server API.
40 * Revision 1.23 1998/10/13 16:12:23 adam
41 * Added support for Surrogate Diagnostics for Scan Term entries.
43 * Revision 1.22 1998/09/02 12:41:51 adam
44 * Added decode stream in bend search structures.
46 * Revision 1.21 1998/07/20 12:38:41 adam
47 * Implemented delete result set service to server API.
49 * Revision 1.20 1998/05/27 16:57:06 adam
50 * Support for surrogate diagnostic records added for bend_fetch.
52 * Revision 1.19 1998/03/31 11:07:45 adam
53 * Furhter work on UNIverse resource report.
54 * Added Extended Services handling in frontend server.
56 * Revision 1.18 1998/02/10 11:03:56 adam
57 * Added support for extended handlers in backend server interface.
59 * Revision 1.17 1998/01/29 13:15:35 adam
60 * Implemented sort for the backend interface.
62 * Revision 1.16 1997/09/17 12:10:31 adam
78 typedef struct request *bend_request;
79 typedef struct association *bend_association;
81 /* old search request input */
84 char *setname; /* name to give to this set */
85 int replace_set; /* replace set, if it already exists */
86 int num_bases; /* number of databases in list */
87 char **basenames; /* databases to search */
88 Z_ReferenceId *referenceId;/* reference ID */
89 Z_Query *query; /* query structure */
90 ODR stream; /* encoding stream */
91 ODR decode; /* decoding stream */
94 /* old search request output */
97 int hits; /* number of hits */
98 int errcode; /* 0==OK */
99 char *errstring; /* system error string or NULL */
102 /* extended search handler (rr = request response) */
104 char *setname; /* name to give to this set */
105 int replace_set; /* replace set, if it already exists */
106 int num_bases; /* number of databases in list */
107 char **basenames; /* databases to search */
108 Z_ReferenceId *referenceId;/* reference ID */
109 Z_Query *query; /* query structure */
110 ODR stream; /* encode stream */
111 ODR decode; /* decode stream */
113 bend_request request;
114 bend_association association;
116 int hits; /* number of hits */
117 int errcode; /* 0==OK */
118 char *errstring; /* system error string or NULL */
121 /* extended present handler. Does not replace bend_fetch. */
123 char *setname; /* set name */
125 int number; /* record number */
126 oid_value format; /* One of the CLASS_RECSYN members */
127 Z_ReferenceId *referenceId;/* reference ID */
128 Z_RecordComposition *comp; /* Formatting instructions */
129 ODR stream; /* encoding stream - memory source if required */
130 bend_request request;
131 bend_association association;
133 int hits; /* number of hits */
134 int errcode; /* 0==OK */
135 char *errstring; /* system error string or NULL */
138 YAZ_EXPORT bend_searchresult *bend_search(void *handle, bend_searchrequest *r,
140 YAZ_EXPORT int bend_searchresponse(void *handle, bend_search_rr *bsrr);
144 char *setname; /* set name */
145 int number; /* record number */
146 Z_ReferenceId *referenceId;/* reference ID */
147 oid_value format; /* One of the CLASS_RECSYN members */
148 Z_RecordComposition *comp; /* Formatting instructions */
149 ODR stream; /* encoding stream - memory source if req */
150 int surrogate_flag; /* surrogate diagnostic flag (rw) */
155 char *basename; /* name of database that provided record */
156 int len; /* length of record or -1 if structured */
157 char *record; /* record */
158 int last_in_set; /* is it? */
159 oid_value format; /* format */
160 int errcode; /* 0==success */
161 char *errstring; /* system error string or NULL */
164 YAZ_EXPORT bend_fetchresult *bend_fetch(void *handle, bend_fetchrequest *r,
166 YAZ_EXPORT bend_fetchresult *bend_fetchresponse(void *handle);
170 int num_bases; /* number of elements in databaselist */
171 char **basenames; /* databases to search */
172 oid_value attributeset;
173 Z_ReferenceId *referenceId; /* reference ID */
174 Z_AttributesPlusTerm *term;
175 int term_position; /* desired index of term in result list */
176 int num_entries; /* number of entries requested */
177 ODR stream; /* encoding stream - memory source if required */
181 char *term; /* the returned scan term */
182 int occurrences; /* no of occurrences or -1 if error (see below) */
183 int errcode; /* Bib-1 diagnostic code; only used when occur.= -1 */
184 char *errstring; /* Additional string */
188 BEND_SCAN_SUCCESS, /* ok */
189 BEND_SCAN_PARTIAL /* not all entries could be found */
192 typedef struct bend_scanresult
195 struct scan_entry *entries;
197 bend_scan_status status;
202 typedef struct bend_scan_rr {
203 int num_bases; /* number of elements in databaselist */
204 char **basenames; /* databases to search */
205 oid_value attributeset;
206 Z_ReferenceId *referenceId; /* reference ID */
207 Z_AttributesPlusTerm *term;
208 ODR stream; /* encoding stream - memory source if required */
210 int term_position; /* desired index of term in result list/returned */
211 int num_entries; /* number of entries requested/returned */
213 struct scan_entry *entries;
214 bend_scan_status status;
219 YAZ_EXPORT bend_scanresult *bend_scan(void *handle, bend_scanrequest *r,
221 YAZ_EXPORT bend_scanresult *bend_scanresponse(void *handle);
224 typedef struct bend_delete_rr {
228 Z_ReferenceId *referenceId;
234 YAZ_EXPORT void bend_close(void *handle);
237 typedef struct bend_sort_rr
239 int num_input_setnames;
240 char **input_setnames;
241 char *output_setname;
242 Z_SortKeySpecList *sort_sequence;
244 Z_ReferenceId *referenceId;/* reference ID */
251 /* extended services handler. Added in from DALI */
252 typedef struct bend_esrequest_rr
255 Z_ExtendedServicesRequest *esr;
257 ODR stream; /* encoding stream */
258 Z_ReferenceId *referenceId;/* reference ID */
259 bend_request request;
260 bend_association association;
261 int errcode; /* 0==success, -1==accepted, >0 = failure */
262 char *errstring; /* system error string or NULL */
265 typedef struct bend_initrequest
268 Z_IdAuthentication *auth;
269 ODR stream; /* encoding stream */
270 Z_ReferenceId *referenceId;/* reference ID */
272 char *implementation_name;
273 char *implementation_version;
274 int (*bend_sort) (void *handle, bend_sort_rr *rr);
275 int (*bend_search) (void *handle, bend_search_rr *rr);
276 int (*bend_present) (void *handle, bend_present_rr *rr);
277 int (*bend_esrequest) (void *handle, bend_esrequest_rr *rr);
278 int (*bend_delete)(void *handle, bend_delete_rr *rr);
279 int (*bend_scan)(void *handle, bend_scan_rr *rr);
282 typedef struct bend_initresult
284 int errcode; /* 0==OK */
285 char *errstring; /* system error string or NULL */
286 void *handle; /* private handle to the backend module */
289 YAZ_EXPORT bend_initresult *bend_init(bend_initrequest *r);
291 YAZ_EXPORT void bend_request_send (bend_association a, bend_request req,
294 YAZ_EXPORT bend_request bend_request_mk (bend_association a);
296 YAZ_EXPORT void bend_request_destroy (bend_request *req);
298 YAZ_EXPORT Z_ReferenceId *bend_request_getid (ODR odr, bend_request req);
299 YAZ_EXPORT int bend_backend_respond (bend_association a, bend_request req);
300 YAZ_EXPORT void bend_request_setdata(bend_request r, void *p);
301 YAZ_EXPORT void *bend_request_getdata(bend_request r);