X-Git-Url: http://git.indexdata.com/?p=yaz-moved-to-github.git;a=blobdiff_plain;f=include%2Fyaz%2Fbackend.h;h=b5086276b0675a1628ad71be36dd7756b17371d0;hp=a0a59e82a255dc10e7c1218e8a652a2b59741c00;hb=f60c0db8c4379047cdd75e2be50549abc0a1c74a;hpb=2ede0bb278b22c8ce1cdd48e9a11a5924d433763 diff --git a/include/yaz/backend.h b/include/yaz/backend.h index a0a59e8..b508627 100644 --- a/include/yaz/backend.h +++ b/include/yaz/backend.h @@ -1,5 +1,5 @@ /* - * Copyright (c) 1995-2006, Index Data + * Copyright (c) 1995-2007, Index Data * All rights reserved. * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions are met: @@ -24,7 +24,7 @@ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ -/* $Id: backend.h,v 1.40 2006-12-06 21:35:58 adam Exp $ */ +/* $Id: backend.h,v 1.48 2007-05-30 08:12:17 adam Exp $ */ /** * \file backend.h @@ -40,13 +40,14 @@ #include #include #include +#include YAZ_BEGIN_CDECL typedef struct request *bend_request; typedef struct association *bend_association; -/* extended search handler (rr = request response) */ +/** \brief Information for Z39.50/SRU search handler */ typedef struct { char *setname; /* name to give to this set */ int replace_set; /* replace set, if it already exists */ @@ -68,14 +69,16 @@ typedef struct { char *srw_sortKeys; /* holds SRU/SRW sortKeys info */ char *srw_setname; /* holds SRU/SRW generated resultsetID */ int *srw_setnameIdleTime; /* holds SRU/SRW life-time */ + int estimated_hit_count; /* if hit count is estimated */ + int partial_resultset; /* if result set is partial */ } bend_search_rr; -/* extended present handler. Does not replace bend_fetch. */ +/** \brief Information for present handler. Does not replace bend_fetch. */ typedef struct { char *setname; /* set name */ int start; int number; /* record number */ - oid_value format; /* One of the CLASS_RECSYN members */ + Odr_oid *format; /* format, transfer syntax (OID) */ Z_ReferenceId *referenceId;/* reference ID */ Z_RecordComposition *comp; /* Formatting instructions */ ODR stream; /* encoding stream - memory source if required */ @@ -88,12 +91,12 @@ typedef struct { char *errstring; /* system error string or NULL */ } bend_present_rr; +/** \brief Information for fetch record handler */ typedef struct bend_fetch_rr { char *setname; /* set name */ int number; /* record number */ Z_ReferenceId *referenceId;/* reference ID */ - oid_value request_format; /* One of the CLASS_RECSYN members */ - int *request_format_raw; /* same as above (raw OID) */ + Odr_oid *request_format; /* format, transfer syntax (OID) */ Z_RecordComposition *comp; /* Formatting instructions */ ODR stream; /* encoding stream - memory source if req */ ODR print; /* printing stream */ @@ -102,14 +105,14 @@ typedef struct bend_fetch_rr { int len; /* length of record or -1 if structured */ 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 */ + Odr_oid *output_format; /* response format/syntax (OID) */ 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; +/** \brief Information for scan entry */ struct scan_entry { char *term; /* the returned scan term */ int occurrences; /* no of occurrences or -1 if error (see below) */ @@ -123,10 +126,11 @@ typedef enum { BEND_SCAN_PARTIAL /* not all entries could be found */ } bend_scan_status; +/** \brief Information for SRU / Z39.50 scan handler */ typedef struct bend_scan_rr { int num_bases; /* number of elements in databaselist */ char **basenames; /* databases to search */ - oid_value attributeset; + Odr_oid *attributeset; Z_ReferenceId *referenceId; /* reference ID */ Z_AttributesPlusTerm *term; ODR stream; /* encoding stream - memory source if required */ @@ -143,8 +147,10 @@ typedef struct bend_scan_rr { int errcode; char *errstring; char *scanClause; /* CQL scan clause */ + char *setname; /* Scan in result set (NULL if omitted) */ } bend_scan_rr; +/** \brief Information for SRU record update handler */ typedef struct bend_update_rr { int num_bases; /* number of elements in databaselist */ char **basenames; /* databases to search */ @@ -167,7 +173,7 @@ typedef struct bend_update_rr { char *details; } bend_update_rr; -/* delete handler */ +/** \brief Information for Z39.50 delete result set handler */ typedef struct bend_delete_rr { int function; int num_setnames; @@ -179,7 +185,7 @@ typedef struct bend_delete_rr { ODR print; } bend_delete_rr; -/* sort handler */ +/** \brief Information for Z39.50 sort handler */ typedef struct bend_sort_rr { int num_input_setnames; @@ -195,6 +201,7 @@ typedef struct bend_sort_rr char *errstring; } bend_sort_rr; +/** \brief Information for Z39.50 extended services handler */ typedef struct bend_esrequest_rr { int ItemNo; @@ -211,6 +218,7 @@ typedef struct bend_esrequest_rr Z_TaskPackage *taskPackage; } bend_esrequest_rr; +/** \brief Information for Z39.50 segment handler */ typedef struct bend_segment_rr { Z_Segment *segment; ODR stream; @@ -220,6 +228,7 @@ typedef struct bend_segment_rr { bend_association association; } bend_segment_rr; +/** \brief Information for SRU Explain handler */ typedef struct { ODR stream; ODR decode; @@ -230,35 +239,79 @@ typedef struct { void *server_node_ptr; } bend_explain_rr; +/** \brief Information for the Init handler + +This includes both request +information (to be read) and response information which should be +set by the bend_init handler +*/ 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) */ + /** \brief user/name/password to be read */ + Z_IdAuthentication *auth; + /** \brief encoding stream (for results) */ + ODR stream; + /** \brief printing stream */ + ODR print; + /** \brief decoding stream (use stream for results) */ + ODR decode; + /** \brief reference ID */ + Z_ReferenceId *referenceId; + /** \brief peer address of client */ + char *peer_name; + + /** \brief character set and language negotiation + + see include/yaz/z-charneg.h + */ + Z_CharSetandLanguageNegotiation *charneg_request; + + /** \brief character negotiation response */ + Z_External *charneg_response; + + /** \brief character set (encoding) for query terms + + This is NULL by default. It should be set to the native character + set that the backend assumes for query terms */ + char *query_charset; + + /** \brief whehter query_charset also applies to recors + Is 0 (No) by default. Set to 1 (yes) if records is in the same + character set as queries. If in doubt, use 0 (No). + */ + int records_in_same_charset; + char *implementation_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_fetch) (void *handle, bend_fetch_rr *rr); - int (*bend_present) (void *handle, bend_present_rr *rr); + + /** \brief Z39.50 sort handler */ + int (*bend_sort)(void *handle, bend_sort_rr *rr); + /** \brief SRU/Z39.50 search handler */ + int (*bend_search)(void *handle, bend_search_rr *rr); + /** \brief SRU/Z39.50 fetch handler */ + int (*bend_fetch)(void *handle, bend_fetch_rr *rr); + /** \brief SRU/Z39.50 present handler */ + int (*bend_present)(void *handle, bend_present_rr *rr); + /** \brief Z39.50 extended services handler */ int (*bend_esrequest) (void *handle, bend_esrequest_rr *rr); + /** \brief Z39.50 delete result set handler */ int (*bend_delete)(void *handle, bend_delete_rr *rr); + /** \brief Z39.50 scan handler */ int (*bend_scan)(void *handle, bend_scan_rr *rr); + /** \brief Z39.50 segment facility handler */ 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; + /** \brief SRU explain handler */ int (*bend_explain)(void *handle, bend_explain_rr *rr); + /** \brief SRU scan handler */ int (*bend_srw_scan)(void *handle, bend_scan_rr *rr); + /** \brief SRU record update handler */ int (*bend_srw_update)(void *handle, bend_update_rr *rr); + } bend_initrequest; +/** \brief result for init handler (must be filled by handler) */ typedef struct bend_initresult { int errcode; /* 0==OK */ @@ -278,16 +331,16 @@ YAZ_EXPORT int bend_backend_respond (bend_association a, bend_request req); YAZ_EXPORT void bend_request_setdata(bend_request r, void *p); YAZ_EXPORT void *bend_request_getdata(bend_request r); +/** \brief control block for server */ typedef struct statserv_options_block { int dynamic; /* fork on incoming requests */ int threads; /* use threads */ int one_shot; /* one session then exit(1) */ - 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 */ - enum oid_proto default_proto; /* PROTO_SR or PROTO_Z3950 */ + enum oid_proto default_proto; /* PROTO_SR or PROTO_Z3950 */ int idle_timeout; /* how many minutes to wait before closing */ int maxrecordsize; /* maximum value for negotiation */ char configname[ODR_MAXNAME+1]; /* given to the backend in bend_init */