Connection::create() API
[ZOOM-Perl-moved-to-github.git] / Changes
1 $Id: Changes,v 1.43 2006-10-10 16:52:30 mike Exp $
2
3 Revision history for Perl extension Net::Z3950::ZOOM.
4
5 1.12  (IN PROGRESS)
6         - Include the useful example program samples/zoom/zselect,
7           which is installed as part of "make install".
8         - Add ZOOM_connection_is_idle() and $conn->is_idle().
9         - Require YAZ version 2.1.35, which is the first to provide
10           ZOOM_connection_is_idle().
11         - Fix bug in ZOOM::Connection class code that made the
12           difficult to subclass -- when called as
13           $class->SUPER::new(@_), the constructor blessed the new
14           object into ZOOM::Connection rather than info the subclass.
15         - ZOOM::Connection::create() may now take either a single
16           argument, which is a ZOOM::Options object, or any even
17           number of argument (including zero), which are key => value
18           pairs of options to set.
19
20 1.11  Thu Aug 31 16:47:53 BST 2006
21         - Require YAZ version 2.1.17, which has important ZOOM-C
22           bug-fixes.
23         - Do not use "-Wdeclaration-after-statement" compiler option,
24           since this supported only by GCC (and only recent versions).
25
26 1.10  Thu Jun 15 16:42:47 BST 2006
27         - No functional changes, but use Adam's modified API to
28           ZOOM_query_ccl2rpn().  This incompatible change means that
29           RELEASE 1.09 WILL NOT BUILD against any recent YAZ.
30
31 1.09  Tue Jun 13 17:44:43 2006
32         - Add new function Net::Z3950::ZOOM::query_ccl2rpn(), for
33           client-side CCL compilation.
34         - Add new ZOOM::Query::CCL2RPN class, encapsulating CCL
35           compiler functionality as a Query subclass.  This allows
36           client-side CCL to be used for both search and scan.
37         - Add two new error-codes, CCL_CONFIG and CCL_PARSE,
38           returned by the client-side CCL facilities.
39         - Supply a sample CCL profile file: samples/ccl/default.bib,
40           copied from the same-named file distributed with YAZ.
41         - The test-scripts t/12-query.t and t/22-query.t are extended
42           to also test client-side CCL searching.
43         - The test-scripts t/15-scan.t and t/25-scan.t are extended
44           to also test client-side CCL scanning.
45         - Documentation updated to describe use of CCL.
46         - Add a nice, simple update client: samples/zoom/update.pl
47
48 1.08  Thu May 11 22:40:41 BST 2006
49         - Requires version 2.1.11 of YAZ, not 2.0.11.  This is a
50           bugfix: the old reliance on 2.0.11 was merely a typo.
51
52 1.07  Thu May 11 17:45:37 BST 2006
53         - Makefile.PL checks for at least version 2.1.11 of YAZ, and
54           refuses to build if it's not present.  Thanks to "gregor"
55           (an otherwise anonymous CPAN tester) for notifying me of the
56           previously poor reporting of failure when running against an
57           earlier YAZ.
58         - No changes to functionality or documentation.
59
60 1.06  Wed Apr 19 21:11:52 BST 2006
61         - Avoid mixed statement/declaration in ZOOM.xs.  *sigh*  Why
62           the heck GCC allows this by default I will never understand.
63         - Add (commented out) OPTIMIZE option to Makefile.PL, to turn
64           on -Wdeclaration-after-statement, which makes mixed
65           statement/declaration illegal.
66
67 1.05  Wed Apr 12 13:31:27 BST 2006
68         - Implementation of asynchronous events!  The Net::Z3950::ZOOM
69           interface provides this through the event, last_event() and
70           event_str() functions.  The ZOOM interface provides it
71           through the ZOOM::event() and ZOOM:event_str() functions,
72           and the ZOOM::Connection class's last_event() function.
73         - New sample programs added illustrating both asynchronous
74           interfaces: samples/net-z3950-zoom/zoomtst3.pl and
75           samples/zoom/zoomtst3.pl respectively.  Additional sample
76           programs "async.pl" and "trivial-async.pl" for the ZOOM
77           interface only, the latter being a "shortest possible
78           broadcast search application".
79         - Added documentation on writing asynchronous applications.
80         - Added test-scripts "t/19-events.t" and "t/29-event.t" for
81           events on an asynchronous connection.
82         - Fix ZOOM::Connection::new so that options are handled in
83           accordance with the documentation: applied _before_ the
84           connection is forged, so that "async" and similar options
85           can take effect.
86
87 1.04  Mon Apr  3 14:56:11 BST 2006
88         - The ZOOM-Perl layer now provides access to the underlying
89           ZOOM-C's character-translation functionality, through new
90           optional arguments to ZOOM::Record's render() and raw()
91           methods, and a new underlying get() method.
92
93 1.03  Thu Mar  9 12:55:23 GMT 2006
94         - Allow additional key => value pairs as arguments to the
95           ZOOM::Connectoion constructor; these are added as Connection
96           options before the protocol connection is forged.
97
98 1.02  Thu Mar  9 11:36:55 GMT 2006
99         - Add interface to yaz_version().
100         - Emit big warning at startup time if YAZ version is less than
101           2.0.11 (which is what ZOOM-Perl 1.02 requires) unless the
102           file /tmp/ignore-ZOOM-YAZ-version-mismatch exists.
103         - Fix incorrect ZOOM-package URL in documentation.
104         - Fix typo ("createdb" package) in documentation.
105         - The ZOOM::Connection constructor may now be called with only
106           a single argument (host-string) and does not require a
107           dummy port-number argument.
108
109 1.01  Thu Dec 22 14:13:34 GMT 2005
110         - Place some CODE: chunks in "ZOOM.xs" inside curly brackets
111           so that the declarations they begin with are at the start of
112           the block.  This avoid mixed code/declarations.  (The
113           "correct" solution is to use INIT: clauses in the XS file,
114           but they don't seem to work: the code in them is slapped
115           down right next to the CODE:, so declarations are not
116           acceptable there either.)
117         - Add new function Net::Z3950::ZOOM::connection_scan1(), which
118           uses a query object to indicate the start-term.  This opens
119           the way for using CQL queries for scanning once the
120           underlying ZOOM-C code supports this.
121         - NOTE BACKWARDS-INCOMPATIBLE CHANGE: The ZOOM::Connection
122           method scan() is renamed scan_pqf(), and a new scan() method
123           is introduced which calls the underlying scan1() function.
124           Thus the scan()/scan_pqf() dichotomy is consistent with that
125           between search()/search_pqf().
126         - The tests t/15-scan.t and t/25-scan.t now also test for
127           scanning by CQL query.  To support these tests, a new files
128           is added to the distribution, "samples/cql/pqf.properties"
129         - Remove nonsensical clause about CQL sort-specifications from
130           the documentation.
131         - Add new function Net::Z3950::ZOOM::query_cql2rpn(), for
132           client-side CQL compilation.
133         - Add new ZOOM::Query::CQL2RPN class, encapsulating CQL
134           compiler functionality as a Query subclass.
135         - Add two new error-codes, CQL_PARSE and CQL_TRANSFORM,
136           returned by the client-side CQL facilities.
137         - The test-scripts t/12-query.t and t/22-query.t are extended
138           to also test client-side CQL compilation.
139         - Add all the yaz_log*() functions within the Net::Z3950::ZOOM
140           namespace. 
141         - Add new ZOOM::Log class for logging, providing aliases for
142           the functions in the Net::Z3950::ZOOM layer.
143         - Add diagnostic set to rendering of Exception objects.
144         - Documentation added for CQL compilation and logging.
145
146 1.00  Wed Dec 14 11:18:33 GMT 2005
147         - First distributed version.
148
149 0.01  Fri Oct  7 16:14:20 2005
150         - original version; created by h2xs 1.23 with options
151                 --name=Net::Z3950::ZOOM --compat-version=5.8.0 \
152                 --omit-constant --skip-exporter --skip-ppport \
153                 --autogen-xsubs yaz/zoom.h -lyaz -lxml2
154
155 --
156
157 To be done in future releases:
158         - Complete, test and document "update.pl"
159         - Fix Net::Z3950::ZOOM::record_get() to use a struct datachunk
160           _when_ appropriate, e.g. for "render" but probably not for
161           "database" and "syntax".
162         - Create old-style Net::Z3950 compatibility layer.
163         - Fix memory leaks in callback functions for option sets.
164         - Fix limitation that option-set callback functions must be
165           specified as strings containing package-qualified function
166           names.
167