Put __UNUSED_loglevel back into structure to maintain binary compatibility.

[yaz-moved-to-github.git] / include / yaz / backend.h

diff --git a/include/yaz/backend.h b/include/yaz/backend.h
index ecd577b..4f7194f 100644 (file)
--- a/include/yaz/backend.h
+++ b/include/yaz/backend.h
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 1995-2003, 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,7 +23,15 @@
  * LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
  * OF THIS SOFTWARE.
  *
- * $Id: backend.h,v 1.19 2003-02-20 15:15:04 adam Exp $
+ * $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
@@ -31,6 +39,7 @@
 
 #include <yaz/yconfig.h>
 #include <yaz/proto.h>
+#include <yaz/srw.h>
 
 YAZ_BEGIN_CDECL
     
@@ -56,6 +65,9 @@ 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 */
 } bend_search_rr;
 
 /* extended present handler. Does not replace bend_fetch. */
@@ -95,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 {
@@ -102,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 {
@@ -122,12 +136,38 @@ typedef struct bend_scan_rr {
     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;
@@ -181,6 +221,16 @@ 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;
@@ -205,6 +255,9 @@ typedef struct bend_initrequest
     /* 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
@@ -215,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);
 
@@ -231,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 */
@@ -259,6 +312,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(
@@ -275,3 +332,11 @@ 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
+ */
+