ZOOM: diagnostics for invalid ES usage, bug #3893.

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

diff --git a/include/yaz/zoom.h b/include/yaz/zoom.h
index 1f0e3c4..a505e12 100644 (file)
--- a/include/yaz/zoom.h
+++ b/include/yaz/zoom.h
@@ -1,5 +1,5 @@
 /* This file is part of the YAZ toolkit.
- * Copyright (C) 1995-2010 Index Data.
+ * Copyright (C) 1995-2011 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:
@@ -52,6 +52,7 @@ typedef struct ZOOM_query_p *ZOOM_query;
 typedef struct ZOOM_connection_p *ZOOM_connection;
 typedef struct ZOOM_resultset_p *ZOOM_resultset;
 typedef struct ZOOM_record_p *ZOOM_record;
+typedef struct ZOOM_facet_field_p *ZOOM_facet_field;
 typedef struct ZOOM_scanset_p *ZOOM_scanset;
 typedef struct ZOOM_package_p *ZOOM_package;
 
@@ -139,6 +140,9 @@ ZOOM_diag_str (int error);
 #define ZOOM_ERROR_CQL_TRANSFORM 10012
 #define ZOOM_ERROR_CCL_CONFIG 10013
 #define ZOOM_ERROR_CCL_PARSE 10014
+#define ZOOM_ERROR_ES_INVALID_ACTION 10015
+#define ZOOM_ERROR_ES_INVALID_VERSION 10016
+#define ZOOM_ERROR_ES_INVALID_SYNTAX 10017
 
 ZOOM_API(int)
 ZOOM_connection_last_event(ZOOM_connection cs);
@@ -170,6 +174,14 @@ ZOOM_connection_search_pqf(ZOOM_connection c, const char *q);
 ZOOM_API(void)
 ZOOM_resultset_destroy(ZOOM_resultset r);
 
+/** release result set from connection.
+
+    The result will will no longer be able to perform retrievals
+    from the connection from which it was created.
+*/
+ZOOM_API(void)
+ZOOM_resultset_release(ZOOM_resultset r);
+
 /* result set option */
 ZOOM_API(const char *)
 ZOOM_resultset_option_get(ZOOM_resultset r, const char *key);
@@ -197,6 +209,29 @@ ZOOM_resultset_record_immediate(ZOOM_resultset s, size_t pos);
 ZOOM_API(void)
 ZOOM_resultset_cache_reset(ZOOM_resultset r);
 
+
+/* retrieve facet field */
+ZOOM_API(ZOOM_facet_field)
+ZOOM_resultset_get_facet_field(ZOOM_resultset r, const char *facet_name);
+
+/* retrieve facet field at position. Returns 0 if unavailable */
+ZOOM_API(ZOOM_facet_field)
+ZOOM_resultset_get_facet_field_by_index(ZOOM_resultset r, int pos);
+
+/* return number of facets available */
+ZOOM_API(size_t)
+ZOOM_resultset_facets_size(ZOOM_resultset r);
+
+/* retrieve (array of pointers to) facet fields */
+ZOOM_API(ZOOM_facet_field *)
+ZOOM_resultset_facets(ZOOM_resultset r);
+
+/* retrieve (array of pointers to) facet fields */
+ZOOM_API(const char **)
+ZOOM_resultset_facets_names(ZOOM_resultset r);
+
+
+
 /* ----------------------------------------------------------- */
 /* records */
 
@@ -218,6 +253,23 @@ ZOOM_API(int)
                       const char **addinfo, const char **diagset);
     
 /* ----------------------------------------------------------- */
+/* facets */
+
+/* get facet name */
+ZOOM_API(const char *)
+ZOOM_facet_field_name(ZOOM_facet_field facet_field);
+
+/* get terms count on facet */
+ZOOM_API(size_t)
+ZOOM_facet_field_term_count(ZOOM_facet_field facet_field);
+
+/* get facet information, term and frequency, at a position. Returns 0 if out of bounds */
+ZOOM_API(const char *)
+ZOOM_facet_field_get_term(ZOOM_facet_field facet_field, size_t idx, int *freq);
+
+/* ----------------------------------------------------------- */
+
+
 /* queries */
 
 /* create search object */
@@ -244,6 +296,9 @@ ZOOM_query_prefix(ZOOM_query s, const char *str);
 ZOOM_API(int)
 ZOOM_query_sortby(ZOOM_query s, const char *criteria);
 
+ZOOM_API(void)
+ZOOM_query_addref(ZOOM_query s);
+
 /* ----------------------------------------------------------- */
 /* scan */
 ZOOM_API(ZOOM_scanset)
@@ -416,6 +471,20 @@ ZOOM_API(int)
 ZOOM_connection_process(ZOOM_connection c);
 
 
+/** \brief executes non-blocking tasks for connection
+    \param c connection
+    \retval 0 no task was executed
+    \retval 1 task was executed (but probably not completed)
+
+    This function, unlike, ZOOM_connection_process, does not try to
+    return any events (and remove them). But events may be generated
+    from it. These are saved and may later be retrieved with
+    ZOOM_connection_process and ZOOM_connection_last_event .
+*/
+ZOOM_API(int)
+ZOOM_connection_exec_task(ZOOM_connection c);
+
+
 /** \brief get socket fd for ZOOM connection
     \param c connection
     \retval -1 no socket assigned for connection
@@ -477,7 +546,6 @@ ZOOM_API(int)
 ZOOM_connection_fire_event_socket(ZOOM_connection c, int mask);
 
 
-
 /** \brief peek at next event
     \param c connection
     \returns ZOOM_EVENT_NONE (for no events in queue), ZOOM_EVENT_CONNECT, ..