/*
- * Public header for ZOOM C.
- * $Id: zoom.h,v 1.12 2002-05-17 12:48:29 adam Exp $
+ * Copyright (C) 1995-2005, Index Data ApS
+ * See the file LICENSE for details.
+ *
+ * $Id: zoom.h,v 1.36 2006-06-15 10:34:16 adam Exp $
+ */
+/**
+ * \file zoom.h
+ * \brief Header for ZOOM
*/
+#include <stdlib.h>
#include <yaz/yconfig.h>
#define ZOOM_BEGIN_CDECL YAZ_BEGIN_CDECL
typedef struct ZOOM_options_p *ZOOM_options;
typedef struct ZOOM_query_p *ZOOM_query;
typedef struct ZOOM_connection_p *ZOOM_connection;
-typedef struct ZOOM_resultset_p *ZOOM_resultset;
-typedef struct ZOOM_task_p *ZOOM_task;
+typedef struct ZOOM_resultset_p *ZOOM_resultset;
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 */
/* connect given existing connection */
ZOOM_API(void)
ZOOM_connection_connect(ZOOM_connection c, const char *host,
- int portnum);
+ int portnum);
/* destroy connection (close connection also) */
ZOOM_API(void)
ZOOM_API(const char *)
ZOOM_connection_option_get (ZOOM_connection c, const char *key);
+ZOOM_API(const char *)
+ZOOM_connection_option_getl (ZOOM_connection c, const char *key, int *lenp);
+
ZOOM_API(void)
ZOOM_connection_option_set (ZOOM_connection c, const char *key,
const char *val);
+ZOOM_API(void)
+ZOOM_connection_option_setl (ZOOM_connection c, const char *key,
+ const char *val, int len);
+
/* return error code (0 == success, failure otherwise). cp
holds error string on failure, addinfo holds addititional info (if any)
*/
ZOOM_API(int)
ZOOM_connection_error (ZOOM_connection c, const char **cp,
- const char **addinfo);
+ 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)
/* returns additional info */
ZOOM_API(const char *)
ZOOM_connection_addinfo (ZOOM_connection c);
+/* returns diagnostic set */
+ZOOM_API(const char *)
+ZOOM_connection_diagset (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
#define ZOOM_ERROR_INIT 10005
#define ZOOM_ERROR_INTERNAL 10006
#define ZOOM_ERROR_TIMEOUT 10007
+#define ZOOM_ERROR_UNSUPPORTED_PROTOCOL 10008
+#define ZOOM_ERROR_UNSUPPORTED_QUERY 10009
+#define ZOOM_ERROR_INVALID_QUERY 10010
+#define ZOOM_ERROR_CQL_PARSE 10011
+#define ZOOM_ERROR_CQL_TRANSFORM 10012
+#define ZOOM_ERROR_CCL_CONFIG 10013
+#define ZOOM_ERROR_CCL_PARSE 10014
ZOOM_API(int)
ZOOM_connection_last_event(ZOOM_connection cs);
#define ZOOM_EVENT_UNKNOWN 5
#define ZOOM_EVENT_SEND_APDU 6
#define ZOOM_EVENT_RECV_APDU 7
+#define ZOOM_EVENT_RECV_RECORD 8
+#define ZOOM_EVENT_RECV_SEARCH 9
+#define ZOOM_EVENT_END 10
/* ----------------------------------------------------------- */
/* result sets */
ZOOM_API(ZOOM_record)
ZOOM_resultset_record_immediate (ZOOM_resultset s, size_t pos);
+/* reset record cache for result set */
+ZOOM_API(void)
+ZOOM_resultset_cache_reset(ZOOM_resultset r);
+
/* ----------------------------------------------------------- */
/* records */
/* 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);
+/* CQL translated client-side into RPN: `conn' is optional for diagnostics */
+ZOOM_API(int)
+ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn);
+/* CCL translated client-side into RPN: `conn' is optional for diagnostics */
+ZOOM_API(int)
+ZOOM_query_ccl2rpn(ZOOM_query s, const char *query_str,
+ const char *config,
+ int *ccl_error, const char **error_string, int *error_pos);
+/* PQF */
ZOOM_API(int)
ZOOM_query_prefix(ZOOM_query s, const char *str);
/* specify sort criteria for search */
ZOOM_API(ZOOM_scanset)
ZOOM_connection_scan (ZOOM_connection c, const char *startterm);
+ZOOM_API(ZOOM_scanset)
+ZOOM_connection_scan1 (ZOOM_connection c, ZOOM_query startterm);
+
ZOOM_API(const char *)
ZOOM_scanset_term(ZOOM_scanset scan, size_t pos,
int *occ, int *len);
+ZOOM_API(const char *)
+ZOOM_scanset_display_term(ZOOM_scanset scan, size_t pos,
+ int *occ, int *len);
+
ZOOM_API(size_t)
ZOOM_scanset_size(ZOOM_scanset scan);
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);
+ 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_package_option_set (ZOOM_package p, const char *key,
+ const char *val);
+
+/* ----------------------------------------------------------- */
+/* Sort. First function is deprecated, use second instead */
+ZOOM_API(void)
+ ZOOM_resultset_sort(ZOOM_resultset r,
+ const char *sort_type, const char *sort_spec);
+ZOOM_API(int)
+ ZOOM_resultset_sort1(ZOOM_resultset r,
+ const char *sort_type, const char *sort_spec);
+
/* ----------------------------------------------------------- */
/* 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);
+ZOOM_API(const char *)
+ZOOM_options_getl (ZOOM_options opt, const char *name, int *lenp);
+
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)
ZOOM_event (int no, ZOOM_connection *cs);
ZOOM_END_CDECL
+/*
+ * Local variables:
+ * c-basic-offset: 4
+ * indent-tabs-mode: nil
+ * End:
+ * vim: shiftwidth=4 tabstop=8 expandtab
+ */
+