include/yaz/zoom.h

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