include/yaz/zoom.h

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