1 /* This file is part of the YAZ toolkit.
2 * Copyright (C) 1995-2013 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/mutex.h>
40 #define ZOOM_RESULT_LISTS 0
42 typedef struct ZOOM_Event_p *ZOOM_Event;
53 typedef struct ZOOM_task_p *ZOOM_task;
56 #define STATE_CONNECTING 1
57 #define STATE_ESTABLISHED 2
60 typedef struct ZOOM_resultsets_p *ZOOM_resultsets;
63 struct ZOOM_connection_p {
94 int url_authentication;
97 int support_named_resultsets;
100 int maximum_record_size;
101 int preferred_message_size;
104 ZOOM_options options;
105 #if ZOOM_RESULT_LISTS
106 ZOOM_resultsets resultsets;
108 ZOOM_resultset resultsets;
110 ZOOM_Event m_queue_front;
111 ZOOM_Event m_queue_back;
112 zoom_sru_mode sru_mode;
113 int no_redirects; /* 0 for no redirects. >0 for number of redirects */
117 WRBUF saveAPDU_wrbuf;
120 #if ZOOM_RESULT_LISTS
121 struct ZOOM_resultsets_p {
122 ZOOM_resultset resultset;
123 ZOOM_resultsets next;
127 typedef struct ZOOM_record_cache_p *ZOOM_record_cache;
129 #define RECORD_HASH_SIZE 131
131 struct ZOOM_resultset_p {
132 Z_SortKeySpecList *r_sort_spec;
140 ZOOM_record_cache record_hash[RECORD_HASH_SIZE];
141 ZOOM_options options;
142 ZOOM_connection connection;
143 char **databaseNames;
144 int num_databaseNames;
147 struct WRBUF_shptr *record_wrbuf;
149 #if ZOOM_RESULT_LISTS
153 ZOOM_facet_field *facets;
158 struct facet_term_p {
163 struct ZOOM_facet_field_p {
166 struct facet_term_p *facet_terms;
169 struct ZOOM_scanset_p {
172 ZOOM_options options;
173 ZOOM_connection connection;
175 Z_ScanResponse *scan_response;
176 Z_SRW_scanResponse *srw_scan_response;
178 char **databaseNames;
179 int num_databaseNames;
182 struct ZOOM_package_p {
185 ZOOM_options options;
186 ZOOM_connection connection;
195 #define ZOOM_TASK_SEARCH 1
199 ZOOM_resultset resultset;
201 char *elementSetName;
203 int recv_search_fired;
205 #define ZOOM_TASK_RETRIEVE 2
208 ZOOM_resultset resultset;
211 char *elementSetName;
214 #define ZOOM_TASK_CONNECT 3
215 #define ZOOM_TASK_SCAN 4
219 #define ZOOM_TASK_PACKAGE 5
220 ZOOM_package package;
221 #define ZOOM_TASK_SORT 6
223 ZOOM_resultset resultset;
235 void ZOOM_options_addref (ZOOM_options opt);
237 void ZOOM_handle_Z3950_apdu(ZOOM_connection c, Z_APDU *apdu);
239 void ZOOM_set_dset_error(ZOOM_connection c, int error,
241 const char *addinfo, const char *addinfo2);
243 void ZOOM_set_error(ZOOM_connection c, int error, const char *addinfo);
245 ZOOM_Event ZOOM_Event_create(int kind);
246 void ZOOM_connection_put_event(ZOOM_connection c, ZOOM_Event event);
248 zoom_ret ZOOM_connection_Z3950_send_search(ZOOM_connection c);
249 zoom_ret send_Z3950_present(ZOOM_connection c);
250 zoom_ret ZOOM_connection_Z3950_send_scan(ZOOM_connection c);
251 zoom_ret ZOOM_send_buf(ZOOM_connection c);
252 zoom_ret send_Z3950_sort(ZOOM_connection c, ZOOM_resultset resultset);
253 char **ZOOM_connection_get_databases(ZOOM_connection con, ZOOM_options options,
255 zoom_ret ZOOM_connection_Z3950_send_init(ZOOM_connection c);
257 ZOOM_task ZOOM_connection_add_task(ZOOM_connection c, int which);
258 void ZOOM_connection_remove_task(ZOOM_connection c);
259 int ZOOM_test_reconnect(ZOOM_connection c);
261 ZOOM_record ZOOM_record_cache_lookup(ZOOM_resultset r, int pos,
263 const char *elementSetName,
265 void ZOOM_record_cache_add(ZOOM_resultset r, Z_NamePlusRecord *npr,
267 const char *syntax, const char *elementSetName,
269 Z_SRW_diagnostic *diag);
271 Z_Query *ZOOM_query_get_Z_Query(ZOOM_query s);
272 Z_SortKeySpecList *ZOOM_query_get_sortspec(ZOOM_query s);
273 const char *ZOOM_query_get_query_string(ZOOM_query s);
274 const char *ZOOM_query_get_sru11(ZOOM_query s);
276 int ZOOM_uri_to_code(const char *uri);
278 zoom_ret ZOOM_connection_srw_send_search(ZOOM_connection c);
279 zoom_ret ZOOM_connection_srw_send_scan(ZOOM_connection c);
281 int ZOOM_handle_sru(ZOOM_connection c, Z_HTTP_Response *hres,
282 zoom_ret *cret, char **addinfo);
284 void ZOOM_set_HTTP_error(ZOOM_connection c, int error,
285 const char *addinfo, const char *addinfo2);
287 ZOOM_Event ZOOM_connection_get_event(ZOOM_connection c);
288 void ZOOM_connection_remove_events(ZOOM_connection c);
289 void ZOOM_Event_destroy(ZOOM_Event event);
290 zoom_ret ZOOM_send_GDU(ZOOM_connection c, Z_GDU *gdu);
291 void ZOOM_handle_facet_list(ZOOM_resultset r, Z_FacetList *fl);
296 * c-file-style: "Stroustrup"
297 * indent-tabs-mode: nil
299 * vim: shiftwidth=4 tabstop=8 expandtab