Towards 1.05
[ZOOM-Perl-moved-to-github.git] / Changes
1 $Id: Changes,v 1.26 2006-04-11 16:27:58 mike Exp $
2
3 Revision history for Perl extension Net::Z3950::ZOOM.
4
5 1.05  [IN PROGRESS]
6         - Implementation of asynchronous events!  The Net::Z3950::ZOOM
7           interface provides this through the event, last_event() and
8           event_str() functions.  The ZOOM interface provides it
9           through the ZOOM::event() and ZOOM:event_str() functions,
10           and the ZOOM::Connection class's last_event() function.
11         - New sample programs added illustrating both asynchronous
12           interfaces: samples/net-z3950-zoom/zoomtst3.pl and
13           samples/zoom/zoomtst3.pl respectively.
14         - Added documentation on writing asynchronous applications.
15         - ### test-case for asynchronous operations.
16         - Fix ZOOM::Connection::new so that options are handled in
17           accordance with the documentation: applied _before_ the
18           connection is forged, so that "async" and similar options
19           can take effect.
20         - ### complete and test "update.pl"
21
22 1.04  Mon Apr  3 14:56:11 BST 2006
23         - The ZOOM-Perl layer now provides access to the underlying
24           ZOOM-C's character-translation functionality, through new
25           optional arguments to ZOOM::Record's render() and raw()
26           methods, and a new underlying get() method.
27
28 1.03  Thu Mar  9 12:55:23 GMT 2006
29         - Allow additional key => value pairs as arguments to the
30           ZOOM::Connectoion constructor; these are added as Connection
31           options before the protocol connection is forged.
32
33 1.02  Thu Mar  9 11:36:55 GMT 2006
34         - Add interface to yaz_version().
35         - Emit big warning at startup time if YAZ version is less than
36           2.0.11 (which is what ZOOM-Perl 1.02 requires) unless the
37           file /tmp/ignore-ZOOM-YAZ-version-mismatch exists.
38         - Fix incorrect ZOOM-package URL in documentation.
39         - Fix typo ("createdb" package) in documentation.
40         - The ZOOM::Connection constructor may now be called with only
41           a single argument (host-string) and does not require a
42           dummy port-number argument.
43
44 1.01  Thu Dec 22 14:13:34 GMT 2005
45         - Place some CODE: chunks in "ZOOM.xs" inside curly brackets
46           so that the declarations they begin with are at the start of
47           the block.  This avoid mixed code/declarations.  (The
48           "correct" solution is to use INIT: clauses in the XS file,
49           but they don't seem to work: the code in them is slapped
50           down right next to the CODE:, so declarations are not
51           acceptable there either.)
52         - Add new function Net::Z3950::ZOOM::connection_scan1(), which
53           uses a query object to indicate the start-term.  This opens
54           the way for using CQL queries for scanning once the
55           underlying ZOOM-C code supports this.
56         - NOTE BACKWARDS-INCOMPATIBLE CHANGE: The ZOOM::Connection
57           method scan() is renamed scan_pqf(), and a new scan() method
58           is introduced which calls the underlying scan1() function.
59           Thus the scan()/scan_pqf() dichotomy is consistent with that
60           between search()/search_pqf().
61         - The tests t/15-scan.t and t/25-scan.t now also test for
62           scanning by CQL query.  To support these tests, a new files
63           is added to the distribution, "samples/cql/pqf.properties"
64         - Remove nonsensical clause about CQL sort-specifications from
65           the documentation.
66         - Add new function Net::Z3950::ZOOM::query_cql2rpn(), for
67           client-side CQL compilation.
68         - Add new ZOOM::Query::CQL2RPN class, encapsulating CQL
69           compiler functionality as a Query subclass.
70         - Add two new error-codes, CQL_PARSE and CQL_TRANSFORM,
71           returned by the client-side CQL facilities.
72         - The test-scripts t/12-query.t and t/22-query.t are extended
73           to also test client-side CQL compilation.
74         - Add all the yaz_log*() functions within the Net::Z3950::ZOOM
75           namespace. 
76         - Add new ZOOM::Log class for logging, providing aliases for
77           the functions in the Net::Z3950::ZOOM layer.
78         - Add diagnostic set to rendering of Exception objects.
79         - Documentation added for CQL compilation and logging.
80
81 1.00  Wed Dec 14 11:18:33 GMT 2005
82         - First distributed version.
83
84 0.01  Fri Oct  7 16:14:20 2005
85         - original version; created by h2xs 1.23 with options
86                 --name=Net::Z3950::ZOOM --compat-version=5.8.0 \
87                 --omit-constant --skip-exporter --skip-ppport \
88                 --autogen-xsubs yaz/zoom.h -lyaz -lxml2
89
90 --
91
92 To be done in future releases:
93         - Fix Net::Z3950::ZOOM::record_get() to use a struct datachunk
94           _when_ appropriate, e.g. for "render" but probably not for
95           "database" and "syntax".
96         - Support for asynchronous multiplexing: implement
97           ZOOM::event() and test ZOOM::Connection::last_event().
98         - Write example programs for "samples" direction.
99         - Create old-style Net::Z3950 compatibility layer.
100         - Fix memory leaks in callback functions for option sets.
101         - Fix limitation that option-set callback functions must be
102           specified as strings containing package-qualified function
103           names.
104         - Fix test-suite to actually send the "drop" packages once
105           Zebra's been fixed so this doesn't current the store.
106