4dcf7925579aa773cc68c0f0d7430bb0154818be
[yaz-moved-to-github.git] / include / yaz / zoom.h
1 /*
2  * Copyright (C) 1995-2005, Index Data ApS
3  * See the file LICENSE for details.
4  *
5  * $Id: zoom.h,v 1.27 2005-10-11 18:24:33 adam Exp $
6  */
7 /**
8  * \file zoom.h
9  * \brief Header for ZOOM
10  */
11
12 #include <stdlib.h>
13 #include <yaz/yconfig.h>
14
15 #define ZOOM_BEGIN_CDECL YAZ_BEGIN_CDECL
16 #define ZOOM_END_CDECL YAZ_END_CDECL
17
18 #ifdef WIN32
19 #  define ZOOM_API(x) __declspec(dllexport) x __stdcall
20 #else
21 #  define ZOOM_API(x) x
22 # endif
23
24 ZOOM_BEGIN_CDECL
25
26 /* ----------------------------------------------------------- */
27 /* the types we use */
28
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;
36
37 typedef const char *(*ZOOM_options_callback)(void *handle, const char *name);
38
39 /* ----------------------------------------------------------- */
40 /* connections */
41
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);
46
47 /* create connection, don't connect, apply options */
48 ZOOM_API(ZOOM_connection)
49 ZOOM_connection_create (ZOOM_options options);
50
51 /* connect given existing connection */
52 ZOOM_API(void)
53 ZOOM_connection_connect(ZOOM_connection c, const char *host,
54                               int portnum);
55
56 /* destroy connection (close connection also) */
57 ZOOM_API(void)
58 ZOOM_connection_destroy (ZOOM_connection c);
59
60 /* get/set option for connection */
61 ZOOM_API(const char *)
62 ZOOM_connection_option_get (ZOOM_connection c, const char *key);
63
64 ZOOM_API(void)
65 ZOOM_connection_option_set (ZOOM_connection c, const char *key,
66                             const char *val);
67
68 ZOOM_API(void)
69 ZOOM_connection_option_setl (ZOOM_connection c, const char *key,
70                              const char *val, int len);
71
72 /* return error code (0 == success, failure otherwise). cp
73    holds error string on failure, addinfo holds addititional info (if any)
74 */
75 ZOOM_API(int)
76 ZOOM_connection_error (ZOOM_connection c, const char **cp,
77                             const char **addinfo);
78
79 ZOOM_API(int)
80 ZOOM_connection_error_x (ZOOM_connection c, const char **cp,
81                          const char **addinfo, const char **diagset);
82
83 /* returns error code */
84 ZOOM_API(int)
85 ZOOM_connection_errcode (ZOOM_connection c);
86 /* returns error message */
87 ZOOM_API(const char *)
88 ZOOM_connection_errmsg (ZOOM_connection c);
89 /* returns additional info */
90 ZOOM_API(const char *)
91 ZOOM_connection_addinfo (ZOOM_connection c);
92 /* translates error code into human-readable string */
93 ZOOM_API(const char *)
94 ZOOM_diag_str (int error);
95
96 #define ZOOM_ERROR_NONE 0
97 #define ZOOM_ERROR_CONNECT 10000
98 #define ZOOM_ERROR_MEMORY  10001
99 #define ZOOM_ERROR_ENCODE  10002
100 #define ZOOM_ERROR_DECODE  10003
101 #define ZOOM_ERROR_CONNECTION_LOST 10004
102 #define ZOOM_ERROR_INIT 10005
103 #define ZOOM_ERROR_INTERNAL 10006
104 #define ZOOM_ERROR_TIMEOUT 10007
105 #define ZOOM_ERROR_UNSUPPORTED_PROTOCOL 10008
106 #define ZOOM_ERROR_UNSUPPORTED_QUERY 10009
107 #define ZOOM_ERROR_INVALID_QUERY 10010
108
109 ZOOM_API(int)
110 ZOOM_connection_last_event(ZOOM_connection cs);
111
112 #define ZOOM_EVENT_NONE 0
113 #define ZOOM_EVENT_CONNECT 1
114 #define ZOOM_EVENT_SEND_DATA  2
115 #define ZOOM_EVENT_RECV_DATA 3
116 #define ZOOM_EVENT_TIMEOUT 4
117 #define ZOOM_EVENT_UNKNOWN 5
118 #define ZOOM_EVENT_SEND_APDU 6
119 #define ZOOM_EVENT_RECV_APDU 7
120 #define ZOOM_EVENT_RECV_RECORD 8
121 #define ZOOM_EVENT_RECV_SEARCH 9
122
123 /* ----------------------------------------------------------- */
124 /* result sets */
125
126 /* create result set given a search */
127 ZOOM_API(ZOOM_resultset)
128 ZOOM_connection_search(ZOOM_connection, ZOOM_query q);
129 /* create result set given PQF query */
130 ZOOM_API(ZOOM_resultset)
131 ZOOM_connection_search_pqf(ZOOM_connection c, const char *q);
132
133 /* destroy result set */
134 ZOOM_API(void)
135 ZOOM_resultset_destroy(ZOOM_resultset r);
136
137 /* result set option */
138 ZOOM_API(const char *)
139 ZOOM_resultset_option_get (ZOOM_resultset r, const char *key);
140 ZOOM_API(void)
141 ZOOM_resultset_option_set (ZOOM_resultset r, const char *key, const char *val);
142
143 /*┬áreturn size of result set (alias hit count AKA result count) */
144 ZOOM_API(size_t)
145 ZOOM_resultset_size (ZOOM_resultset r);
146
147 /* retrieve records */
148 ZOOM_API(void)
149 ZOOM_resultset_records (ZOOM_resultset r, ZOOM_record *recs,
150                         size_t start, size_t count);
151
152 /* return record object at pos. Returns 0 if unavailable */
153 ZOOM_API(ZOOM_record)
154 ZOOM_resultset_record (ZOOM_resultset s, size_t pos);
155
156 /* like ZOOM_resultset_record - but never blocks .. */
157 ZOOM_API(ZOOM_record)
158 ZOOM_resultset_record_immediate (ZOOM_resultset s, size_t pos);
159
160 /* reset record cache for result set */
161 ZOOM_API(void)
162 ZOOM_resultset_cache_reset(ZOOM_resultset r);
163
164 /* ----------------------------------------------------------- */
165 /* records */
166
167 /* get record information, in a form given by type */
168 ZOOM_API(const char *)
169 ZOOM_record_get (ZOOM_record rec, const char *type, int *len);
170
171 /* destroy record */
172 ZOOM_API(void)
173 ZOOM_record_destroy (ZOOM_record rec);
174
175 /* return copy of record */
176 ZOOM_API(ZOOM_record)
177 ZOOM_record_clone (ZOOM_record srec);
178
179 /* ----------------------------------------------------------- */
180 /* queries */
181
182 /* create search object */
183 ZOOM_API(ZOOM_query)
184 ZOOM_query_create(void);
185 /* destroy it */
186 ZOOM_API(void)
187 ZOOM_query_destroy(ZOOM_query s);
188 /* CQL */
189 ZOOM_API(int)
190 ZOOM_query_cql(ZOOM_query s, const char *str);
191 /* PQF */
192 ZOOM_API(int)
193 ZOOM_query_prefix(ZOOM_query s, const char *str);
194 /* specify sort criteria for search */
195 ZOOM_API(int)
196 ZOOM_query_sortby(ZOOM_query s, const char *criteria);
197
198 /* ----------------------------------------------------------- */
199 /* scan */
200 ZOOM_API(ZOOM_scanset)
201 ZOOM_connection_scan (ZOOM_connection c, const char *startterm);
202
203 ZOOM_API(const char *)
204 ZOOM_scanset_term(ZOOM_scanset scan, size_t pos,
205                   int *occ, int *len);
206
207 ZOOM_API(const char *)
208 ZOOM_scanset_display_term(ZOOM_scanset scan, size_t pos,
209                           int *occ, int *len);
210
211 ZOOM_API(size_t)
212 ZOOM_scanset_size(ZOOM_scanset scan);
213
214 ZOOM_API(void)
215 ZOOM_scanset_destroy (ZOOM_scanset scan);
216
217 ZOOM_API(const char *)
218     ZOOM_scanset_option_get (ZOOM_scanset scan, const char *key);
219
220 ZOOM_API(void)
221     ZOOM_scanset_option_set (ZOOM_scanset scan, const char *key,
222                              const char *val);
223 /* ----------------------------------------------------------- */
224 /* Extended Services Packages */
225
226 ZOOM_API(ZOOM_package)
227     ZOOM_connection_package (ZOOM_connection c, ZOOM_options options);
228
229 ZOOM_API(void)
230     ZOOM_package_destroy(ZOOM_package p);
231
232 ZOOM_API(void)
233     ZOOM_package_send (ZOOM_package p, const char *type);
234
235 ZOOM_API(const char *)
236     ZOOM_package_option_get (ZOOM_package p, const char *key);
237
238 ZOOM_API(void)
239     ZOOM_package_option_set (ZOOM_package p, const char *key,
240                              const char *val);
241
242 /* ----------------------------------------------------------- */
243 /* Sort */
244 ZOOM_API(void)
245     ZOOM_resultset_sort(ZOOM_resultset r,
246                         const char *sort_type, const char *sort_spec);
247
248 /* ----------------------------------------------------------- */
249 /* options */
250
251 ZOOM_API(ZOOM_options_callback)
252     ZOOM_options_set_callback (ZOOM_options opt,
253                                ZOOM_options_callback c,
254                                void *handle);
255 ZOOM_API(ZOOM_options)
256 ZOOM_options_create (void);
257
258 ZOOM_API(ZOOM_options)
259 ZOOM_options_create_with_parent (ZOOM_options parent);
260
261 ZOOM_API(ZOOM_options)
262     ZOOM_options_create_with_parent2 (ZOOM_options parent1,
263                                       ZOOM_options parent2);
264
265 ZOOM_API(const char *)
266 ZOOM_options_get (ZOOM_options opt, const char *name);
267
268 ZOOM_API(void)
269 ZOOM_options_set (ZOOM_options opt, const char *name, const char *v);
270
271 ZOOM_API(void)
272 ZOOM_options_setl (ZOOM_options opt, const char *name, const char *value,
273                    int len);
274
275 ZOOM_API(void)
276 ZOOM_options_destroy (ZOOM_options opt);
277
278 ZOOM_API(int)
279 ZOOM_options_get_bool (ZOOM_options opt, const char *name, int defa);
280
281 ZOOM_API(int)
282 ZOOM_options_get_int (ZOOM_options opt, const char *name, int defa);
283
284 ZOOM_API(void)
285 ZOOM_options_set_int(ZOOM_options opt, const char *name, int value);
286
287 /* ----------------------------------------------------------- */
288 /* events */
289 /* poll for events on a number of connections. Returns positive
290    integer if event occurred ; zero if none occurred and no more
291    events are pending. The positive integer specifies the
292    connection for which the event occurred. */
293 ZOOM_API(int)
294 ZOOM_event (int no, ZOOM_connection *cs);
295
296 ZOOM_END_CDECL
297 /*
298  * Local variables:
299  * c-basic-offset: 4
300  * indent-tabs-mode: nil
301  * End:
302  * vim: shiftwidth=4 tabstop=8 expandtab
303  */
304