include/yaz/zoom.h

   1 /*
   2  * Public header for ZOOM C.
   3  * $Id: zoom.h,v 1.20 2004-02-11 13:37:16 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 #define ZOOM_ERROR_INVALID_QUERY 10010
  98
  99 ZOOM_API(int)
 100 ZOOM_connection_last_event(ZOOM_connection cs);
 101
 102 #define ZOOM_EVENT_NONE 0
 103 #define ZOOM_EVENT_CONNECT 1
 104 #define ZOOM_EVENT_SEND_DATA  2
 105 #define ZOOM_EVENT_RECV_DATA 3
 106 #define ZOOM_EVENT_TIMEOUT 4
 107 #define ZOOM_EVENT_UNKNOWN 5
 108 #define ZOOM_EVENT_SEND_APDU 6
 109 #define ZOOM_EVENT_RECV_APDU 7
 110 #define ZOOM_EVENT_RECV_RECORD 8
 111 #define ZOOM_EVENT_RECV_SEARCH 9
 112
 113 /* ----------------------------------------------------------- */
 114 /* result sets */
 115
 116 /* create result set given a search */
 117 ZOOM_API(ZOOM_resultset)
 118 ZOOM_connection_search(ZOOM_connection, ZOOM_query q);
 119 /* create result set given PQF query */
 120 ZOOM_API(ZOOM_resultset)
 121 ZOOM_connection_search_pqf(ZOOM_connection c, const char *q);
 122
 123 /* destroy result set */
 124 ZOOM_API(void)
 125 ZOOM_resultset_destroy(ZOOM_resultset r);
 126
 127 /* result set option */
 128 ZOOM_API(const char *)
 129 ZOOM_resultset_option_get (ZOOM_resultset r, const char *key);
 130 ZOOM_API(void)
 131 ZOOM_resultset_option_set (ZOOM_resultset r, const char *key, const char *val);
 132
 133 /* return size of result set (alias hit count AKA result count) */
 134 ZOOM_API(size_t)
 135 ZOOM_resultset_size (ZOOM_resultset r);
 136
 137 /* retrieve records */
 138 ZOOM_API(void)
 139 ZOOM_resultset_records (ZOOM_resultset r, ZOOM_record *recs,
 140                         size_t start, size_t count);
 141
 142 /* return record object at pos. Returns 0 if unavailable */
 143 ZOOM_API(ZOOM_record)
 144 ZOOM_resultset_record (ZOOM_resultset s, size_t pos);
 145
 146 /* like ZOOM_resultset_record - but never blocks .. */
 147 ZOOM_API(ZOOM_record)
 148 ZOOM_resultset_record_immediate (ZOOM_resultset s, size_t pos);
 149
 150 /* ----------------------------------------------------------- */
 151 /* records */
 152
 153 /* get record information, in a form given by type */
 154 ZOOM_API(const char *)
 155 ZOOM_record_get (ZOOM_record rec, const char *type, int *len);
 156
 157 /* destroy record */
 158 ZOOM_API(void)
 159 ZOOM_record_destroy (ZOOM_record rec);
 160
 161 /* return copy of record */
 162 ZOOM_API(ZOOM_record)
 163 ZOOM_record_clone (ZOOM_record srec);
 164
 165 /* ----------------------------------------------------------- */
 166 /* queries */
 167
 168 /* create search object */
 169 ZOOM_API(ZOOM_query)
 170 ZOOM_query_create(void);
 171 /* destroy it */
 172 ZOOM_API(void)
 173 ZOOM_query_destroy(ZOOM_query s);
 174 /* CQL */
 175 ZOOM_API(int)
 176 ZOOM_query_cql(ZOOM_query s, const char *str);
 177 /* PQF */
 178 ZOOM_API(int)
 179 ZOOM_query_prefix(ZOOM_query s, const char *str);
 180 /* specify sort criteria for search */
 181 ZOOM_API(int)
 182 ZOOM_query_sortby(ZOOM_query s, const char *criteria);
 183
 184 /* ----------------------------------------------------------- */
 185 /* scan */
 186 ZOOM_API(ZOOM_scanset)
 187 ZOOM_connection_scan (ZOOM_connection c, const char *startterm);
 188
 189 ZOOM_API(const char *)
 190 ZOOM_scanset_term(ZOOM_scanset scan, size_t pos,
 191                   int *occ, int *len);
 192
 193 ZOOM_API(const char *)
 194 ZOOM_scanset_display_term(ZOOM_scanset scan, size_t pos,
 195                           int *occ, int *len);
 196
 197 ZOOM_API(size_t)
 198 ZOOM_scanset_size(ZOOM_scanset scan);
 199
 200 ZOOM_API(void)
 201 ZOOM_scanset_destroy (ZOOM_scanset scan);
 202
 203 ZOOM_API(const char *)
 204     ZOOM_scanset_option_get (ZOOM_scanset scan, const char *key);
 205
 206 ZOOM_API(void)
 207     ZOOM_scanset_option_set (ZOOM_scanset scan, const char *key,
 208                              const char *val);
 209 /* ----------------------------------------------------------- */
 210 /* Extended Services Packages */
 211
 212 ZOOM_API(ZOOM_package)
 213     ZOOM_connection_package (ZOOM_connection c, ZOOM_options options);
 214
 215 ZOOM_API(void)
 216     ZOOM_package_destroy(ZOOM_package p);
 217
 218 ZOOM_API(void)
 219     ZOOM_package_send (ZOOM_package p, const char *type);
 220
 221 ZOOM_API(const char *)
 222     ZOOM_package_option_get (ZOOM_package p, const char *key);
 223
 224 ZOOM_API(void)
 225     ZOOM_package_option_set (ZOOM_package p, const char *key,
 226                              const char *val);
 227
 228 /* ----------------------------------------------------------- */
 229 /* options */
 230
 231 ZOOM_API(ZOOM_options_callback)
 232     ZOOM_options_set_callback (ZOOM_options opt,
 233                                ZOOM_options_callback c,
 234                                void *handle);
 235 ZOOM_API(ZOOM_options)
 236 ZOOM_options_create (void);
 237
 238 ZOOM_API(ZOOM_options)
 239 ZOOM_options_create_with_parent (ZOOM_options parent);
 240
 241 ZOOM_API(ZOOM_options)
 242     ZOOM_options_create_with_parent2 (ZOOM_options parent1,
 243                                       ZOOM_options parent2);
 244
 245 ZOOM_API(const char *)
 246 ZOOM_options_get (ZOOM_options opt, const char *name);
 247
 248 ZOOM_API(void)
 249 ZOOM_options_set (ZOOM_options opt, const char *name, const char *v);
 250
 251 ZOOM_API(void)
 252 ZOOM_options_setl (ZOOM_options opt, const char *name, const char *value,
 253                    int len);
 254
 255 ZOOM_API(void)
 256 ZOOM_options_destroy (ZOOM_options opt);
 257
 258 ZOOM_API(int)
 259 ZOOM_options_get_bool (ZOOM_options opt, const char *name, int defa);
 260
 261 ZOOM_API(int)
 262 ZOOM_options_get_int (ZOOM_options opt, const char *name, int defa);
 263
 264 ZOOM_API(void)
 265 ZOOM_options_set_int(ZOOM_options opt, const char *name, int value);
 266
 267 /* ----------------------------------------------------------- */
 268 /* events */
 269 /* poll for events on a number of connections. Returns positive
 270    integer if event occurred ; zero if none occurred and no more
 271    events are pending. The positive integer specifies the
 272    connection for which the event occurred. */
 273 ZOOM_API(int)
 274 ZOOM_event (int no, ZOOM_connection *cs);
 275
 276 ZOOM_END_CDECL