1 /* This file is part of the YAZ toolkit.
2 * Copyright (C) Index Data.
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions are met:
7 * * Redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer.
9 * * Redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution.
12 * * Neither the name of Index Data nor the names of its contributors
13 * may be used to endorse or promote products derived from this
14 * software without specific prior written permission.
16 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY
17 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
18 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
19 * DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
20 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
21 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
22 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
23 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
25 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 * \brief Internal header for ZOOM implementation
31 #include <yaz/proto.h>
32 #include <yaz/oid_db.h>
33 #include <yaz/comstack.h>
34 #include <yaz/wrbuf.h>
37 #include <yaz/cookie.h>
38 #include <yaz/mutex.h>
40 #include <libmemcached/memcached.h>
43 #include <hiredis/hiredis.h>
48 typedef struct ZOOM_Event_p *ZOOM_Event;
59 typedef struct ZOOM_task_p *ZOOM_task;
62 #define STATE_CONNECTING 1
63 #define STATE_ESTABLISHED 2
65 struct ZOOM_connection_p {
97 int url_authentication;
100 int support_named_resultsets;
103 int maximum_record_size;
104 int preferred_message_size;
107 ZOOM_options options;
108 ZOOM_resultset resultsets;
109 ZOOM_Event m_queue_front;
110 ZOOM_Event m_queue_back;
111 zoom_sru_mode sru_mode;
112 int no_redirects; /* 0 for no redirects. >0 for number of redirects */
113 yaz_cookies_t cookies;
118 WRBUF saveAPDU_wrbuf;
119 #if HAVE_LIBMEMCACHED
123 redisContext *redis_c;
129 typedef struct ZOOM_record_cache_p *ZOOM_record_cache;
131 #define RECORD_HASH_SIZE 131
133 struct ZOOM_resultset_p {
134 Z_SortKeySpecList *r_sort_spec;
142 ZOOM_record_cache record_hash[RECORD_HASH_SIZE];
143 ZOOM_options options;
144 ZOOM_connection connection;
145 char **databaseNames;
146 int num_databaseNames;
149 struct WRBUF_shptr *record_wrbuf;
153 ZOOM_facet_field *res_facets;
155 char **facets_names; /* redundant. For ZOOM_resultset_facets_names only */
157 int live_set; /* 0=no hit count, 1=cached hit, 2=hits + real set */
160 struct facet_term_p {
165 struct ZOOM_facet_field_p {
168 struct facet_term_p *facet_terms;
171 struct ZOOM_scanset_p {
174 ZOOM_options options;
175 ZOOM_connection connection;
177 Z_ScanResponse *scan_response;
178 Z_SRW_scanResponse *srw_scan_response;
180 char **databaseNames;
181 int num_databaseNames;
184 struct ZOOM_package_p {
187 ZOOM_options options;
188 ZOOM_connection connection;
197 #define ZOOM_TASK_SEARCH 1
201 ZOOM_resultset resultset;
203 char *elementSetName;
206 #define ZOOM_TASK_CONNECT 3
207 #define ZOOM_TASK_SCAN 4
211 #define ZOOM_TASK_PACKAGE 5
212 ZOOM_package package;
213 #define ZOOM_TASK_SORT 6
215 ZOOM_resultset resultset;
227 void ZOOM_options_addref (ZOOM_options opt);
229 void ZOOM_handle_Z3950_apdu(ZOOM_connection c, Z_APDU *apdu);
231 void ZOOM_set_dset_error(ZOOM_connection c, int error,
233 const char *addinfo, const char *addinfo2);
235 void ZOOM_set_error(ZOOM_connection c, int error, const char *addinfo);
237 ZOOM_Event ZOOM_Event_create(int kind);
238 void ZOOM_connection_put_event(ZOOM_connection c, ZOOM_Event event);
240 zoom_ret ZOOM_connection_Z3950_search(ZOOM_connection c);
241 zoom_ret ZOOM_connection_Z3950_send_scan(ZOOM_connection c);
242 zoom_ret ZOOM_send_buf(ZOOM_connection c);
243 zoom_ret send_Z3950_sort(ZOOM_connection c, ZOOM_resultset resultset);
244 char **ZOOM_connection_get_databases(ZOOM_connection con, ZOOM_options options,
246 zoom_ret ZOOM_connection_Z3950_send_init(ZOOM_connection c);
248 ZOOM_task ZOOM_connection_add_task(ZOOM_connection c, int which);
249 void ZOOM_connection_remove_task(ZOOM_connection c);
250 int ZOOM_test_reconnect(ZOOM_connection c);
252 ZOOM_record ZOOM_record_cache_lookup(ZOOM_resultset r, int pos,
254 const char *elementSetName,
256 void ZOOM_record_cache_add(ZOOM_resultset r, Z_NamePlusRecord *npr,
258 const char *syntax, const char *elementSetName,
260 Z_SRW_diagnostic *diag);
262 Z_Query *ZOOM_query_get_Z_Query(ZOOM_query s);
263 Z_SortKeySpecList *ZOOM_query_get_sortspec(ZOOM_query s);
264 const char *ZOOM_query_get_query_string(ZOOM_query s);
265 const char *ZOOM_query_get_sru11(ZOOM_query s);
266 void ZOOM_query_get_hash(ZOOM_query s, WRBUF w);
268 int ZOOM_uri_to_code(const char *uri);
270 zoom_ret ZOOM_connection_srw_send_search(ZOOM_connection c);
271 zoom_ret ZOOM_connection_srw_send_scan(ZOOM_connection c);
273 int ZOOM_handle_sru(ZOOM_connection c, Z_HTTP_Response *hres,
274 zoom_ret *cret, char **addinfo);
276 void ZOOM_set_HTTP_error(ZOOM_connection c, int error,
277 const char *addinfo, const char *addinfo2);
279 ZOOM_Event ZOOM_connection_get_event(ZOOM_connection c);
280 void ZOOM_connection_remove_events(ZOOM_connection c);
281 void ZOOM_Event_destroy(ZOOM_Event event);
282 zoom_ret ZOOM_send_GDU(ZOOM_connection c, Z_GDU *gdu);
283 void ZOOM_handle_facet_list(ZOOM_resultset r, Z_FacetList *fl);
285 void ZOOM_memcached_init(ZOOM_connection c);
286 int ZOOM_memcached_configure(ZOOM_connection c);
287 void ZOOM_memcached_destroy(ZOOM_connection c);
288 void ZOOM_memcached_resultset(ZOOM_resultset r, ZOOM_query q);
289 void ZOOM_memcached_search(ZOOM_connection c, ZOOM_resultset r);
290 void ZOOM_memcached_hitcount(ZOOM_connection c, ZOOM_resultset result,
291 Z_OtherInformation *oi, const char *precision);
292 void ZOOM_memcached_add(ZOOM_resultset r, Z_NamePlusRecord *npr,
294 const char *syntax, const char *elementSetName,
296 Z_SRW_diagnostic *diag);
297 Z_NamePlusRecord *ZOOM_memcached_lookup(ZOOM_resultset r, int pos,
299 const char *elementSetName,
301 ZOOM_record ZOOM_record_cache_lookup_i(ZOOM_resultset r, int pos,
303 const char *elementSetName,
305 void ZOOM_handle_facet_result(ZOOM_connection c, ZOOM_resultset r,
306 Z_OtherInformation *o);
307 void ZOOM_handle_search_result(ZOOM_connection c, ZOOM_resultset resultset,
308 Z_OtherInformation *o);
313 * c-file-style: "Stroustrup"
314 * indent-tabs-mode: nil
316 * vim: shiftwidth=4 tabstop=8 expandtab