SRW, CQL, 2003

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

diff --git a/include/yaz/zoom.h b/include/yaz/zoom.h
index 50b448b..956bd51 100644 (file)
--- a/include/yaz/zoom.h
+++ b/include/yaz/zoom.h
@@ -1,6 +1,6 @@
 /*
  * Public header for ZOOM C.
- * $Id: zoom.h,v 1.12 2002-05-17 12:48:29 adam Exp $
+ * $Id: zoom.h,v 1.16 2003-01-06 08:20:27 adam Exp $
  */
 
 #include <yaz/yconfig.h>
@@ -26,6 +26,9 @@ typedef       struct ZOOM_resultset_p *ZOOM_resultset;
 typedef struct ZOOM_task_p *ZOOM_task;
 typedef struct ZOOM_record_p *ZOOM_record;
 typedef struct ZOOM_scanset_p *ZOOM_scanset;
+typedef struct ZOOM_package_p *ZOOM_package;
+
+typedef const char *(*ZOOM_options_callback)(void *handle, const char *name);
 
 /* ----------------------------------------------------------- */
 /* connections */
@@ -63,6 +66,10 @@ ZOOM_API(int)
 ZOOM_connection_error (ZOOM_connection c, const char **cp,
                            const char **addinfo);
 
+ZOOM_API(int)
+ZOOM_connection_error_x (ZOOM_connection c, const char **cp,
+                         const char **addinfo, const char **diagset);
+
 /* returns error code */
 ZOOM_API(int)
 ZOOM_connection_errcode (ZOOM_connection c);
@@ -72,6 +79,9 @@ ZOOM_connection_errmsg (ZOOM_connection c);
 /* returns additional info */
 ZOOM_API(const char *)
 ZOOM_connection_addinfo (ZOOM_connection c);
+/* translates error code into human-readable string */
+ZOOM_API(const char *)
+ZOOM_diag_str (int error);
 
 #define ZOOM_ERROR_NONE 0
 #define ZOOM_ERROR_CONNECT 10000
@@ -82,6 +92,7 @@ ZOOM_connection_addinfo (ZOOM_connection c);
 #define ZOOM_ERROR_INIT 10005
 #define ZOOM_ERROR_INTERNAL 10006
 #define ZOOM_ERROR_TIMEOUT 10007
+#define ZOOM_ERROR_UNSUPPORTED_PROTOCOL 10008
 
 ZOOM_API(int)
 ZOOM_connection_last_event(ZOOM_connection cs);
@@ -156,7 +167,10 @@ ZOOM_query_create(void);
 /* destroy it */
 ZOOM_API(void)
 ZOOM_query_destroy(ZOOM_query s);
-/* specify prefix query for search */
+/* CQL */
+ZOOM_API(int)
+ZOOM_query_cql(ZOOM_query s, const char *str);
+/* PQF */
 ZOOM_API(int)
 ZOOM_query_prefix(ZOOM_query s, const char *str);
 /* specify sort criteria for search */
@@ -179,25 +193,47 @@ ZOOM_API(void)
 ZOOM_scanset_destroy (ZOOM_scanset scan);
 
 ZOOM_API(const char *)
-ZOOM_scanset_option_get (ZOOM_scanset scan, const char *key);
+    ZOOM_scanset_option_get (ZOOM_scanset scan, const char *key);
+
+ZOOM_API(void)
+    ZOOM_scanset_option_set (ZOOM_scanset scan, const char *key,
+                             const char *val);
+/* ----------------------------------------------------------- */
+/* Extended Services Packages */
+
+ZOOM_API(ZOOM_package)
+    ZOOM_connection_package (ZOOM_connection c, ZOOM_options options);
+
+ZOOM_API(void)
+    ZOOM_package_destroy(ZOOM_package p);
+
+ZOOM_API(void)
+    ZOOM_package_send (ZOOM_package p, const char *type);
+
+ZOOM_API(const char *)
+    ZOOM_package_option_get (ZOOM_package p, const char *key);
 
 ZOOM_API(void)
-ZOOM_scanset_option_set (ZOOM_scanset scan, const char *key,
-                         const char *val);
+    ZOOM_package_option_set (ZOOM_package p, const char *key,
+                             const char *val);
+
 /* ----------------------------------------------------------- */
 /* options */
-typedef const char *(*ZOOM_options_callback)(void *handle, const char *name);
 
 ZOOM_API(ZOOM_options_callback)
-ZOOM_options_set_callback (ZOOM_options opt,
-                                                  ZOOM_options_callback c,
-                                                  void *handle);
+    ZOOM_options_set_callback (ZOOM_options opt,
+                               ZOOM_options_callback c,
+                               void *handle);
 ZOOM_API(ZOOM_options)
 ZOOM_options_create (void);
 
 ZOOM_API(ZOOM_options)
 ZOOM_options_create_with_parent (ZOOM_options parent);
 
+ZOOM_API(ZOOM_options)
+    ZOOM_options_create_with_parent2 (ZOOM_options parent1,
+                                      ZOOM_options parent2);
+
 ZOOM_API(const char *)
 ZOOM_options_get (ZOOM_options opt, const char *name);
 
@@ -205,6 +241,10 @@ ZOOM_API(void)
 ZOOM_options_set (ZOOM_options opt, const char *name, const char *v);
 
 ZOOM_API(void)
+ZOOM_options_setl (ZOOM_options opt, const char *name, const char *value,
+                   int len);
+
+ZOOM_API(void)
 ZOOM_options_destroy (ZOOM_options opt);
 
 ZOOM_API(int)