2 * Copyright (C) 1995-2005, Index Data ApS
4 * Permission to use, copy, modify, distribute, and sell this software and
5 * its documentation, in whole or in part, for any purpose, is hereby granted,
8 * 1. This copyright and permission notice appear in all copies of the
9 * software and its documentation. Notices of copyright or attribution
10 * which appear at the beginning of any file must remain unchanged.
12 * 2. The name of Index Data or the individual authors may not be used to
13 * endorse or promote products derived from this software without specific
14 * prior written permission.
16 * THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT WARRANTY OF ANY KIND,
17 * EXPRESS, IMPLIED, OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY
18 * WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
19 * IN NO EVENT SHALL INDEX DATA BE LIABLE FOR ANY SPECIAL, INCIDENTAL,
20 * INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, OR ANY DAMAGES
21 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER OR
22 * NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF
23 * LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
26 * $Id: backend.h,v 1.34 2005-11-08 15:08:02 adam Exp $
31 * \brief Header for GFS
33 * This header includes all public definitions for the
34 * Generic Frontend Server (GFS).
40 #include <yaz/yconfig.h>
41 #include <yaz/proto.h>
46 typedef struct request *bend_request;
47 typedef struct association *bend_association;
49 /* extended search handler (rr = request response) */
51 char *setname; /* name to give to this set */
52 int replace_set; /* replace set, if it already exists */
53 int num_bases; /* number of databases in list */
54 char **basenames; /* databases to search */
55 Z_ReferenceId *referenceId;/* reference ID */
56 Z_Query *query; /* query structure */
57 ODR stream; /* encode stream */
58 ODR decode; /* decode stream */
59 ODR print; /* print stream */
62 bend_association association;
64 int hits; /* number of hits */
65 int errcode; /* 0==OK */
66 char *errstring; /* system error string or NULL */
67 Z_OtherInformation *search_info; /* additional search info */
68 char *srw_sortKeys; /* holds SRU/SRW sortKeys info */
69 char *srw_setname; /* holds SRU/SRW generated resultsetID */
70 int *srw_setnameIdleTime; /* holds SRU/SRW life-time */
73 /* extended present handler. Does not replace bend_fetch. */
75 char *setname; /* set name */
77 int number; /* record number */
78 oid_value format; /* One of the CLASS_RECSYN members */
79 Z_ReferenceId *referenceId;/* reference ID */
80 Z_RecordComposition *comp; /* Formatting instructions */
81 ODR stream; /* encoding stream - memory source if required */
82 ODR print; /* printing stream */
84 bend_association association;
86 int hits; /* number of hits */
87 int errcode; /* 0==OK */
88 char *errstring; /* system error string or NULL */
91 typedef struct bend_fetch_rr {
92 char *setname; /* set name */
93 int number; /* record number */
94 Z_ReferenceId *referenceId;/* reference ID */
95 oid_value request_format; /* One of the CLASS_RECSYN members */
96 int *request_format_raw; /* same as above (raw OID) */
97 Z_RecordComposition *comp; /* Formatting instructions */
98 ODR stream; /* encoding stream - memory source if req */
99 ODR print; /* printing stream */
101 char *basename; /* name of database that provided record */
102 int len; /* length of record or -1 if structured */
103 char *record; /* record */
104 int last_in_set; /* is it? */
105 oid_value output_format; /* format */
106 int *output_format_raw; /* used instead of above if not-null */
107 int errcode; /* 0==success */
108 char *errstring; /* system error string or NULL */
109 int surrogate_flag; /* surrogate diagnostic */
110 char *schema; /* string record schema input/output */
114 char *term; /* the returned scan term */
115 int occurrences; /* no of occurrences or -1 if error (see below) */
116 int errcode; /* Bib-1 diagnostic code; only used when occur.= -1 */
117 char *errstring; /* Additional string */
122 BEND_SCAN_SUCCESS, /* ok */
123 BEND_SCAN_PARTIAL /* not all entries could be found */
126 typedef struct bend_scan_rr {
127 int num_bases; /* number of elements in databaselist */
128 char **basenames; /* databases to search */
129 oid_value attributeset;
130 Z_ReferenceId *referenceId; /* reference ID */
131 Z_AttributesPlusTerm *term;
132 ODR stream; /* encoding stream - memory source if required */
133 ODR print; /* printing stream */
135 int *step_size; /* step size */
136 int term_position; /* desired index of term in result list/returned */
137 int num_entries; /* number of entries requested/returned */
139 /* scan term entries. The called handler does not have
140 to allocate this. Size of entries is num_entries (see above) */
141 struct scan_entry *entries;
142 bend_scan_status status;
145 char *scanClause; /* CQL scan clause */
148 typedef struct bend_update_rr {
149 int num_bases; /* number of elements in databaselist */
150 char **basenames; /* databases to search */
151 Z_ReferenceId *referenceId; /* reference ID */
152 ODR stream; /* encoding stream - memory source if required */
153 ODR print; /* printing stream */
155 char *operation_status;
157 char *record_version;
158 char *record_checksum;
159 char *record_old_version;
160 char *record_packing;
163 Z_SRW_extra_record *request_extra_record;
164 Z_SRW_extra_record *response_extra_record;
165 char *extra_request_data;
166 char *extra_response_data;
172 typedef struct bend_delete_rr {
176 Z_ReferenceId *referenceId;
177 int delete_status; /* status for the whole operation */
178 int *statuses; /* status each set - indexed as setnames */
184 typedef struct bend_sort_rr
186 int num_input_setnames;
187 char **input_setnames;
188 char *output_setname;
189 Z_SortKeySpecList *sort_sequence;
192 Z_ReferenceId *referenceId;/* reference ID */
199 typedef struct bend_esrequest_rr
202 Z_ExtendedServicesRequest *esr;
204 ODR stream; /* encoding stream */
205 ODR decode; /* decoding stream */
206 ODR print; /* printing stream */
207 Z_ReferenceId *referenceId;/* reference ID */
208 bend_request request;
209 bend_association association;
210 int errcode; /* 0==success, -1==accepted, >0 = failure */
211 char *errstring; /* system error string or NULL */
212 Z_TaskPackage *taskPackage;
215 typedef struct bend_segment_rr {
220 bend_request request;
221 bend_association association;
231 void *server_node_ptr;
234 typedef struct bend_initrequest
236 Z_IdAuthentication *auth;
237 ODR stream; /* encoding stream */
238 ODR print; /* printing stream */
239 Z_ReferenceId *referenceId;/* reference ID */
240 char *peer_name; /* dns host of peer (client) */
242 char *implementation_id;
243 char *implementation_name;
244 char *implementation_version;
245 int (*bend_sort) (void *handle, bend_sort_rr *rr);
246 int (*bend_search) (void *handle, bend_search_rr *rr);
247 int (*bend_fetch) (void *handle, bend_fetch_rr *rr);
248 int (*bend_present) (void *handle, bend_present_rr *rr);
249 int (*bend_esrequest) (void *handle, bend_esrequest_rr *rr);
250 int (*bend_delete)(void *handle, bend_delete_rr *rr);
251 int (*bend_scan)(void *handle, bend_scan_rr *rr);
252 int (*bend_segment)(void *handle, bend_segment_rr *rr);
254 ODR decode; /* decoding stream */
255 /* character set and language negotiation - see include/yaz/z-charneg.h */
256 Z_CharSetandLanguageNegotiation *charneg_request;
257 Z_External *charneg_response;
258 int (*bend_explain)(void *handle, bend_explain_rr *rr);
259 int (*bend_srw_scan)(void *handle, bend_scan_rr *rr);
260 int (*bend_srw_update)(void *handle, bend_update_rr *rr);
263 typedef struct bend_initresult
265 int errcode; /* 0==OK */
266 char *errstring; /* system error string or NULL */
267 void *handle; /* private handle to the backend module */
270 YAZ_EXPORT void bend_request_send (bend_association a, bend_request req,
273 YAZ_EXPORT bend_request bend_request_mk (bend_association a);
275 YAZ_EXPORT void bend_request_destroy (bend_request *req);
277 YAZ_EXPORT Z_ReferenceId *bend_request_getid (ODR odr, bend_request req);
278 YAZ_EXPORT int bend_backend_respond (bend_association a, bend_request req);
279 YAZ_EXPORT void bend_request_setdata(bend_request r, void *p);
280 YAZ_EXPORT void *bend_request_getdata(bend_request r);
282 typedef struct statserv_options_block
284 int dynamic; /* fork on incoming requests */
285 int threads; /* use threads */
286 int one_shot; /* one session then exit(1) */
287 int loglevel; /* desired logging-level */
288 char apdufile[ODR_MAXNAME+1]; /* file for pretty-printed PDUs */
289 char logfile[ODR_MAXNAME+1]; /* file for diagnostic output */
290 char default_listen[1024]; /* 0 == no default listen */
291 enum oid_proto default_proto; /* PROTO_SR or PROTO_Z3950 */
292 int idle_timeout; /* how many minutes to wait before closing */
293 int maxrecordsize; /* maximum value for negotiation */
294 char configname[ODR_MAXNAME+1]; /* given to the backend in bend_init */
295 char setuid[ODR_MAXNAME+1]; /* setuid to this user after binding */
296 void (*bend_start)(struct statserv_options_block *p);
297 void (*bend_stop)(struct statserv_options_block *p);
298 int (*options_func)(int argc, char **argv);
299 int (*check_ip)(void *cd, const char *addr, int len, int type);
300 char daemon_name[128];
301 int inetd; /* Do we use the inet deamon or not */
303 void *handle; /* Handle */
304 bend_initresult *(*bend_init)(bend_initrequest *r);
305 void (*bend_close)(void *handle);
307 /* We only have these members for the windows version */
308 /* They seemed a bit large to have them there in general */
309 char service_name[128]; /* NT Service Name */
310 char app_name[128]; /* Application Name */
311 char service_dependencies[128]; /* The services we are dependent on */
312 char service_display_name[128]; /* The service display name */
314 struct bend_soap_handler *soap_handlers;
315 char pid_fname[128]; /* pid fname */
316 int background; /* auto daemon */
317 char cert_fname[128]; /* SSL certificate fname */
318 char xml_config[128]; /* XML config filename */
319 } statserv_options_block;
321 YAZ_EXPORT int statserv_main(
322 int argc, char **argv,
323 bend_initresult *(*bend_init)(bend_initrequest *r),
324 void (*bend_close)(void *handle));
325 YAZ_EXPORT int statserv_start(int argc, char **argv);
326 YAZ_EXPORT void statserv_closedown(void);
327 YAZ_EXPORT statserv_options_block *statserv_getcontrol(void);
328 YAZ_EXPORT void statserv_setcontrol(statserv_options_block *block);
329 YAZ_EXPORT int check_ip_tcpd(void *cd, const char *addr, int len, int type);
338 * indent-tabs-mode: nil
340 * vim: shiftwidth=4 tabstop=8 expandtab