2 * Copyright (C) 1995-2005, Index Data ApS
3 * See the file LICENSE for details.
5 * $Id: zoom.h,v 1.33 2005-12-21 16:43:13 mike Exp $
9 * \brief Header for ZOOM
13 #include <yaz/yconfig.h>
15 #define ZOOM_BEGIN_CDECL YAZ_BEGIN_CDECL
16 #define ZOOM_END_CDECL YAZ_END_CDECL
19 # define ZOOM_API(x) __declspec(dllexport) x __stdcall
21 # define ZOOM_API(x) x
26 /* ----------------------------------------------------------- */
27 /* the types we use */
29 typedef struct ZOOM_options_p *ZOOM_options;
30 typedef struct ZOOM_query_p *ZOOM_query;
31 typedef struct ZOOM_connection_p *ZOOM_connection;
32 typedef struct ZOOM_resultset_p *ZOOM_resultset;
33 typedef struct ZOOM_record_p *ZOOM_record;
34 typedef struct ZOOM_scanset_p *ZOOM_scanset;
35 typedef struct ZOOM_package_p *ZOOM_package;
37 typedef const char *(*ZOOM_options_callback)(void *handle, const char *name);
39 /* ----------------------------------------------------------- */
42 /* create connection, connect to host, if portnum is 0, then port is
43 read from host string (e.g. myhost:9821) */
44 ZOOM_API(ZOOM_connection)
45 ZOOM_connection_new (const char *host, int portnum);
47 /* create connection, don't connect, apply options */
48 ZOOM_API(ZOOM_connection)
49 ZOOM_connection_create (ZOOM_options options);
51 /* connect given existing connection */
53 ZOOM_connection_connect(ZOOM_connection c, const char *host,
56 /* destroy connection (close connection also) */
58 ZOOM_connection_destroy (ZOOM_connection c);
60 /* get/set option for connection */
61 ZOOM_API(const char *)
62 ZOOM_connection_option_get (ZOOM_connection c, const char *key);
64 ZOOM_API(const char *)
65 ZOOM_connection_option_getl (ZOOM_connection c, const char *key, int *lenp);
68 ZOOM_connection_option_set (ZOOM_connection c, const char *key,
72 ZOOM_connection_option_setl (ZOOM_connection c, const char *key,
73 const char *val, int len);
75 /* return error code (0 == success, failure otherwise). cp
76 holds error string on failure, addinfo holds addititional info (if any)
79 ZOOM_connection_error (ZOOM_connection c, const char **cp,
80 const char **addinfo);
83 ZOOM_connection_error_x (ZOOM_connection c, const char **cp,
84 const char **addinfo, const char **diagset);
86 /* returns error code */
88 ZOOM_connection_errcode (ZOOM_connection c);
89 /* returns error message */
90 ZOOM_API(const char *)
91 ZOOM_connection_errmsg (ZOOM_connection c);
92 /* returns additional info */
93 ZOOM_API(const char *)
94 ZOOM_connection_addinfo (ZOOM_connection c);
95 /* returns diagnostic set */
96 ZOOM_API(const char *)
97 ZOOM_connection_diagset (ZOOM_connection c);
98 /* translates error code into human-readable string */
99 ZOOM_API(const char *)
100 ZOOM_diag_str (int error);
102 #define ZOOM_ERROR_NONE 0
103 #define ZOOM_ERROR_CONNECT 10000
104 #define ZOOM_ERROR_MEMORY 10001
105 #define ZOOM_ERROR_ENCODE 10002
106 #define ZOOM_ERROR_DECODE 10003
107 #define ZOOM_ERROR_CONNECTION_LOST 10004
108 #define ZOOM_ERROR_INIT 10005
109 #define ZOOM_ERROR_INTERNAL 10006
110 #define ZOOM_ERROR_TIMEOUT 10007
111 #define ZOOM_ERROR_UNSUPPORTED_PROTOCOL 10008
112 #define ZOOM_ERROR_UNSUPPORTED_QUERY 10009
113 #define ZOOM_ERROR_INVALID_QUERY 10010
114 #define ZOOM_ERROR_CQL_PARSE 10011
115 #define ZOOM_ERROR_CQL_TRANSFORM 10012
118 ZOOM_connection_last_event(ZOOM_connection cs);
120 #define ZOOM_EVENT_NONE 0
121 #define ZOOM_EVENT_CONNECT 1
122 #define ZOOM_EVENT_SEND_DATA 2
123 #define ZOOM_EVENT_RECV_DATA 3
124 #define ZOOM_EVENT_TIMEOUT 4
125 #define ZOOM_EVENT_UNKNOWN 5
126 #define ZOOM_EVENT_SEND_APDU 6
127 #define ZOOM_EVENT_RECV_APDU 7
128 #define ZOOM_EVENT_RECV_RECORD 8
129 #define ZOOM_EVENT_RECV_SEARCH 9
131 /* ----------------------------------------------------------- */
134 /* create result set given a search */
135 ZOOM_API(ZOOM_resultset)
136 ZOOM_connection_search(ZOOM_connection, ZOOM_query q);
137 /* create result set given PQF query */
138 ZOOM_API(ZOOM_resultset)
139 ZOOM_connection_search_pqf(ZOOM_connection c, const char *q);
141 /* destroy result set */
143 ZOOM_resultset_destroy(ZOOM_resultset r);
145 /* result set option */
146 ZOOM_API(const char *)
147 ZOOM_resultset_option_get (ZOOM_resultset r, const char *key);
149 ZOOM_resultset_option_set (ZOOM_resultset r, const char *key, const char *val);
151 /* return size of result set (alias hit count AKA result count) */
153 ZOOM_resultset_size (ZOOM_resultset r);
155 /* retrieve records */
157 ZOOM_resultset_records (ZOOM_resultset r, ZOOM_record *recs,
158 size_t start, size_t count);
160 /* return record object at pos. Returns 0 if unavailable */
161 ZOOM_API(ZOOM_record)
162 ZOOM_resultset_record (ZOOM_resultset s, size_t pos);
164 /* like ZOOM_resultset_record - but never blocks .. */
165 ZOOM_API(ZOOM_record)
166 ZOOM_resultset_record_immediate (ZOOM_resultset s, size_t pos);
168 /* reset record cache for result set */
170 ZOOM_resultset_cache_reset(ZOOM_resultset r);
172 /* ----------------------------------------------------------- */
175 /* get record information, in a form given by type */
176 ZOOM_API(const char *)
177 ZOOM_record_get (ZOOM_record rec, const char *type, int *len);
181 ZOOM_record_destroy (ZOOM_record rec);
183 /* return copy of record */
184 ZOOM_API(ZOOM_record)
185 ZOOM_record_clone (ZOOM_record srec);
187 /* ----------------------------------------------------------- */
190 /* create search object */
192 ZOOM_query_create(void);
195 ZOOM_query_destroy(ZOOM_query s);
198 ZOOM_query_cql(ZOOM_query s, const char *str);
199 /* CQL translated client-side into RPN: `conn' is optional for diagnostics */
201 ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn);
204 ZOOM_query_prefix(ZOOM_query s, const char *str);
205 /* specify sort criteria for search */
207 ZOOM_query_sortby(ZOOM_query s, const char *criteria);
209 /* ----------------------------------------------------------- */
211 ZOOM_API(ZOOM_scanset)
212 ZOOM_connection_scan (ZOOM_connection c, const char *startterm);
214 ZOOM_API(ZOOM_scanset)
215 ZOOM_connection_scan1 (ZOOM_connection c, ZOOM_query startterm);
217 ZOOM_API(const char *)
218 ZOOM_scanset_term(ZOOM_scanset scan, size_t pos,
221 ZOOM_API(const char *)
222 ZOOM_scanset_display_term(ZOOM_scanset scan, size_t pos,
226 ZOOM_scanset_size(ZOOM_scanset scan);
229 ZOOM_scanset_destroy (ZOOM_scanset scan);
231 ZOOM_API(const char *)
232 ZOOM_scanset_option_get (ZOOM_scanset scan, const char *key);
235 ZOOM_scanset_option_set (ZOOM_scanset scan, const char *key,
237 /* ----------------------------------------------------------- */
238 /* Extended Services Packages */
240 ZOOM_API(ZOOM_package)
241 ZOOM_connection_package (ZOOM_connection c, ZOOM_options options);
244 ZOOM_package_destroy(ZOOM_package p);
247 ZOOM_package_send (ZOOM_package p, const char *type);
249 ZOOM_API(const char *)
250 ZOOM_package_option_get (ZOOM_package p, const char *key);
253 ZOOM_package_option_set (ZOOM_package p, const char *key,
256 /* ----------------------------------------------------------- */
257 /* Sort. First function is deprecated, use second instead */
259 ZOOM_resultset_sort(ZOOM_resultset r,
260 const char *sort_type, const char *sort_spec);
262 ZOOM_resultset_sort1(ZOOM_resultset r,
263 const char *sort_type, const char *sort_spec);
265 /* ----------------------------------------------------------- */
268 ZOOM_API(ZOOM_options_callback)
269 ZOOM_options_set_callback (ZOOM_options opt,
270 ZOOM_options_callback c,
272 ZOOM_API(ZOOM_options)
273 ZOOM_options_create (void);
275 ZOOM_API(ZOOM_options)
276 ZOOM_options_create_with_parent (ZOOM_options parent);
278 ZOOM_API(ZOOM_options)
279 ZOOM_options_create_with_parent2 (ZOOM_options parent1,
280 ZOOM_options parent2);
282 ZOOM_API(const char *)
283 ZOOM_options_get (ZOOM_options opt, const char *name);
285 ZOOM_API(const char *)
286 ZOOM_options_getl (ZOOM_options opt, const char *name, int *lenp);
289 ZOOM_options_set (ZOOM_options opt, const char *name, const char *v);
292 ZOOM_options_setl (ZOOM_options opt, const char *name, const char *value,
296 ZOOM_options_destroy (ZOOM_options opt);
299 ZOOM_options_get_bool (ZOOM_options opt, const char *name, int defa);
302 ZOOM_options_get_int (ZOOM_options opt, const char *name, int defa);
305 ZOOM_options_set_int(ZOOM_options opt, const char *name, int value);
307 /* ----------------------------------------------------------- */
309 /* poll for events on a number of connections. Returns positive
310 integer if event occurred ; zero if none occurred and no more
311 events are pending. The positive integer specifies the
312 connection for which the event occurred. */
314 ZOOM_event (int no, ZOOM_connection *cs);
320 * indent-tabs-mode: nil
322 * vim: shiftwidth=4 tabstop=8 expandtab