X-Git-Url: http://git.indexdata.com/?p=yaz-moved-to-github.git;a=blobdiff_plain;f=include%2Fyaz%2Fbackend.h;h=4f7194ff296341078ed331d60b01171e5020e344;hp=4a43f410e3fd44bd50316de091f0d4972576a110;hb=e38c23b29a89e9c4e1cd5aa9033015efc39b26c0;hpb=68d5c20794c09348e4a0fed7f00c2bd97f535e12 diff --git a/include/yaz/backend.h b/include/yaz/backend.h index 4a43f41..4f7194f 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,76 +23,15 @@ * LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE * OF THIS SOFTWARE. * - * $Log: backend.h,v $ - * Revision 1.9 2000-08-31 10:20:12 adam - * Added member request_format and output_format for backend fetch method. - * - * 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.36 2006-03-22 13:55:06 mike Exp $ + */ + +/** + * \file backend.h + * \brief Header for GFS * + * This header includes all public definitions for the + * Generic Frontend Server (GFS). */ #ifndef BACKEND_H @@ -100,6 +39,7 @@ #include #include +#include YAZ_BEGIN_CDECL @@ -124,6 +64,10 @@ 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 */ + char *srw_sortKeys; /* holds SRU/SRW sortKeys info */ + char *srw_setname; /* holds SRU/SRW generated resultsetID */ + int *srw_setnameIdleTime; /* holds SRU/SRW life-time */ } bend_search_rr; /* extended present handler. Does not replace bend_fetch. */ @@ -163,6 +107,7 @@ typedef struct bend_fetch_rr { 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 { @@ -170,6 +115,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 { @@ -186,15 +132,42 @@ 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; +typedef struct bend_update_rr { + int num_bases; /* number of elements in databaselist */ + char **basenames; /* databases to search */ + Z_ReferenceId *referenceId; /* reference ID */ + ODR stream; /* encoding stream - memory source if required */ + ODR print; /* printing stream */ + char *operation; + char *operation_status; + char *record_id; + char *record_version; + char *record_checksum; + char *record_old_version; + char *record_packing; + char *record_schema; + char *record_data; + Z_SRW_extra_record *request_extra_record; + Z_SRW_extra_record *response_extra_record; + char *extra_request_data; + char *extra_response_data; + int errcode; + char *errstring; +} bend_update_rr; + /* delete handler */ typedef struct bend_delete_rr { int function; @@ -236,6 +209,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 { @@ -247,13 +221,25 @@ 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; + void *server_node_ptr; +} 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); @@ -264,6 +250,14 @@ 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); + int (*bend_srw_update)(void *handle, bend_update_rr *rr); } bend_initrequest; typedef struct bend_initresult @@ -274,7 +268,7 @@ typedef struct bend_initresult } bend_initresult; YAZ_EXPORT void bend_request_send (bend_association a, bend_request req, - Z_APDU *res); + Z_APDU *res); YAZ_EXPORT bend_request bend_request_mk (bend_association a); @@ -290,7 +284,7 @@ typedef struct statserv_options_block int dynamic; /* fork on incoming requests */ int threads; /* use threads */ int one_shot; /* one session then exit(1) */ - int loglevel; /* desired logging-level */ + int __UNUSED__loglevel; /* desired logging-level */ char apdufile[ODR_MAXNAME+1]; /* file for pretty-printed PDUs */ char logfile[ODR_MAXNAME+1]; /* file for diagnostic output */ char default_listen[1024]; /* 0 == no default listen */ @@ -317,6 +311,11 @@ 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 */ + char xml_config[128]; /* XML config filename */ } statserv_options_block; YAZ_EXPORT int statserv_main( @@ -329,6 +328,15 @@ 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 +/* + * Local variables: + * c-basic-offset: 4 + * indent-tabs-mode: nil + * End: + * vim: shiftwidth=4 tabstop=8 expandtab + */ +