lib/Net/Z3950/ZOOM.pm

   1 # $Id: ZOOM.pm,v 1.24 2006-06-15 13:21:30 mike Exp $
   2
   3 package Net::Z3950::ZOOM;
   4
   5 use 5.008;
   6 use strict;
   7 use warnings;
   8
   9 our $VERSION = '1.10';
  10
  11 require XSLoader;
  12 XSLoader::load('Net::Z3950::ZOOM', $VERSION);
  13
  14 my($vs, $ss) = ("x" x 100, "x" x 100); # allocate space for these strings
  15 my $version = Net::Z3950::ZOOM::yaz_version($vs, $ss);
  16 if ($version < 0x020115 && ! -f "/tmp/ignore-ZOOM-YAZ-version-mismatch") {
  17     warn <<__EOT__;
  18 *** WARNING!
  19 ZOOM-Perl requires at least version 2.1.21 of YAZ, but is currently
  20 running against only version $vs (sys-string '$ss').
  21 Some things may not work.
  22 __EOT__
  23 }
  24
  25 # The only thing this module does is define the following constants,
  26 # which MUST BE KEPT SYNCHRONISED with the definitions in <yaz/zoom.h>
  27
  28 # Error codes, as returned from connection_error()
  29 sub ERROR_NONE { 0 }
  30 sub ERROR_CONNECT { 10000 }
  31 sub ERROR_MEMORY { 10001 }
  32 sub ERROR_ENCODE { 10002 }
  33 sub ERROR_DECODE { 10003 }
  34 sub ERROR_CONNECTION_LOST { 10004 }
  35 sub ERROR_INIT { 10005 }
  36 sub ERROR_INTERNAL { 10006 }
  37 sub ERROR_TIMEOUT { 10007 }
  38 sub ERROR_UNSUPPORTED_PROTOCOL { 10008 }
  39 sub ERROR_UNSUPPORTED_QUERY { 10009 }
  40 sub ERROR_INVALID_QUERY { 10010 }
  41 sub ERROR_CQL_PARSE { 10011 }
  42 sub ERROR_CQL_TRANSFORM { 10012 }
  43 sub ERROR_CCL_CONFIG { 10013 }
  44 sub ERROR_CCL_PARSE { 10014 }
  45
  46 # Event types, as returned from connection_last_event()
  47 sub EVENT_NONE { 0 }
  48 sub EVENT_CONNECT { 1 }
  49 sub EVENT_SEND_DATA { 2 }
  50 sub EVENT_RECV_DATA { 3 }
  51 sub EVENT_TIMEOUT { 4 }
  52 sub EVENT_UNKNOWN { 5 }
  53 sub EVENT_SEND_APDU { 6 }
  54 sub EVENT_RECV_APDU { 7 }
  55 sub EVENT_RECV_RECORD { 8 }
  56 sub EVENT_RECV_SEARCH { 9 }
  57 sub EVENT_END { 10 }            # In YAZ 2.1.17 and later
  58
  59
  60 =head1 NAME
  61
  62 Net::Z3950::ZOOM - Perl extension for invoking the ZOOM-C API.
  63
  64 =head1 SYNOPSIS
  65
  66  use Net::Z3950::ZOOM;
  67  $conn = Net::Z3950::ZOOM::connection_new($host, $port);
  68  $errcode = Net::Z3950::ZOOM::connection_error($conn, $errmsg, $addinfo);
  69  Net::Z3950::ZOOM::connection_option_set($conn, databaseName => "foo");
  70  # etc.
  71
  72 =head1 DESCRIPTION
  73
  74 This module provides a simple thin-layer through to the ZOOM-C
  75 functions in the YAZ toolkit for Z39.50 and SRW/U communication.  You
  76 should not be using this very nasty, low-level API.  You should be
  77 using the C<ZOOM> module instead, which implements a nice, Perlish API
  78 on top of this module, conformant to the ZOOM Abstract API described at
  79 http://zoom.z3950.org/api/
  80
  81 To enforce the don't-use-this-module prohibition, I am not even going
  82 to document it.  If you really, really, really want to use it, then it
  83 pretty much follows the API described in the ZOOM-C documentation at
  84 http://www.indexdata.dk/yaz/doc/zoom.tkl
  85
  86 The only additional (non-ZOOM-C) function provided by this module is
  87 C<event_str()>, which takes as its argument an event code such as
  88 C<Net::Z3950::ZOOM::EVENT_SEND_APDU>, and returns a corresponding
  89 short string.
  90
  91 =cut
  92
  93 sub event_str {
  94     my($code) = @_;
  95
  96     if ($code == EVENT_NONE) {
  97         return "none";
  98     } elsif ($code == EVENT_CONNECT) {
  99         return "connect";
 100     } elsif ($code == EVENT_SEND_DATA) {
 101         return "send data";
 102     } elsif ($code == EVENT_RECV_DATA) {
 103         return "receive data";
 104     } elsif ($code == EVENT_TIMEOUT) {
 105         return "timeout";
 106     } elsif ($code == EVENT_UNKNOWN) {
 107         return "unknown";
 108     } elsif ($code == EVENT_SEND_APDU) {
 109         return "send apdu";
 110     } elsif ($code == EVENT_RECV_APDU) {
 111         return "receive apdu";
 112     } elsif ($code == EVENT_RECV_RECORD) {
 113         return "receive record";
 114     } elsif ($code == EVENT_RECV_SEARCH) {
 115         return "receive search";
 116     } elsif ($code == EVENT_END) {
 117         return "end";
 118     }
 119     return "impossible event " . $code;
 120 }
 121
 122 =head1 SEE ALSO
 123
 124 The C<ZOOM> module, included in the same distribution as this one.
 125
 126 =head1 AUTHOR
 127
 128 Mike Taylor, E<lt>mike@indexdata.comE<gt>
 129
 130 =head1 COPYRIGHT AND LICENCE
 131
 132 Copyright (C) 2005 by Index Data.
 133
 134 This library is free software; you can redistribute it and/or modify
 135 it under the same terms as Perl itself, either Perl version 5.8.4 or,
 136 at your option, any later version of Perl 5 you may have available.
 137
 138 =cut
 139
 140 1;