X-Git-Url: http://sru.miketaylor.org.uk/?a=blobdiff_plain;f=lib%2FNet%2FZ3950%2FZOOM.pm;h=175bbca690768c9a954289e1d89220766b0fb3cb;hb=53f80bb9976ef9e6bb4d632e61181ed19936b7d2;hp=56a678f6f06870fd90faf67dabdf5e615f6b22b8;hpb=7775c1094c9b0288b2208925f0250356441f6bfd;p=ZOOM-Perl-moved-to-github.git

diff --git a/lib/Net/Z3950/ZOOM.pm b/lib/Net/Z3950/ZOOM.pm
index 56a678f..175bbca 100644
--- a/lib/Net/Z3950/ZOOM.pm
+++ b/lib/Net/Z3950/ZOOM.pm
@@ -1,4 +1,4 @@
-# $Id: ZOOM.pm,v 1.11 2006-03-09 12:57:19 mike Exp $
+# $Id: ZOOM.pm,v 1.15 2006-04-07 11:03:35 mike Exp $
 
 package Net::Z3950::ZOOM; 
 
@@ -6,7 +6,7 @@ use 5.008;
 use strict;
 use warnings;
 
-our $VERSION = '1.03';
+our $VERSION = '1.05';
 
 require XSLoader;
 XSLoader::load('Net::Z3950::ZOOM', $VERSION);
@@ -80,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.