include/yaz/zoom.h

   1 /*
   2  * Copyright (C) 1995-2005, Index Data ApS
   3  * See the file LICENSE for details.
   4  *
   5  * $Id: zoom.h,v 1.25 2005-01-15 19:47:10 adam Exp $
   6  */
   7 /**
   8  * \file zoom.h
   9  * \brief Header for ZOOM
  10  */
  11
  12 #include <stdlib.h>
  13 #include <yaz/yconfig.h>
  14
  15 #define ZOOM_BEGIN_CDECL YAZ_BEGIN_CDECL
  16 #define ZOOM_END_CDECL YAZ_END_CDECL
  17
  18 #ifdef WIN32
  19 #  define ZOOM_API(x) __declspec(dllexport) x __stdcall
  20 #else
  21 #  define ZOOM_API(x) x
  22 # endif
  23
  24 ZOOM_BEGIN_CDECL
  25
  26 /* ----------------------------------------------------------- */
  27 /* the types we use */
  28
  29 typedef struct ZOOM_options_p *ZOOM_options;
  30 typedef struct ZOOM_query_p *ZOOM_query;
  31 typedef struct ZOOM_connection_p *ZOOM_connection;
  32 typedef struct ZOOM_resultset_p *ZOOM_resultset;
  33 typedef struct ZOOM_task_p *ZOOM_task;
  34 typedef struct ZOOM_record_p *ZOOM_record;
  35 typedef struct ZOOM_scanset_p *ZOOM_scanset;
  36 typedef struct ZOOM_package_p *ZOOM_package;
  37
  38 typedef const char *(*ZOOM_options_callback)(void *handle, const char *name);
  39
  40 /* ----------------------------------------------------------- */
  41 /* connections */
  42
  43 /* create connection, connect to host, if portnum is 0, then port is
  44 read from host string (e.g. myhost:9821) */
  45 ZOOM_API(ZOOM_connection)
  46 ZOOM_connection_new (const char *host, int portnum);
  47
  48 /* create connection, don't connect, apply options */
  49 ZOOM_API(ZOOM_connection)
  50 ZOOM_connection_create (ZOOM_options options);
  51
  52 /* connect given existing connection */
  53 ZOOM_API(void)
  54 ZOOM_connection_connect(ZOOM_connection c, const char *host,
  55                               int portnum);
  56
  57 /* destroy connection (close connection also) */
  58 ZOOM_API(void)
  59 ZOOM_connection_destroy (ZOOM_connection c);
  60
  61 /* get/set option for connection */
  62 ZOOM_API(const char *)
  63 ZOOM_connection_option_get (ZOOM_connection c, const char *key);
  64
  65 ZOOM_API(void)
  66 ZOOM_connection_option_set (ZOOM_connection c, const char *key,
  67                             const char *val);
  68
  69 ZOOM_API(void)
  70 ZOOM_connection_option_setl (ZOOM_connection c, const char *key,
  71                              const char *val, int len);
  72
  73 /* return error code (0 == success, failure otherwise). cp
  74    holds error string on failure, addinfo holds addititional info (if any)
  75 */
  76 ZOOM_API(int)
  77 ZOOM_connection_error (ZOOM_connection c, const char **cp,
  78                             const char **addinfo);
  79
  80 ZOOM_API(int)
  81 ZOOM_connection_error_x (ZOOM_connection c, const char **cp,
  82                          const char **addinfo, const char **diagset);
  83
  84 /* returns error code */
  85 ZOOM_API(int)
  86 ZOOM_connection_errcode (ZOOM_connection c);
  87 /* returns error message */
  88 ZOOM_API(const char *)
  89 ZOOM_connection_errmsg (ZOOM_connection c);
  90 /* returns additional info */
  91 ZOOM_API(const char *)
  92 ZOOM_connection_addinfo (ZOOM_connection c);
  93 /* translates error code into human-readable string */
  94 ZOOM_API(const char *)
  95 ZOOM_diag_str (int error);
  96
  97 #define ZOOM_ERROR_NONE 0
  98 #define ZOOM_ERROR_CONNECT 10000
  99 #define ZOOM_ERROR_MEMORY  10001
 100 #define ZOOM_ERROR_ENCODE  10002
 101 #define ZOOM_ERROR_DECODE  10003
 102 #define ZOOM_ERROR_CONNECTION_LOST 10004
 103 #define ZOOM_ERROR_INIT 10005
 104 #define ZOOM_ERROR_INTERNAL 10006
 105 #define ZOOM_ERROR_TIMEOUT 10007
 106 #define ZOOM_ERROR_UNSUPPORTED_PROTOCOL 10008
 107 #define ZOOM_ERROR_UNSUPPORTED_QUERY 10009
 108 #define ZOOM_ERROR_INVALID_QUERY 10010
 109
 110 ZOOM_API(int)
 111 ZOOM_connection_last_event(ZOOM_connection cs);
 112
 113 #define ZOOM_EVENT_NONE 0
 114 #define ZOOM_EVENT_CONNECT 1
 115 #define ZOOM_EVENT_SEND_DATA  2
 116 #define ZOOM_EVENT_RECV_DATA 3
 117 #define ZOOM_EVENT_TIMEOUT 4
 118 #define ZOOM_EVENT_UNKNOWN 5
 119 #define ZOOM_EVENT_SEND_APDU 6
 120 #define ZOOM_EVENT_RECV_APDU 7
 121 #define ZOOM_EVENT_RECV_RECORD 8
 122 #define ZOOM_EVENT_RECV_SEARCH 9
 123
 124 /* ----------------------------------------------------------- */
 125 /* result sets */
 126
 127 /* create result set given a search */
 128 ZOOM_API(ZOOM_resultset)
 129 ZOOM_connection_search(ZOOM_connection, ZOOM_query q);
 130 /* create result set given PQF query */
 131 ZOOM_API(ZOOM_resultset)
 132 ZOOM_connection_search_pqf(ZOOM_connection c, const char *q);
 133
 134 /* destroy result set */
 135 ZOOM_API(void)
 136 ZOOM_resultset_destroy(ZOOM_resultset r);
 137
 138 /* result set option */
 139 ZOOM_API(const char *)
 140 ZOOM_resultset_option_get (ZOOM_resultset r, const char *key);
 141 ZOOM_API(void)
 142 ZOOM_resultset_option_set (ZOOM_resultset r, const char *key, const char *val);
 143
 144 /* return size of result set (alias hit count AKA result count) */
 145 ZOOM_API(size_t)
 146 ZOOM_resultset_size (ZOOM_resultset r);
 147
 148 /* retrieve records */
 149 ZOOM_API(void)
 150 ZOOM_resultset_records (ZOOM_resultset r, ZOOM_record *recs,
 151                         size_t start, size_t count);
 152
 153 /* return record object at pos. Returns 0 if unavailable */
 154 ZOOM_API(ZOOM_record)
 155 ZOOM_resultset_record (ZOOM_resultset s, size_t pos);
 156
 157 /* like ZOOM_resultset_record - but never blocks .. */
 158 ZOOM_API(ZOOM_record)
 159 ZOOM_resultset_record_immediate (ZOOM_resultset s, size_t pos);
 160
 161 /* reset record cache for result set */
 162 ZOOM_API(void)
 163 ZOOM_resultset_cache_reset(ZOOM_resultset r);
 164
 165 /* ----------------------------------------------------------- */
 166 /* records */
 167
 168 /* get record information, in a form given by type */
 169 ZOOM_API(const char *)
 170 ZOOM_record_get (ZOOM_record rec, const char *type, int *len);
 171
 172 /* destroy record */
 173 ZOOM_API(void)
 174 ZOOM_record_destroy (ZOOM_record rec);
 175
 176 /* return copy of record */
 177 ZOOM_API(ZOOM_record)
 178 ZOOM_record_clone (ZOOM_record srec);
 179
 180 /* ----------------------------------------------------------- */
 181 /* queries */
 182
 183 /* create search object */
 184 ZOOM_API(ZOOM_query)
 185 ZOOM_query_create(void);
 186 /* destroy it */
 187 ZOOM_API(void)
 188 ZOOM_query_destroy(ZOOM_query s);
 189 /* CQL */
 190 ZOOM_API(int)
 191 ZOOM_query_cql(ZOOM_query s, const char *str);
 192 /* PQF */
 193 ZOOM_API(int)
 194 ZOOM_query_prefix(ZOOM_query s, const char *str);
 195 /* specify sort criteria for search */
 196 ZOOM_API(int)
 197 ZOOM_query_sortby(ZOOM_query s, const char *criteria);
 198
 199 /* ----------------------------------------------------------- */
 200 /* scan */
 201 ZOOM_API(ZOOM_scanset)
 202 ZOOM_connection_scan (ZOOM_connection c, const char *startterm);
 203
 204 ZOOM_API(const char *)
 205 ZOOM_scanset_term(ZOOM_scanset scan, size_t pos,
 206                   int *occ, int *len);
 207
 208 ZOOM_API(const char *)
 209 ZOOM_scanset_display_term(ZOOM_scanset scan, size_t pos,
 210                           int *occ, int *len);
 211
 212 ZOOM_API(size_t)
 213 ZOOM_scanset_size(ZOOM_scanset scan);
 214
 215 ZOOM_API(void)
 216 ZOOM_scanset_destroy (ZOOM_scanset scan);
 217
 218 ZOOM_API(const char *)
 219     ZOOM_scanset_option_get (ZOOM_scanset scan, const char *key);
 220
 221 ZOOM_API(void)
 222     ZOOM_scanset_option_set (ZOOM_scanset scan, const char *key,
 223                              const char *val);
 224 /* ----------------------------------------------------------- */
 225 /* Extended Services Packages */
 226
 227 ZOOM_API(ZOOM_package)
 228     ZOOM_connection_package (ZOOM_connection c, ZOOM_options options);
 229
 230 ZOOM_API(void)
 231     ZOOM_package_destroy(ZOOM_package p);
 232
 233 ZOOM_API(void)
 234     ZOOM_package_send (ZOOM_package p, const char *type);
 235
 236 ZOOM_API(const char *)
 237     ZOOM_package_option_get (ZOOM_package p, const char *key);
 238
 239 ZOOM_API(void)
 240     ZOOM_package_option_set (ZOOM_package p, const char *key,
 241                              const char *val);
 242
 243 /* ----------------------------------------------------------- */
 244 /* Sort */
 245 ZOOM_API(void)
 246     ZOOM_resultset_sort(ZOOM_resultset r,
 247                         const char *sort_type, const char *sort_spec);
 248
 249 /* ----------------------------------------------------------- */
 250 /* options */
 251
 252 ZOOM_API(ZOOM_options_callback)
 253     ZOOM_options_set_callback (ZOOM_options opt,
 254                                ZOOM_options_callback c,
 255                                void *handle);
 256 ZOOM_API(ZOOM_options)
 257 ZOOM_options_create (void);
 258
 259 ZOOM_API(ZOOM_options)
 260 ZOOM_options_create_with_parent (ZOOM_options parent);
 261
 262 ZOOM_API(ZOOM_options)
 263     ZOOM_options_create_with_parent2 (ZOOM_options parent1,
 264                                       ZOOM_options parent2);
 265
 266 ZOOM_API(const char *)
 267 ZOOM_options_get (ZOOM_options opt, const char *name);
 268
 269 ZOOM_API(void)
 270 ZOOM_options_set (ZOOM_options opt, const char *name, const char *v);
 271
 272 ZOOM_API(void)
 273 ZOOM_options_setl (ZOOM_options opt, const char *name, const char *value,
 274                    int len);
 275
 276 ZOOM_API(void)
 277 ZOOM_options_destroy (ZOOM_options opt);
 278
 279 ZOOM_API(int)
 280 ZOOM_options_get_bool (ZOOM_options opt, const char *name, int defa);
 281
 282 ZOOM_API(int)
 283 ZOOM_options_get_int (ZOOM_options opt, const char *name, int defa);
 284
 285 ZOOM_API(void)
 286 ZOOM_options_set_int(ZOOM_options opt, const char *name, int value);
 287
 288 /* ----------------------------------------------------------- */
 289 /* events */
 290 /* poll for events on a number of connections. Returns positive
 291    integer if event occurred ; zero if none occurred and no more
 292    events are pending. The positive integer specifies the
 293    connection for which the event occurred. */
 294 ZOOM_API(int)
 295 ZOOM_event (int no, ZOOM_connection *cs);
 296
 297 ZOOM_END_CDECL