X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=include%2Fyaz%2Fbackend.h;h=9fcd3bfec921906704986910c72998390ee7588b;hb=af019cc83166ab755de4b9c9133c23caacc2f103;hp=d321de5f98383fd38b4139854bbf28381f253460;hpb=06e73cb9f6d59fc7a38f17636016f2daaed02548;p=yaz-moved-to-github.git diff --git a/include/yaz/backend.h b/include/yaz/backend.h index d321de5..9fcd3bf 100644 --- a/include/yaz/backend.h +++ b/include/yaz/backend.h @@ -1,29 +1,37 @@ /* - * Copyright (c) 1995-2003, 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: * - * Permission to use, copy, modify, distribute, and sell this software and - * its documentation, in whole or in part, for any purpose, is hereby granted, - * provided that: + * * Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * * Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * * Neither the name of Index Data nor the names of its contributors + * may be used to endorse or promote products derived from this + * software without specific prior written permission. * - * 1. This copyright and permission notice appear in all copies of the - * software and its documentation. Notices of copyright or attribution - * which appear at the beginning of any file must remain unchanged. - * - * 2. The name of Index Data or the individual authors may not be used to - * endorse or promote products derived from this software without specific - * prior written permission. - * - * THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT WARRANTY OF ANY KIND, - * EXPRESS, IMPLIED, OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY - * WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. - * IN NO EVENT SHALL INDEX DATA BE LIABLE FOR ANY SPECIAL, INCIDENTAL, - * INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, OR ANY DAMAGES - * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER OR - * NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF - * LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE - * OF THIS SOFTWARE. + * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY + * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED + * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE + * DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY + * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES + * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; + * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND + * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (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.44 2007-05-02 11:53:25 adam Exp $ */ + +/** + * \file backend.h + * \brief Header for GFS * - * $Id: backend.h,v 1.21 2003-04-24 13:30:32 adam Exp $ + * This header includes all public definitions for the + * Generic Frontend Server (GFS). */ #ifndef BACKEND_H @@ -31,6 +39,8 @@ #include #include +#include +#include YAZ_BEGIN_CDECL @@ -56,6 +66,11 @@ typedef struct { 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 */ + 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. */ @@ -63,7 +78,7 @@ typedef struct { char *setname; /* set name */ int start; int number; /* record number */ - oid_value format; /* One of the CLASS_RECSYN members */ + int *format; /* format, transfer syntax (OID) */ Z_ReferenceId *referenceId;/* reference ID */ Z_RecordComposition *comp; /* Formatting instructions */ ODR stream; /* encoding stream - memory source if required */ @@ -80,8 +95,7 @@ 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) */ + int *request_format; /* format, transfer syntax (OID) */ Z_RecordComposition *comp; /* Formatting instructions */ ODR stream; /* encoding stream - memory source if req */ ODR print; /* printing stream */ @@ -90,8 +104,7 @@ 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 */ + int *output_format; /* response format/syntax (OID) */ int errcode; /* 0==success */ char *errstring; /* system error string or NULL */ int surrogate_flag; /* surrogate diagnostic */ @@ -114,7 +127,7 @@ typedef enum { typedef struct bend_scan_rr { int num_bases; /* number of elements in databaselist */ char **basenames; /* databases to search */ - oid_value attributeset; + int *attributeset; Z_ReferenceId *referenceId; /* reference ID */ Z_AttributesPlusTerm *term; ODR stream; /* encoding stream - memory source if required */ @@ -130,8 +143,31 @@ typedef struct bend_scan_rr { 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; + Z_SRW_recordVersion *record_versions; + int num_versions; + char *record_packing; + char *record_schema; + char *record_data; + char *extra_record_data; + char *extra_request_data; + char *extra_response_data; + char *uri; + char *message; + char *details; +} bend_update_rr; + /* delete handler */ typedef struct bend_delete_rr { int function; @@ -190,33 +226,45 @@ typedef struct { ODR decode; ODR print; char *explain_buf; + char *database; + char *schema; + void *server_node_ptr; } bend_explain_rr; typedef struct bend_initrequest { + /* arguments to be read by a backend */ Z_IdAuthentication *auth; ODR stream; /* encoding stream */ ODR print; /* printing stream */ Z_ReferenceId *referenceId;/* reference ID */ char *peer_name; /* dns host of peer (client) */ - + ODR decode; /* decoding stream */ + /* character set and language negotiation - see include/yaz/z-charneg.h */ + Z_CharSetandLanguageNegotiation *charneg_request; + + + /* stuff to be modified/set by backend */ + + /* character negotiation response */ + Z_External *charneg_response; + char *query_charset; + int records_in_same_charset; /* as query_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); + 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); 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); 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 @@ -227,7 +275,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); @@ -243,11 +291,10 @@ 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 */ 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 */ @@ -271,6 +318,10 @@ typedef struct statserv_options_block 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( @@ -283,7 +334,16 @@ 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_EXPORT int bend_assoc_is_alive(bend_association assoc); YAZ_END_CDECL #endif +/* + * Local variables: + * c-basic-offset: 4 + * indent-tabs-mode: nil + * End: + * vim: shiftwidth=4 tabstop=8 expandtab + */ +