X-Git-Url: http://git.indexdata.com/?p=yaz-moved-to-github.git;a=blobdiff_plain;f=include%2Fbackend.h;h=32f87a8613c115562913549d29bef1852bb02855;hp=2eb7be442f996325fb9b1709ec9852497c541104;hb=cb182c3eb21ca4405d0c9f928ceb33f3fd2f95ba;hpb=3060b77b776350c6e677c06b3070542dba5c42b6 diff --git a/include/backend.h b/include/backend.h index 2eb7be4..32f87a8 100644 --- a/include/backend.h +++ b/include/backend.h @@ -1,5 +1,5 @@ /* - * Copyright (c) 1995-1998, Index Data. + * Copyright (c) 1995-1999, Index Data. * * Permission to use, copy, modify, distribute, and sell this software and * its documentation, in whole or in part, for any purpose, is hereby granted, @@ -24,7 +24,30 @@ * OF THIS SOFTWARE. * * $Log: backend.h,v $ - * Revision 1.21 1998-07-20 12:38:41 adam + * Revision 1.28 1999-11-04 14:58:44 adam + * Added status elements for backend delete result set handler. + * Updated delete result result set command for client. + * + * Revision 1.27 1999/10/11 10:01:24 adam + * Implemented bend_sort_rr handler for frontend server. + * + * Revision 1.26 1999/06/17 10:54:44 adam + * Added facility to specify implementation version - and name + * for server. + * + * Revision 1.25 1999/06/01 14:29:12 adam + * Work on Extended Services. + * + * Revision 1.24 1999/03/31 11:18:24 adam + * Implemented odr_strdup. Added Reference ID to backend server API. + * + * Revision 1.23 1998/10/13 16:12:23 adam + * Added support for Surrogate Diagnostics for Scan Term entries. + * + * Revision 1.22 1998/09/02 12:41:51 adam + * Added decode stream in bend search structures. + * + * Revision 1.21 1998/07/20 12:38:41 adam * Implemented delete result set service to server API. * * Revision 1.20 1998/05/27 16:57:06 adam @@ -66,8 +89,10 @@ typedef struct int replace_set; /* replace set, if it already exists */ int num_bases; /* number of databases in list */ char **basenames; /* databases to search */ + Z_ReferenceId *referenceId;/* reference ID */ Z_Query *query; /* query structure */ ODR stream; /* encoding stream */ + ODR decode; /* decoding stream */ } bend_searchrequest; /* old search request output */ @@ -84,8 +109,10 @@ typedef struct { int replace_set; /* replace set, if it already exists */ int num_bases; /* number of databases in list */ char **basenames; /* databases to search */ + Z_ReferenceId *referenceId;/* reference ID */ Z_Query *query; /* query structure */ ODR stream; /* encode stream */ + ODR decode; /* decode stream */ bend_request request; bend_association association; @@ -101,6 +128,7 @@ typedef struct { int start; int number; /* record number */ oid_value format; /* One of the CLASS_RECSYN members */ + Z_ReferenceId *referenceId;/* reference ID */ Z_RecordComposition *comp; /* Formatting instructions */ ODR stream; /* encoding stream - memory source if required */ bend_request request; @@ -119,6 +147,7 @@ typedef struct { char *setname; /* set name */ int number; /* record number */ + Z_ReferenceId *referenceId;/* reference ID */ oid_value format; /* One of the CLASS_RECSYN members */ Z_RecordComposition *comp; /* Formatting instructions */ ODR stream; /* encoding stream - memory source if req */ @@ -145,6 +174,7 @@ typedef struct int num_bases; /* number of elements in databaselist */ char **basenames; /* databases to search */ oid_value attributeset; + Z_ReferenceId *referenceId; /* reference ID */ Z_AttributesPlusTerm *term; int term_position; /* desired index of term in result list */ int num_entries; /* number of entries requested */ @@ -152,12 +182,14 @@ typedef struct } bend_scanrequest; struct scan_entry { - char *term; - int occurrences; + char *term; /* the returned scan term */ + int occurrences; /* no of occurrences or -1 if error (see below) */ + int errcode; /* Bib-1 diagnostic code; only used when occur.= -1 */ + char *errstring; /* Additional string */ }; typedef enum { - BEND_SCAN_SUCCESS, /* ok */ + BEND_SCAN_SUCCESS, /* ok */ BEND_SCAN_PARTIAL /* not all entries could be found */ } bend_scan_status; @@ -171,6 +203,23 @@ typedef struct bend_scanresult char *errstring; } bend_scanresult; +typedef struct bend_scan_rr { + int num_bases; /* number of elements in databaselist */ + char **basenames; /* databases to search */ + oid_value attributeset; + Z_ReferenceId *referenceId; /* reference ID */ + Z_AttributesPlusTerm *term; + ODR stream; /* encoding stream - memory source if required */ + + int term_position; /* desired index of term in result list/returned */ + int num_entries; /* number of entries requested/returned */ + + struct scan_entry *entries; + bend_scan_status status; + int errcode; + char *errstring; +} bend_scan_rr; + YAZ_EXPORT bend_scanresult *bend_scan(void *handle, bend_scanrequest *r, int *fd); YAZ_EXPORT bend_scanresult *bend_scanresponse(void *handle); @@ -180,7 +229,9 @@ typedef struct bend_delete_rr { int function; int num_setnames; char **setnames; - int delete_status; + Z_ReferenceId *referenceId; + int delete_status; /* status for the whole operation */ + int *statuses; /* status each set - indexed as setnames */ ODR stream; } bend_delete_rr; @@ -195,6 +246,7 @@ typedef struct bend_sort_rr char *output_setname; Z_SortKeySpecList *sort_sequence; ODR stream; + Z_ReferenceId *referenceId;/* reference ID */ int sort_status; int errcode; @@ -206,10 +258,12 @@ typedef struct bend_esrequest_rr { int ItemNo; Z_ExtendedServicesRequest *esr; + ODR stream; /* encoding stream */ + Z_ReferenceId *referenceId;/* reference ID */ bend_request request; bend_association association; - int errcode; /* 0==success */ + int errcode; /* 0==success, -1==accepted, >0 = failure */ char *errstring; /* system error string or NULL */ } bend_esrequest_rr; @@ -218,12 +272,16 @@ typedef struct bend_initrequest char *configname; Z_IdAuthentication *auth; ODR stream; /* encoding stream */ + Z_ReferenceId *referenceId;/* reference ID */ + char *implementation_name; + char *implementation_version; int (*bend_sort) (void *handle, bend_sort_rr *rr); int (*bend_search) (void *handle, bend_search_rr *rr); int (*bend_present) (void *handle, bend_present_rr *rr); int (*bend_esrequest) (void *handle, bend_esrequest_rr *rr); int (*bend_delete)(void *handle, bend_delete_rr *rr); + int (*bend_scan)(void *handle, bend_scan_rr *rr); } bend_initrequest; typedef struct bend_initresult