1 /* $Id: ZOOM.xs,v 1.13 2005-10-17 13:42:43 mike Exp $ */
9 /* Used by the *_setl() functions */
10 typedef char opaquechar;
12 /* Used as the return value of the *_getl() functions */
18 MODULE = Net::Z3950::ZOOM PACKAGE = Net::Z3950::ZOOM PREFIX=ZOOM_
25 ZOOM_connection_new(host, portnum)
31 ZOOM_connection_create(options)
36 ZOOM_connection_connect(c, host, portnum)
43 ZOOM_connection_destroy(c)
48 ZOOM_connection_option_get(c, key)
54 ZOOM_connection_option_getl(c, key, len)
59 RETVAL.data = (char*) ZOOM_connection_option_getl(c, key, &RETVAL.len);
65 ZOOM_connection_option_set(c, key, val)
70 # In ZOOM-C, the `val' parameter is const char*. However, our typemap
71 # treats this as T_PV, i.e. it's "known" that it points to a
72 # NUL-terminated string. Instead, then, I here use const void*, which
73 # is an opaque pointer. The underlying C function can then use this
74 # along with `len' to Do The Right Thing.
78 ZOOM_connection_option_setl(c, key, val, len)
84 # The reference parameters, `cp' and `addinfo', need to already have
85 # values when this function is called, otherwise an "uninitialised
86 # value" warning is generated. As far as I can see, there is no way
87 # around this: no way to specify in a prototype that an argument is
88 # allowed to be undefined, for example. Since these function will
89 # never be called directly by well-behaved client code, but only by
90 # our own wrapper classes, I think we can live with that.
92 # The poxing about with cpp and caddinfo is due to Perl XS's lack of
93 # support for const char**, but who can blame it? If you ask me, the
94 # whole "const" thing was well-intentioned by ghastly mistake.
98 ZOOM_connection_error(c, cp, addinfo)
103 const char *ccp, *caddinfo;
104 RETVAL = ZOOM_connection_error(c, &ccp, &caddinfo);
106 addinfo = (char*) caddinfo;
112 # See comments for ZOOM_connection_error() above
115 ZOOM_connection_error_x(c, cp, addinfo, diagset)
118 const char * &addinfo
119 const char * &diagset
121 const char *ccp, *caddinfo, *cdset;
122 RETVAL = ZOOM_connection_error_x(c, &ccp, &caddinfo, &cdset);
124 addinfo = (char*) caddinfo;
125 diagset = (char*) cdset;
134 ZOOM_connection_errcode(c)
139 ZOOM_connection_errmsg(c)
144 ZOOM_connection_addinfo(c)
154 ZOOM_connection_last_event(cs)
159 ZOOM_connection_search(arg0, q)
165 ZOOM_connection_search_pqf(c, q)
171 ZOOM_resultset_destroy(r)
176 ZOOM_resultset_option_get(r, key)
182 ZOOM_resultset_option_set(r, key, val)
189 ZOOM_resultset_size(r)
194 ZOOM_resultset_records(r, recs, start, count)
202 ZOOM_resultset_record(s, pos)
208 ZOOM_resultset_record_immediate(s, pos)
214 ZOOM_resultset_cache_reset(r)
217 # See "typemap" for discussion of the "const char *" return-type.
220 ### but should use datachunk
222 ZOOM_record_get(rec, type, len)
232 ZOOM_record_destroy(rec)
237 ZOOM_record_clone(srec)
246 ZOOM_query_destroy(s)
251 ZOOM_query_cql(s, str)
257 ZOOM_query_prefix(s, str)
263 ZOOM_query_sortby(s, criteria)
265 const char * criteria
269 ZOOM_connection_scan(c, startterm)
271 const char * startterm
275 ZOOM_scanset_term(scan, pos, occ, len)
283 ZOOM_scanset_display_term(scan, pos, occ, len)
291 ZOOM_scanset_size(scan)
296 ZOOM_scanset_destroy(scan)
301 ZOOM_scanset_option_get(scan, key)
307 ZOOM_scanset_option_set(scan, key, val)
314 ZOOM_connection_package(c, options)
320 ZOOM_package_destroy(p)
325 ZOOM_package_send(p, type)
331 ZOOM_package_option_get(p, key)
337 ZOOM_package_option_set(p, key, val)
344 ZOOM_resultset_sort(r, sort_type, sort_spec)
346 const char * sort_type
347 const char * sort_spec
350 ZOOM_options_callback
351 ZOOM_options_set_callback(opt, c, handle)
353 ZOOM_options_callback c
358 ZOOM_options_create()
362 ZOOM_options_create_with_parent(parent)
367 ZOOM_options_create_with_parent2(parent1, parent2)
373 ZOOM_options_get(opt, name)
379 ZOOM_options_getl(opt, name, len)
386 ZOOM_options_set(opt, name, v)
393 ZOOM_options_setl(opt, name, value, len)
401 ZOOM_options_destroy(opt)
406 ZOOM_options_get_bool(opt, name, defa)
413 ZOOM_options_get_int(opt, name, defa)
420 ZOOM_options_set_int(opt, name, value)