include/yaz/zoom.h

   1 /*
   2  * Public header for ZOOM C.
   3  * $Id: zoom.h,v 1.14 2002-11-30 22:30:51 mike 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 /* returns error code */
  70 ZOOM_API(int)
  71 ZOOM_connection_errcode (ZOOM_connection c);
  72 /* returns error message */
  73 ZOOM_API(const char *)
  74 ZOOM_connection_errmsg (ZOOM_connection c);
  75 /* returns additional info */
  76 ZOOM_API(const char *)
  77 ZOOM_connection_addinfo (ZOOM_connection c);
  78 /* translates error code into human-readable string */
  79 ZOOM_API(const char *)
  80 ZOOM_diag_str (int error);
  81
  82 #define ZOOM_ERROR_NONE 0
  83 #define ZOOM_ERROR_CONNECT 10000
  84 #define ZOOM_ERROR_MEMORY  10001
  85 #define ZOOM_ERROR_ENCODE  10002
  86 #define ZOOM_ERROR_DECODE  10003
  87 #define ZOOM_ERROR_CONNECTION_LOST 10004
  88 #define ZOOM_ERROR_INIT 10005
  89 #define ZOOM_ERROR_INTERNAL 10006
  90 #define ZOOM_ERROR_TIMEOUT 10007
  91
  92 ZOOM_API(int)
  93 ZOOM_connection_last_event(ZOOM_connection cs);
  94
  95 #define ZOOM_EVENT_NONE 0
  96 #define ZOOM_EVENT_CONNECT 1
  97 #define ZOOM_EVENT_SEND_DATA  2
  98 #define ZOOM_EVENT_RECV_DATA 3
  99 #define ZOOM_EVENT_TIMEOUT 4
 100 #define ZOOM_EVENT_UNKNOWN 5
 101 #define ZOOM_EVENT_SEND_APDU 6
 102 #define ZOOM_EVENT_RECV_APDU 7
 103
 104 /* ----------------------------------------------------------- */
 105 /* result sets */
 106
 107 /* create result set given a search */
 108 ZOOM_API(ZOOM_resultset)
 109 ZOOM_connection_search(ZOOM_connection, ZOOM_query q);
 110 /* create result set given PQF query */
 111 ZOOM_API(ZOOM_resultset)
 112 ZOOM_connection_search_pqf(ZOOM_connection c, const char *q);
 113
 114 /* destroy result set */
 115 ZOOM_API(void)
 116 ZOOM_resultset_destroy(ZOOM_resultset r);
 117
 118 /* result set option */
 119 ZOOM_API(const char *)
 120 ZOOM_resultset_option_get (ZOOM_resultset r, const char *key);
 121 ZOOM_API(void)
 122 ZOOM_resultset_option_set (ZOOM_resultset r, const char *key, const char *val);
 123
 124 /* return size of result set (alias hit count AKA result count) */
 125 ZOOM_API(size_t)
 126 ZOOM_resultset_size (ZOOM_resultset r);
 127
 128 /* retrieve records */
 129 ZOOM_API(void)
 130 ZOOM_resultset_records (ZOOM_resultset r, ZOOM_record *recs,
 131                         size_t start, size_t count);
 132
 133 /* return record object at pos. Returns 0 if unavailable */
 134 ZOOM_API(ZOOM_record)
 135 ZOOM_resultset_record (ZOOM_resultset s, size_t pos);
 136
 137 /* like ZOOM_resultset_record - but never blocks .. */
 138 ZOOM_API(ZOOM_record)
 139 ZOOM_resultset_record_immediate (ZOOM_resultset s, size_t pos);
 140
 141 /* ----------------------------------------------------------- */
 142 /* records */
 143
 144 /* get record information, in a form given by type */
 145 ZOOM_API(const char *)
 146 ZOOM_record_get (ZOOM_record rec, const char *type, int *len);
 147
 148 /* destroy record */
 149 ZOOM_API(void)
 150 ZOOM_record_destroy (ZOOM_record rec);
 151
 152 /* return copy of record */
 153 ZOOM_API(ZOOM_record)
 154 ZOOM_record_clone (ZOOM_record srec);
 155
 156 /* ----------------------------------------------------------- */
 157 /* queries */
 158
 159 /* create search object */
 160 ZOOM_API(ZOOM_query)
 161 ZOOM_query_create(void);
 162 /* destroy it */
 163 ZOOM_API(void)
 164 ZOOM_query_destroy(ZOOM_query s);
 165 /* specify prefix query for search */
 166 ZOOM_API(int)
 167 ZOOM_query_prefix(ZOOM_query s, const char *str);
 168 /* specify sort criteria for search */
 169 ZOOM_API(int)
 170 ZOOM_query_sortby(ZOOM_query s, const char *criteria);
 171
 172 /* ----------------------------------------------------------- */
 173 /* scan */
 174 ZOOM_API(ZOOM_scanset)
 175 ZOOM_connection_scan (ZOOM_connection c, const char *startterm);
 176
 177 ZOOM_API(const char *)
 178 ZOOM_scanset_term(ZOOM_scanset scan, size_t pos,
 179                   int *occ, int *len);
 180
 181 ZOOM_API(size_t)
 182 ZOOM_scanset_size(ZOOM_scanset scan);
 183
 184 ZOOM_API(void)
 185 ZOOM_scanset_destroy (ZOOM_scanset scan);
 186
 187 ZOOM_API(const char *)
 188     ZOOM_scanset_option_get (ZOOM_scanset scan, const char *key);
 189
 190 ZOOM_API(void)
 191     ZOOM_scanset_option_set (ZOOM_scanset scan, const char *key,
 192                              const char *val);
 193 /* ----------------------------------------------------------- */
 194 /* Extended Services Packages */
 195
 196 ZOOM_API(ZOOM_package)
 197     ZOOM_connection_package (ZOOM_connection c, ZOOM_options options);
 198
 199 ZOOM_API(void)
 200     ZOOM_package_destroy(ZOOM_package p);
 201
 202 ZOOM_API(void)
 203     ZOOM_package_send (ZOOM_package p, const char *type);
 204
 205 ZOOM_API(const char *)
 206     ZOOM_package_option_get (ZOOM_package p, const char *key);
 207
 208 ZOOM_API(void)
 209     ZOOM_package_option_set (ZOOM_package p, const char *key,
 210                              const char *val);
 211
 212 /* ----------------------------------------------------------- */
 213 /* options */
 214
 215 ZOOM_API(ZOOM_options_callback)
 216     ZOOM_options_set_callback (ZOOM_options opt,
 217                                ZOOM_options_callback c,
 218                                void *handle);
 219 ZOOM_API(ZOOM_options)
 220 ZOOM_options_create (void);
 221
 222 ZOOM_API(ZOOM_options)
 223 ZOOM_options_create_with_parent (ZOOM_options parent);
 224
 225 ZOOM_API(ZOOM_options)
 226     ZOOM_options_create_with_parent2 (ZOOM_options parent1,
 227                                       ZOOM_options parent2);
 228
 229 ZOOM_API(const char *)
 230 ZOOM_options_get (ZOOM_options opt, const char *name);
 231
 232 ZOOM_API(void)
 233 ZOOM_options_set (ZOOM_options opt, const char *name, const char *v);
 234
 235 ZOOM_API(void)
 236 ZOOM_options_setl (ZOOM_options opt, const char *name, const char *value,
 237                    int len);
 238
 239 ZOOM_API(void)
 240 ZOOM_options_destroy (ZOOM_options opt);
 241
 242 ZOOM_API(int)
 243 ZOOM_options_get_bool (ZOOM_options opt, const char *name, int defa);
 244
 245 ZOOM_API(int)
 246 ZOOM_options_get_int (ZOOM_options opt, const char *name, int defa);
 247
 248 ZOOM_API(void)
 249 ZOOM_options_set_int(ZOOM_options opt, const char *name, int value);
 250
 251 /* ----------------------------------------------------------- */
 252 /* events */
 253 /* poll for events on a number of connections. Returns positive
 254    integer if event occurred ; zero if none occurred and no more
 255    events are pending. The positive integer specifies the
 256    connection for which the event occurred. */
 257 ZOOM_API(int)
 258 ZOOM_event (int no, ZOOM_connection *cs);
 259
 260 ZOOM_END_CDECL