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 28 /** 29 * \file zoom.h 30 * \brief Header for ZOOM 31 */ 32 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 45 ZOOM_BEGIN_CDECL 46 47 /* ----------------------------------------------------------- */ 48 /* the types we use */ 49 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; 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 178 /** release result set from connection. 179 180 The result will will no longer be able to perform retrievals 181 from the connection from which it was created. 182 */ 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 373 ZOOM_API(ZOOM_options_callback) 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 414 /** \brief select/poll socket mask: read */ 415 #define ZOOM_SELECT_READ 1 416 /** \brief select/poll socket mask: write */ 417 #define ZOOM_SELECT_WRITE 2 418 /** \brief select/poll socket mask: except */ 419 #define ZOOM_SELECT_EXCEPT 4 420 421 /** \brief wait for events on connection(s) (BLOCKING) 422 \param no number of connections (size of cs) 423 \param cs connection array 424 \retval 0 no event was fired 425 \retval >0 event was fired for connection at (retval-1) 426 427 blocking poll for events on a number of connections. Returns positive 428 integer if event occurred ; zero if none occurred and no more 429 events are pending. The positive integer specifies the 430 connection for which the event occurred. 431 */ 432 ZOOM_API(int) 433 ZOOM_event(int no, ZOOM_connection *cs); 434 435 436 /** \brief determines if connection is idle (no active or pending work) 437 \param c connection 438 \retval 1 is idle 439 \retval 0 is non-idle (active) 440 */ 441 ZOOM_API(int) 442 ZOOM_connection_is_idle(ZOOM_connection c); 443 444 445 /** \brief process one event for one of connections given 446 \param no number of connections (size of cs) 447 \param cs connection array 448 \retval 0 no event was processed 449 \retval >0 event was processed for connection at (retval-1) 450 451 This function attemps to deal with outstandings events in a non-blocking 452 mode. If no events was processed (return value of 0), then the system 453 should attempt to deal with sockets in blocking mode using socket 454 select/poll which means calling the following functions: 455 ZOOM_connection_get_socket, ZOOM_connection_get_mask, 456 ZOOM_connection_get_timeout. 457 */ 458 ZOOM_API(int) 459 ZOOM_event_nonblock(int no, ZOOM_connection *cs); 460 461 462 /** \brief process one event for connection 463 \param c connection 464 \retval 0 no event was processed 465 \retval 1 event was processed for connection 466 467 This function attemps to deal with outstandings events in 468 a non-blocking fashion. If no event was processed (return value of 0), 469 then the system should attempt to deal with sockets in blocking mode 470 using socket select/poll which means calling the following functions: 471 ZOOM_connection_get_socket, ZOOM_connection_get_mask, 472 ZOOM_connection_get_timeout. If an event was processed call this 473 function again. 474 */ 475 ZOOM_API(int) 476 ZOOM_connection_process(ZOOM_connection c); 477 478 479 /** \brief executes non-blocking tasks for connection 480 \param c connection 481 \retval 0 no task was executed 482 \retval 1 task was executed (but probably not completed) 483 484 This function, unlike, ZOOM_connection_process, does not try to 485 return any events (and remove them). But events may be generated 486 from it. These are saved and may later be retrieved with 487 ZOOM_connection_process and ZOOM_connection_last_event . 488 */ 489 ZOOM_API(int) 490 ZOOM_connection_exec_task(ZOOM_connection c); 491 492 493 /** \brief get socket fd for ZOOM connection 494 \param c connection 495 \retval -1 no socket assigned for connection 496 \retval >=0 socket for connection 497 498 Use this function when preparing for socket/poll and 499 in conjunction with ZOOM_connection_get_mask. 500 */ 501 ZOOM_API(int) 502 ZOOM_connection_get_socket(ZOOM_connection c); 503 504 505 /** \brief get socket mask for connection 506 \param c connection 507 \returns mask for connection (possibly 0) 508 509 Use this function when preparing for socket select/poll and 510 in conjunction with ZOOM_connection_get_socket. 511 */ 512 ZOOM_API(int) 513 ZOOM_connection_get_mask(ZOOM_connection c); 514 515 516 /** \brief set socket mask for connection (DO NOT call outside zoom) */ 517 ZOOM_API(int) 518 ZOOM_connection_set_mask(ZOOM_connection c, int mask); 519 520 521 /** \brief get timeout in seconds for ZOOM connection 522 \param c connection 523 \returns timeout value in seconds 524 525 Use this function when preparing for socket/poll and 526 in conjunction with ZOOM_connection_get_socket. 527 */ 528 ZOOM_API(int) 529 ZOOM_connection_get_timeout(ZOOM_connection c); 530 531 532 /** \brief fire socket event timeout 533 \param c connection 534 \retval 0 event was fired OK 535 \retval -1 event was not fired 536 537 Call this function when a timeout occurs - for example in the 538 case of select(2) returning 0. 539 */ 540 ZOOM_API(int) 541 ZOOM_connection_fire_event_timeout(ZOOM_connection c); 542 543 544 /** \brief fire socket event activity (read,write,except) 545 \param c connection 546 \param mask or'ed mask of ZOOM_SELECT_.. values 547 \retval 0 event was fired OK 548 \retval -1 event was not fired 549 */ 550 ZOOM_API(int) 551 ZOOM_connection_fire_event_socket(ZOOM_connection c, int mask); 552 553 554 /** \brief peek at next event 555 \param c connection 556 \returns ZOOM_EVENT_NONE (for no events in queue), ZOOM_EVENT_CONNECT, .. 557 558 Does not actually remove the event from the event queue. ZOOM_event and 559 ZOOM_process_event removes one event. 560 */ 561 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 570 /** \brief log APDUs to WRBUF 571 \param c connection 572 \param w WRBUF where APDUs are logged 573 */ 574 ZOOM_API(void) ZOOM_connection_save_apdu_wrbuf(ZOOM_connection c, WRBUF w); 575 #endif 576 577 ZOOM_END_CDECL 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 588