include/yaz/zoom.h

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