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