X-Git-Url: http://git.indexdata.com/?p=yaz-moved-to-github.git;a=blobdiff_plain;f=include%2Fyaz%2Fbackend.h;h=51a9324ec83f20808a7b2b2376f013871cdd1382;hp=46d1d4bba3a133f133746b1faf96d1299ef7cd30;hb=4c176312acdc3444c9afc820f76a393e64668e52;hpb=4f7e8b411cb0c30c02b3eaf23fdfef5275dae098 diff --git a/include/yaz/backend.h b/include/yaz/backend.h index 46d1d4b..51a9324 100644 --- a/include/yaz/backend.h +++ b/include/yaz/backend.h @@ -1,5 +1,5 @@ /* - * Copyright (c) 1995-2000, Index Data. + * Copyright (C) 1995-2005, Index Data ApS * * Permission to use, copy, modify, distribute, and sell this software and * its documentation, in whole or in part, for any purpose, is hereby granted, @@ -23,73 +23,15 @@ * LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE * OF THIS SOFTWARE. * - * $Log: backend.h,v $ - * Revision 1.8 2000-08-31 09:51:25 adam - * Added record_syntax member for fetch method (raw OID). - * - * Revision 1.7 2000/04/05 07:39:55 adam - * Added shared library support (libtool). - * - * Revision 1.6 2000/03/20 19:06:25 adam - * Added Segment request for fronend server. Work on admin for client. - * - * Revision 1.5 2000/03/15 12:59:49 adam - * Added handle member to statserv_control. - * - * Revision 1.4 2000/02/28 11:20:06 adam - * Using autoconf. New definitions: YAZ_BEGIN_CDECL/YAZ_END_CDECL. - * - * Revision 1.3 2000/01/12 14:36:07 adam - * Added printing stream (ODR) for backend functions. - * - * Revision 1.2 1999/12/16 23:36:19 adam - * Implemented ILL protocol. Minor updates ASN.1 compiler. - * - * Revision 1.1 1999/11/30 13:47:11 adam - * Improved installation. Moved header files to include/yaz. - * - * 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 - * Support for surrogate diagnostic records added for bend_fetch. - * - * Revision 1.19 1998/03/31 11:07:45 adam - * Furhter work on UNIverse resource report. - * Added Extended Services handling in frontend server. - * - * Revision 1.18 1998/02/10 11:03:56 adam - * Added support for extended handlers in backend server interface. - * - * Revision 1.17 1998/01/29 13:15:35 adam - * Implemented sort for the backend interface. - * - * Revision 1.16 1997/09/17 12:10:31 adam - * YAZ version 1.4. + * $Id: backend.h,v 1.28 2005-01-15 19:47:09 adam Exp $ + */ + +/** + * \file backend.h + * \brief Header for GFS * + * This header includes all public definitions for the + * Generic Frontend Server (GFS). */ #ifndef BACKEND_H @@ -121,6 +63,7 @@ typedef struct { int hits; /* number of hits */ int errcode; /* 0==OK */ char *errstring; /* system error string or NULL */ + Z_OtherInformation *search_info; /* additional search info */ } bend_search_rr; /* extended present handler. Does not replace bend_fetch. */ @@ -129,7 +72,6 @@ typedef struct { int start; int number; /* record number */ oid_value format; /* One of the CLASS_RECSYN members */ - int *record_syntax; /* same as above (raw OID) */ Z_ReferenceId *referenceId;/* reference ID */ Z_RecordComposition *comp; /* Formatting instructions */ ODR stream; /* encoding stream - memory source if required */ @@ -147,7 +89,7 @@ typedef struct bend_fetch_rr { int number; /* record number */ Z_ReferenceId *referenceId;/* reference ID */ oid_value request_format; /* One of the CLASS_RECSYN members */ - int *record_syntax; /* same as above (raw OID) */ + int *request_format_raw; /* same as above (raw OID) */ Z_RecordComposition *comp; /* Formatting instructions */ ODR stream; /* encoding stream - memory source if req */ ODR print; /* printing stream */ @@ -157,9 +99,11 @@ typedef struct bend_fetch_rr { char *record; /* record */ int last_in_set; /* is it? */ oid_value output_format; /* format */ + int *output_format_raw; /* used instead of above if not-null */ int errcode; /* 0==success */ char *errstring; /* system error string or NULL */ int surrogate_flag; /* surrogate diagnostic */ + char *schema; /* string record schema input/output */ } bend_fetch_rr; struct scan_entry { @@ -167,6 +111,7 @@ struct scan_entry { 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 */ + char *display_term; }; typedef enum { @@ -183,13 +128,17 @@ typedef struct bend_scan_rr { ODR stream; /* encoding stream - memory source if required */ ODR print; /* printing stream */ + int *step_size; /* step size */ int term_position; /* desired index of term in result list/returned */ int num_entries; /* number of entries requested/returned */ + /* scan term entries. The called handler does not have + to allocate this. Size of entries is num_entries (see above) */ struct scan_entry *entries; bend_scan_status status; int errcode; char *errstring; + char *scanClause; /* CQL scan clause */ } bend_scan_rr; /* delete handler */ @@ -233,6 +182,7 @@ typedef struct bend_esrequest_rr bend_association association; int errcode; /* 0==success, -1==accepted, >0 = failure */ char *errstring; /* system error string or NULL */ + Z_TaskPackage *taskPackage; } bend_esrequest_rr; typedef struct bend_segment_rr { @@ -244,13 +194,24 @@ typedef struct bend_segment_rr { bend_association association; } bend_segment_rr; +typedef struct { + ODR stream; + ODR decode; + ODR print; + char *explain_buf; + char *database; + char *schema; +} bend_explain_rr; + typedef struct bend_initrequest { Z_IdAuthentication *auth; ODR stream; /* encoding stream */ ODR print; /* printing stream */ Z_ReferenceId *referenceId;/* reference ID */ + char *peer_name; /* dns host of peer (client) */ + char *implementation_id; char *implementation_name; char *implementation_version; int (*bend_sort) (void *handle, bend_sort_rr *rr); @@ -261,6 +222,13 @@ typedef struct bend_initrequest int (*bend_delete)(void *handle, bend_delete_rr *rr); int (*bend_scan)(void *handle, bend_scan_rr *rr); int (*bend_segment)(void *handle, bend_segment_rr *rr); + + ODR decode; /* decoding stream */ + /* character set and language negotiation - see include/yaz/z-charneg.h */ + Z_CharSetandLanguageNegotiation *charneg_request; + Z_External *charneg_response; + int (*bend_explain)(void *handle, bend_explain_rr *rr); + int (*bend_srw_scan)(void *handle, bend_scan_rr *rr); } bend_initrequest; typedef struct bend_initresult @@ -314,6 +282,10 @@ typedef struct statserv_options_block char service_dependencies[128]; /* The services we are dependent on */ char service_display_name[128]; /* The service display name */ #endif /* WIN32 */ + struct bend_soap_handler *soap_handlers; + char pid_fname[128]; /* pid fname */ + int background; /* auto daemon */ + char cert_fname[128]; /* SSL certificate fname */ } statserv_options_block; YAZ_EXPORT int statserv_main( @@ -326,6 +298,7 @@ YAZ_EXPORT statserv_options_block *statserv_getcontrol(void); YAZ_EXPORT void statserv_setcontrol(statserv_options_block *block); YAZ_EXPORT int check_ip_tcpd(void *cd, const char *addr, int len, int type); + YAZ_END_CDECL #endif