include/yaz/zoom.h

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