Add ZOOM_connection_option_getl() and ZOOM_options_getl()
[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.28 2005-10-17 12:25:04 mike 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(const char *)
65 ZOOM_connection_option_getl (ZOOM_connection c, const char *key, int *lenp);
66
67 ZOOM_API(void)
68 ZOOM_connection_option_set (ZOOM_connection c, const char *key,
69                             const char *val);
70
71 ZOOM_API(void)
72 ZOOM_connection_option_setl (ZOOM_connection c, const char *key,
73                              const char *val, int len);
74
75 /* return error code (0 == success, failure otherwise). cp
76    holds error string on failure, addinfo holds addititional info (if any)
77 */
78 ZOOM_API(int)
79 ZOOM_connection_error (ZOOM_connection c, const char **cp,
80                             const char **addinfo);
81
82 ZOOM_API(int)
83 ZOOM_connection_error_x (ZOOM_connection c, const char **cp,
84                          const char **addinfo, const char **diagset);
85
86 /* returns error code */
87 ZOOM_API(int)
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 /* translates error code into human-readable string */
96 ZOOM_API(const char *)
97 ZOOM_diag_str (int error);
98
99 #define ZOOM_ERROR_NONE 0
100 #define ZOOM_ERROR_CONNECT 10000
101 #define ZOOM_ERROR_MEMORY  10001
102 #define ZOOM_ERROR_ENCODE  10002
103 #define ZOOM_ERROR_DECODE  10003
104 #define ZOOM_ERROR_CONNECTION_LOST 10004
105 #define ZOOM_ERROR_INIT 10005
106 #define ZOOM_ERROR_INTERNAL 10006
107 #define ZOOM_ERROR_TIMEOUT 10007
108 #define ZOOM_ERROR_UNSUPPORTED_PROTOCOL 10008
109 #define ZOOM_ERROR_UNSUPPORTED_QUERY 10009
110 #define ZOOM_ERROR_INVALID_QUERY 10010
111
112 ZOOM_API(int)
113 ZOOM_connection_last_event(ZOOM_connection cs);
114
115 #define ZOOM_EVENT_NONE 0
116 #define ZOOM_EVENT_CONNECT 1
117 #define ZOOM_EVENT_SEND_DATA  2
118 #define ZOOM_EVENT_RECV_DATA 3
119 #define ZOOM_EVENT_TIMEOUT 4
120 #define ZOOM_EVENT_UNKNOWN 5
121 #define ZOOM_EVENT_SEND_APDU 6
122 #define ZOOM_EVENT_RECV_APDU 7
123 #define ZOOM_EVENT_RECV_RECORD 8
124 #define ZOOM_EVENT_RECV_SEARCH 9
125
126 /* ----------------------------------------------------------- */
127 /* result sets */
128
129 /* create result set given a search */
130 ZOOM_API(ZOOM_resultset)
131 ZOOM_connection_search(ZOOM_connection, ZOOM_query q);
132 /* create result set given PQF query */
133 ZOOM_API(ZOOM_resultset)
134 ZOOM_connection_search_pqf(ZOOM_connection c, const char *q);
135
136 /* destroy result set */
137 ZOOM_API(void)
138 ZOOM_resultset_destroy(ZOOM_resultset r);
139
140 /* result set option */
141 ZOOM_API(const char *)
142 ZOOM_resultset_option_get (ZOOM_resultset r, const char *key);
143 ZOOM_API(void)
144 ZOOM_resultset_option_set (ZOOM_resultset r, const char *key, const char *val);
145
146 /*┬áreturn size of result set (alias hit count AKA result count) */
147 ZOOM_API(size_t)
148 ZOOM_resultset_size (ZOOM_resultset r);
149
150 /* retrieve records */
151 ZOOM_API(void)
152 ZOOM_resultset_records (ZOOM_resultset r, ZOOM_record *recs,
153                         size_t start, size_t count);
154
155 /* return record object at pos. Returns 0 if unavailable */
156 ZOOM_API(ZOOM_record)
157 ZOOM_resultset_record (ZOOM_resultset s, size_t pos);
158
159 /* like ZOOM_resultset_record - but never blocks .. */
160 ZOOM_API(ZOOM_record)
161 ZOOM_resultset_record_immediate (ZOOM_resultset s, size_t pos);
162
163 /* reset record cache for result set */
164 ZOOM_API(void)
165 ZOOM_resultset_cache_reset(ZOOM_resultset r);
166
167 /* ----------------------------------------------------------- */
168 /* records */
169
170 /* get record information, in a form given by type */
171 ZOOM_API(const char *)
172 ZOOM_record_get (ZOOM_record rec, const char *type, int *len);
173
174 /* destroy record */
175 ZOOM_API(void)
176 ZOOM_record_destroy (ZOOM_record rec);
177
178 /* return copy of record */
179 ZOOM_API(ZOOM_record)
180 ZOOM_record_clone (ZOOM_record srec);
181
182 /* ----------------------------------------------------------- */
183 /* queries */
184
185 /* create search object */
186 ZOOM_API(ZOOM_query)
187 ZOOM_query_create(void);
188 /* destroy it */
189 ZOOM_API(void)
190 ZOOM_query_destroy(ZOOM_query s);
191 /* CQL */
192 ZOOM_API(int)
193 ZOOM_query_cql(ZOOM_query s, const char *str);
194 /* PQF */
195 ZOOM_API(int)
196 ZOOM_query_prefix(ZOOM_query s, const char *str);
197 /* specify sort criteria for search */
198 ZOOM_API(int)
199 ZOOM_query_sortby(ZOOM_query s, const char *criteria);
200
201 /* ----------------------------------------------------------- */
202 /* scan */
203 ZOOM_API(ZOOM_scanset)
204 ZOOM_connection_scan (ZOOM_connection c, const char *startterm);
205
206 ZOOM_API(const char *)
207 ZOOM_scanset_term(ZOOM_scanset scan, size_t pos,
208                   int *occ, int *len);
209
210 ZOOM_API(const char *)
211 ZOOM_scanset_display_term(ZOOM_scanset scan, size_t pos,
212                           int *occ, int *len);
213
214 ZOOM_API(size_t)
215 ZOOM_scanset_size(ZOOM_scanset scan);
216
217 ZOOM_API(void)
218 ZOOM_scanset_destroy (ZOOM_scanset scan);
219
220 ZOOM_API(const char *)
221     ZOOM_scanset_option_get (ZOOM_scanset scan, const char *key);
222
223 ZOOM_API(void)
224     ZOOM_scanset_option_set (ZOOM_scanset scan, const char *key,
225                              const char *val);
226 /* ----------------------------------------------------------- */
227 /* Extended Services Packages */
228
229 ZOOM_API(ZOOM_package)
230     ZOOM_connection_package (ZOOM_connection c, ZOOM_options options);
231
232 ZOOM_API(void)
233     ZOOM_package_destroy(ZOOM_package p);
234
235 ZOOM_API(void)
236     ZOOM_package_send (ZOOM_package p, const char *type);
237
238 ZOOM_API(const char *)
239     ZOOM_package_option_get (ZOOM_package p, const char *key);
240
241 ZOOM_API(void)
242     ZOOM_package_option_set (ZOOM_package p, const char *key,
243                              const char *val);
244
245 /* ----------------------------------------------------------- */
246 /* Sort */
247 ZOOM_API(void)
248     ZOOM_resultset_sort(ZOOM_resultset r,
249                         const char *sort_type, const char *sort_spec);
250
251 /* ----------------------------------------------------------- */
252 /* options */
253
254 ZOOM_API(ZOOM_options_callback)
255     ZOOM_options_set_callback (ZOOM_options opt,
256                                ZOOM_options_callback c,
257                                void *handle);
258 ZOOM_API(ZOOM_options)
259 ZOOM_options_create (void);
260
261 ZOOM_API(ZOOM_options)
262 ZOOM_options_create_with_parent (ZOOM_options parent);
263
264 ZOOM_API(ZOOM_options)
265     ZOOM_options_create_with_parent2 (ZOOM_options parent1,
266                                       ZOOM_options parent2);
267
268 ZOOM_API(const char *)
269 ZOOM_options_get (ZOOM_options opt, const char *name);
270
271 ZOOM_API(const char *)
272 ZOOM_options_getl (ZOOM_options opt, const char *name, int *lenp);
273
274 ZOOM_API(void)
275 ZOOM_options_set (ZOOM_options opt, const char *name, const char *v);
276
277 ZOOM_API(void)
278 ZOOM_options_setl (ZOOM_options opt, const char *name, const char *value,
279                    int len);
280
281 ZOOM_API(void)
282 ZOOM_options_destroy (ZOOM_options opt);
283
284 ZOOM_API(int)
285 ZOOM_options_get_bool (ZOOM_options opt, const char *name, int defa);
286
287 ZOOM_API(int)
288 ZOOM_options_get_int (ZOOM_options opt, const char *name, int defa);
289
290 ZOOM_API(void)
291 ZOOM_options_set_int(ZOOM_options opt, const char *name, int value);
292
293 /* ----------------------------------------------------------- */
294 /* events */
295 /* poll for events on a number of connections. Returns positive
296    integer if event occurred ; zero if none occurred and no more
297    events are pending. The positive integer specifies the
298    connection for which the event occurred. */
299 ZOOM_API(int)
300 ZOOM_event (int no, ZOOM_connection *cs);
301
302 ZOOM_END_CDECL
303 /*
304  * Local variables:
305  * c-basic-offset: 4
306  * indent-tabs-mode: nil
307  * End:
308  * vim: shiftwidth=4 tabstop=8 expandtab
309  */
310