First work on request queue.
[ir-tcl-moved-to-github.git] / ir-tclp.h
index 1cfdcfe..e5b03b6 100644 (file)
--- a/ir-tclp.h
+++ b/ir-tclp.h
@@ -1,10 +1,51 @@
 /*
  * IR toolkit for tcl/tk
  * (c) Index Data 1995
+ * See the file LICENSE for details.
  * Sebastian Hammer, Adam Dickmeiss
  *
  * $Log: ir-tclp.h,v $
- * Revision 1.1  1995-05-23 15:34:49  adam
+ * Revision 1.12  1995-07-28 10:28:38  adam
+ * First work on request queue.
+ *
+ * Revision 1.11  1995/06/20  08:07:35  adam
+ * New setting: failInfo.
+ * Working on better cancel mechanism.
+ *
+ * Revision 1.10  1995/06/16  12:28:20  adam
+ * Implemented preferredRecordSyntax.
+ * Minor changes in diagnostic handling.
+ * Record list deleted when connection closes.
+ *
+ * Revision 1.9  1995/06/14  15:08:01  adam
+ * Bug fix in cascade-target-list. Uses yaz-version.h.
+ *
+ * Revision 1.8  1995/06/14  13:37:18  adam
+ * Setting recordType implemented.
+ * Setting implementationVersion implemented.
+ * Settings implementationId / implementationName edited.
+ *
+ * Revision 1.7  1995/06/01  07:31:28  adam
+ * Rename of many typedefs -> IrTcl_...
+ *
+ * Revision 1.6  1995/05/31  08:36:40  adam
+ * Bug fix in client.tcl: didn't save options on clientrc.tcl.
+ * New method: referenceId. More work on scan.
+ *
+ * Revision 1.5  1995/05/29  08:44:25  adam
+ * Work on delete of objects.
+ *
+ * Revision 1.4  1995/05/26  11:44:10  adam
+ * Bugs fixed. More work on MARC utilities and queries. Test
+ * client is up-to-date again.
+ *
+ * Revision 1.3  1995/05/26  08:54:17  adam
+ * New MARC utilities. Uses prefix query.
+ *
+ * Revision 1.2  1995/05/24  14:10:23  adam
+ * Work on idAuthentication, protocolVersion and options.
+ *
+ * Revision 1.1  1995/05/23  15:34:49  adam
  * Many new settings, userInformationField, smallSetUpperBound, etc.
  * A number of settings are inherited when ir-set is executed.
  * This version is incompatible with the graphical test client (client.tcl).
 
 #include <tcl.h>
 
+#include <log.h>
+#include <pquery.h>
+#if CCL2RPN
 #include <yaz-ccl.h>
-#include <iso2709.h>
+#endif
+
 #include <comstack.h>
 #include <tcpip.h>
 
@@ -25,6 +70,7 @@
 #include <xmosi.h>
 #endif
 
+#include <yaz-version.h>
 #include <odr.h>
 #include <proto.h>
 #include <oid.h>
 typedef struct {
     char      **databaseNames;
     int         num_databaseNames;
-
     char       *queryType;
+    enum oid_value *preferredRecordSyntax;
     int         replaceIndicator;
+    char       *referenceId;
 
     int         smallSetUpperBound;
     int         largeSetLowerBound;
     int         mediumSetPresentNumber;
-} IRSetCObj;
+} IrTcl_SetCObj;
     
 typedef struct {
+    int         ref_count;
+
     char       *cs_type;
-    char       *protocol_type;
+    int         protocol_type;
     int         connectFlag;
+    int         failInfo;
     COMSTACK    cs_link;
 
     int         preferredMessageSize;
     int         maximumRecordSize;
     Odr_bitmask options;
     Odr_bitmask protocolVersion;
-    char       *idAuthentication;
+
+    char       *idAuthenticationOpen;
+    char       *idAuthenticationGroupId;
+    char       *idAuthenticationUserId;
+    char       *idAuthenticationPassword;
+
     char       *implementationName;
     char       *implementationId;
+    char       *implementationVersion;
     int        initResult;
     char       *targetImplementationName;
     char       *targetImplementationId;
@@ -79,47 +135,73 @@ typedef struct {
     char       *callback;
     char       *failback;
 
+#if CCL2RPN
     CCL_bibset  bibset;
-    oident      bib1;
+#endif
 
-    struct IRSetObj_ *set_child;
-    struct IRScanObj_ *scan_child;
+    struct IrTcl_SetObj_ *set_child;
+    struct IrTcl_ScanObj_ *scan_child;
+    struct IrTcl_Request_ *request_queue;
 
-    IRSetCObj   set_inher;
-} IRObj;
+    IrTcl_SetCObj   set_inher;
+} IrTcl_Obj;
 
-typedef struct IRRecordList_ {
+typedef struct IrTcl_Request_ {
+    char       *name_of_object;
+    struct IrTcl_Request_ *next; 
+    
+    char       *buf_out;
+    int         len_out;
+    char       *buf_in;
+    int         len_in;
+
+    char       *callback;
+    char       *failback;
+
+    int         state;
+} IrTcl_Request;
+
+typedef struct {
+    int condition;
+    char *addinfo;
+} IrTcl_Diagnostic;
+
+typedef struct IrTcl_RecordList_ {
     int no;
     int which;
     union {
         struct {
-            Iso2709Rec rec;
-        } marc;
+           char *buf;
+           size_t size;
+            enum oid_value type;
+        } dbrec;
         struct {
-            int  condition;
-            char *addinfo;
-        } diag;
+            int num;
+            IrTcl_Diagnostic *list;
+        } surrogateDiagnostics;
     } u;
-    struct IRRecordList_ *next;
-} IRRecordList;
+    struct IrTcl_RecordList_ *next;
+} IrTcl_RecordList;
 
-typedef struct IRSetObj_ {
-    IRObj      *parent;
+typedef struct IrTcl_SetObj_ {
+    IrTcl_Obj  *parent;
     int         searchStatus;
+    int         presentStatus;
     int         resultCount;
+    int         nextResultSetPosition;
     int         start;
     int         number;
     int         numberOfRecordsReturned;
     char       *setName;
     int         recordFlag;
     int         which;
-    int         condition;
-    char       *addinfo;
-    IRRecordList *record_list;
-    IRSetCObj   set_inher;
-} IRSetObj;
+    int         nonSurrogateDiagnosticNum;
+    IrTcl_Diagnostic *nonSurrogateDiagnosticList;
+    IrTcl_RecordList *record_list;
+    IrTcl_SetCObj set_inher;
+} IrTcl_SetObj;
 
-typedef struct IRScanEntry_ {
+typedef struct IrTcl_ScanEntry_ {
     int         which;
     union {
         struct {
@@ -127,18 +209,14 @@ typedef struct IRScanEntry_ {
            int  globalOccurrences;
        } term;
        struct {
-           int  condition;
-           char *addinfo;
+            IrTcl_Diagnostic *list;
+            int num;
        } diag;
     } u;
-} IRScanEntry;
+} IrTcl_ScanEntry;
 
-typedef struct IRScanDiag_ {
-    int         dummy;
-} IRScanDiag;
-
-typedef struct IRScanObj_ {
-    IRObj      *parent;
+typedef struct IrTcl_ScanObj_ {
+    IrTcl_Obj   *parent;
     int         stepSize;
     int         numberOfTermsRequested;
     int         preferredPositionInResponse;
@@ -153,8 +231,29 @@ typedef struct IRScanObj_ {
     int         num_entries;
     int         num_diagRecs;
 
-    IRScanEntry *entries;
-    IRScanDiag  *nonSurrogateDiagnostics;
-} IRScanObj;
+    IrTcl_ScanEntry *entries;
+    IrTcl_Diagnostic  *nonSurrogateDiagnosticList;
+    int         nonSurrogateDiagnosticNum;
+} IrTcl_ScanObj;
+
+struct ir_named_entry {
+    char *name;
+    int  pos;
+};
+
+int ir_tcl_get_marc (Tcl_Interp *interp, const char *buf,
+                     int argc, char **argv);
+int ir_tcl_send (Tcl_Interp *interp, IrTcl_Obj *p, Z_APDU *apdu,
+                 const char *msg);
+char *ir_tcl_fread_marc (FILE *inf, size_t *size);
+
+#define IR_TCL_FAIL_CONNECT      1
+#define IR_TCL_FAIL_READ         2
+#define IR_TCL_FAIL_WRITE        3
+#define IR_TCL_FAIL_IN_APDU      4
+#define IR_TCL_FAIL_UNKNOWN_APDU 5
 
+#define IR_TCL_R_Queue           0
+#define IR_TCL_R_Writing         1
+#define IR_TCL_R_Waiting         2
 #endif