/*
- * Public header for ZOOM C.
- * $Id: zoom.h,v 1.6 2001-11-16 09:52:39 adam Exp $
+ * Copyright (C) 1995-2005, Index Data ApS
+ * See the file LICENSE for details.
+ *
+ * $Id: zoom.h,v 1.33 2005-12-21 16:43:13 mike Exp $
+ */
+/**
+ * \file zoom.h
+ * \brief Header for ZOOM
*/
+#include <stdlib.h>
#include <yaz/yconfig.h>
-#define ZOOM_EXPORT YAZ_EXPORT
#define ZOOM_BEGIN_CDECL YAZ_BEGIN_CDECL
#define ZOOM_END_CDECL YAZ_END_CDECL
+#ifdef WIN32
+# define ZOOM_API(x) __declspec(dllexport) x __stdcall
+#else
+# define ZOOM_API(x) x
+# endif
+
ZOOM_BEGIN_CDECL
/* ----------------------------------------------------------- */
/* the types we use */
-typedef struct Z3950_options_p *Z3950_options;
-typedef struct Z3950_query_p *Z3950_query;
-typedef struct Z3950_connection_p *Z3950_connection;
-typedef struct Z3950_resultset_p *Z3950_resultset;
-typedef struct Z3950_task_p *Z3950_task;
-typedef struct Z3950_record_p *Z3950_record;
+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_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 */
/* create connection, connect to host, if portnum is 0, then port is
read from host string (e.g. myhost:9821) */
-ZOOM_EXPORT
-Z3950_connection Z3950_connection_new (const char *host, int portnum);
+ZOOM_API(ZOOM_connection)
+ZOOM_connection_new (const char *host, int portnum);
/* create connection, don't connect, apply options */
-ZOOM_EXPORT
-Z3950_connection Z3950_connection_create (Z3950_options options);
+ZOOM_API(ZOOM_connection)
+ZOOM_connection_create (ZOOM_options options);
/* connect given existing connection */
-ZOOM_EXPORT
-void Z3950_connection_connect(Z3950_connection c, const char *host,
- int portnum);
+ZOOM_API(void)
+ZOOM_connection_connect(ZOOM_connection c, const char *host,
+ int portnum);
/* destroy connection (close connection also) */
-ZOOM_EXPORT
-void Z3950_connection_destroy (Z3950_connection c);
+ZOOM_API(void)
+ZOOM_connection_destroy (ZOOM_connection c);
/* get/set option for connection */
-ZOOM_EXPORT
-const char *Z3950_connection_option_get (Z3950_connection c, const char *key);
+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_EXPORT
-void Z3950_connection_option_set (Z3950_connection c, const char *key,
- const char *val);
+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_EXPORT
-int Z3950_connection_error (Z3950_connection c, const char **cp,
- const char **addinfo);
+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_EXPORT
-int Z3950_connection_errcode (Z3950_connection c);
+ZOOM_API(int)
+ZOOM_connection_errcode (ZOOM_connection c);
/* returns error message */
-ZOOM_EXPORT
-const char *Z3950_connection_errmsg (Z3950_connection c);
+ZOOM_API(const char *)
+ZOOM_connection_errmsg (ZOOM_connection c);
/* returns additional info */
-ZOOM_EXPORT
-const char *Z3950_connection_addinfo (Z3950_connection c);
-
-#define Z3950_ERROR_NONE 0
-#define Z3950_ERROR_CONNECT 10000
-#define Z3950_ERROR_MEMORY 10001
-#define Z3950_ERROR_ENCODE 10002
-#define Z3950_ERROR_DECODE 10003
-#define Z3950_ERROR_CONNECTION_LOST 10004
-#define Z3950_ERROR_INIT 10005
-#define Z3950_ERROR_INTERNAL 10006
-#define Z3950_ERROR_TIMEOUT 10007
+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_MEMORY 10001
+#define ZOOM_ERROR_ENCODE 10002
+#define ZOOM_ERROR_DECODE 10003
+#define ZOOM_ERROR_CONNECTION_LOST 10004
+#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
+
+ZOOM_API(int)
+ZOOM_connection_last_event(ZOOM_connection cs);
+
+#define ZOOM_EVENT_NONE 0
+#define ZOOM_EVENT_CONNECT 1
+#define ZOOM_EVENT_SEND_DATA 2
+#define ZOOM_EVENT_RECV_DATA 3
+#define ZOOM_EVENT_TIMEOUT 4
+#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
/* ----------------------------------------------------------- */
/* result sets */
/* create result set given a search */
-ZOOM_EXPORT
-Z3950_resultset Z3950_connection_search(Z3950_connection, Z3950_query q);
+ZOOM_API(ZOOM_resultset)
+ZOOM_connection_search(ZOOM_connection, ZOOM_query q);
/* create result set given PQF query */
-ZOOM_EXPORT
-Z3950_resultset Z3950_connection_search_pqf(Z3950_connection c, const char *q);
+ZOOM_API(ZOOM_resultset)
+ZOOM_connection_search_pqf(ZOOM_connection c, const char *q);
/* destroy result set */
-ZOOM_EXPORT
-void Z3950_resultset_destroy(Z3950_resultset r);
+ZOOM_API(void)
+ZOOM_resultset_destroy(ZOOM_resultset r);
/* result set option */
-ZOOM_EXPORT
-const char *Z3950_resultset_option_get (Z3950_resultset r, const char *key);
-ZOOM_EXPORT
-void Z3950_resultset_option_set (Z3950_resultset r, const char *key, const char *val);
+ZOOM_API(const char *)
+ZOOM_resultset_option_get (ZOOM_resultset r, const char *key);
+ZOOM_API(void)
+ZOOM_resultset_option_set (ZOOM_resultset r, const char *key, const char *val);
/* return size of result set (alias hit count AKA result count) */
-ZOOM_EXPORT
-size_t Z3950_resultset_size (Z3950_resultset r);
+ZOOM_API(size_t)
+ZOOM_resultset_size (ZOOM_resultset r);
/* retrieve records */
-ZOOM_EXPORT
-void Z3950_resultset_records (Z3950_resultset r, Z3950_record *recs,
- size_t start, size_t count);
+ZOOM_API(void)
+ZOOM_resultset_records (ZOOM_resultset r, ZOOM_record *recs,
+ size_t start, size_t count);
/* return record object at pos. Returns 0 if unavailable */
-ZOOM_EXPORT
-Z3950_record Z3950_resultset_record (Z3950_resultset s, size_t pos);
+ZOOM_API(ZOOM_record)
+ZOOM_resultset_record (ZOOM_resultset s, size_t pos);
-/* like Z3950_resultset_record - but never blocks .. */
-ZOOM_EXPORT
-Z3950_record Z3950_resultset_record_immediate (Z3950_resultset s, size_t pos);
+/* like ZOOM_resultset_record - but never blocks .. */
+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 */
/* get record information, in a form given by type */
-ZOOM_EXPORT
-void *Z3950_record_get (Z3950_record rec, const char *type, size_t *len);
+ZOOM_API(const char *)
+ZOOM_record_get (ZOOM_record rec, const char *type, int *len);
/* destroy record */
-ZOOM_EXPORT
-void Z3950_record_destroy (Z3950_record rec);
+ZOOM_API(void)
+ZOOM_record_destroy (ZOOM_record rec);
/* return copy of record */
-ZOOM_EXPORT
-Z3950_record Z3950_record_dup (Z3950_record srec);
+ZOOM_API(ZOOM_record)
+ZOOM_record_clone (ZOOM_record srec);
/* ----------------------------------------------------------- */
-/* searches */
+/* queries */
/* create search object */
-ZOOM_EXPORT
-Z3950_query Z3950_query_create(void);
+ZOOM_API(ZOOM_query)
+ZOOM_query_create(void);
/* destroy it */
-ZOOM_EXPORT
-void Z3950_query_destroy(Z3950_query s);
-/* specify prefix query for search */
-ZOOM_EXPORT
-int Z3950_query_prefix(Z3950_query s, const char *str);
+ZOOM_API(void)
+ZOOM_query_destroy(ZOOM_query s);
+/* 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);
+/* PQF */
+ZOOM_API(int)
+ZOOM_query_prefix(ZOOM_query s, const char *str);
/* specify sort criteria for search */
-ZOOM_EXPORT
-int Z3950_query_sortby(Z3950_query s, const char *criteria);
+ZOOM_API(int)
+ZOOM_query_sortby(ZOOM_query s, const char *criteria);
+
+/* ----------------------------------------------------------- */
+/* scan */
+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_API(void)
+ZOOM_scanset_destroy (ZOOM_scanset scan);
+
+ZOOM_API(const char *)
+ 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_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 *(*Z3950_options_callback)(void *handle, const char *name);
-ZOOM_EXPORT
-Z3950_options_callback Z3950_options_set_callback (Z3950_options opt,
- Z3950_options_callback c,
- void *handle);
-ZOOM_EXPORT
-Z3950_options Z3950_options_create (void);
+ZOOM_API(ZOOM_options_callback)
+ 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_EXPORT
-Z3950_options Z3950_options_create_with_parent (Z3950_options parent);
+ZOOM_API(const char *)
+ZOOM_options_getl (ZOOM_options opt, const char *name, int *lenp);
-ZOOM_EXPORT
-const char *Z3950_options_get (Z3950_options opt, const char *name);
+ZOOM_API(void)
+ZOOM_options_set (ZOOM_options opt, const char *name, const char *v);
-ZOOM_EXPORT
-void Z3950_options_set (Z3950_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_EXPORT
-void Z3950_options_destroy (Z3950_options opt);
+ZOOM_API(void)
+ZOOM_options_destroy (ZOOM_options opt);
-ZOOM_EXPORT
-int Z3950_options_get_bool (Z3950_options opt, const char *name, int defa);
+ZOOM_API(int)
+ZOOM_options_get_bool (ZOOM_options opt, const char *name, int defa);
-ZOOM_EXPORT
-int Z3950_options_get_int (Z3950_options opt, const char *name, int defa);
+ZOOM_API(int)
+ZOOM_options_get_int (ZOOM_options opt, const char *name, int defa);
-ZOOM_EXPORT
-void Z3950_options_addref (Z3950_options opt);
+ZOOM_API(void)
+ZOOM_options_set_int(ZOOM_options opt, const char *name, int value);
/* ----------------------------------------------------------- */
/* events */
/* poll for events on a number of connections. Returns positive
integer if event occurred ; zero if none occurred and no more
events are pending. The positive integer specifies the
- connection for which the event occurred. There's no way to get
- the details yet, sigh. */
-ZOOM_EXPORT
-int Z3950_event (int no, Z3950_connection *cs);
+ connection for which the event occurred. */
+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
+ */
+
projects / yaz-moved-to-github.git / blobdiff