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