include/yaz/backend.h

   1 /*
   2  * Copyright (c) 1995-1999, Index Data.
   3  *
   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,
   6  * provided that:
   7  *
   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.
  11  *
  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.
  15  *
  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
  24  * OF THIS SOFTWARE.
  25  *
  26  * $Log: backend.h,v $
  27  * Revision 1.1  1999-11-30 13:47:11  adam
  28  * Improved installation. Moved header files to include/yaz.
  29  *
  30  * Revision 1.28  1999/11/04 14:58:44  adam
  31  * Added status elements for backend delete result set handler.
  32  * Updated delete result result set command for client.
  33  *
  34  * Revision 1.27  1999/10/11 10:01:24  adam
  35  * Implemented bend_sort_rr handler for frontend server.
  36  *
  37  * Revision 1.26  1999/06/17 10:54:44  adam
  38  * Added facility to specify implementation version - and name
  39  * for server.
  40  *
  41  * Revision 1.25  1999/06/01 14:29:12  adam
  42  * Work on Extended Services.
  43  *
  44  * Revision 1.24  1999/03/31 11:18:24  adam
  45  * Implemented odr_strdup. Added Reference ID to backend server API.
  46  *
  47  * Revision 1.23  1998/10/13 16:12:23  adam
  48  * Added support for Surrogate Diagnostics for Scan Term entries.
  49  *
  50  * Revision 1.22  1998/09/02 12:41:51  adam
  51  * Added decode stream in bend search structures.
  52  *
  53  * Revision 1.21  1998/07/20 12:38:41  adam
  54  * Implemented delete result set service to server API.
  55  *
  56  * Revision 1.20  1998/05/27 16:57:06  adam
  57  * Support for surrogate diagnostic records added for bend_fetch.
  58  *
  59  * Revision 1.19  1998/03/31 11:07:45  adam
  60  * Furhter work on UNIverse resource report.
  61  * Added Extended Services handling in frontend server.
  62  *
  63  * Revision 1.18  1998/02/10 11:03:56  adam
  64  * Added support for extended handlers in backend server interface.
  65  *
  66  * Revision 1.17  1998/01/29 13:15:35  adam
  67  * Implemented sort for the backend interface.
  68  *
  69  * Revision 1.16  1997/09/17 12:10:31  adam
  70  * YAZ version 1.4.
  71  *
  72  */
  73
  74 #ifndef BACKEND_H
  75 #define BACKEND_H
  76
  77 #include <yaz/yconfig.h>
  78 #include <yaz/proto.h>
  79 #include <yaz/statserv.h>
  80
  81 #ifdef __cplusplus
  82 extern "C" {
  83 #endif
  84
  85 typedef struct request *bend_request;
  86 typedef struct association *bend_association;
  87
  88 /* old search request input */
  89 typedef struct
  90 {
  91     char *setname;             /* name to give to this set */
  92     int replace_set;           /* replace set, if it already exists */
  93     int num_bases;             /* number of databases in list */
  94     char **basenames;          /* databases to search */
  95     Z_ReferenceId *referenceId;/* reference ID */
  96     Z_Query *query;            /* query structure */
  97     ODR stream;                /* encoding stream */
  98     ODR decode;                /* decoding stream */
  99 } bend_searchrequest;
 100
 101 /* old search request output */
 102 typedef struct
 103 {
 104     int hits;                  /* number of hits */
 105     int errcode;               /* 0==OK */
 106     char *errstring;           /* system error string or NULL */
 107 } bend_searchresult;
 108
 109 /* extended search handler (rr = request response) */
 110 typedef struct {
 111     char *setname;             /* name to give to this set */
 112     int replace_set;           /* replace set, if it already exists */
 113     int num_bases;             /* number of databases in list */
 114     char **basenames;          /* databases to search */
 115     Z_ReferenceId *referenceId;/* reference ID */
 116     Z_Query *query;            /* query structure */
 117     ODR stream;                /* encode stream */
 118     ODR decode;                /* decode stream */
 119
 120     bend_request request;
 121     bend_association association;
 122     int *fd;
 123     int hits;                  /* number of hits */
 124     int errcode;               /* 0==OK */
 125     char *errstring;           /* system error string or NULL */
 126 } bend_search_rr;
 127
 128 /* extended present handler. Does not replace bend_fetch. */
 129 typedef struct {
 130     char *setname;             /* set name */
 131     int start;
 132     int number;                /* record number */
 133     oid_value format;          /* One of the CLASS_RECSYN members */
 134     Z_ReferenceId *referenceId;/* reference ID */
 135     Z_RecordComposition *comp; /* Formatting instructions */
 136     ODR stream;                /* encoding stream - memory source if required */
 137     bend_request request;
 138     bend_association association;
 139
 140     int hits;                  /* number of hits */
 141     int errcode;               /* 0==OK */
 142     char *errstring;           /* system error string or NULL */
 143 } bend_present_rr;
 144
 145 YAZ_EXPORT bend_searchresult *bend_search(void *handle, bend_searchrequest *r,
 146                                           int *fd);
 147 YAZ_EXPORT int bend_searchresponse(void *handle, bend_search_rr *bsrr);
 148
 149 typedef struct
 150 {
 151     char *setname;             /* set name */
 152     int number;                /* record number */
 153     Z_ReferenceId *referenceId;/* reference ID */
 154     oid_value format;          /* One of the CLASS_RECSYN members */
 155     Z_RecordComposition *comp; /* Formatting instructions */
 156     ODR stream;                /* encoding stream - memory source if req */
 157     int surrogate_flag;        /* surrogate diagnostic flag (rw) */
 158 } bend_fetchrequest;
 159
 160 typedef struct
 161 {
 162     char *basename;            /* name of database that provided record */
 163     int len;                   /* length of record or -1 if structured */
 164     char *record;              /* record */
 165     int last_in_set;           /* is it?  */
 166     oid_value format;          /* format */
 167     int errcode;               /* 0==success */
 168     char *errstring;           /* system error string or NULL */
 169 } bend_fetchresult;
 170
 171 YAZ_EXPORT bend_fetchresult *bend_fetch(void *handle, bend_fetchrequest *r,
 172                                         int *fd);
 173 YAZ_EXPORT bend_fetchresult *bend_fetchresponse(void *handle);
 174
 175 typedef struct
 176 {
 177     int num_bases;      /* number of elements in databaselist */
 178     char **basenames;   /* databases to search */
 179     oid_value attributeset;
 180     Z_ReferenceId *referenceId; /* reference ID */
 181     Z_AttributesPlusTerm *term;
 182     int term_position;  /* desired index of term in result list */
 183     int num_entries;    /* number of entries requested */
 184     ODR stream;         /* encoding stream - memory source if required */
 185 } bend_scanrequest;
 186
 187 struct scan_entry {
 188     char *term;         /* the returned scan term */
 189     int occurrences;    /* no of occurrences or -1 if error (see below) */
 190     int errcode;        /* Bib-1 diagnostic code; only used when occur.= -1 */
 191     char *errstring;    /* Additional string */
 192 };
 193
 194 typedef enum {
 195     BEND_SCAN_SUCCESS,  /* ok */
 196     BEND_SCAN_PARTIAL   /* not all entries could be found */
 197 } bend_scan_status;
 198
 199 typedef struct bend_scanresult
 200 {
 201     int num_entries;
 202     struct scan_entry *entries;
 203     int term_position;
 204     bend_scan_status status;
 205     int errcode;
 206     char *errstring;
 207 } bend_scanresult;
 208
 209 typedef struct bend_scan_rr {
 210     int num_bases;      /* number of elements in databaselist */
 211     char **basenames;   /* databases to search */
 212     oid_value attributeset;
 213     Z_ReferenceId *referenceId; /* reference ID */
 214     Z_AttributesPlusTerm *term;
 215     ODR stream;         /* encoding stream - memory source if required */
 216
 217     int term_position;  /* desired index of term in result list/returned */
 218     int num_entries;    /* number of entries requested/returned */
 219
 220     struct scan_entry *entries;
 221     bend_scan_status status;
 222     int errcode;
 223     char *errstring;
 224 } bend_scan_rr;
 225
 226 YAZ_EXPORT bend_scanresult *bend_scan(void *handle, bend_scanrequest *r,
 227                                       int *fd);
 228 YAZ_EXPORT bend_scanresult *bend_scanresponse(void *handle);
 229
 230 /* delete handler */
 231 typedef struct bend_delete_rr {
 232     int function;
 233     int num_setnames;
 234     char **setnames;
 235     Z_ReferenceId *referenceId;
 236     int delete_status;      /* status for the whole operation */
 237     int *statuses;          /* status each set - indexed as setnames */
 238     ODR stream;
 239 } bend_delete_rr;
 240
 241 /* close handler */
 242 YAZ_EXPORT void bend_close(void *handle);
 243
 244 /* sort handler */
 245 typedef struct bend_sort_rr
 246 {
 247     int num_input_setnames;
 248     char **input_setnames;
 249     char *output_setname;
 250     Z_SortKeySpecList *sort_sequence;
 251     ODR stream;
 252     Z_ReferenceId *referenceId;/* reference ID */
 253
 254     int sort_status;
 255     int errcode;
 256     char *errstring;
 257 } bend_sort_rr;
 258
 259 /* extended services handler. Added in from DALI */
 260 typedef struct bend_esrequest_rr
 261 {
 262     int ItemNo;
 263     Z_ExtendedServicesRequest *esr;
 264
 265     ODR stream;                /* encoding stream */
 266     Z_ReferenceId *referenceId;/* reference ID */
 267     bend_request request;
 268     bend_association association;
 269     int errcode;               /* 0==success, -1==accepted, >0 = failure */
 270     char *errstring;           /* system error string or NULL */
 271 } bend_esrequest_rr;
 272
 273 typedef struct bend_initrequest
 274 {
 275     char *configname;
 276     Z_IdAuthentication *auth;
 277     ODR stream;                /* encoding stream */
 278     Z_ReferenceId *referenceId;/* reference ID */
 279
 280     char *implementation_name;
 281     char *implementation_version;
 282     int (*bend_sort) (void *handle, bend_sort_rr *rr);
 283     int (*bend_search) (void *handle, bend_search_rr *rr);
 284     int (*bend_present) (void *handle, bend_present_rr *rr);
 285     int (*bend_esrequest) (void *handle, bend_esrequest_rr *rr);
 286     int (*bend_delete)(void *handle, bend_delete_rr *rr);
 287     int (*bend_scan)(void *handle, bend_scan_rr *rr);
 288 } bend_initrequest;
 289
 290 typedef struct bend_initresult
 291 {
 292     int errcode;               /* 0==OK */
 293     char *errstring;           /* system error string or NULL */
 294     void *handle;              /* private handle to the backend module */
 295 } bend_initresult;
 296
 297 YAZ_EXPORT bend_initresult *bend_init(bend_initrequest *r);
 298
 299 YAZ_EXPORT void bend_request_send (bend_association a, bend_request req,
 300                                    Z_APDU *res);
 301
 302 YAZ_EXPORT bend_request bend_request_mk (bend_association a);
 303
 304 YAZ_EXPORT void bend_request_destroy (bend_request *req);
 305
 306 YAZ_EXPORT Z_ReferenceId *bend_request_getid (ODR odr, bend_request req);
 307 YAZ_EXPORT int bend_backend_respond (bend_association a, bend_request req);
 308 YAZ_EXPORT void bend_request_setdata(bend_request r, void *p);
 309 YAZ_EXPORT void *bend_request_getdata(bend_request r);
 310
 311 #ifdef __cplusplus
 312 }
 313 #endif
 314
 315 #endif