include/yaz/zoom.h

   1 /*
   2  * Public header for ZOOM C.
   3  * $Id: zoom.h,v 1.12 2002-05-17 12:48: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
  30 /* ----------------------------------------------------------- */
  31 /* connections */
  32
  33 /* create connection, connect to host, if portnum is 0, then port is
  34 read from host string (e.g. myhost:9821) */
  35 ZOOM_API(ZOOM_connection)
  36 ZOOM_connection_new (const char *host, int portnum);
  37
  38 /* create connection, don't connect, apply options */
  39 ZOOM_API(ZOOM_connection)
  40 ZOOM_connection_create (ZOOM_options options);
  41
  42 /* connect given existing connection */
  43 ZOOM_API(void)
  44 ZOOM_connection_connect(ZOOM_connection c, const char *host,
  45                               int portnum);
  46
  47 /* destroy connection (close connection also) */
  48 ZOOM_API(void)
  49 ZOOM_connection_destroy (ZOOM_connection c);
  50
  51 /* get/set option for connection */
  52 ZOOM_API(const char *)
  53 ZOOM_connection_option_get (ZOOM_connection c, const char *key);
  54
  55 ZOOM_API(void)
  56 ZOOM_connection_option_set (ZOOM_connection c, const char *key,
  57                             const char *val);
  58
  59 /* return error code (0 == success, failure otherwise). cp
  60    holds error string on failure, addinfo holds addititional info (if any)
  61 */
  62 ZOOM_API(int)
  63 ZOOM_connection_error (ZOOM_connection c, const char **cp,
  64                             const char **addinfo);
  65
  66 /* returns error code */
  67 ZOOM_API(int)
  68 ZOOM_connection_errcode (ZOOM_connection c);
  69 /* returns error message */
  70 ZOOM_API(const char *)
  71 ZOOM_connection_errmsg (ZOOM_connection c);
  72 /* returns additional info */
  73 ZOOM_API(const char *)
  74 ZOOM_connection_addinfo (ZOOM_connection c);
  75
  76 #define ZOOM_ERROR_NONE 0
  77 #define ZOOM_ERROR_CONNECT 10000
  78 #define ZOOM_ERROR_MEMORY  10001
  79 #define ZOOM_ERROR_ENCODE  10002
  80 #define ZOOM_ERROR_DECODE  10003
  81 #define ZOOM_ERROR_CONNECTION_LOST 10004
  82 #define ZOOM_ERROR_INIT 10005
  83 #define ZOOM_ERROR_INTERNAL 10006
  84 #define ZOOM_ERROR_TIMEOUT 10007
  85
  86 ZOOM_API(int)
  87 ZOOM_connection_last_event(ZOOM_connection cs);
  88
  89 #define ZOOM_EVENT_NONE 0
  90 #define ZOOM_EVENT_CONNECT 1
  91 #define ZOOM_EVENT_SEND_DATA  2
  92 #define ZOOM_EVENT_RECV_DATA 3
  93 #define ZOOM_EVENT_TIMEOUT 4
  94 #define ZOOM_EVENT_UNKNOWN 5
  95 #define ZOOM_EVENT_SEND_APDU 6
  96 #define ZOOM_EVENT_RECV_APDU 7
  97
  98 /* ----------------------------------------------------------- */
  99 /* result sets */
 100
 101 /* create result set given a search */
 102 ZOOM_API(ZOOM_resultset)
 103 ZOOM_connection_search(ZOOM_connection, ZOOM_query q);
 104 /* create result set given PQF query */
 105 ZOOM_API(ZOOM_resultset)
 106 ZOOM_connection_search_pqf(ZOOM_connection c, const char *q);
 107
 108 /* destroy result set */
 109 ZOOM_API(void)
 110 ZOOM_resultset_destroy(ZOOM_resultset r);
 111
 112 /* result set option */
 113 ZOOM_API(const char *)
 114 ZOOM_resultset_option_get (ZOOM_resultset r, const char *key);
 115 ZOOM_API(void)
 116 ZOOM_resultset_option_set (ZOOM_resultset r, const char *key, const char *val);
 117
 118 /* return size of result set (alias hit count AKA result count) */
 119 ZOOM_API(size_t)
 120 ZOOM_resultset_size (ZOOM_resultset r);
 121
 122 /* retrieve records */
 123 ZOOM_API(void)
 124 ZOOM_resultset_records (ZOOM_resultset r, ZOOM_record *recs,
 125                         size_t start, size_t count);
 126
 127 /* return record object at pos. Returns 0 if unavailable */
 128 ZOOM_API(ZOOM_record)
 129 ZOOM_resultset_record (ZOOM_resultset s, size_t pos);
 130
 131 /* like ZOOM_resultset_record - but never blocks .. */
 132 ZOOM_API(ZOOM_record)
 133 ZOOM_resultset_record_immediate (ZOOM_resultset s, size_t pos);
 134
 135 /* ----------------------------------------------------------- */
 136 /* records */
 137
 138 /* get record information, in a form given by type */
 139 ZOOM_API(const char *)
 140 ZOOM_record_get (ZOOM_record rec, const char *type, int *len);
 141
 142 /* destroy record */
 143 ZOOM_API(void)
 144 ZOOM_record_destroy (ZOOM_record rec);
 145
 146 /* return copy of record */
 147 ZOOM_API(ZOOM_record)
 148 ZOOM_record_clone (ZOOM_record srec);
 149
 150 /* ----------------------------------------------------------- */
 151 /* queries */
 152
 153 /* create search object */
 154 ZOOM_API(ZOOM_query)
 155 ZOOM_query_create(void);
 156 /* destroy it */
 157 ZOOM_API(void)
 158 ZOOM_query_destroy(ZOOM_query s);
 159 /* specify prefix query for search */
 160 ZOOM_API(int)
 161 ZOOM_query_prefix(ZOOM_query s, const char *str);
 162 /* specify sort criteria for search */
 163 ZOOM_API(int)
 164 ZOOM_query_sortby(ZOOM_query s, const char *criteria);
 165
 166 /* ----------------------------------------------------------- */
 167 /* scan */
 168 ZOOM_API(ZOOM_scanset)
 169 ZOOM_connection_scan (ZOOM_connection c, const char *startterm);
 170
 171 ZOOM_API(const char *)
 172 ZOOM_scanset_term(ZOOM_scanset scan, size_t pos,
 173                   int *occ, int *len);
 174
 175 ZOOM_API(size_t)
 176 ZOOM_scanset_size(ZOOM_scanset scan);
 177
 178 ZOOM_API(void)
 179 ZOOM_scanset_destroy (ZOOM_scanset scan);
 180
 181 ZOOM_API(const char *)
 182 ZOOM_scanset_option_get (ZOOM_scanset scan, const char *key);
 183
 184 ZOOM_API(void)
 185 ZOOM_scanset_option_set (ZOOM_scanset scan, const char *key,
 186                          const char *val);
 187 /* ----------------------------------------------------------- */
 188 /* options */
 189 typedef const char *(*ZOOM_options_callback)(void *handle, const char *name);
 190
 191 ZOOM_API(ZOOM_options_callback)
 192 ZOOM_options_set_callback (ZOOM_options opt,
 193                                                    ZOOM_options_callback c,
 194                                                    void *handle);
 195 ZOOM_API(ZOOM_options)
 196 ZOOM_options_create (void);
 197
 198 ZOOM_API(ZOOM_options)
 199 ZOOM_options_create_with_parent (ZOOM_options parent);
 200
 201 ZOOM_API(const char *)
 202 ZOOM_options_get (ZOOM_options opt, const char *name);
 203
 204 ZOOM_API(void)
 205 ZOOM_options_set (ZOOM_options opt, const char *name, const char *v);
 206
 207 ZOOM_API(void)
 208 ZOOM_options_destroy (ZOOM_options opt);
 209
 210 ZOOM_API(int)
 211 ZOOM_options_get_bool (ZOOM_options opt, const char *name, int defa);
 212
 213 ZOOM_API(int)
 214 ZOOM_options_get_int (ZOOM_options opt, const char *name, int defa);
 215
 216 ZOOM_API(void)
 217 ZOOM_options_set_int(ZOOM_options opt, const char *name, int value);
 218
 219 /* ----------------------------------------------------------- */
 220 /* events */
 221 /* poll for events on a number of connections. Returns positive
 222    integer if event occurred ; zero if none occurred and no more
 223    events are pending. The positive integer specifies the
 224    connection for which the event occurred. */
 225 ZOOM_API(int)
 226 ZOOM_event (int no, ZOOM_connection *cs);
 227
 228 ZOOM_END_CDECL