Add eventstr()
[ZOOM-Perl-moved-to-github.git] / lib / Net / Z3950 / ZOOM.pm
index ea8cf10..6ff9b1a 100644 (file)
@@ -1,4 +1,4 @@
-# $Id: ZOOM.pm,v 1.9 2006-01-31 15:39:05 mike Exp $
+# $Id: ZOOM.pm,v 1.14 2006-04-07 07:48:42 mike Exp $
 
 package Net::Z3950::ZOOM; 
 
@@ -6,18 +6,19 @@ use 5.008;
 use strict;
 use warnings;
 
-our $VERSION = '1.02';
+our $VERSION = '1.05';
 
 require XSLoader;
 XSLoader::load('Net::Z3950::ZOOM', $VERSION);
 
-my($vs, $ss) = ("", "");
+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.  Some things may not work.
+running against only version $vs (sys-string '$ss').
+Some things may not work.
 __EOT__
 }
 
@@ -79,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<eventstr()>, 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 eventstr {
+    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.