1 # $Id: ZOOM.pm,v 1.8 2005-10-19 13:53:35 mike Exp $
12 return Net::Z3950::ZOOM::diag_str($code);
16 # Member naming convention: hash-element names which begin with an
17 # underscore represent underlying ZOOM-C object descriptors; those
18 # which lack them represent Perl's ZOOM objects. (The same convention
19 # is used in naming local variables where appropriate.)
21 # So, for example, the ZOOM::Connection class has an {_conn} element,
22 # which is a pointer to the ZOOM-C Connection object; but the
23 # ZOOM::ResultSet class has a {conn} element, which is a reference to
24 # the Perl-level Connection object by which it was created. (It may
25 # be that we find we have no need for these references, but for now
28 # To get at the underlying ZOOM-C connection object of a result-set
29 # (if you ever needed to do such a thing, which you probably don't)
30 # you'd use $rs->{conn}->_conn().
32 # ----------------------------------------------------------------------------
34 # The "Error" package contains constants returned as error-codes.
36 sub NONE { Net::Z3950::ZOOM::ERROR_NONE }
37 sub CONNECT { Net::Z3950::ZOOM::ERROR_CONNECT }
38 sub MEMORY { Net::Z3950::ZOOM::ERROR_MEMORY }
39 sub ENCODE { Net::Z3950::ZOOM::ERROR_ENCODE }
40 sub DECODE { Net::Z3950::ZOOM::ERROR_DECODE }
41 sub CONNECTION_LOST { Net::Z3950::ZOOM::ERROR_CONNECTION_LOST }
42 sub INIT { Net::Z3950::ZOOM::ERROR_INIT }
43 sub INTERNAL { Net::Z3950::ZOOM::ERROR_INTERNAL }
44 sub TIMEOUT { Net::Z3950::ZOOM::ERROR_TIMEOUT }
45 sub UNSUPPORTED_PROTOCOL { Net::Z3950::ZOOM::ERROR_UNSUPPORTED_PROTOCOL }
46 sub UNSUPPORTED_QUERY { Net::Z3950::ZOOM::ERROR_UNSUPPORTED_QUERY }
47 sub INVALID_QUERY { Net::Z3950::ZOOM::ERROR_INVALID_QUERY }
49 # The "Event" package contains constants returned by last_event()
51 sub NONE { Net::Z3950::ZOOM::EVENT_NONE }
52 sub CONNECT { Net::Z3950::ZOOM::EVENT_CONNECT }
53 sub SEND_DATA { Net::Z3950::ZOOM::EVENT_SEND_DATA }
54 sub RECV_DATA { Net::Z3950::ZOOM::EVENT_RECV_DATA }
55 sub TIMEOUT { Net::Z3950::ZOOM::EVENT_TIMEOUT }
56 sub UNKNOWN { Net::Z3950::ZOOM::EVENT_UNKNOWN }
57 sub SEND_APDU { Net::Z3950::ZOOM::EVENT_SEND_APDU }
58 sub RECV_APDU { Net::Z3950::ZOOM::EVENT_RECV_APDU }
59 sub RECV_RECORD { Net::Z3950::ZOOM::EVENT_RECV_RECORD }
60 sub RECV_SEARCH { Net::Z3950::ZOOM::EVENT_RECV_SEARCH }
63 # ----------------------------------------------------------------------------
65 package ZOOM::Exception;
69 my($code, $message, $addinfo) = @_;
70 ### support diag-set, too
86 return $this->{message};
91 return $this->{addinfo};
95 # ----------------------------------------------------------------------------
97 package ZOOM::Options;
105 $opts = Net::Z3950::ZOOM::options_create();
107 $opts = Net::Z3950::ZOOM::options_create_with_parent($p1->_opts());
109 $opts = Net::Z3950::ZOOM::options_create_with_parent2($p1->_opts(),
112 die "can't make $class object with more than 2 parents";
123 my $_opts = $this->{_opts};
124 die "{_opts} undefined: has this Options block been destroy()ed?"
132 my($key, $value) = @_;
134 my $oldval = Net::Z3950::ZOOM::options_get($this->_opts(), $key);
135 Net::Z3950::ZOOM::options_set($this->_opts(), $key, $value)
143 my($key, $value) = @_;
146 my $oldval = Net::Z3950::ZOOM::options_getl($this->_opts(),
148 Net::Z3950::ZOOM::options_setl($this->_opts(), $key,
149 $value, length($value))
155 # This is a bit stupid, since the scalar values that Perl returns from
156 # option() can be used as a boolean; but it's just possible that some
157 # applications will rely on ZOOM_options_get_bool()'s idiosyncratic
158 # interpretation of what constitutes truth.
162 my($key, $default) = @_;
164 return Net::Z3950::ZOOM::options_get_bool($this->_opts(), $key, $default);
167 # .. and the next two are even more stupid
170 my($key, $default) = @_;
172 return Net::Z3950::ZOOM::options_get_int($this->_opts(), $key, $default);
177 my($key, $value) = @_;
179 Net::Z3950::ZOOM::options_set_int($this->_opts(), $key, $value);
185 Net::Z3950::ZOOM::options_destroy($this->_opts());
186 $this->{_opts} = undef;
190 # ----------------------------------------------------------------------------
192 package ZOOM::Connection;
196 my($host, $port) = @_;
198 my $_conn = Net::Z3950::ZOOM::connection_new($host, $port);
199 my($errcode, $errmsg, $addinfo) = (undef, "dummy", "dummy");
200 $errcode = Net::Z3950::ZOOM::connection_error($_conn, $errmsg, $addinfo);
201 die new ZOOM::Exception($errcode, $errmsg, $addinfo) if $errcode;
214 my $_conn = Net::Z3950::ZOOM::connection_create($options->_opts());
222 # PRIVATE within this class
226 my $_conn = $this->{_conn};
227 die "{_conn} undefined: has this ResultSet been destroy()ed?"
236 my($errcode, $errmsg, $addinfo, $diagset) = (undef, "dummy", "dummy", "d");
237 $errcode = Net::Z3950::ZOOM::connection_error_x($this->_conn(), $errmsg,
239 return ($errcode, $errmsg, $addinfo, $diagset);
244 return Net::Z3950::ZOOM::connection_errcode($this->_conn());
249 return Net::Z3950::ZOOM::connection_errmsg($this->_conn());
254 return Net::Z3950::ZOOM::connection_addinfo($this->_conn());
259 my($host, $port) = @_;
261 Net::Z3950::ZOOM::connection_connect($this->_conn(), $host, $port);
262 my($errcode, $errmsg, $addinfo) = (undef, "dummy", "dummy");
263 $errcode = Net::Z3950::ZOOM::connection_error($this->_conn(),
265 die new ZOOM::Exception($errcode, $errmsg, $addinfo) if $errcode;
271 my($key, $value) = @_;
273 my $oldval = Net::Z3950::ZOOM::connection_option_get($this->_conn(), $key);
274 Net::Z3950::ZOOM::connection_option_set($this->_conn(), $key, $value)
282 my($key, $value) = @_;
285 my $oldval = Net::Z3950::ZOOM::connection_option_getl($this->_conn(),
287 Net::Z3950::ZOOM::connection_option_setl($this->_conn(), $key,
288 $value, length($value))
299 my $_rs = Net::Z3950::ZOOM::connection_search_pqf($this->_conn(), $query);
300 my($errcode, $errmsg, $addinfo) = (undef, "dummy", "dummy");
301 $errcode = Net::Z3950::ZOOM::connection_error($this->_conn(),
303 die new ZOOM::Exception($errcode, $errmsg, $addinfo) if $errcode;
305 return _new ZOOM::ResultSet($this, $query, $_rs);
311 Net::Z3950::ZOOM::connection_destroy($this->_conn());
312 $this->{_conn} = undef;
316 # ----------------------------------------------------------------------------
318 package ZOOM::ResultSet;
322 die "You can't create $class objects directly";
325 # PRIVATE to ZOOM::Connection::search()
328 my($conn, $query, $_rs) = @_;
337 # PRIVATE within this class
341 my $_rs = $this->{_rs};
342 die "{_rs} undefined: has this ResultSet been destroy()ed?"
351 return Net::Z3950::ZOOM::resultset_size($this->_rs());
358 my $_rec = Net::Z3950::ZOOM::resultset_record($this->_rs(), $which);
359 ### Check for error -- but how?
361 # For some reason, I have to use the explicit "->" syntax in order
362 # to invoke the ZOOM::Record constructor here, even though I don't
363 # have to do the same for _new ZOOM::ResultSet above. Weird.
364 return ZOOM::Record->_new($this, $which, $_rec);
370 Net::Z3950::ZOOM::resultset_destroy($this->_rs());
371 $this->{_rs} = undef;
375 # ----------------------------------------------------------------------------
377 package ZOOM::Record;
381 die "You can't create $class objects directly";
384 # PRIVATE to ZOOM::ResultSet::record()
387 my($rs, $which, $_rec) = @_;
396 # PRIVATE within this class
400 return $this->{_rec};
407 my $string = Net::Z3950::ZOOM::record_get($this->_rec(), "render", $len);
408 # I don't think we need '$len' at all. ### Probably the Perl-to-C
409 # glue code should use the value of `len' as well as the opaque
410 # data-pointer returned, to ensure that the SV contains all of the
411 # returned data and does not stop at the first NUL character in
412 # binary data. Carefully check the ZOOM_record_get() documentation.
420 my $string = Net::Z3950::ZOOM::record_get($this->_rec(), "raw", $len);
421 # See comment about $len in render()