ZOOM Connection setting 'logapdu' logs APDUs to YAZ log.
[yaz-moved-to-github.git] / src / zoom-p.h
index d852feb..139d559 100644 (file)
@@ -1,13 +1,41 @@
-/*
- * Private C header for ZOOM C.
- * $Id: zoom-p.h,v 1.2 2003-12-20 00:51:19 adam Exp $
+/* This file is part of the YAZ toolkit.
+ * Copyright (C) 1995-2008 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:
+ *
+ *     * 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.
+ *
+ * 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.
+ */
+/**
+ * \file zoom-p.h
+ * \brief Internal header for ZOOM implementation
  */
-
 #include <yaz/proto.h>
+#include <yaz/oid_db.h>
 #include <yaz/comstack.h>
 #include <yaz/wrbuf.h>
 #include <yaz/zoom.h>
 #include <yaz/sortspec.h>
+#include <yaz/srw.h>
+
 typedef struct ZOOM_Event_p *ZOOM_Event;
 
 struct ZOOM_query_p {
@@ -18,14 +46,20 @@ struct ZOOM_query_p {
     char *query_string;
 };
 
+typedef enum {
+    zoom_sru_error,
+    zoom_sru_soap,
+    zoom_sru_get,
+    zoom_sru_post
+} zoom_sru_mode;
+    
+
+typedef struct ZOOM_task_p *ZOOM_task;
+
 #define STATE_IDLE 0
 #define STATE_CONNECTING 1
 #define STATE_ESTABLISHED 2
 
-#define ZOOM_SELECT_READ 1
-#define ZOOM_SELECT_WRITE 2
-#define ZOOM_SELECT_EXCEPT 4
-
 struct ZOOM_connection_p {
     enum oid_proto proto;
     COMSTACK cs;
@@ -33,12 +67,13 @@ struct ZOOM_connection_p {
     char *path;
     int error;
     char *addinfo;
-    const char *diagset;
+    char *diagset;
     int state;
     int mask;
     int reconnect_ok;
     ODR odr_in;
     ODR odr_out;
+    ODR odr_print;
     char *buf_in;
     int len_in;
     char *buf_out;
@@ -49,19 +84,31 @@ struct ZOOM_connection_p {
     char *cookie_out;
     char *cookie_in;
     char *client_IP;
+    char *sru_version;
+
+    char *user;
+    char *group;
+    char *password;
+
     int async;
     int support_named_resultsets;
     int last_event;
+
+    int maximum_record_size;
+    int preferred_message_size;
+
     ZOOM_task tasks;
     ZOOM_options options;
     ZOOM_resultset resultsets;
     ZOOM_Event m_queue_front;
     ZOOM_Event m_queue_back;
+    zoom_sru_mode sru_mode;
 };
 
 struct ZOOM_options_entry {
     char *name;
     char *value;
+    int len;                  /* of `value', which may contain NULs */
     struct ZOOM_options_entry *next;
 };
 
@@ -74,24 +121,27 @@ struct ZOOM_options_p {
     ZOOM_options parent2;
 };
 
+
 typedef struct ZOOM_record_cache_p *ZOOM_record_cache;
 
+#define RECORD_HASH_SIZE  131
+
 struct ZOOM_resultset_p {
     Z_SortKeySpecList *r_sort_spec;
     ZOOM_query query;
     int refcount;
     int size;
-    int start;
-    int count;
     int step;
     int piggyback;
     char *setname;
     char *schema;
     ODR odr;
-    ZOOM_record_cache record_cache;
+    ZOOM_record_cache record_hash[RECORD_HASH_SIZE];
     ZOOM_options options;
     ZOOM_connection connection;
     ZOOM_resultset next;
+    char **databaseNames;
+    int num_databaseNames;
 };
 
 struct ZOOM_record_p {
@@ -100,6 +150,12 @@ struct ZOOM_record_p {
     WRBUF wrbuf_iconv;
     WRBUF wrbuf_opac;
     Z_NamePlusRecord *npr;
+    const char *schema;
+
+    const char *diag_uri;
+    const char *diag_message;
+    const char *diag_details;
+    const char *diag_set;
 };
 
 struct ZOOM_record_cache_p {
@@ -116,9 +172,12 @@ struct ZOOM_scanset_p {
     ODR odr;
     ZOOM_options options;
     ZOOM_connection connection;
-    Z_AttributesPlusTerm *termListAndStartPoint;
-    Z_AttributeSetId *attributeSet;
+    ZOOM_query query;
     Z_ScanResponse *scan_response;
+    Z_SRW_scanResponse *srw_scan_response;
+
+    char **databaseNames;
+    int num_databaseNames;
 };
 
 struct ZOOM_package_p {
@@ -136,13 +195,19 @@ struct ZOOM_task_p {
     union {
 #define ZOOM_TASK_SEARCH 1
         struct {
+            int count;
+            int start;
             ZOOM_resultset resultset;
+            char *syntax;
+            char *elementSetName;
         } search;
 #define ZOOM_TASK_RETRIEVE 2
         struct {
             int start;
             ZOOM_resultset resultset;
             int count;
+            char *syntax;
+            char *elementSetName;
         } retrieve;
 #define ZOOM_TASK_CONNECT 3
 #define ZOOM_TASK_SCAN 4
@@ -151,6 +216,11 @@ struct ZOOM_task_p {
         } scan;
 #define ZOOM_TASK_PACKAGE 5
         ZOOM_package package;
+#define ZOOM_TASK_SORT 6
+        struct {
+            ZOOM_resultset resultset;
+            ZOOM_query q;
+        } sort;
     } u;
     ZOOM_task next;
 };
@@ -162,3 +232,12 @@ struct ZOOM_Event_p {
 };
 
 void ZOOM_options_addref (ZOOM_options opt);
+
+/*
+ * Local variables:
+ * c-basic-offset: 4
+ * indent-tabs-mode: nil
+ * End:
+ * vim: shiftwidth=4 tabstop=8 expandtab
+ */
+