eventstr() -> event_str()

[ZOOM-Perl-moved-to-github.git] / lib / Net / Z3950 / ZOOM.pm

diff --git a/lib/Net/Z3950/ZOOM.pm b/lib/Net/Z3950/ZOOM.pm
index 22818cd..175bbca 100644 (file)
--- a/lib/Net/Z3950/ZOOM.pm
+++ b/lib/Net/Z3950/ZOOM.pm
@@ -1,4 +1,4 @@
-# $Id: ZOOM.pm,v 1.3 2005-10-12 14:35:01 mike Exp $
+# $Id: ZOOM.pm,v 1.15 2006-04-07 11:03:35 mike Exp $
 
 package Net::Z3950::ZOOM; 
 
@@ -6,11 +6,21 @@ use 5.008;
 use strict;
 use warnings;
 
-our $VERSION = '0.01';
+our $VERSION = '1.05';
 
 require XSLoader;
 XSLoader::load('Net::Z3950::ZOOM', $VERSION);
 
+my($vs, $ss) = ("x" x 100, "x" x 100); # allocate space for these strings
+my $version = Net::Z3950::ZOOM::yaz_version($vs, $ss);
+if ($version < 0x02010B && ! -f "/tmp/ignore-ZOOM-YAZ-version-mismatch") {
+    warn <<__EOT__;
+*** WARNING!
+ZOOM-Perl requires at least version 2.0.11 of YAZ, but is currently
+running against only version $vs (sys-string '$ss').
+Some things may not work.
+__EOT__
+}
 
 # The only thing this module does is define the following constants,
 # which MUST BE KEPT SYNCHRONISED with the definitions in <yaz/zoom.h>
@@ -28,6 +38,8 @@ sub ERROR_TIMEOUT { 10007 }
 sub ERROR_UNSUPPORTED_PROTOCOL { 10008 }
 sub ERROR_UNSUPPORTED_QUERY { 10009 }
 sub ERROR_INVALID_QUERY { 10010 }
+sub ERROR_CQL_PARSE { 10011 }
+sub ERROR_CQL_TRANSFORM { 10012 }
 
 # Event types, as returned from connection_last_event()
 sub EVENT_NONE { 0 }
@@ -68,6 +80,40 @@ to document it.  If you really, really, really want to use it, then it
 pretty much follows the API described in the ZOOM-C documentation at
 http://www.indexdata.dk/yaz/doc/zoom.tkl
 
+The only additional (non-ZOOM-C) function provided by this module is
+C<event_str()>, which takes as its argument an event code such as
+C<Net::Z3950::ZOOM::EVENT_SEND_APDU>, and returns a corresponding
+short string.
+
+=cut
+
+sub event_str {
+    my($code) = @_;
+
+    if ($code == EVENT_NONE) {
+       return "none";
+    } elsif ($code == EVENT_CONNECT) {
+       return "connect";
+    } elsif ($code == EVENT_SEND_DATA) {
+       return "send data";
+    } elsif ($code == EVENT_RECV_DATA) {
+       return "receive data";
+    } elsif ($code == EVENT_TIMEOUT) {
+       return "timeout";
+    } elsif ($code == EVENT_UNKNOWN) {
+       return "unknown";
+    } elsif ($code == EVENT_SEND_APDU) {
+       return "send apdu";
+    } elsif ($code == EVENT_RECV_APDU) {
+       return "receive apdu";
+    } elsif ($code == EVENT_RECV_RECORD) {
+       return "receive record";
+    } elsif ($code == EVENT_RECV_SEARCH) {
+       return "receive search";
+    }
+    return "impossible event " . $code;
+}
+
 =head1 SEE ALSO
 
 The C<ZOOM> module, included in the same distribution as this one.