include/yaz/zoom.h

   1 /* This file is part of the YAZ toolkit.
   2  * Copyright (C) 1995-2011 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
 147 ZOOM_API(int)
 148 ZOOM_connection_last_event(ZOOM_connection cs);
 149
 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
 162
 163 /* ----------------------------------------------------------- */
 164 /* result sets */
 165
 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);
 172
 173 /* destroy result set */
 174 ZOOM_API(void)
 175 ZOOM_resultset_destroy(ZOOM_resultset r);
 176
 177 /** release result set from connection.
 178
 179     The result will will no longer be able to perform retrievals
 180     from the connection from which it was created.
 181 */
 182 ZOOM_API(void)
 183 ZOOM_resultset_release(ZOOM_resultset r);
 184
 185 /* result set option */
 186 ZOOM_API(const char *)
 187 ZOOM_resultset_option_get(ZOOM_resultset r, const char *key);
 188 ZOOM_API(void)
 189 ZOOM_resultset_option_set(ZOOM_resultset r, const char *key, const char *val);
 190
 191 /* return size of result set (alias hit count AKA result count) */
 192 ZOOM_API(size_t)
 193 ZOOM_resultset_size(ZOOM_resultset r);
 194
 195 /* retrieve records */
 196 ZOOM_API(void)
 197 ZOOM_resultset_records(ZOOM_resultset r, ZOOM_record *recs,
 198                        size_t start, size_t count);
 199
 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);
 203
 204 /* like ZOOM_resultset_record - but never blocks .. */
 205 ZOOM_API(ZOOM_record)
 206 ZOOM_resultset_record_immediate(ZOOM_resultset s, size_t pos);
 207
 208 /* reset record cache for result set */
 209 ZOOM_API(void)
 210 ZOOM_resultset_cache_reset(ZOOM_resultset r);
 211
 212
 213 /* retrieve facet field */
 214 ZOOM_API(ZOOM_facet_field)
 215 ZOOM_resultset_get_facet_field(ZOOM_resultset r, const char *facet_name);
 216
 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);
 220
 221 /* return number of facets available */
 222 ZOOM_API(size_t)
 223 ZOOM_resultset_facets_size(ZOOM_resultset r);
 224
 225 /* retrieve (array of pointers to) facet fields */
 226 ZOOM_API(ZOOM_facet_field *)
 227 ZOOM_resultset_facets(ZOOM_resultset r);
 228
 229 /* retrieve (array of pointers to) facet fields */
 230 ZOOM_API(const char **)
 231 ZOOM_resultset_facets_names(ZOOM_resultset r);
 232
 233
 234
 235 /* ----------------------------------------------------------- */
 236 /* records */
 237
 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);
 241
 242 /* destroy record */
 243 ZOOM_API(void)
 244 ZOOM_record_destroy(ZOOM_record rec);
 245
 246 /* return copy of record */
 247 ZOOM_API(ZOOM_record)
 248 ZOOM_record_clone(ZOOM_record srec);
 249
 250 /* return error info (surrogate diagnostic) for record */
 251 ZOOM_API(int)
 252     ZOOM_record_error(ZOOM_record rec, const char **msg,
 253                       const char **addinfo, const char **diagset);
 254
 255 /* ----------------------------------------------------------- */
 256 /* facets */
 257
 258 /* get facet name */
 259 ZOOM_API(const char *)
 260 ZOOM_facet_field_name(ZOOM_facet_field facet_field);
 261
 262 /* get terms count on facet */
 263 ZOOM_API(size_t)
 264 ZOOM_facet_field_term_count(ZOOM_facet_field facet_field);
 265
 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);
 269
 270 /* ----------------------------------------------------------- */
 271
 272
 273 /* queries */
 274
 275 /* create search object */
 276 ZOOM_API(ZOOM_query)
 277 ZOOM_query_create(void);
 278 /* destroy it */
 279 ZOOM_API(void)
 280 ZOOM_query_destroy(ZOOM_query s);
 281 /* CQL */
 282 ZOOM_API(int)
 283 ZOOM_query_cql(ZOOM_query s, const char *str);
 284 /* CQL translated client-side into RPN: `conn' is optional for diagnostics */
 285 ZOOM_API(int)
 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 */
 288 ZOOM_API(int)
 289 ZOOM_query_ccl2rpn(ZOOM_query s, const char *query_str,
 290                    const char *config,
 291                    int *ccl_error, const char **error_string, int *error_pos);
 292 /* PQF */
 293 ZOOM_API(int)
 294 ZOOM_query_prefix(ZOOM_query s, const char *str);
 295 /* specify sort criteria for search */
 296 ZOOM_API(int)
 297 ZOOM_query_sortby(ZOOM_query s, const char *criteria);
 298
 299 ZOOM_API(void)
 300 ZOOM_query_addref(ZOOM_query s);
 301
 302 /* ----------------------------------------------------------- */
 303 /* scan */
 304 ZOOM_API(ZOOM_scanset)
 305 ZOOM_connection_scan(ZOOM_connection c, const char *startterm);
 306
 307 ZOOM_API(ZOOM_scanset)
 308 ZOOM_connection_scan1(ZOOM_connection c, ZOOM_query startterm);
 309
 310 ZOOM_API(const char *)
 311 ZOOM_scanset_term(ZOOM_scanset scan, size_t pos,
 312                   size_t *occ, size_t *len);
 313
 314 ZOOM_API(const char *)
 315 ZOOM_scanset_display_term(ZOOM_scanset scan, size_t pos,
 316                           size_t *occ, size_t *len);
 317
 318 ZOOM_API(size_t)
 319 ZOOM_scanset_size(ZOOM_scanset scan);
 320
 321 ZOOM_API(void)
 322 ZOOM_scanset_destroy(ZOOM_scanset scan);
 323
 324 ZOOM_API(const char *)
 325 ZOOM_scanset_option_get(ZOOM_scanset scan, const char *key);
 326
 327 ZOOM_API(void)
 328 ZOOM_scanset_option_set(ZOOM_scanset scan, const char *key,
 329                             const char *val);
 330 /* ----------------------------------------------------------- */
 331 /* Extended Services Packages */
 332
 333 ZOOM_API(ZOOM_package)
 334 ZOOM_connection_package(ZOOM_connection c, ZOOM_options options);
 335
 336 ZOOM_API(void)
 337 ZOOM_package_destroy(ZOOM_package p);
 338
 339 ZOOM_API(void)
 340 ZOOM_package_send(ZOOM_package p, const char *type);
 341
 342 ZOOM_API(const char *)
 343 ZOOM_package_option_get(ZOOM_package p, const char *key);
 344
 345 ZOOM_API(const char *)
 346 ZOOM_package_option_getl(ZOOM_package p, const char *key, int *lenp);
 347
 348 ZOOM_API(void)
 349 ZOOM_package_option_set(ZOOM_package p, const char *key,
 350                         const char *val);
 351
 352 ZOOM_API(void)
 353 ZOOM_package_option_setl(ZOOM_package p, const char *key,
 354                          const char *val, int len);
 355
 356 /* ----------------------------------------------------------- */
 357 /* Sort.  First function is deprecated, use second instead */
 358 ZOOM_API(void)
 359 ZOOM_resultset_sort(ZOOM_resultset r,
 360                     const char *sort_type, const char *sort_spec);
 361 ZOOM_API(int)
 362 ZOOM_resultset_sort1(ZOOM_resultset r,
 363                      const char *sort_type, const char *sort_spec);
 364
 365 /* ----------------------------------------------------------- */
 366 /* options */
 367
 368 ZOOM_API(ZOOM_options_callback)
 369 ZOOM_options_set_callback(ZOOM_options opt,
 370                           ZOOM_options_callback c, void *handle);
 371 ZOOM_API(ZOOM_options)
 372 ZOOM_options_create(void);
 373
 374 ZOOM_API(ZOOM_options)
 375 ZOOM_options_create_with_parent(ZOOM_options parent);
 376
 377 ZOOM_API(ZOOM_options)
 378 ZOOM_options_create_with_parent2(ZOOM_options parent1,
 379                                  ZOOM_options parent2);
 380
 381 ZOOM_API(ZOOM_options)
 382 ZOOM_options_dup(ZOOM_options src);
 383
 384 ZOOM_API(const char *)
 385 ZOOM_options_get(ZOOM_options opt, const char *name);
 386
 387 ZOOM_API(const char *)
 388 ZOOM_options_getl(ZOOM_options opt, const char *name, int *lenp);
 389
 390 ZOOM_API(void)
 391 ZOOM_options_set(ZOOM_options opt, const char *name, const char *v);
 392
 393 ZOOM_API(void)
 394 ZOOM_options_setl(ZOOM_options opt, const char *name, const char *value,
 395                   int len);
 396
 397 ZOOM_API(void)
 398 ZOOM_options_destroy(ZOOM_options opt);
 399
 400 ZOOM_API(int)
 401 ZOOM_options_get_bool(ZOOM_options opt, const char *name, int defa);
 402
 403 ZOOM_API(int)
 404 ZOOM_options_get_int(ZOOM_options opt, const char *name, int defa);
 405
 406 ZOOM_API(void)
 407 ZOOM_options_set_int(ZOOM_options opt, const char *name, int value);
 408
 409 /** \brief select/poll socket mask: read */
 410 #define ZOOM_SELECT_READ 1
 411 /** \brief select/poll socket mask: write */
 412 #define ZOOM_SELECT_WRITE 2
 413 /** \brief select/poll socket mask: except */
 414 #define ZOOM_SELECT_EXCEPT 4
 415
 416 /** \brief wait for events on connection(s) (BLOCKING)
 417     \param no number of connections (size of cs)
 418     \param cs connection array
 419     \retval 0 no event was fired
 420     \retval >0 event was fired for connection at (retval-1)
 421
 422     blocking poll for events on a number of connections. Returns positive
 423     integer if event occurred ; zero if none occurred and no more
 424     events are pending. The positive integer specifies the
 425     connection for which the event occurred.
 426 */
 427 ZOOM_API(int)
 428 ZOOM_event(int no, ZOOM_connection *cs);
 429
 430
 431 /** \brief determines if connection is idle (no active or pending work)
 432     \param c connection
 433     \retval 1 is idle
 434     \retval 0 is non-idle (active)
 435 */
 436 ZOOM_API(int)
 437 ZOOM_connection_is_idle(ZOOM_connection c);
 438
 439
 440 /** \brief process one event for one of connections given
 441     \param no number of connections (size of cs)
 442     \param cs connection array
 443     \retval 0 no event was processed
 444     \retval >0 event was processed for connection at (retval-1)
 445
 446     This function attemps to deal with outstandings events in a non-blocking
 447     mode. If no events was processed (return value of 0),  then the system
 448     should attempt to deal with sockets in blocking mode using socket
 449     select/poll which means calling the following functions:
 450     ZOOM_connection_get_socket, ZOOM_connection_get_mask,
 451     ZOOM_connection_get_timeout.
 452 */
 453 ZOOM_API(int)
 454 ZOOM_event_nonblock(int no, ZOOM_connection *cs);
 455
 456
 457 /** \brief process one event for connection
 458     \param c connection
 459     \retval 0 no event was processed
 460     \retval 1 event was processed for connection
 461
 462     This function attemps to deal with outstandings events in
 463     a non-blocking fashion. If no event was processed (return value of 0),
 464     then the system should attempt to deal with sockets in blocking mode
 465     using socket select/poll which means calling the following functions:
 466     ZOOM_connection_get_socket, ZOOM_connection_get_mask,
 467     ZOOM_connection_get_timeout. If an event was processed call this
 468     function again.
 469 */
 470 ZOOM_API(int)
 471 ZOOM_connection_process(ZOOM_connection c);
 472
 473
 474 /** \brief executes non-blocking tasks for connection
 475     \param c connection
 476     \retval 0 no task was executed
 477     \retval 1 task was executed (but probably not completed)
 478
 479     This function, unlike, ZOOM_connection_process, does not try to
 480     return any events (and remove them). But events may be generated
 481     from it. These are saved and may later be retrieved with
 482     ZOOM_connection_process and ZOOM_connection_last_event .
 483 */
 484 ZOOM_API(int)
 485 ZOOM_connection_exec_task(ZOOM_connection c);
 486
 487
 488 /** \brief get socket fd for ZOOM connection
 489     \param c connection
 490     \retval -1 no socket assigned for connection
 491     \retval >=0 socket for connection
 492
 493     Use this function when preparing for socket/poll and
 494     in conjunction with ZOOM_connection_get_mask.
 495 */
 496 ZOOM_API(int)
 497 ZOOM_connection_get_socket(ZOOM_connection c);
 498
 499
 500 /** \brief get socket mask for connection
 501     \param c connection
 502     \returns mask for connection (possibly 0)
 503
 504     Use this function when preparing for socket select/poll and
 505     in conjunction with ZOOM_connection_get_socket.
 506 */
 507 ZOOM_API(int)
 508 ZOOM_connection_get_mask(ZOOM_connection c);
 509
 510
 511 /** \brief set socket mask for connection (DO NOT call outside zoom) */
 512 ZOOM_API(int)
 513 ZOOM_connection_set_mask(ZOOM_connection c, int mask);
 514
 515
 516 /** \brief get timeout in seconds for ZOOM connection
 517     \param c connection
 518     \returns timeout value in seconds
 519
 520     Use this function when preparing for socket/poll and
 521     in conjunction with ZOOM_connection_get_socket.
 522 */
 523 ZOOM_API(int)
 524 ZOOM_connection_get_timeout(ZOOM_connection c);
 525
 526
 527 /** \brief fire socket event timeout
 528     \param c connection
 529     \retval 0 event was fired OK
 530     \retval -1 event was not fired
 531
 532     Call this function when a timeout occurs - for example in the
 533     case of select(2) returning 0.
 534 */
 535 ZOOM_API(int)
 536 ZOOM_connection_fire_event_timeout(ZOOM_connection c);
 537
 538
 539 /** \brief fire socket event activity (read,write,except)
 540     \param c connection
 541     \param mask or'ed mask of ZOOM_SELECT_.. values
 542     \retval 0 event was fired OK
 543     \retval -1 event was not fired
 544 */
 545 ZOOM_API(int)
 546 ZOOM_connection_fire_event_socket(ZOOM_connection c, int mask);
 547
 548
 549 /** \brief peek at next event
 550     \param c connection
 551     \returns ZOOM_EVENT_NONE (for no events in queue), ZOOM_EVENT_CONNECT, ..
 552
 553     Does not actually remove the event from the event queue. ZOOM_event and
 554     ZOOM_process_event removes one event.
 555 */
 556
 557 ZOOM_API(int)
 558 ZOOM_connection_peek_event(ZOOM_connection c);
 559
 560 ZOOM_API(const char *)
 561 ZOOM_get_event_str(int event);
 562
 563 ZOOM_END_CDECL
 564
 565 /*
 566  * Local variables:
 567  * c-basic-offset: 4
 568  * c-file-style: "Stroustrup"
 569  * indent-tabs-mode: nil
 570  * End:
 571  * vim: shiftwidth=4 tabstop=8 expandtab
 572  */
 573