1 /* This file is part of the YAZ toolkit.
2 * Copyright (C) 1995-2012 Index Data.
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions are met:
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.
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.
30 * \brief Header for ZOOM
34 #include <yaz/yconfig.h>
36 #define ZOOM_BEGIN_CDECL YAZ_BEGIN_CDECL
37 #define ZOOM_END_CDECL YAZ_END_CDECL
40 # define ZOOM_API(x) __declspec(dllexport) x __stdcall
42 # define ZOOM_API(x) x
47 /* ----------------------------------------------------------- */
48 /* the types we use */
50 typedef struct ZOOM_options_p *ZOOM_options;
51 typedef struct ZOOM_query_p *ZOOM_query;
52 typedef struct ZOOM_connection_p *ZOOM_connection;
53 typedef struct ZOOM_resultset_p *ZOOM_resultset;
54 typedef struct ZOOM_record_p *ZOOM_record;
55 typedef struct ZOOM_facet_field_p *ZOOM_facet_field;
56 typedef struct ZOOM_scanset_p *ZOOM_scanset;
57 typedef struct ZOOM_package_p *ZOOM_package;
59 typedef const char *(*ZOOM_options_callback)(void *handle, const char *name);
61 /* ----------------------------------------------------------- */
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);
69 /* create connection, don't connect, apply options */
70 ZOOM_API(ZOOM_connection)
71 ZOOM_connection_create(ZOOM_options options);
73 /* connect given existing connection */
75 ZOOM_connection_connect(ZOOM_connection c, const char *host,
79 ZOOM_connection_close(ZOOM_connection c);
81 /* destroy connection (close connection also) */
83 ZOOM_connection_destroy(ZOOM_connection c);
85 /* get/set option for connection */
86 ZOOM_API(const char *)
87 ZOOM_connection_option_get(ZOOM_connection c, const char *key);
89 ZOOM_API(const char *)
90 ZOOM_connection_option_getl(ZOOM_connection c, const char *key, int *lenp);
93 ZOOM_connection_option_set(ZOOM_connection c, const char *key,
97 ZOOM_connection_option_setl(ZOOM_connection c, const char *key,
98 const char *val, int len);
100 /* return error code (0 == success, failure otherwise). cp
101 holds error string on failure, addinfo holds addititional info (if any)
104 ZOOM_connection_error(ZOOM_connection c, const char **cp,
105 const char **addinfo);
108 ZOOM_connection_error_x(ZOOM_connection c, const char **cp,
109 const char **addinfo, const char **diagset);
111 /* returns error code */
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);
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
148 ZOOM_connection_last_event(ZOOM_connection cs);
150 #define ZOOM_EVENT_NONE 0
151 #define ZOOM_EVENT_CONNECT 1
152 #define ZOOM_EVENT_SEND_DATA 2
153 #define ZOOM_EVENT_RECV_DATA 3
154 #define ZOOM_EVENT_TIMEOUT 4
155 #define ZOOM_EVENT_UNKNOWN 5
156 #define ZOOM_EVENT_SEND_APDU 6
157 #define ZOOM_EVENT_RECV_APDU 7
158 #define ZOOM_EVENT_RECV_RECORD 8
159 #define ZOOM_EVENT_RECV_SEARCH 9
160 #define ZOOM_EVENT_END 10
161 #define ZOOM_EVENT_MAX 10
163 /* ----------------------------------------------------------- */
166 /* create result set given a search */
167 ZOOM_API(ZOOM_resultset)
168 ZOOM_connection_search(ZOOM_connection, ZOOM_query q);
169 /* create result set given PQF query */
170 ZOOM_API(ZOOM_resultset)
171 ZOOM_connection_search_pqf(ZOOM_connection c, const char *q);
173 /* destroy result set */
175 ZOOM_resultset_destroy(ZOOM_resultset r);
177 /** release result set from connection.
179 The result will will no longer be able to perform retrievals
180 from the connection from which it was created.
183 ZOOM_resultset_release(ZOOM_resultset r);
185 /* result set option */
186 ZOOM_API(const char *)
187 ZOOM_resultset_option_get(ZOOM_resultset r, const char *key);
189 ZOOM_resultset_option_set(ZOOM_resultset r, const char *key, const char *val);
191 /* return size of result set (alias hit count AKA result count) */
193 ZOOM_resultset_size(ZOOM_resultset r);
195 /* retrieve records */
197 ZOOM_resultset_records(ZOOM_resultset r, ZOOM_record *recs,
198 size_t start, size_t count);
200 /* return record object at pos. Returns 0 if unavailable */
201 ZOOM_API(ZOOM_record)
202 ZOOM_resultset_record(ZOOM_resultset s, size_t pos);
204 /* like ZOOM_resultset_record - but never blocks .. */
205 ZOOM_API(ZOOM_record)
206 ZOOM_resultset_record_immediate(ZOOM_resultset s, size_t pos);
208 /* reset record cache for result set */
210 ZOOM_resultset_cache_reset(ZOOM_resultset r);
213 /* retrieve facet field */
214 ZOOM_API(ZOOM_facet_field)
215 ZOOM_resultset_get_facet_field(ZOOM_resultset r, const char *facet_name);
217 /* retrieve facet field at position. Returns 0 if unavailable */
218 ZOOM_API(ZOOM_facet_field)
219 ZOOM_resultset_get_facet_field_by_index(ZOOM_resultset r, int pos);
221 /* return number of facets available */
223 ZOOM_resultset_facets_size(ZOOM_resultset r);
225 /* retrieve (array of pointers to) facet fields */
226 ZOOM_API(ZOOM_facet_field *)
227 ZOOM_resultset_facets(ZOOM_resultset r);
229 /* retrieve (array of pointers to) facet fields */
230 ZOOM_API(const char **)
231 ZOOM_resultset_facets_names(ZOOM_resultset r);
235 /* ----------------------------------------------------------- */
238 /* get record information, in a form given by type */
239 ZOOM_API(const char *)
240 ZOOM_record_get(ZOOM_record rec, const char *type, int *len);
244 ZOOM_record_destroy(ZOOM_record rec);
246 /* return copy of record */
247 ZOOM_API(ZOOM_record)
248 ZOOM_record_clone(ZOOM_record srec);
250 /* return error info (surrogate diagnostic) for record */
252 ZOOM_record_error(ZOOM_record rec, const char **msg,
253 const char **addinfo, const char **diagset);
255 /* ----------------------------------------------------------- */
259 ZOOM_API(const char *)
260 ZOOM_facet_field_name(ZOOM_facet_field facet_field);
262 /* get terms count on facet */
264 ZOOM_facet_field_term_count(ZOOM_facet_field facet_field);
266 /* get facet information, term and frequency, at a position. Returns 0 if out of bounds */
267 ZOOM_API(const char *)
268 ZOOM_facet_field_get_term(ZOOM_facet_field facet_field, size_t idx, int *freq);
270 /* ----------------------------------------------------------- */
275 /* create search object */
277 ZOOM_query_create(void);
280 ZOOM_query_destroy(ZOOM_query s);
283 ZOOM_query_cql(ZOOM_query s, const char *str);
284 /* CQL translated client-side into RPN: `conn' is optional for diagnostics */
286 ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn);
287 /* CCL translated client-side into RPN: `conn' is optional for diagnostics */
289 ZOOM_query_ccl2rpn(ZOOM_query s, const char *query_str,
291 int *ccl_error, const char **error_string, int *error_pos);
294 ZOOM_query_prefix(ZOOM_query s, const char *str);
295 /* specify sort criteria for search */
297 ZOOM_query_sortby(ZOOM_query s, const char *criteria);
299 ZOOM_query_sortby2(ZOOM_query s, const char *strategy, const char *criteria);
302 ZOOM_query_addref(ZOOM_query s);
304 /* ----------------------------------------------------------- */
306 ZOOM_API(ZOOM_scanset)
307 ZOOM_connection_scan(ZOOM_connection c, const char *startterm);
309 ZOOM_API(ZOOM_scanset)
310 ZOOM_connection_scan1(ZOOM_connection c, ZOOM_query startterm);
312 ZOOM_API(const char *)
313 ZOOM_scanset_term(ZOOM_scanset scan, size_t pos,
314 size_t *occ, size_t *len);
316 ZOOM_API(const char *)
317 ZOOM_scanset_display_term(ZOOM_scanset scan, size_t pos,
318 size_t *occ, size_t *len);
321 ZOOM_scanset_size(ZOOM_scanset scan);
324 ZOOM_scanset_destroy(ZOOM_scanset scan);
326 ZOOM_API(const char *)
327 ZOOM_scanset_option_get(ZOOM_scanset scan, const char *key);
330 ZOOM_scanset_option_set(ZOOM_scanset scan, const char *key,
332 /* ----------------------------------------------------------- */
333 /* Extended Services Packages */
335 ZOOM_API(ZOOM_package)
336 ZOOM_connection_package(ZOOM_connection c, ZOOM_options options);
339 ZOOM_package_destroy(ZOOM_package p);
342 ZOOM_package_send(ZOOM_package p, const char *type);
344 ZOOM_API(const char *)
345 ZOOM_package_option_get(ZOOM_package p, const char *key);
347 ZOOM_API(const char *)
348 ZOOM_package_option_getl(ZOOM_package p, const char *key, int *lenp);
351 ZOOM_package_option_set(ZOOM_package p, const char *key,
355 ZOOM_package_option_setl(ZOOM_package p, const char *key,
356 const char *val, int len);
358 /* ----------------------------------------------------------- */
359 /* Sort. First function is deprecated, use second instead */
361 ZOOM_resultset_sort(ZOOM_resultset r,
362 const char *sort_type, const char *sort_spec);
364 ZOOM_resultset_sort1(ZOOM_resultset r,
365 const char *sort_type, const char *sort_spec);
367 /* ----------------------------------------------------------- */
370 ZOOM_API(ZOOM_options_callback)
371 ZOOM_options_set_callback(ZOOM_options opt,
372 ZOOM_options_callback c, void *handle);
373 ZOOM_API(ZOOM_options)
374 ZOOM_options_create(void);
376 ZOOM_API(ZOOM_options)
377 ZOOM_options_create_with_parent(ZOOM_options parent);
379 ZOOM_API(ZOOM_options)
380 ZOOM_options_create_with_parent2(ZOOM_options parent1,
381 ZOOM_options parent2);
383 ZOOM_API(ZOOM_options)
384 ZOOM_options_dup(ZOOM_options src);
386 ZOOM_API(const char *)
387 ZOOM_options_get(ZOOM_options opt, const char *name);
389 ZOOM_API(const char *)
390 ZOOM_options_getl(ZOOM_options opt, const char *name, int *lenp);
393 ZOOM_options_set(ZOOM_options opt, const char *name, const char *v);
396 ZOOM_options_setl(ZOOM_options opt, const char *name, const char *value,
400 ZOOM_options_destroy(ZOOM_options opt);
403 ZOOM_options_get_bool(ZOOM_options opt, const char *name, int defa);
406 ZOOM_options_get_int(ZOOM_options opt, const char *name, int defa);
409 ZOOM_options_set_int(ZOOM_options opt, const char *name, int value);
411 /** \brief select/poll socket mask: read */
412 #define ZOOM_SELECT_READ 1
413 /** \brief select/poll socket mask: write */
414 #define ZOOM_SELECT_WRITE 2
415 /** \brief select/poll socket mask: except */
416 #define ZOOM_SELECT_EXCEPT 4
418 /** \brief wait for events on connection(s) (BLOCKING)
419 \param no number of connections (size of cs)
420 \param cs connection array
421 \retval 0 no event was fired
422 \retval >0 event was fired for connection at (retval-1)
424 blocking poll for events on a number of connections. Returns positive
425 integer if event occurred ; zero if none occurred and no more
426 events are pending. The positive integer specifies the
427 connection for which the event occurred.
430 ZOOM_event(int no, ZOOM_connection *cs);
433 /** \brief determines if connection is idle (no active or pending work)
436 \retval 0 is non-idle (active)
439 ZOOM_connection_is_idle(ZOOM_connection c);
442 /** \brief process one event for one of connections given
443 \param no number of connections (size of cs)
444 \param cs connection array
445 \retval 0 no event was processed
446 \retval >0 event was processed for connection at (retval-1)
448 This function attemps to deal with outstandings events in a non-blocking
449 mode. If no events was processed (return value of 0), then the system
450 should attempt to deal with sockets in blocking mode using socket
451 select/poll which means calling the following functions:
452 ZOOM_connection_get_socket, ZOOM_connection_get_mask,
453 ZOOM_connection_get_timeout.
456 ZOOM_event_nonblock(int no, ZOOM_connection *cs);
459 /** \brief process one event for connection
461 \retval 0 no event was processed
462 \retval 1 event was processed for connection
464 This function attemps to deal with outstandings events in
465 a non-blocking fashion. If no event was processed (return value of 0),
466 then the system should attempt to deal with sockets in blocking mode
467 using socket select/poll which means calling the following functions:
468 ZOOM_connection_get_socket, ZOOM_connection_get_mask,
469 ZOOM_connection_get_timeout. If an event was processed call this
473 ZOOM_connection_process(ZOOM_connection c);
476 /** \brief executes non-blocking tasks for connection
478 \retval 0 no task was executed
479 \retval 1 task was executed (but probably not completed)
481 This function, unlike, ZOOM_connection_process, does not try to
482 return any events (and remove them). But events may be generated
483 from it. These are saved and may later be retrieved with
484 ZOOM_connection_process and ZOOM_connection_last_event .
487 ZOOM_connection_exec_task(ZOOM_connection c);
490 /** \brief get socket fd for ZOOM connection
492 \retval -1 no socket assigned for connection
493 \retval >=0 socket for connection
495 Use this function when preparing for socket/poll and
496 in conjunction with ZOOM_connection_get_mask.
499 ZOOM_connection_get_socket(ZOOM_connection c);
502 /** \brief get socket mask for connection
504 \returns mask for connection (possibly 0)
506 Use this function when preparing for socket select/poll and
507 in conjunction with ZOOM_connection_get_socket.
510 ZOOM_connection_get_mask(ZOOM_connection c);
513 /** \brief set socket mask for connection (DO NOT call outside zoom) */
515 ZOOM_connection_set_mask(ZOOM_connection c, int mask);
518 /** \brief get timeout in seconds for ZOOM connection
520 \returns timeout value in seconds
522 Use this function when preparing for socket/poll and
523 in conjunction with ZOOM_connection_get_socket.
526 ZOOM_connection_get_timeout(ZOOM_connection c);
529 /** \brief fire socket event timeout
531 \retval 0 event was fired OK
532 \retval -1 event was not fired
534 Call this function when a timeout occurs - for example in the
535 case of select(2) returning 0.
538 ZOOM_connection_fire_event_timeout(ZOOM_connection c);
541 /** \brief fire socket event activity (read,write,except)
543 \param mask or'ed mask of ZOOM_SELECT_.. values
544 \retval 0 event was fired OK
545 \retval -1 event was not fired
548 ZOOM_connection_fire_event_socket(ZOOM_connection c, int mask);
551 /** \brief peek at next event
553 \returns ZOOM_EVENT_NONE (for no events in queue), ZOOM_EVENT_CONNECT, ..
555 Does not actually remove the event from the event queue. ZOOM_event and
556 ZOOM_process_event removes one event.
560 ZOOM_connection_peek_event(ZOOM_connection c);
562 ZOOM_API(const char *)
563 ZOOM_get_event_str(int event);
567 /** \brief log APDUs to WRBUF
569 \param w WRBUF where APDUs are logged
571 ZOOM_API(void) ZOOM_connection_save_apdu_wrbuf(ZOOM_connection c, WRBUF w);
579 * c-file-style: "Stroustrup"
580 * indent-tabs-mode: nil
582 * vim: shiftwidth=4 tabstop=8 expandtab