YAZ  5.23.1
zoom.h
Go to the documentation of this file.
1 /* This file is part of the YAZ toolkit.
2  * Copyright (C) Index Data.
3  * All rights reserved.
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are met:
6  *
7  * * Redistributions of source code must retain the above copyright
8  * notice, this list of conditions and the following disclaimer.
9  * * Redistributions in binary form must reproduce the above copyright
10  * notice, this list of conditions and the following disclaimer in the
11  * documentation and/or other materials provided with the distribution.
12  * * Neither the name of Index Data nor the names of its contributors
13  * may be used to endorse or promote products derived from this
14  * software without specific prior written permission.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY
17  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
18  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
19  * DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
20  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
21  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
22  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
23  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
25  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26  */
27 
33 #include <stdlib.h>
34 #include <yaz/yconfig.h>
35 
36 #define ZOOM_BEGIN_CDECL YAZ_BEGIN_CDECL
37 #define ZOOM_END_CDECL YAZ_END_CDECL
38 
39 #ifdef WIN32
40 # define ZOOM_API(x) __declspec(dllexport) x __stdcall
41 #else
42 # define ZOOM_API(x) x
43 # endif
44 
46 
47 /* ----------------------------------------------------------- */
48 /* the types we use */
49 
50 typedef struct ZOOM_options_p *ZOOM_options;
51 typedef struct ZOOM_query_p *ZOOM_query;
54 typedef struct ZOOM_record_p *ZOOM_record;
56 typedef struct ZOOM_scanset_p *ZOOM_scanset;
57 typedef struct ZOOM_package_p *ZOOM_package;
58 
59 typedef const char *(*ZOOM_options_callback)(void *handle, const char *name);
60 
61 /* ----------------------------------------------------------- */
62 /* connections */
63 
64 /* create connection, connect to host, if portnum is 0, then port is
65  read from host string (e.g. myhost:9821) */
66 ZOOM_API(ZOOM_connection)
67 ZOOM_connection_new(const char *host, int portnum);
68 
69 /* create connection, don't connect, apply options */
70 ZOOM_API(ZOOM_connection)
71 ZOOM_connection_create(ZOOM_options options);
72 
73 /* connect given existing connection */
74 ZOOM_API(void)
75 ZOOM_connection_connect(ZOOM_connection c, const char *host,
76  int portnum);
77 
78 ZOOM_API(void)
79 ZOOM_connection_close(ZOOM_connection c);
80 
81 /* destroy connection (close connection also) */
82 ZOOM_API(void)
83 ZOOM_connection_destroy(ZOOM_connection c);
84 
85 /* get/set option for connection */
86 ZOOM_API(const char *)
87 ZOOM_connection_option_get(ZOOM_connection c, const char *key);
88 
89 ZOOM_API(const char *)
90 ZOOM_connection_option_getl(ZOOM_connection c, const char *key, int *lenp);
91 
92 ZOOM_API(void)
93 ZOOM_connection_option_set(ZOOM_connection c, const char *key,
94  const char *val);
95 
96 ZOOM_API(void)
97 ZOOM_connection_option_setl(ZOOM_connection c, const char *key,
98  const char *val, int len);
99 
100 /* return error code (0 == success, failure otherwise). cp
101  holds error string on failure, addinfo holds addititional info (if any)
102 */
103 ZOOM_API(int)
104 ZOOM_connection_error(ZOOM_connection c, const char **cp,
105  const char **addinfo);
106 
107 ZOOM_API(int)
108 ZOOM_connection_error_x(ZOOM_connection c, const char **cp,
109  const char **addinfo, const char **diagset);
110 
111 /* returns error code */
112 ZOOM_API(int)
113 ZOOM_connection_errcode(ZOOM_connection c);
114 /* returns error message */
115 ZOOM_API(const char *)
116 ZOOM_connection_errmsg(ZOOM_connection c);
117 /* returns additional info */
118 ZOOM_API(const char *)
119 ZOOM_connection_addinfo(ZOOM_connection c);
120 /* returns diagnostic set */
121 ZOOM_API(const char *)
122 ZOOM_connection_diagset(ZOOM_connection c);
123 /* translates error code into human-readable string */
124 ZOOM_API(const char *)
125 ZOOM_diag_str (int error);
126 
127 #define ZOOM_ERROR_NONE 0
128 #define ZOOM_ERROR_CONNECT 10000
129 #define ZOOM_ERROR_MEMORY 10001
130 #define ZOOM_ERROR_ENCODE 10002
131 #define ZOOM_ERROR_DECODE 10003
132 #define ZOOM_ERROR_CONNECTION_LOST 10004
133 #define ZOOM_ERROR_INIT 10005
134 #define ZOOM_ERROR_INTERNAL 10006
135 #define ZOOM_ERROR_TIMEOUT 10007
136 #define ZOOM_ERROR_UNSUPPORTED_PROTOCOL 10008
137 #define ZOOM_ERROR_UNSUPPORTED_QUERY 10009
138 #define ZOOM_ERROR_INVALID_QUERY 10010
139 #define ZOOM_ERROR_CQL_PARSE 10011
140 #define ZOOM_ERROR_CQL_TRANSFORM 10012
141 #define ZOOM_ERROR_CCL_CONFIG 10013
142 #define ZOOM_ERROR_CCL_PARSE 10014
143 #define ZOOM_ERROR_ES_INVALID_ACTION 10015
144 #define ZOOM_ERROR_ES_INVALID_VERSION 10016
145 #define ZOOM_ERROR_ES_INVALID_SYNTAX 10017
146 #define ZOOM_ERROR_MEMCACHED 10018
147 
148 ZOOM_API(int)
149 ZOOM_connection_last_event(ZOOM_connection cs);
150 
151 #define ZOOM_EVENT_NONE 0
152 #define ZOOM_EVENT_CONNECT 1
153 #define ZOOM_EVENT_SEND_DATA 2
154 #define ZOOM_EVENT_RECV_DATA 3
155 #define ZOOM_EVENT_TIMEOUT 4
156 #define ZOOM_EVENT_UNKNOWN 5
157 #define ZOOM_EVENT_SEND_APDU 6
158 #define ZOOM_EVENT_RECV_APDU 7
159 #define ZOOM_EVENT_RECV_RECORD 8
160 #define ZOOM_EVENT_RECV_SEARCH 9
161 #define ZOOM_EVENT_END 10
162 #define ZOOM_EVENT_MAX 10
163 
164 /* ----------------------------------------------------------- */
165 /* result sets */
166 
167 /* create result set given a search */
168 ZOOM_API(ZOOM_resultset)
169 ZOOM_connection_search(ZOOM_connection, ZOOM_query q);
170 /* create result set given PQF query */
171 ZOOM_API(ZOOM_resultset)
172 ZOOM_connection_search_pqf(ZOOM_connection c, const char *q);
173 
174 /* destroy result set */
175 ZOOM_API(void)
176 ZOOM_resultset_destroy(ZOOM_resultset r);
177 
183 ZOOM_API(void)
184 ZOOM_resultset_release(ZOOM_resultset r);
185 
186 /* result set option */
187 ZOOM_API(const char *)
188 ZOOM_resultset_option_get(ZOOM_resultset r, const char *key);
189 ZOOM_API(void)
190 ZOOM_resultset_option_set(ZOOM_resultset r, const char *key, const char *val);
191 
192 /* return size of result set (alias hit count AKA result count) */
193 ZOOM_API(size_t)
194 ZOOM_resultset_size(ZOOM_resultset r);
195 
196 /* retrieve records */
197 ZOOM_API(void)
198 ZOOM_resultset_records(ZOOM_resultset r, ZOOM_record *recs,
199  size_t start, size_t count);
200 
201 /* return record object at pos. Returns 0 if unavailable */
202 ZOOM_API(ZOOM_record)
203 ZOOM_resultset_record(ZOOM_resultset s, size_t pos);
204 
205 /* like ZOOM_resultset_record - but never blocks .. */
206 ZOOM_API(ZOOM_record)
207 ZOOM_resultset_record_immediate(ZOOM_resultset s, size_t pos);
208 
209 /* reset record cache for result set */
210 ZOOM_API(void)
211 ZOOM_resultset_cache_reset(ZOOM_resultset r);
212 
213 
214 /* retrieve facet field */
215 ZOOM_API(ZOOM_facet_field)
216 ZOOM_resultset_get_facet_field(ZOOM_resultset r, const char *facet_name);
217 
218 /* retrieve facet field at position. Returns 0 if unavailable */
219 ZOOM_API(ZOOM_facet_field)
220 ZOOM_resultset_get_facet_field_by_index(ZOOM_resultset r, int pos);
221 
222 /* return number of facets available */
223 ZOOM_API(size_t)
224 ZOOM_resultset_facets_size(ZOOM_resultset r);
225 
226 /* retrieve (array of pointers to) facet fields */
227 ZOOM_API(ZOOM_facet_field *)
228 ZOOM_resultset_facets(ZOOM_resultset r);
229 
230 /* retrieve (array of pointers to) facet fields */
231 ZOOM_API(const char **)
232 ZOOM_resultset_facets_names(ZOOM_resultset r)
233 #ifdef __GNUC__
234  __attribute__ ((deprecated))
235 #endif
236  ;
237 
238 /* ----------------------------------------------------------- */
239 /* records */
240 
241 /* get record information, in a form given by type */
242 ZOOM_API(const char *)
243 ZOOM_record_get(ZOOM_record rec, const char *type, int *len);
244 
245 /* destroy record */
246 ZOOM_API(void)
247 ZOOM_record_destroy(ZOOM_record rec);
248 
249 /* return copy of record */
250 ZOOM_API(ZOOM_record)
251 ZOOM_record_clone(ZOOM_record srec);
252 
253 /* return error info (surrogate diagnostic) for record */
254 ZOOM_API(int)
255  ZOOM_record_error(ZOOM_record rec, const char **msg,
256  const char **addinfo, const char **diagset);
257 
258 /* ----------------------------------------------------------- */
259 /* facets */
260 
261 /* get facet name */
262 ZOOM_API(const char *)
263 ZOOM_facet_field_name(ZOOM_facet_field facet_field);
264 
265 /* get terms count on facet */
266 ZOOM_API(size_t)
267 ZOOM_facet_field_term_count(ZOOM_facet_field facet_field);
268 
269 /* get facet information, term and frequency, at a position. Returns 0 if out of bounds */
270 ZOOM_API(const char *)
271 ZOOM_facet_field_get_term(ZOOM_facet_field facet_field, size_t idx, int *freq);
272 
273 /* ----------------------------------------------------------- */
274 
275 
276 /* queries */
277 
278 /* create search object */
279 ZOOM_API(ZOOM_query)
280 ZOOM_query_create(void);
281 /* destroy it */
282 ZOOM_API(void)
283 ZOOM_query_destroy(ZOOM_query s);
284 /* CQL */
285 ZOOM_API(int)
286 ZOOM_query_cql(ZOOM_query s, const char *str);
287 /* CQL translated client-side into RPN: `conn' is optional for diagnostics */
288 ZOOM_API(int)
289 ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn);
290 /* CCL translated client-side into RPN: `conn' is optional for diagnostics */
291 ZOOM_API(int)
292 ZOOM_query_ccl2rpn(ZOOM_query s, const char *query_str,
293  const char *config,
294  int *ccl_error, const char **error_string, int *error_pos);
295 /* PQF */
296 ZOOM_API(int)
297 ZOOM_query_prefix(ZOOM_query s, const char *str);
298 /* specify sort criteria for search */
299 ZOOM_API(int)
300 ZOOM_query_sortby(ZOOM_query s, const char *criteria);
301 ZOOM_API(int)
302 ZOOM_query_sortby2(ZOOM_query s, const char *strategy, const char *criteria);
303 
304 ZOOM_API(void)
305 ZOOM_query_addref(ZOOM_query s);
306 
307 /* ----------------------------------------------------------- */
308 /* scan */
309 ZOOM_API(ZOOM_scanset)
310 ZOOM_connection_scan(ZOOM_connection c, const char *startterm);
311 
312 ZOOM_API(ZOOM_scanset)
313 ZOOM_connection_scan1(ZOOM_connection c, ZOOM_query startterm);
314 
315 ZOOM_API(const char *)
316 ZOOM_scanset_term(ZOOM_scanset scan, size_t pos,
317  size_t *occ, size_t *len);
318 
319 ZOOM_API(const char *)
320 ZOOM_scanset_display_term(ZOOM_scanset scan, size_t pos,
321  size_t *occ, size_t *len);
322 
323 ZOOM_API(size_t)
324 ZOOM_scanset_size(ZOOM_scanset scan);
325 
326 ZOOM_API(void)
327 ZOOM_scanset_destroy(ZOOM_scanset scan);
328 
329 ZOOM_API(const char *)
330 ZOOM_scanset_option_get(ZOOM_scanset scan, const char *key);
331 
332 ZOOM_API(void)
333 ZOOM_scanset_option_set(ZOOM_scanset scan, const char *key,
334  const char *val);
335 /* ----------------------------------------------------------- */
336 /* Extended Services Packages */
337 
338 ZOOM_API(ZOOM_package)
339 ZOOM_connection_package(ZOOM_connection c, ZOOM_options options);
340 
341 ZOOM_API(void)
342 ZOOM_package_destroy(ZOOM_package p);
343 
344 ZOOM_API(void)
345 ZOOM_package_send(ZOOM_package p, const char *type);
346 
347 ZOOM_API(const char *)
348 ZOOM_package_option_get(ZOOM_package p, const char *key);
349 
350 ZOOM_API(const char *)
351 ZOOM_package_option_getl(ZOOM_package p, const char *key, int *lenp);
352 
353 ZOOM_API(void)
354 ZOOM_package_option_set(ZOOM_package p, const char *key,
355  const char *val);
356 
357 ZOOM_API(void)
358 ZOOM_package_option_setl(ZOOM_package p, const char *key,
359  const char *val, int len);
360 
361 /* ----------------------------------------------------------- */
362 /* Sort. First function is deprecated, use second instead */
363 ZOOM_API(void)
364 ZOOM_resultset_sort(ZOOM_resultset r,
365  const char *sort_type, const char *sort_spec);
366 ZOOM_API(int)
367 ZOOM_resultset_sort1(ZOOM_resultset r,
368  const char *sort_type, const char *sort_spec);
369 
370 /* ----------------------------------------------------------- */
371 /* options */
372 
374 ZOOM_options_set_callback(ZOOM_options opt,
375  ZOOM_options_callback c, void *handle);
376 ZOOM_API(ZOOM_options)
377 ZOOM_options_create(void);
378 
379 ZOOM_API(ZOOM_options)
380 ZOOM_options_create_with_parent(ZOOM_options parent);
381 
382 ZOOM_API(ZOOM_options)
383 ZOOM_options_create_with_parent2(ZOOM_options parent1,
384  ZOOM_options parent2);
385 
386 ZOOM_API(ZOOM_options)
387 ZOOM_options_dup(ZOOM_options src);
388 
389 ZOOM_API(const char *)
390 ZOOM_options_get(ZOOM_options opt, const char *name);
391 
392 ZOOM_API(const char *)
393 ZOOM_options_getl(ZOOM_options opt, const char *name, int *lenp);
394 
395 ZOOM_API(void)
396 ZOOM_options_set(ZOOM_options opt, const char *name, const char *v);
397 
398 ZOOM_API(void)
399 ZOOM_options_setl(ZOOM_options opt, const char *name, const char *value,
400  int len);
401 
402 ZOOM_API(void)
403 ZOOM_options_destroy(ZOOM_options opt);
404 
405 ZOOM_API(int)
406 ZOOM_options_get_bool(ZOOM_options opt, const char *name, int defa);
407 
408 ZOOM_API(int)
409 ZOOM_options_get_int(ZOOM_options opt, const char *name, int defa);
410 
411 ZOOM_API(void)
412 ZOOM_options_set_int(ZOOM_options opt, const char *name, int value);
413 
415 #define ZOOM_SELECT_READ 1
416 
417 #define ZOOM_SELECT_WRITE 2
418 
419 #define ZOOM_SELECT_EXCEPT 4
420 
432 ZOOM_API(int)
433 ZOOM_event(int no, ZOOM_connection *cs);
434 
435 
441 ZOOM_API(int)
442 ZOOM_connection_is_idle(ZOOM_connection c);
443 
444 
458 ZOOM_API(int)
459 ZOOM_event_nonblock(int no, ZOOM_connection *cs);
460 
461 
475 ZOOM_API(int)
476 ZOOM_connection_process(ZOOM_connection c);
477 
478 
489 ZOOM_API(int)
490 ZOOM_connection_exec_task(ZOOM_connection c);
491 
492 
501 ZOOM_API(int)
502 ZOOM_connection_get_socket(ZOOM_connection c);
503 
504 
512 ZOOM_API(int)
513 ZOOM_connection_get_mask(ZOOM_connection c);
514 
515 
517 ZOOM_API(int)
518 ZOOM_connection_set_mask(ZOOM_connection c, int mask);
519 
520 
528 ZOOM_API(int)
529 ZOOM_connection_get_timeout(ZOOM_connection c);
530 
531 
540 ZOOM_API(int)
541 ZOOM_connection_fire_event_timeout(ZOOM_connection c);
542 
543 
550 ZOOM_API(int)
551 ZOOM_connection_fire_event_socket(ZOOM_connection c, int mask);
552 
553 
562 ZOOM_API(int)
563 ZOOM_connection_peek_event(ZOOM_connection c);
564 
565 ZOOM_API(const char *)
566 ZOOM_get_event_str(int event);
567 
568 #ifdef WRBUF_H
569 
574 ZOOM_API(void) ZOOM_connection_save_apdu_wrbuf(ZOOM_connection c, WRBUF w);
575 #endif
576 
578 
579 /*
580  * Local variables:
581  * c-basic-offset: 4
582  * c-file-style: "Stroustrup"
583  * indent-tabs-mode: nil
584  * End:
585  * vim: shiftwidth=4 tabstop=8 expandtab
586  */
587 
ZOOM_connection_peek_event(ZOOM_connection c)
peek at next event
ZOOM_connection_new(const char *host, int portnum)
Definition: zoom-c.c:337
ZOOM_resultset_destroy(ZOOM_resultset r)
Definition: zoom-c.c:863
ZOOM_connection_option_setl(ZOOM_connection c, const char *key, const char *val, int len)
Definition: zoom-c.c:1825
ZOOM_connection_close(ZOOM_connection c)
#define ZOOM_END_CDECL
Definition: zoom.h:37
ZOOM_package_option_set(ZOOM_package p, const char *key, const char *val)
Definition: zoom-c.c:1421
ZOOM_connection_addinfo(ZOOM_connection c)
Definition: zoom-c.c:1860
ZOOM_scanset_destroy(ZOOM_scanset scan)
Definition: zoom-c.c:1228
struct ZOOM_connection_p * ZOOM_connection
Definition: zoom.h:52
ZOOM_options_set_callback(ZOOM_options opt, ZOOM_options_callback c, void *handle)
Definition: zoom-opt.c:119
ZOOM_connection_search_pqf(ZOOM_connection c, const char *q)
Definition: zoom-c.c:722
ZOOM_options_set(ZOOM_options opt, const char *name, const char *v)
Definition: zoom-opt.c:180
ZOOM_resultset_option_set(ZOOM_resultset r, const char *key, const char *val)
Definition: zoom-c.c:1838
struct ZOOM_record_p * ZOOM_record
Definition: zoom.h:54
ZOOM_package_option_get(ZOOM_package p, const char *key)
Definition: zoom-c.c:1409
ZOOM_scanset_term(ZOOM_scanset scan, size_t pos, size_t *occ, size_t *len)
Definition: zoom-c.c:1333
ZOOM_query_cql(ZOOM_query s, const char *str)
Definition: zoom-query.c:264
ZOOM_event_nonblock(int no, ZOOM_connection *cs)
process one event for one of connections given
Definition: zoom-c.c:2080
ZOOM_connection_destroy(ZOOM_connection c)
Definition: zoom-c.c:605
ZOOM_resultset_record_immediate(ZOOM_resultset s, size_t pos)
Definition: zoom-c.c:1143
char * name
Definition: initopt.c:18
ZOOM_resultset_facets(ZOOM_resultset r)
Definition: zoom-c.c:1022
ZOOM_resultset_facets_names(ZOOM_resultset r)
Definition: zoom-c.c:1028
ZOOM_query_sortby2(ZOOM_query s, const char *strategy, const char *criteria)
Definition: zoom-query.c:342
ZOOM_scanset_display_term(ZOOM_scanset scan, size_t pos, size_t *occ, size_t *len)
Definition: zoom-c.c:1349
ZOOM_connection_diagset(ZOOM_connection c)
Definition: zoom-c.c:1868
ZOOM_connection_fire_event_socket(ZOOM_connection c, int mask)
fire socket event activity (read,write,except)
ZOOM_diag_str(int error)
Definition: zoom-c.c:1876
struct ZOOM_scanset_p * ZOOM_scanset
Definition: zoom.h:56
ZOOM_connection_errcode(ZOOM_connection c)
Definition: zoom-c.c:1846
ZOOM_options_destroy(ZOOM_options opt)
Definition: zoom-opt.c:134
ZOOM_connection_error(ZOOM_connection c, const char **cp, const char **addinfo)
Definition: zoom-c.c:1951
string buffer
Definition: wrbuf.h:42
ZOOM_resultset_records(ZOOM_resultset r, ZOOM_record *recs, size_t start, size_t count)
Definition: zoom-c.c:973
ZOOM_connection_package(ZOOM_connection c, ZOOM_options options)
Definition: zoom-c.c:1379
ZOOM_package_destroy(ZOOM_package p)
Definition: zoom-c.c:1393
ZOOM_connection_errmsg(ZOOM_connection c)
Definition: zoom-c.c:1852
ZOOM_options_set_int(ZOOM_options opt, const char *name, int value)
Definition: zoom-opt.c:245
ZOOM_query_ccl2rpn(ZOOM_query s, const char *query_str, const char *config, int *ccl_error, const char **error_string, int *error_pos)
Definition: zoom-query.c:306
const char *(* ZOOM_options_callback)(void *handle, const char *name)
Definition: zoom.h:59
ZOOM_resultset_get_facet_field(ZOOM_resultset r, const char *facet_name)
Definition: zoom-c.c:1000
ZOOM_record_destroy(ZOOM_record rec)
ZOOM_resultset_cache_reset(ZOOM_resultset r)
ZOOM_facet_field_name(ZOOM_facet_field facet_field)
Definition: zoom-c.c:1034
ZOOM_resultset_facets_size(ZOOM_resultset r)
Definition: zoom-c.c:994
ZOOM_connection_connect(ZOOM_connection c, const char *host, int portnum)
Definition: zoom-c.c:361
ZOOM_connection_set_mask(ZOOM_connection c, int mask)
set socket mask for connection (DO NOT call outside zoom)
struct ZOOM_facet_field_p * ZOOM_facet_field
Definition: zoom.h:55
Header with fundamental macros.
ZOOM_resultset_option_get(ZOOM_resultset r, const char *key)
Definition: zoom-c.c:1832
ZOOM_connection_is_idle(ZOOM_connection c)
determines if connection is idle (no active or pending work)
ZOOM_record_error(ZOOM_record rec, const char **msg, const char **addinfo, const char **diagset)
ZOOM_connection_scan1(ZOOM_connection c, ZOOM_query startterm)
Definition: zoom-c.c:1191
enum l_file_type type
Definition: log.c:45
ZOOM_options_get_bool(ZOOM_options opt, const char *name, int defa)
Definition: zoom-opt.c:223
struct ZOOM_package_p * ZOOM_package
Definition: zoom.h:57
ZOOM_options_create(void)
Definition: zoom-opt.c:87
ZOOM_resultset_sort(ZOOM_resultset r, const char *sort_type, const char *sort_spec)
Definition: zoom-c.c:808
ZOOM_connection_fire_event_timeout(ZOOM_connection c)
fire socket event timeout
int options(const char *desc, char **argv, int argc, char **arg)
command-line options parsing for main
Definition: options.c:21
ZOOM_query_addref(ZOOM_query s)
Definition: zoom-query.c:248
ZOOM_connection_last_event(ZOOM_connection cs)
Definition: zoom-c.c:2035
ZOOM_query_create(void)
Definition: zoom-query.c:213
ZOOM_options_create_with_parent(ZOOM_options parent)
Definition: zoom-opt.c:81
#define ZOOM_API(x)
Definition: zoom.h:42
ZOOM_connection_exec_task(ZOOM_connection c)
executes non-blocking tasks for connection
Definition: zoom-c.c:1435
ZOOM_resultset_get_facet_field_by_index(ZOOM_resultset r, int pos)
Definition: zoom-c.c:1012
ZOOM_options_setl(ZOOM_options opt, const char *name, const char *value, int len)
Definition: zoom-opt.c:160
typedefZOOM_BEGIN_CDECL struct ZOOM_options_p * ZOOM_options
Definition: zoom.h:50
ZOOM_connection_option_getl(ZOOM_connection c, const char *key, int *lenp)
Definition: zoom-c.c:1781
ZOOM_connection_scan(ZOOM_connection c, const char *startterm)
Definition: zoom-c.c:1177
ZOOM_facet_field_term_count(ZOOM_facet_field facet_field)
Definition: zoom-c.c:1040
ZOOM_connection_get_mask(ZOOM_connection c)
get socket mask for connection
struct ZOOM_resultset_p * ZOOM_resultset
Definition: zoom.h:53
ZOOM_facet_field_get_term(ZOOM_facet_field facet_field, size_t idx, int *freq)
Definition: zoom-c.c:1046
ZOOM_resultset_size(ZOOM_resultset r)
Definition: zoom-c.c:899
struct ZOOM_query_p * ZOOM_query
Definition: zoom.h:51
ZOOM_record_get(ZOOM_record rec, const char *type, int *len)
ZOOM_connection_search(ZOOM_connection, ZOOM_query q)
Definition: zoom-c.c:735
ZOOM_package_send(ZOOM_package p, const char *type)
Definition: zoom-z3950.c:880
ZOOM_resultset_record(ZOOM_resultset s, size_t pos)
Definition: zoom-c.c:1156
int opt
Definition: initopt.c:19
ZOOM_options_dup(ZOOM_options src)
Definition: zoom-opt.c:58
ZOOM_connection_get_socket(ZOOM_connection c)
get socket fd for ZOOM connection
ZOOM_connection_process(ZOOM_connection c)
process one event for connection
Definition: zoom-c.c:2057
ZOOM_connection_option_get(ZOOM_connection c, const char *key)
Definition: zoom-c.c:1770
#define ZOOM_BEGIN_CDECL
Definition: zoom.h:36
ZOOM_package_option_setl(ZOOM_package p, const char *key, const char *val, int len)
Definition: zoom-c.c:1428
ZOOM_package_option_getl(ZOOM_package p, const char *key, int *lenp)
Definition: zoom-c.c:1415
ZOOM_options_get_int(ZOOM_options opt, const char *name, int defa)
Definition: zoom-opt.c:235
ZOOM_scanset_size(ZOOM_scanset scan)
Definition: zoom-c.c:1263
ZOOM_connection_get_timeout(ZOOM_connection c)
get timeout in seconds for ZOOM connection
ZOOM_scanset_option_get(ZOOM_scanset scan, const char *key)
Definition: zoom-c.c:1365
ZOOM_query_destroy(ZOOM_query s)
Definition: zoom-query.c:230
ZOOM_connection_error_x(ZOOM_connection c, const char **cp, const char **addinfo, const char **diagset)
Definition: zoom-c.c:1926
ZOOM_scanset_option_set(ZOOM_scanset scan, const char *key, const char *val)
Definition: zoom-c.c:1371
ZOOM_get_event_str(int event)
ZOOM_connection_option_set(ZOOM_connection c, const char *key, const char *val)
Definition: zoom-c.c:1801
ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn)
Definition: zoom-query.c:280
ZOOM_options_create_with_parent2(ZOOM_options parent1, ZOOM_options parent2)
Definition: zoom-opt.c:94
ZOOM_options_getl(ZOOM_options opt, const char *name, int *lenp)
Definition: zoom-opt.c:186
ZOOM_resultset_sort1(ZOOM_resultset r, const char *sort_type, const char *sort_spec)
Definition: zoom-c.c:815
ZOOM_options_get(ZOOM_options opt, const char *name)
Definition: zoom-opt.c:216
ZOOM_event(int no, ZOOM_connection *cs)
wait for events on connection(s) (BLOCKING)
Definition: zoom-socket.c:99
ZOOM_record_clone(ZOOM_record srec)
ZOOM_resultset_release(ZOOM_resultset r)
ZOOM_query_sortby(ZOOM_query s, const char *criteria)
Definition: zoom-query.c:336
int mask
Definition: log.c:81
ZOOM_connection_create(ZOOM_options options)
Definition: zoom-c.c:237
ZOOM_query_prefix(ZOOM_query s, const char *str)
Definition: zoom-query.c:255