include/yaz/zoom.h

   1 /* This file is part of the YAZ toolkit.
   2  * Copyright (C) 1995-2008 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_scanset_p *ZOOM_scanset;
  56 typedef struct ZOOM_package_p *ZOOM_package;
  57
  58 typedef const char *(*ZOOM_options_callback)(void *handle, const char *name);
  59
  60 /* ----------------------------------------------------------- */
  61 /* connections */
  62
  63 /* create connection, connect to host, if portnum is 0, then port is
  64 read from host string (e.g. myhost:9821) */
  65 ZOOM_API(ZOOM_connection)
  66 ZOOM_connection_new (const char *host, int portnum);
  67
  68 /* create connection, don't connect, apply options */
  69 ZOOM_API(ZOOM_connection)
  70 ZOOM_connection_create (ZOOM_options options);
  71
  72 /* connect given existing connection */
  73 ZOOM_API(void)
  74 ZOOM_connection_connect(ZOOM_connection c, const char *host,
  75                               int portnum);
  76
  77 /* destroy connection (close connection also) */
  78 ZOOM_API(void)
  79 ZOOM_connection_destroy (ZOOM_connection c);
  80
  81 /* get/set option for connection */
  82 ZOOM_API(const char *)
  83 ZOOM_connection_option_get (ZOOM_connection c, const char *key);
  84
  85 ZOOM_API(const char *)
  86 ZOOM_connection_option_getl (ZOOM_connection c, const char *key, int *lenp);
  87
  88 ZOOM_API(void)
  89 ZOOM_connection_option_set (ZOOM_connection c, const char *key,
  90                             const char *val);
  91
  92 ZOOM_API(void)
  93 ZOOM_connection_option_setl (ZOOM_connection c, const char *key,
  94                              const char *val, int len);
  95
  96 /* return error code (0 == success, failure otherwise). cp
  97    holds error string on failure, addinfo holds addititional info (if any)
  98 */
  99 ZOOM_API(int)
 100 ZOOM_connection_error (ZOOM_connection c, const char **cp,
 101                             const char **addinfo);
 102
 103 ZOOM_API(int)
 104 ZOOM_connection_error_x (ZOOM_connection c, const char **cp,
 105                          const char **addinfo, const char **diagset);
 106
 107 /* returns error code */
 108 ZOOM_API(int)
 109 ZOOM_connection_errcode (ZOOM_connection c);
 110 /* returns error message */
 111 ZOOM_API(const char *)
 112 ZOOM_connection_errmsg (ZOOM_connection c);
 113 /* returns additional info */
 114 ZOOM_API(const char *)
 115 ZOOM_connection_addinfo (ZOOM_connection c);
 116 /* returns diagnostic set */
 117 ZOOM_API(const char *)
 118 ZOOM_connection_diagset (ZOOM_connection c);
 119 /* translates error code into human-readable string */
 120 ZOOM_API(const char *)
 121 ZOOM_diag_str (int error);
 122
 123 #define ZOOM_ERROR_NONE 0
 124 #define ZOOM_ERROR_CONNECT 10000
 125 #define ZOOM_ERROR_MEMORY  10001
 126 #define ZOOM_ERROR_ENCODE  10002
 127 #define ZOOM_ERROR_DECODE  10003
 128 #define ZOOM_ERROR_CONNECTION_LOST 10004
 129 #define ZOOM_ERROR_INIT 10005
 130 #define ZOOM_ERROR_INTERNAL 10006
 131 #define ZOOM_ERROR_TIMEOUT 10007
 132 #define ZOOM_ERROR_UNSUPPORTED_PROTOCOL 10008
 133 #define ZOOM_ERROR_UNSUPPORTED_QUERY 10009
 134 #define ZOOM_ERROR_INVALID_QUERY 10010
 135 #define ZOOM_ERROR_CQL_PARSE 10011
 136 #define ZOOM_ERROR_CQL_TRANSFORM 10012
 137 #define ZOOM_ERROR_CCL_CONFIG 10013
 138 #define ZOOM_ERROR_CCL_PARSE 10014
 139
 140 ZOOM_API(int)
 141 ZOOM_connection_last_event(ZOOM_connection cs);
 142
 143 #define ZOOM_EVENT_NONE 0
 144 #define ZOOM_EVENT_CONNECT 1
 145 #define ZOOM_EVENT_SEND_DATA  2
 146 #define ZOOM_EVENT_RECV_DATA 3
 147 #define ZOOM_EVENT_TIMEOUT 4
 148 #define ZOOM_EVENT_UNKNOWN 5
 149 #define ZOOM_EVENT_SEND_APDU 6
 150 #define ZOOM_EVENT_RECV_APDU 7
 151 #define ZOOM_EVENT_RECV_RECORD 8
 152 #define ZOOM_EVENT_RECV_SEARCH 9
 153 #define ZOOM_EVENT_END 10
 154
 155 /* ----------------------------------------------------------- */
 156 /* result sets */
 157
 158 /* create result set given a search */
 159 ZOOM_API(ZOOM_resultset)
 160 ZOOM_connection_search(ZOOM_connection, ZOOM_query q);
 161 /* create result set given PQF query */
 162 ZOOM_API(ZOOM_resultset)
 163 ZOOM_connection_search_pqf(ZOOM_connection c, const char *q);
 164
 165 /* destroy result set */
 166 ZOOM_API(void)
 167 ZOOM_resultset_destroy(ZOOM_resultset r);
 168
 169 /* result set option */
 170 ZOOM_API(const char *)
 171 ZOOM_resultset_option_get (ZOOM_resultset r, const char *key);
 172 ZOOM_API(void)
 173 ZOOM_resultset_option_set (ZOOM_resultset r, const char *key, const char *val);
 174
 175 /* return size of result set (alias hit count AKA result count) */
 176 ZOOM_API(size_t)
 177 ZOOM_resultset_size (ZOOM_resultset r);
 178
 179 /* retrieve records */
 180 ZOOM_API(void)
 181 ZOOM_resultset_records (ZOOM_resultset r, ZOOM_record *recs,
 182                         size_t start, size_t count);
 183
 184 /* return record object at pos. Returns 0 if unavailable */
 185 ZOOM_API(ZOOM_record)
 186 ZOOM_resultset_record (ZOOM_resultset s, size_t pos);
 187
 188 /* like ZOOM_resultset_record - but never blocks .. */
 189 ZOOM_API(ZOOM_record)
 190 ZOOM_resultset_record_immediate (ZOOM_resultset s, size_t pos);
 191
 192 /* reset record cache for result set */
 193 ZOOM_API(void)
 194 ZOOM_resultset_cache_reset(ZOOM_resultset r);
 195
 196 /* ----------------------------------------------------------- */
 197 /* records */
 198
 199 /* get record information, in a form given by type */
 200 ZOOM_API(const char *)
 201 ZOOM_record_get (ZOOM_record rec, const char *type, int *len);
 202
 203 /* destroy record */
 204 ZOOM_API(void)
 205 ZOOM_record_destroy (ZOOM_record rec);
 206
 207 /* return copy of record */
 208 ZOOM_API(ZOOM_record)
 209 ZOOM_record_clone (ZOOM_record srec);
 210
 211 /* return error info (surrogate diagnostic) for record */
 212 ZOOM_API(int)
 213     ZOOM_record_error(ZOOM_record rec, const char **msg,
 214                       const char **addinfo, const char **diagset);
 215
 216 /* ----------------------------------------------------------- */
 217 /* queries */
 218
 219 /* create search object */
 220 ZOOM_API(ZOOM_query)
 221 ZOOM_query_create(void);
 222 /* destroy it */
 223 ZOOM_API(void)
 224 ZOOM_query_destroy(ZOOM_query s);
 225 /* CQL */
 226 ZOOM_API(int)
 227 ZOOM_query_cql(ZOOM_query s, const char *str);
 228 /* CQL translated client-side into RPN: `conn' is optional for diagnostics */
 229 ZOOM_API(int)
 230 ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn);
 231 /* CCL translated client-side into RPN: `conn' is optional for diagnostics */
 232 ZOOM_API(int)
 233 ZOOM_query_ccl2rpn(ZOOM_query s, const char *query_str,
 234                    const char *config,
 235                    int *ccl_error, const char **error_string, int *error_pos);
 236 /* PQF */
 237 ZOOM_API(int)
 238 ZOOM_query_prefix(ZOOM_query s, const char *str);
 239 /* specify sort criteria for search */
 240 ZOOM_API(int)
 241 ZOOM_query_sortby(ZOOM_query s, const char *criteria);
 242
 243 /* ----------------------------------------------------------- */
 244 /* scan */
 245 ZOOM_API(ZOOM_scanset)
 246 ZOOM_connection_scan (ZOOM_connection c, const char *startterm);
 247
 248 ZOOM_API(ZOOM_scanset)
 249 ZOOM_connection_scan1 (ZOOM_connection c, ZOOM_query startterm);
 250
 251 ZOOM_API(const char *)
 252 ZOOM_scanset_term(ZOOM_scanset scan, size_t pos,
 253                   int *occ, int *len);
 254
 255 ZOOM_API(const char *)
 256 ZOOM_scanset_display_term(ZOOM_scanset scan, size_t pos,
 257                           int *occ, int *len);
 258
 259 ZOOM_API(size_t)
 260 ZOOM_scanset_size(ZOOM_scanset scan);
 261
 262 ZOOM_API(void)
 263 ZOOM_scanset_destroy (ZOOM_scanset scan);
 264
 265 ZOOM_API(const char *)
 266     ZOOM_scanset_option_get (ZOOM_scanset scan, const char *key);
 267
 268 ZOOM_API(void)
 269     ZOOM_scanset_option_set (ZOOM_scanset scan, const char *key,
 270                              const char *val);
 271 /* ----------------------------------------------------------- */
 272 /* Extended Services Packages */
 273
 274 ZOOM_API(ZOOM_package)
 275     ZOOM_connection_package (ZOOM_connection c, ZOOM_options options);
 276
 277 ZOOM_API(void)
 278     ZOOM_package_destroy(ZOOM_package p);
 279
 280 ZOOM_API(void)
 281     ZOOM_package_send (ZOOM_package p, const char *type);
 282
 283 ZOOM_API(const char *)
 284     ZOOM_package_option_get (ZOOM_package p, const char *key);
 285
 286 ZOOM_API(const char *)
 287     ZOOM_package_option_getl (ZOOM_package p, const char *key, int *lenp);
 288
 289 ZOOM_API(void)
 290     ZOOM_package_option_set (ZOOM_package p, const char *key,
 291                              const char *val);
 292
 293 ZOOM_API(void)
 294     ZOOM_package_option_setl (ZOOM_package p, const char *key,
 295                               const char *val, int len);
 296
 297 /* ----------------------------------------------------------- */
 298 /* Sort.  First function is deprecated, use second instead */
 299 ZOOM_API(void)
 300     ZOOM_resultset_sort(ZOOM_resultset r,
 301                         const char *sort_type, const char *sort_spec);
 302 ZOOM_API(int)
 303     ZOOM_resultset_sort1(ZOOM_resultset r,
 304                         const char *sort_type, const char *sort_spec);
 305
 306 /* ----------------------------------------------------------- */
 307 /* options */
 308
 309 ZOOM_API(ZOOM_options_callback)
 310     ZOOM_options_set_callback (ZOOM_options opt,
 311                                ZOOM_options_callback c,
 312                                void *handle);
 313 ZOOM_API(ZOOM_options)
 314 ZOOM_options_create (void);
 315
 316 ZOOM_API(ZOOM_options)
 317 ZOOM_options_create_with_parent (ZOOM_options parent);
 318
 319 ZOOM_API(ZOOM_options)
 320     ZOOM_options_create_with_parent2 (ZOOM_options parent1,
 321                                       ZOOM_options parent2);
 322
 323 ZOOM_API(ZOOM_options)
 324     ZOOM_options_dup(ZOOM_options src);
 325
 326 ZOOM_API(const char *)
 327 ZOOM_options_get (ZOOM_options opt, const char *name);
 328
 329 ZOOM_API(const char *)
 330 ZOOM_options_getl (ZOOM_options opt, const char *name, int *lenp);
 331
 332 ZOOM_API(void)
 333 ZOOM_options_set (ZOOM_options opt, const char *name, const char *v);
 334
 335 ZOOM_API(void)
 336 ZOOM_options_setl (ZOOM_options opt, const char *name, const char *value,
 337                    int len);
 338
 339 ZOOM_API(void)
 340 ZOOM_options_destroy (ZOOM_options opt);
 341
 342 ZOOM_API(int)
 343 ZOOM_options_get_bool (ZOOM_options opt, const char *name, int defa);
 344
 345 ZOOM_API(int)
 346 ZOOM_options_get_int (ZOOM_options opt, const char *name, int defa);
 347
 348 ZOOM_API(void)
 349 ZOOM_options_set_int(ZOOM_options opt, const char *name, int value);
 350
 351 /** \brief select/poll socket mask: read */
 352 #define ZOOM_SELECT_READ 1
 353 /** \brief select/poll socket mask: write */
 354 #define ZOOM_SELECT_WRITE 2
 355 /** \brief select/poll socket mask: except */
 356 #define ZOOM_SELECT_EXCEPT 4
 357
 358 /** \brief wait for events on connection(s) (BLOCKING)
 359     \param no number of connections (size of cs)
 360     \param cs connection array
 361     \retval 0 no event was fired
 362     \retval >0 event was fired for connection at (retval-1)
 363
 364     blocking poll for events on a number of connections. Returns positive
 365     integer if event occurred ; zero if none occurred and no more
 366     events are pending. The positive integer specifies the
 367     connection for which the event occurred.
 368 */
 369 ZOOM_API(int)
 370 ZOOM_event (int no, ZOOM_connection *cs);
 371
 372
 373 /** \brief determines if connection is idle (no active or pending work)
 374     \param c connection
 375     \retval 1 is idle
 376     \retval 0 is non-idle (active)
 377 */
 378 ZOOM_API(int)
 379 ZOOM_connection_is_idle(ZOOM_connection c);
 380
 381
 382 /** \brief process one event for one of connections given
 383     \param no number of connections (size of cs)
 384     \param cs connection array
 385     \retval 0 no event was processed
 386     \retval >0 event was processed for connection at (retval-1)
 387
 388     This function attemps to deal with outstandings events in a non-blocking
 389     mode. If no events was processed (return value of 0),  then the system
 390     should attempt to deal with sockets in blocking mode using socket
 391     select/poll which means calling the following functions:
 392     ZOOM_connection_get_socket, ZOOM_connection_get_mask,
 393     ZOOM_connection_get_timeout.
 394 */
 395 ZOOM_API(int)
 396     ZOOM_event_nonblock(int no, ZOOM_connection *cs);
 397
 398
 399 /** \brief process one event for connection
 400     \param c connection
 401     \retval 0 no event was processed
 402     \retval 1 event was processed for connection
 403
 404     This function attemps to deal with outstandings events in
 405     a non-blocking fashion. If no event was processed (return value of 0),
 406     then the system should attempt to deal with sockets in blocking mode
 407     using socket select/poll which means calling the following functions:
 408     ZOOM_connection_get_socket, ZOOM_connection_get_mask,
 409     ZOOM_connection_get_timeout. If an event was processed call this
 410     function again.
 411 */
 412 ZOOM_API(int)
 413     ZOOM_connection_process(ZOOM_connection c);
 414
 415
 416 /** \brief get socket fd for ZOOM connection
 417     \param c connection
 418     \retval -1 no socket assigned for connection
 419     \retval >=0 socket for connection
 420
 421     Use this function when preparing for socket/poll and
 422     in conjunction with ZOOM_connection_get_mask.
 423 */
 424 ZOOM_API(int)
 425     ZOOM_connection_get_socket(ZOOM_connection c);
 426
 427
 428 /** \brief get socket mask for connection
 429     \param c connection
 430     \returns mask for connection (possibly 0)
 431
 432     Use this function when preparing for socket select/poll and
 433     in conjunction with ZOOM_connection_get_socket.
 434 */
 435 ZOOM_API(int)
 436     ZOOM_connection_get_mask(ZOOM_connection c);
 437
 438
 439 /** \brief set socket mask for connection (DO NOT call outside zoom) */
 440 ZOOM_API(int)
 441     ZOOM_connection_set_mask(ZOOM_connection c, int mask);
 442
 443
 444 /** \brief get timeout in seconds for ZOOM connection
 445     \param c connection
 446     \returns timeout value in seconds
 447
 448     Use this function when preparing for socket/poll and
 449     in conjunction with ZOOM_connection_get_socket.
 450 */
 451 ZOOM_API(int)
 452     ZOOM_connection_get_timeout(ZOOM_connection c);
 453
 454
 455 /** \brief fire socket event timeout
 456     \param c connection
 457     \retval 0 event was fired OK
 458     \retval -1 event was not fired
 459
 460     Call this function when a timeout occurs - for example in the
 461     case of select(2) returning 0.
 462 */
 463 ZOOM_API(int)
 464     ZOOM_connection_fire_event_timeout(ZOOM_connection c);
 465
 466
 467 /** \brief fire socket event activity (read,write,except)
 468     \param c connection
 469     \param mask or'ed mask of ZOOM_SELECT_.. values
 470     \retval 0 event was fired OK
 471     \retval -1 event was not fired
 472 */
 473 ZOOM_API(int)
 474     ZOOM_connection_fire_event_socket(ZOOM_connection c, int mask);
 475
 476
 477
 478 /** \brief peek at next event
 479     \param c connection
 480     \returns ZOOM_EVENT_NONE (for no events in queue), ZOOM_EVENT_CONNECT, ..
 481
 482     Does not actually remove the event from the event queue. ZOOM_event and
 483     ZOOM_process_event removes one event.
 484 */
 485
 486 ZOOM_API(int)
 487     ZOOM_connection_peek_event(ZOOM_connection c);
 488
 489 ZOOM_API(const char *)
 490     ZOOM_get_event_str(int event);
 491
 492 /*
 493  * Local variables:
 494  * c-basic-offset: 4
 495  * indent-tabs-mode: nil
 496  * End:
 497  * vim: shiftwidth=4 tabstop=8 expandtab
 498  */
 499