Update information about Windows installation YAZ-804
[yaz-moved-to-github.git] / doc / book.xml
1 <?xml version="1.0" standalone="no"?>
2 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
3     "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd"
4 [
5      <!ENTITY % local SYSTEM "local.ent">
6      %local;
7      <!ENTITY % entities SYSTEM "entities.ent">
8      %entities;
9      <!ENTITY % idcommon SYSTEM "common/common.ent">
10      %idcommon;
11 ]>
12 <book>
13  <bookinfo>
14   <title>YAZ User&apos;s Guide and Reference</title>
15   <authorgroup>
16    <author><firstname>Sebastian</firstname><surname>Hammer</surname></author>
17    <author><firstname>Adam</firstname><surname>Dickmeiss</surname></author>
18    <author><firstname>Mike</firstname><surname>Taylor</surname></author>
19    <author><firstname>Heikki</firstname><surname>Levanto</surname></author>
20    <author><firstname>Dennis</firstname><surname>Schafroth</surname></author>
21   </authorgroup>
22   <releaseinfo>&version;</releaseinfo>
23   <copyright>
24    <year>&copyright-year;</year>
25    <holder>Index Data</holder>
26   </copyright>
27   <abstract>
28    <simpara>
29     This document is the programmer's guide and reference to the &yaz;
30     package version &version;. &yaz; is a compact toolkit that provides
31     access to the Z39.50 and SRU/Solr protocols, as well as a set of
32     higher-level tools for implementing the server and client
33     roles, respectively.
34     The documentation can be used on its own, or as a reference when
35     looking at the example applications provided with the package.
36    </simpara>
37    <simpara>
38     <inlinemediaobject>
39      <imageobject>
40       <imagedata fileref="common/id.png" format="PNG"/>
41      </imageobject>
42      <imageobject>
43       <imagedata fileref="common/id.eps" format="EPS"/>
44      </imageobject>
45     </inlinemediaobject>
46    </simpara></abstract>
47  </bookinfo>
48  <chapter id="introduction">
49   <title>Introduction</title>
50   <para>
51    &yaz; is a C/C++ library for information retrieval applications
52    using the Z39.50/SRU/Solr protocols for information retrieval.
53   </para>
54   <para>
55    Properties of &yaz;:
56    <itemizedlist>
57     <listitem>
58      <para>
59       Complete
60       <ulink url="&url.z39.50;">Z39.50</ulink> version 3 support.
61       Amendments and Z39.50-2002 revision is supported.
62     </para>
63     </listitem>
64     <listitem>
65      <para>
66       Supports
67       <ulink url="&url.sru;">SRU GET/POST/SOAP</ulink>
68       version 1.1, 1.2 and 2.0 (over HTTP and HTTPS).
69     </para>
70     </listitem>
71     <listitem>
72      <para>
73       Includes BER encoders/decoders for the
74       <ulink url="&url.ill;">ISO ILL</ulink>
75       protocol.
76     </para>
77     </listitem>
78     <listitem>
79      <para>
80       Supports
81       <ulink url="&url.solr;">Solr</ulink> Web Service version 1.4.x
82       (client side only)
83      </para>
84     </listitem>
85     <listitem>
86      <para>
87       Supports the following transports: BER over TCP/IP
88       (<ulink url="&url.ber.over.tcpip;">RFC1729</ulink>),
89       BER over unix local socket, and
90       <ulink url="&url.http.1.1;">HTTP 1.1</ulink>.
91     </para>
92     </listitem>
93     <listitem>
94      <para>
95       Secure Socket Layer support using
96       <ulink url="&url.gnutls;">GnuTLS</ulink>.
97       If enabled, &yaz; uses HTTPS transport (for SOAP) or
98       "Secure BER" (for Z39.50).
99      </para>
100     </listitem>
101     <listitem>
102      <para>
103       Offers
104       <ulink url="&url.zoom;">ZOOM</ulink> C API implementing
105       Z39.50, SRU and Solr Web Service.
106     </para>
107     </listitem>
108     <listitem>
109      <para>
110       The &yaz; library offers a set of useful utilities
111       related to the protocols, such as MARC (ISO2709) parser,
112       CCL (ISO8777) parser,
113       <ulink url="&url.cql;">CQL</ulink>
114       parser, memory management routines, character set conversion.
115      </para>
116     </listitem>
117     <listitem>
118      <para>
119       Portable code. &yaz; compiles out-of-the box on most Unixes and
120       on Windows using Microsoft Visual C++.
121      </para>
122     </listitem>
123     <listitem>
124      <para>
125       Fast operation. The C based BER encoders/decoders as well
126       as the server component of &yaz; is very fast.
127     </para>
128     </listitem>
129     <listitem>
130      <para>
131       Liberal license that allows for commercial use of &yaz;.
132      </para>
133     </listitem>
134    </itemizedlist>
135   </para>
136
137   <sect1 id="introduction.reading">
138    <title>Reading this Manual</title>
139    <para>
140     Most implementors only need to read a fraction of the
141     material in thie manual, so a quick walkthrough of the chapters
142     is in order.
143    </para>
144    <itemizedlist>
145     <listitem>
146      <para>
147       <xref linkend="installation"/> contains installation
148       instructions for &yaz;. You don't need reading this
149       if you expect to download &yaz; binaries.
150       However, the chapter contains information about how
151       to make <emphasis>your</emphasis> application link
152       with &yaz;.
153      </para>
154     </listitem>
155     <listitem>
156      <para>
157       <xref linkend="zoom"/> describes the ZOOM API of &yaz;.
158       This is definitely worth a read if you wish to develop a Z39.50/SRU
159       client.
160      </para>
161     </listitem>
162     <listitem>
163      <para>
164       <xref linkend="server"/> describes the generic frontend server
165       and explains how to develop server Z39.50/SRU applications for &yaz;.
166       Obviously worth reading if you're to develop a server.
167     </para>
168     </listitem>
169     <listitem>
170      <para>
171       <xref linkend="yaz-client"/> describes how to use the &yaz; Z39.50
172       client. If you're developer and wish to test your server
173       or a server from another party, you might find this chapter
174       useful.
175     </para>
176     </listitem>
177     <listitem>
178      <para>
179       <xref linkend="asn"/> documents the most commonly used Z39.50
180       C data structures offered by the &yaz; API. Client
181       developers using ZOOM and non-Z39.50 implementors may skip this.
182      </para>
183     </listitem>
184     <listitem>
185      <para>
186       <xref linkend="soap"/> describes how SRU and SOAP is used
187       in &yaz;. Only if you're developing SRU applications
188       this section is a must.
189      </para>
190     </listitem>
191     <listitem>
192      <para>
193       <xref linkend="tools"/> contains sections for the various
194       tools offered by &yaz;. Scan through the material quickly
195       and see what's relevant to you! SRU implementors
196       might find the <link linkend="cql">CQL</link> section
197       particularly useful.
198      </para>
199     </listitem>
200     <listitem>
201      <para>
202       <xref linkend="odr"/> goes through the details of the
203       ODR module which is the work horse that encodes and decodes
204       BER packages. Implementors using ZOOM only, do <emphasis>not</emphasis>
205       need reading this.
206       Most other Z39.50 implementors only need to read the first two
207       sections (<xref linkend="odr.introduction"/> and
208       <xref linkend="odr.use"/>).
209      </para>
210     </listitem>
211     <listitem>
212      <para>
213       <xref linkend="comstack"/> describes the network layer module
214       COMSTACK. Implementors using ZOOM or the generic frontend server
215       may skip this. Others, presumably, handling client/server
216      communication on their own should read this.
217      </para>
218     </listitem>
219    </itemizedlist>
220   </sect1>
221   <sect1 id="introduction.api">
222    <title>The API</title>
223    <para>
224     The <ulink url="&url.yaz;">&yaz;</ulink>
225     toolkit offers several different levels of access to the
226     <ulink url="&url.z39.50;">ISO23950/Z39.50</ulink>,
227     <ulink url="&url.ill;">ILL</ulink> and
228     <ulink url="&url.sru;">SRU</ulink>
229     protocols.
230     The level that you need to use depends on your requirements, and
231     the role (server or client) that you want to implement.
232     If you're developing a client application you should consider the
233     <link linkend="zoom">ZOOM</link> API.
234     It is, by far, the easiest way to develop clients in C.
235     Server implementers should consider the
236     <link linkend="server">generic frontend server</link>.
237     None of those high-level APIs support the whole protocol, but
238     they do include most facilities used in existing Z39.50 applications.
239    </para>
240    <para>
241     If you're using 'exotic' functionality (meaning anything not included in
242     the high-level APIs), developing non-standard extensions to Z39.50 or
243     you're going to develop an ILL application you'll have to learn the lower
244     level APIs of &yaz;.
245    </para>
246    <para>
247     The YAZ toolkit modules is shown in figure <xref linkend="yaz.layer"/>.
248    </para>
249    <figure id="yaz.layer">
250     <title>YAZ layers</title>
251     <mediaobject>
252      <imageobject>
253       <imagedata fileref="apilayer.png" format="PNG"/>
254      </imageobject>
255      <imageobject>
256       <imagedata fileref="apilayer.eps" format="EPS"/>
257      </imageobject>
258     </mediaobject>
259    </figure>
260    <para>
261     There are four layers.
262     <itemizedlist>
263      <listitem>
264       <para>A client or server application (or both).
265        This layer includes ZOOM and the generic frontend server.
266       </para>
267      </listitem>
268      <listitem>
269       <para>
270        The second layer provides a C represenation of the
271        protocol units (packages) for Z39.50 ASN.1, ILL ASN.1,
272        SRU.
273       </para>
274      </listitem>
275      <listitem>
276       <para>
277        The third layer encodes and decodes protocol data units to
278        simple packages (buffer with certain length). The &odr; module
279        encodes and decodes BER whereas the HTTP modules encodes and
280        decodes HTTP ruquests/responses.
281       </para>
282      </listitem>
283      <listitem>
284       <para>
285        The lowest layer is &comstack; which exchanges the encoded packages
286        with a peer process over a network.
287       </para>
288      </listitem>
289     </itemizedlist>
290    </para>
291    <para>
292     The &asn; module represents the ASN.1 definition of
293     the Z39.50 protocol. It establishes a set of type and
294     structure definitions, with one structure for each of the top-level
295     PDUs, and one structure or type for each of the contained ASN.1 types.
296     For primitive types, or other types that are defined by the ASN.1
297     standard itself (such as the EXTERNAL type), the C representation is
298     provided by the &odr; (Open Data Representation) subsystem.
299   </para>
300    <para>
301      &odr; is a basic mechanism for representing an
302     ASN.1 type in the C programming language, and for implementing BER
303     encoders and decoders for values of that type. The types defined in
304     the &asn; module generally have the prefix <literal>Z_</literal>, and
305     a suffix corresponding to the name of the type in the ASN.1
306     specification of the protocol (generally Z39.50-1995). In the case of
307     base types (those originating in the ASN.1 standard itself), the prefix
308     <literal>Odr_</literal> is sometimes seen. Either way, look for
309     the actual definition in either <filename>z-core.h</filename> (for the types
310     from the protocol), <filename>odr.h</filename> (for the primitive ASN.1
311     types).
312     The &asn; library also provides functions (which are, in turn,
313     defined using &odr; primitives) for encoding and decoding data values.
314     Their general form is
315     <funcsynopsis>
316      <funcprototype><funcdef>int <function>z_<replaceable>xxx</replaceable></function></funcdef>
317       <paramdef>ODR <parameter>o</parameter></paramdef>
318       <paramdef>Z_<replaceable>xxx</replaceable> **<parameter>p</parameter></paramdef>
319       <paramdef>int <parameter>optional</parameter></paramdef>
320       <paramdef>const char *<parameter>name</parameter></paramdef>
321      </funcprototype>
322     </funcsynopsis>
323     (note the lower-case &quot;z&quot; in the function name)
324    </para>
325    <note>
326     <para>
327      If you are using the premade definitions of the &asn; module, and you
328      are not adding new protocol of your own, the only parts of &odr; that you
329      need to worry about are documented in
330      <xref linkend="odr.use"/>.
331     </para>
332    </note>
333    <para>
334     When you have created a BER-encoded buffer, you can use the &comstack;
335     subsystem to transmit (or receive) data over the network. The &comstack;
336     module provides simple functions for establishing a connection
337     (passively or actively, depending on the role of your application),
338     and for exchanging BER-encoded PDUs over that connection. When you
339     create a connection endpoint, you need to specify what transport to
340     use (TCP/IP, SSL or UNIX sockets).
341     For the remainder of the connection's lifetime, you don't have
342     to worry about the underlying transport protocol at all - the &comstack;
343     will ensure that the correct mechanism is used.
344    </para>
345    <para>
346     We call the combined interfaces to &odr;, &asn;, and &comstack; the service
347     level API. It's the API that most closely models the Z39.50
348     service/protocol definition, and it provides unlimited access to all
349     fields and facilities of the protocol definitions.
350    </para>
351    <para>
352     The reason that the &yaz; service-level API is a conglomerate of the
353     APIs from three different submodules is twofold. First, we wanted to allow
354     the user a choice of different options for each major task. For instance,
355     if you don't like the protocol API provided by &odr;/&asn;, you
356     can use SNACC or BERUtils instead, and still have the benefits of the
357     transparent transport approach of the &comstack; module. Secondly,
358     we realize that you may have to fit the toolkit into an existing
359     event-processing structure, in a way that is incompatible with
360     the &comstack; interface or some other part of &yaz;.
361    </para>
362   </sect1>
363  </chapter>
364  <chapter id="installation">
365   <title>Compilation and Installation</title>
366   <sect1 id="installation-introduction">
367    <title>Introduction</title>
368    <para>
369     The latest version of the software will generally be found at:
370    </para>
371    <para>
372     <ulink url="&url.yaz.download;"/>
373    </para>
374    <para>
375     We have tried our best to keep the software portable, and on many
376     platforms, you should be able to compile everything with little or
377     no changes.
378    </para>
379    <para>
380     The software is regularly tested on
381     <ulink url="&url.debian;">Debian GNU/Linux</ulink>,
382     <ulink url="&url.centos;">CentOS</ulink>,
383     <ulink url="&url.ubuntu;">Ubuntu Linux</ulink>,
384     <ulink url="&url.freebsd;">FreeBSD (i386)</ulink>,
385     <ulink url="&url.macosx;">MAC OSX</ulink>,
386     <ulink url="&url.solaris;">Solaris</ulink>,
387     Windows 7, Windows XP.
388    </para>
389    <para>
390     Some versions have be known to work on HP/UX,
391     DEC Unix, <ulink url="&url.netbsd;">NetBSD</ulink>,
392     <ulink url="&url.openbsd;">OpenBSD</ulink>,
393     IBM AIX,
394     Data General DG/UX (with some CFLAGS tinkering),
395     SGI/IRIX, DDE Supermax, Apple Macintosh (using the Codewarrior programming
396     environment and the GUSI socket libraries),
397     IBM AS/400 .
398    </para>
399    <para>
400     If you move the software to other platforms, we'd be grateful if you'd
401     let us know about it. If you run into difficulties, we will try to help
402     if we can, and if you solve the problems, we would be happy to include
403     your fixes in the next release. So far, we have mostly avoided
404     <literal>#ifdefs</literal> for individual platforms, and we'd
405     like to keep it that way as far as it makes sense.
406    </para>
407    <para>
408     We maintain a mailing-list for the purpose of announcing new releases and
409     bug-fixes, as well as general discussion. Subscribe by
410     filling-in the form
411     <ulink url="&url.yaz.mailinglist;">here</ulink>.
412     General questions and problems can be directed at
413     <ulink url="&url.yaz.mail;"/>, or the address given at the top of
414      this document.
415    </para>
416   </sect1>
417   <sect1 id="installation.unix"><title>UNIX</title>
418    <para>
419     We provide
420     <ulink url="&url.debian;">Debian GNU/Linux</ulink> (i386 and amd64),
421     <ulink url="&url.ubuntu;">Ubuntu</ulink> (i386 and amd64)
422     and
423     <ulink url="&url.centos;">CentOS</ulink> (amd64 only) packages for &yaz;.
424     You should be able to create packages for other CPUs by building
425     them from the source package.
426    </para>
427    <para>
428     YAZ is also part of several packages repositories. Some of them are
429    </para>
430    <itemizedlist>
431     <listitem>
432      <para>
433       Solaris CSW: <ulink url="http://www.opencsw.org/packages/yaz/"/>
434      </para>
435     </listitem>
436     <listitem>
437      <para>
438       Solaris: <ulink url="http://unixpackages.com"/>
439      </para>
440     </listitem>
441     <listitem>
442      <para>
443       FreeBSD: <ulink url="http://www.freshports.org/net/yaz"/>
444      </para>
445     </listitem>
446     <listitem>
447      <para>
448       Debian: <ulink url="http://packages.debian.org/search?keywords=yaz"/>
449      </para>
450     </listitem>
451     <listitem>
452      <para>
453       Ubuntu: <ulink url="https://launchpad.net/ubuntu/+source/yaz"/>
454      </para>
455     </listitem>
456     <listitem>
457      <para>
458       NetBSD:
459       <ulink url="http://ftp.netbsd.org/pub/pkgsrc/current/pkgsrc/net/yaz/README.html"/>
460      </para>
461     </listitem>
462    </itemizedlist>
463    <sect2 id="installation.source.unix">
464     <title>Compiling from source on Unix</title>
465     <para>
466      Note that if your system doesn't have a native ANSI C compiler, you may
467      have to acquire one separately. We recommend
468      <ulink url="&url.gcc;">GCC</ulink>.
469     </para>
470     <para>
471      If you wish to use character set conversion facilities in &yaz; or if you
472      are compiling &yaz; for use with Zebra it is a good idea to ensure that
473      the iconv library is installed. Some Unixes today already have it
474      - if not, we suggest
475      <ulink url="&url.libiconv;">GNU libiconv</ulink>.
476     </para>
477     <para>
478      YAZ 3.0.16 and later includes a wrapper for the
479      <ulink url="&url.icu;">ICU</ulink>
480      (International Components for Unicode).
481      In order to use this, the developer version of the ICU library
482      must be available. ICU support is recommended for applications
483      such as Pazpar2 and Zebra.
484     </para>
485     <para>
486      The <ulink url="&url.libxslt;">libxslt</ulink>,
487      <ulink url="&url.libxml2;">libxml2</ulink> librararies are required
488      if &yaz; is to support SRU/Solr.
489      These libraries are very portable and should compile out-of-the
490      box on virtually all Unix platforms. It is available in binary
491      forms for Linux and others.
492     </para>
493     <para>
494      The GNU tools
495      <ulink url="&url.autoconf;">Autoconf</ulink>,
496      <ulink url="&url.automake;">Automake</ulink> and
497      <ulink url="&url.libtool;">Libtool</ulink>
498      are used to generate Makefiles and configure &yaz; for the system.
499      You do <emphasis>not</emphasis> these tools unless you're using the
500      Git version of &yaz;.
501     </para>
502     <para>
503      The CQL parser for &yaz; is built using
504      GNU <ulink url="&url.bison;">Bison</ulink>.
505      This tool is only needed if you're using the Git version of &yaz;.
506     </para>
507     <para>
508      &yaz; includes a tiny ASN.1 compiler. This compiler is
509      written in <ulink url="&url.tcl;">Tcl</ulink>.
510      But as for Bison you do not need it unless you're using Git
511      version of &yaz; or you're using the compiler to built own codecs
512      for private ASN.1.
513     </para>
514     <para>
515      Generally it should be sufficient to run configure without options,
516      like this:
517     </para>
518     <screen>
519      ./configure
520     </screen>
521     <para>
522      The configure script attempts to use use the C compiler specified by
523      the <literal>CC</literal> environment variable. If not set, GNU C will be
524      used if it is available. The <literal>CFLAGS</literal> environment
525      variable holds options to be passed to the C compiler. If you're using
526      Bourne-compatible shell you may pass something like this to use a
527      particular C compiler with optimization enabled:
528     </para>
529     <screen>
530      CC=/opt/ccs/bin/cc CFLAGS=-O ./configure
531     </screen>
532     <para>
533      To customize &yaz;, the configure script also accepts a set of options.
534      The most important are:
535      <variablelist>
536       <varlistentry>
537        <term>
538         <literal>--prefix</literal>=<replaceable>prefix</replaceable>
539        </term>
540        <listitem>
541         <para>Specifies installation prefix for &yaz;. This is
542         only needed if you run <literal>make install</literal> later to
543         perform a "system" installation. The prefix is
544         <literal>/usr/local</literal> if not specified.
545         </para>
546        </listitem>
547       </varlistentry>
548       <varlistentry>
549        <term>
550         <literal>--enable-tcpd</literal>
551        </term>
552        <listitem>
553         <para>The front end server will be built using Wietse's
554         <ulink url="&url.tcpwrapper;">TCP wrapper library</ulink>.
555         It allows you to allow/deny clients depending on IP number.
556         The TCP wrapper library is often used in GNU/Linux and
557         BSD distributions.
558         See
559         <citerefentry>
560          <refentrytitle>hosts_access</refentrytitle>
561          <manvolnum>5</manvolnum>
562         </citerefentry>
563         and
564         <citerefentry>
565          <refentrytitle>tcpd</refentrytitle>
566          <manvolnum>8</manvolnum>
567          </citerefentry>.
568         </para>
569        </listitem>
570       </varlistentry>
571       <varlistentry>
572        <term>
573         <literal>--enable-threads</literal>
574        </term>
575        <listitem>
576         <para>&yaz; will be built using POSIX threads.
577         Specifically, <constant>_REENTRANT</constant> will be defined during
578         compilation.
579         </para>
580        </listitem>
581       </varlistentry>
582       <varlistentry>
583        <term>
584         <literal>--disable-shared</literal>
585        </term>
586        <listitem>
587         <para>The make process will not create shared
588         libraries (also known as shared objects <filename>.so</filename>).
589         By default, shared libraries are created -
590         equivalent to <literal>--enable-shared</literal>.
591        </para>
592        </listitem>
593       </varlistentry>
594       <varlistentry>
595        <term>
596         <literal>--disable-shared</literal>
597        </term>
598        <listitem>
599         <para>The make process will not create
600         static libraries (<filename>.a</filename>).
601         By default, static libraries are created -
602         equivalent to <literal>--enable-static</literal>.
603         </para>
604        </listitem>
605       </varlistentry>
606       <varlistentry>
607        <term>
608         <literal>--with-iconv</literal>[=<replaceable>prefix</replaceable>]
609        </term>
610        <listitem>
611         <para>Compile &yaz; with iconv library in directory
612         <replaceable>prefix</replaceable>. By default configure will
613         search for iconv on the system. Use this option if it
614         doesn't find iconv. Alternatively,
615         <literal>--without-iconv</literal>, can be uset to force &yaz;
616         not to use iconv.
617         </para>
618        </listitem>
619       </varlistentry>
620       <varlistentry>
621        <term>
622         <literal>--with-xslt</literal>[=<replaceable>prefix</replaceable>]
623        </term>
624        <listitem>
625         <para>Compile &yaz; with
626         <ulink url="&url.libxslt;">libxslt</ulink> in directory
627         <replaceable>prefix</replaceable>.
628         Use this option if you want XSLT and XML support.
629         By default, configure will
630         search for libxslt on the system. Use this option if it
631         libxslt is not found automatically. Alternatively,
632         <literal>--without-xslt</literal>, can be used to force &yaz;
633         not to use libxslt.
634         </para>
635        </listitem>
636       </varlistentry>
637       <varlistentry>
638        <term>
639         <literal>--with-xml2</literal>[=<replaceable>prefix</replaceable>]
640        </term>
641        <listitem>
642         <para>Compile &yaz; with
643         <ulink url="&url.libxml2;">libxml2</ulink> in directory
644         <replaceable>prefix</replaceable>.
645         Use this option if you want &yaz; to use XML and support SRU/Solr.
646         By default, configure will
647         search for libxml2 on the system. Use this option if it
648         libxml2 is not found automatically. Alternatively,
649         <literal>--without-xml2</literal>, can be used to force &yaz;
650         not to use libxml2.
651         </para>
652         <para>
653          Note that option <literal>--with-xslt</literal>
654          also enables libxml2.
655         </para>
656        </listitem>
657       </varlistentry>
658       <varlistentry>
659        <term>
660         <literal>--with-gnutls</literal>[=<replaceable>prefix</replaceable>]
661        </term>
662        <listitem>
663         <para>&yaz; will be linked with the GNU TLS libraries and
664         an SSL COMSTACK will be provided. By default configure enables
665         SSL support for YAZ if the GNU TLS development libraries are found
666         on the system.
667         </para>
668        </listitem>
669       </varlistentry>
670       <varlistentry>
671        <term>
672         <literal>--with-icu</literal>[=<replaceable>prefix</replaceable>]
673        </term>
674        <listitem>
675         <para>&yaz; will be linked the
676         <ulink url="&url.icu;">ICU</ulink> library in the prefix if given.
677         If prefix is not given, the libraries exposed by the script
678         <application>icu-config</application> will be used if found.
679         </para>
680        </listitem>
681       </varlistentry>
682
683       <varlistentry>
684        <term>
685         <literal>--with-libgcrypt</literal>[=<replaceable>prefix</replaceable>]
686        </term>
687        <listitem>
688         <para>&yaz; will be linked with
689         <ulink url="&url.libgcrypt;">Libgcrypt</ulink> in the prefix if given.
690         If prefix is not given, the libraries exposed by the script
691         <application>libgcrypt-config</application> will be used if found.
692         </para>
693        </listitem>
694       </varlistentry>
695       <varlistentry>
696        <term>
697         <literal>--with-memcached</literal>
698        </term>
699        <listitem>
700         <para>&yaz; will be linked with
701         <ulink url="&url.libmemcached;">libMemcached</ulink> to allow
702         for result-set caching for ZOOM.
703         The prefix can not be given. Note that YAZ will only search
704         for libMemcached if Libgcrypt is also enabled.
705         Note that 0.40 of libmemcached is required.
706        </para>
707        </listitem>
708       </varlistentry>
709       <varlistentry>
710        <term>
711         <literal>--with-redis</literal>
712        </term>
713        <listitem>
714         <para>&yaz; will be linked with the hiredis C library
715         to allow for result-set caching for ZOOM on a
716         <ulink url="&url.redis;">redis</ulink> server.
717         The prefix can not be given. Note that YAZ will only search
718         for hiredis if Libgcrypt is also enabled.
719        </para>
720        </listitem>
721       </varlistentry>
722
723      </variablelist>
724     </para>
725     <para>
726      When configured, build the software by typing:
727      <screen>
728       make
729      </screen>
730     </para>
731     <para>
732      The following files are generated by the make process:
733      <variablelist>
734       <varlistentry>
735        <term><filename>src/libyaz.la</filename></term>
736        <listitem><para>
737         Main &yaz; library. This is no ordinary library. It's
738         a Libtool archive.
739         By default, &yaz; creates a static library in
740         <filename>lib/.libs/libyaz.a</filename>.
741        </para></listitem>
742       </varlistentry>
743       <varlistentry>
744        <term><filename>src/libyaz_server.la</filename></term>
745        <listitem><para>
746          Generic Frontend server. This is an add-on for libyaz.la.
747          Code in this library uses POSIX threads functions - if POSIX
748          threads are available on the platform.
749         </para></listitem>
750       </varlistentry>
751       <varlistentry>
752        <term><filename>src/libyaz_icu.la</filename></term>
753        <listitem><para>
754         Functions that wrap the ICU library.
755         </para></listitem>
756       </varlistentry>
757       <varlistentry>
758        <term><filename>ztest/yaz-ztest</filename></term>
759        <listitem><para>Test Z39.50 server.
760        </para></listitem>
761       </varlistentry>
762       <varlistentry>
763        <term><filename>client/yaz-client</filename></term>
764        <listitem><para>Z39.50 client for testing the protocol.
765        See chapter <link linkend="yaz-client">
766        YAZ client</link> for more information.
767        </para></listitem>
768       </varlistentry>
769       <varlistentry>
770        <term><filename>util/yaz-config</filename></term>
771        <listitem><para>A Bourne-shell script, generated by configure, that
772        specifies how external applications should compile - and link with
773        &yaz;.
774        </para></listitem>
775       </varlistentry>
776       <varlistentry>
777        <term><filename>util/yaz-asncomp</filename></term>
778        <listitem><para>The ASN.1 compiler for &yaz;. Requires the
779        Tcl Shell, <application>tclsh</application>, in
780        <literal>PATH</literal> to operate.
781        </para></listitem>
782       </varlistentry>
783       <varlistentry>
784        <term><filename>util/yaz-iconv</filename></term>
785        <listitem><para>This program converts data in one character set to
786        another. This command exercises the YAZ character set
787        conversion API.
788        </para></listitem>
789       </varlistentry>
790       <varlistentry>
791        <term><filename>util/yaz-marcdump</filename></term>
792        <listitem><para>This program parses ISO2709 encoded MARC records
793        and prints them in line-format or XML.
794        </para></listitem>
795       </varlistentry>
796       <varlistentry>
797        <term><filename>util/yaz-icu</filename></term>
798        <listitem><para>This program exposes the ICU wrapper library if that
799        is enabled for YAZ. Only if ICU is available this program is
800        useful.
801        </para></listitem>
802       </varlistentry>
803       <varlistentry>
804        <term><filename>util/yaz-url</filename></term>
805        <listitem><para>This program is a simple HTTP page fetcher ala
806        wget or curl.
807        </para></listitem>
808       </varlistentry>
809       <varlistentry>
810        <term><filename>zoom/zoomsh</filename></term>
811        <listitem><para>
812         A simple shell implemented on top of the
813         <link linkend="zoom">ZOOM</link> functions.
814         The shell is a command line application that allows you to enter
815         simple commands to perform ZOOM operations.
816        </para></listitem>
817       </varlistentry>
818       <varlistentry>
819        <term><filename>zoom/zoomtst1</filename>,
820        <filename>zoom/zoomtst2</filename>, ..</term>
821        <listitem><para>
822         Several small applications that demonstrates the ZOOM API.
823        </para></listitem>
824       </varlistentry>
825      </variablelist>
826     </para>
827     <para>
828      If you wish to install &yaz; in system directories
829      <filename>/usr/local/bin</filename>,
830      <filename>/usr/local/lib</filename> .. etc, you can type:
831     </para>
832     <screen>
833      make install
834     </screen>
835     <para>
836      You probably need to have root access in order to perform this.
837      You must specify the <literal>--prefix</literal> option for configure if
838      you wish to install &yaz; in other directories than the default
839      <filename>/usr/local/</filename>.
840     </para>
841     <para>
842      If you wish to perform an un-installation of &yaz;, use:
843     </para>
844     <screen>
845      make uninstall
846     </screen>
847     <para>
848      This will only work if you haven't reconfigured &yaz; (and therefore
849      changed installation prefix). Note that uninstall will not
850      remove directories created by make install, e.g.
851      <filename>/usr/local/include/yaz</filename>.
852     </para>
853    </sect2>
854    <sect2 id="installation-linking-yaz-unix">
855     <title>How to make apps using YAZ on UNIX</title>
856     <para>
857      This section describes how to compile - and link your own
858      applications using the &yaz; toolkit.
859      If you're used to Makefiles this shouldn't be hard. As for
860      other libraries you have used before, you have to set a proper include
861      path for your C/C++ compiler and specify the location of
862      &yaz; libraries. You can do it by hand, but generally we suggest
863      you use the <filename>yaz-config</filename> that is generated
864      by <filename>configure</filename>. This is especially
865      important if you're using the threaded version of &yaz; which
866      require you to pass more options to your linker/compiler.
867     </para>
868     <para>
869      The <filename>yaz-config</filename> script accepts command line
870      options that makes the <filename>yaz-config</filename> script print
871      options that you should use in your make process.
872      The most important ones are:
873      <literal>--cflags</literal>, <literal>--libs</literal>
874      which prints C compiler flags, and linker flags respectively.
875     </para>
876     <para>
877      A small and complete <literal>Makefile</literal> for a C
878      application consisting of one source file,
879      <filename>myprog.c</filename>, may look like this:
880      <screen>
881       YAZCONFIG=/usr/local/bin/yaz-config
882       CFLAGS=`$(YAZCONFIG) --cflags`
883       LIBS=`$(YAZCONFIG) --libs`
884       myprog: myprog.o
885          $(CC) $(CFLAGS) -o myprog myprog.o $(LIBS)
886       </screen>
887     </para>
888     <para>
889      The CFLAGS variable consists of a C compiler directive that will set
890      the include path to the <emphasis>parent</emphasis> directory
891      of <filename>yaz</filename>. That is, if &yaz; header files were
892      installed in <filename>/usr/local/include/yaz</filename>,
893      then include path is set to <filename>/usr/local/include</filename>.
894      Therefore, in your applications you should use
895      <screen>
896       #include &lt;yaz/proto.h>
897      </screen>
898      and <emphasis>not</emphasis>
899      <screen>
900       #include &lt;proto.h>
901      </screen>
902     </para>
903     <para>
904      For Libtool users, the <filename>yaz-config</filename> script provides
905      a different variant of option <literal>--libs</literal>, called
906      <literal>--lalibs</literal> that returns the name of the
907      Libtool archive(s) for &yaz; rather than the ordinary ones.
908     </para>
909     <para>
910      For applications using the threaded version of &yaz;,
911      specify <literal>threads</literal> after the
912      other options. When <literal>threads</literal> is given,
913      more flags and linker flags will be printed by
914      <filename>yaz-config</filename>. If our previous example was
915       using threads, you'd have to modify the lines that set
916      <literal>CFLAGS</literal> and <literal>LIBS</literal> as
917      follows:
918      <screen>
919       CFLAGS=`$(YAZCONFIG) --cflags threads`
920       LIBS=`$(YAZCONFIG) --libs threads`
921      </screen>
922      There is no need specify POSIX thread libraries in your Makefile.
923      The <literal>LIBS</literal> variable includes that as well.
924     </para>
925    </sect2>
926   </sect1>
927   <sect1 id="installation.win32">
928    <title>WIN32</title>
929    <para>The easiest way to install YAZ on Windows is by downloading
930    an installer from
931    <ulink url="&url.yaz.download.win32;">here</ulink>.
932    The installer comes with source too - in case you wish to
933    compile YAZ with different compiler options, etc.
934    </para>
935
936    <sect2 id="installation.win32.source">
937     <title>Compiling from Source on WIN32</title>
938     <para>
939      &yaz; is shipped with "makefiles" for the NMAKE tool that comes
940      with <ulink url="&url.vstudio;">
941      Microsoft Visual Studio</ulink>. It has been tested with
942      Microsoft Visual Studio 2003/2005/2008.
943     </para>
944     <para>
945      Start a command prompt and switch the sub directory
946      <filename>WIN</filename> where the file <filename>makefile</filename>
947      is located. Customize the installation by editing the
948      <filename>makefile</filename> file (for example by using notepad).
949      The following summarizes the most important settings in that file:
950      <variablelist>
951       <varlistentry>
952        <term><literal>DEBUG</literal></term>
953        <listitem><para>
954         If set to 1, the software is
955         compiled with debugging libraries (code generation is
956         multi-threaded debug DLL).
957         If set to 0, the software is compiled with release libraries
958         (code generation is multi-threaded DLL).
959        </para></listitem>
960       </varlistentry>
961       <varlistentry>
962        <term><literal>HAVE_TCL</literal>, <literal>TCL</literal></term>
963        <listitem><para>
964         If <literal>HAVE_TCL</literal> is set to 1, nmake will
965         use the ASN.1 compiler (<ulink url="&url.tcl;">Tcl</ulink> based).
966         You must set <literal>TCL</literal> to the full path of the Tcl
967         interpreter. A Windows version of Tcl is part of
968         <ulink url="&url.gitwindows;">Git for Windows</ulink>.
969        </para>
970        <para>
971         If you do not have Tcl installed, set
972         <literal>HAVE_TCL</literal> to 0.
973        </para></listitem>
974       </varlistentry>
975       <varlistentry>
976        <term><literal>HAVE_BISON</literal>,
977        <literal>BISON</literal></term>
978        <listitem><para>
979         If GNU Bison is present, you might set <literal>HAVE_BISON</literal>
980         to 1 and specify the Bison executable in <literal>BISON</literal>.
981         Bison is only required if you use the Git version of
982         YAZ or if you modify the grammar for CQL
983         (<filename>cql.y</filename>).
984        </para>
985        <para>
986         A Windows version of GNU Bison is part of
987         <ulink url="&url.gitwindows;">Git for Windows</ulink>.
988        </para></listitem>
989       </varlistentry>
990       <varlistentry>
991        <term><literal>HAVE_ICONV</literal>,
992        <literal>ICONV_DIR</literal></term>
993        <listitem><para>
994         If <literal>HAVE_ICONV</literal> is set to 1, YAZ is compiled
995         with iconv support. In this configuration, set
996         <literal>ICONV_DIR</literal> to the iconv source directory.
997        </para></listitem>
998       </varlistentry>
999       <varlistentry>
1000        <term><literal>HAVE_LIBXML2</literal>,
1001        <literal>LIBXML2_DIR</literal></term>
1002        <listitem>
1003         <para>
1004          If <literal>HAVE_LIBXML2</literal> is set to 1, YAZ is compiled
1005          with SRU support. In this configuration, set
1006          <literal>LIBXML2_DIR</literal> to the
1007          <ulink url="&url.libxml2;">libxml2</ulink> source directory.
1008         </para>
1009         <para>
1010          Refer to <xref linkend="installation.win32.libxml2"/>.
1011         </para>
1012        </listitem>
1013       </varlistentry>
1014       <varlistentry>
1015        <term><literal>HAVE_LIBXSLT</literal>,
1016        <literal>LIBXSLT_DIR</literal></term>
1017        <listitem>
1018         <para>
1019          If <literal>HAVE_LIBXSLT</literal> is set to 1, YAZ is compiled
1020          with XSLT support. In this configuration, set
1021          <literal>LIBXSLT_DIR</literal> to the
1022          <ulink url="&url.libxslt;">libxslt</ulink> source directory.
1023         </para>
1024         <note>
1025          <para>
1026           libxslt depends libxml2.
1027          </para>
1028         </note>
1029        </listitem>
1030       </varlistentry>
1031       <varlistentry>
1032        <term><literal>HAVE_ICU</literal>,
1033        <literal>ICU_DIR</literal></term>
1034        <listitem>
1035         <para>
1036          If <literal>HAVE_ICU</literal> is set to 1, YAZ is compiled
1037          with <ulink url="&url.icu;">ICU</ulink> support.
1038          In this configuration, set
1039          <literal>ICU_DIR</literal> to the
1040          <ulink url="&url.icu;">ICU</ulink> source directory.
1041         </para>
1042        </listitem>
1043       </varlistentry>
1044      </variablelist>
1045     </para>
1046     <para>
1047      When satisfied with the settings in the makefile, type
1048      <screen>
1049       nmake
1050      </screen>
1051     </para>
1052     <note>
1053      <para>
1054       If the <filename>nmake</filename> command is not found on your system
1055       you probably haven't defined the environment variables required to
1056       use that tool. To fix that, find and run the batch file
1057       <filename>vcvars32.bat</filename>. You need to run it from within
1058       the command prompt or set the environment variables "globally";
1059       otherwise it doesn't work.
1060      </para>
1061     </note>
1062     <para>
1063      If you wish to recompile &yaz; - for example if you modify
1064      settings in the <filename>makefile</filename> you can delete
1065      object files, etc by running.
1066      <screen>
1067       nmake clean
1068      </screen>
1069     </para>
1070     <para>
1071      The following files are generated upon successful compilation:
1072      <variablelist>
1073       <varlistentry>
1074        <term><filename>bin/yaz&soversion;.dll</filename> /
1075        <filename>bin/yaz&soversion;d.dll</filename></term>
1076        <listitem><para>
1077         &yaz; Release/Debug DLL.
1078        </para></listitem>
1079       </varlistentry>
1080       <varlistentry>
1081        <term><filename>lib/yaz&soversion;.lib</filename> /
1082        <filename>lib/yaz&soversion;d.lib</filename></term>
1083        <listitem><para>
1084         Import library for <filename>yaz&soversion;.dll</filename> /
1085         <filename>yaz&soversion;d.dll</filename>.
1086       </para></listitem>
1087       </varlistentry>
1088       <varlistentry>
1089        <term><filename>bin/yaz_cond&soversion;.dll</filename> /
1090        <filename>bin/yaz_cond&soversion;d.dll</filename></term>
1091        <listitem><para>
1092         Release/Debug DLL for condition variable utilities (condvar.c).
1093        </para></listitem>
1094       </varlistentry>
1095       <varlistentry>
1096        <term><filename>lib/yaz_cond&soversion;.lib</filename> /
1097        <filename>lib/yaz_cond&soversion;d.lib</filename></term>
1098        <listitem><para>
1099         Import library for <filename>yaz_cond&soversion;.dll</filename> /
1100         <filename>yaz_cond&soversion;d.dll</filename>.
1101        </para></listitem>
1102       </varlistentry>
1103       <varlistentry>
1104        <term><filename>bin/yaz_icu&soversion;.dll</filename> /
1105        <filename>bin/yaz_icu&soversion;d.dll</filename></term>
1106        <listitem><para>
1107         Release/Debug DLL for the ICU wrapper utility.
1108         Only build if HAVE_ICU is 1.
1109        </para></listitem>
1110       </varlistentry>
1111       <varlistentry>
1112        <term><filename>lib/yaz_icu&soversion;.lib</filename> /
1113        <filename>lib/yaz_icu&soversion;d.lib</filename></term>
1114        <listitem><para>
1115         Import library for <filename>yaz_icu&soversion;.dll</filename> /
1116         <filename>yaz_icu&soversion;d.dll</filename>.
1117        </para></listitem>
1118       </varlistentry>
1119       <varlistentry>
1120        <term><filename>bin/yaz-ztest.exe</filename></term>
1121        <listitem><para>
1122         Z39.50 multi-threaded test/example server. It's a WIN32
1123         console application.
1124       </para></listitem>
1125       </varlistentry>
1126       <varlistentry>
1127        <term><filename>bin/yaz-client.exe</filename></term>
1128        <listitem><para>
1129         &yaz; Z39.50 client application. It's a WIN32 console application.
1130         See chapter <link linkend="yaz-client">YAZ client</link> for more
1131         information.
1132       </para></listitem>
1133       </varlistentry>
1134       <varlistentry>
1135        <term><filename>bin/yaz-icu.exe</filename></term>
1136        <listitem><para>This program exposes the ICU wrapper library if that
1137        is enabled for YAZ. Only if ICU is available this program is
1138        build.
1139       </para></listitem>
1140       </varlistentry>
1141       <varlistentry>
1142        <term><filename>bin/zoomsh.exe</filename></term>
1143        <listitem><para>
1144         Simple console application implemented on top of the
1145         <link linkend="zoom">ZOOM</link> functions.
1146         The application is a command line shell that allows you to enter
1147         simple commands to perform ZOOM operations.
1148       </para></listitem>
1149       </varlistentry>
1150       <varlistentry>
1151        <term><filename>bin/zoomtst1.exe</filename>,
1152        <filename>bin/zoomtst2.exe</filename>, ..</term>
1153        <listitem><para>
1154         Several small applications that demonstrates the ZOOM API.
1155       </para></listitem>
1156       </varlistentry>
1157      </variablelist>
1158     </para>
1159    </sect2>
1160
1161    <sect2 id="installation-linking-yaz-win32">
1162     <title>How to make apps using YAZ on Windows</title>
1163     <para>
1164      This section will go though the process of linking your Windows
1165      applications with &yaz;.
1166     </para>
1167     <para>
1168      Some people are confused by the fact that we use the nmake
1169      tool to build &yaz;. They think they have to do that too - in order
1170      to make their Windows applications work with &yaz;. The good news is that
1171      you don't have to. You can use the integrated environment of
1172      Visual Studio if desired for your own application.
1173     </para>
1174     <para>
1175      When setting up a project or Makefile you have to set the following:
1176      <variablelist>
1177       <varlistentry>
1178        <term>include path</term>
1179        <listitem><para>
1180         Set it to the <filename>include</filename> directory of &yaz;.
1181         </para></listitem>
1182       </varlistentry>
1183       <varlistentry>
1184        <term>import library <filename>yaz&soversion;.lib</filename></term>
1185        <listitem><para>
1186         You must link with this library. It's located in the
1187         sub directory <filename>lib</filename> of &yaz;.
1188         If you want to link with the debug version of &yaz;, you must
1189         link against <filename>yaz&soversion;d.lib</filename> instead.
1190        </para></listitem>
1191       </varlistentry>
1192       <varlistentry>
1193        <term>dynamic link library
1194        <filename>yaz&soversion;.dll</filename>
1195        </term>
1196        <listitem><para>
1197         This DLL must be in your execution path when you invoke
1198         your application. Specifically, you should distribute this
1199         DLL with your application.
1200        </para></listitem>
1201       </varlistentry>
1202      </variablelist>
1203     </para>
1204    </sect2>
1205
1206    <sect2 id="installation.win32.libxml2">
1207     <title>Compiling Libxml2 and Libxslt on windows</title>
1208     <para>
1209      Download libxml2 and Libxslt source and unpack it.
1210      In the example below we install  Libxml2 2.9.2 and Libxslt 1.1.28
1211      for 32-bit, so we  use the destination directories
1212      libxml2.2.9.2.win32 and libxslt-1.1.28.win32 to reflect both
1213      version and architecture.
1214      <screen>
1215       cd win32
1216       cscript configure.js prefix=c:\libxml2-2.9.2.win32 iconv=no
1217       nmake
1218       nmake install
1219      </screen>
1220     </para>
1221     <para>
1222      For Libxslt it is similar. We must ensure that compilation of
1223      Libxslt links against the already installed libxml2.
1224      <screen>
1225       cd win32
1226       cscript configure.js prefix=c:\libxslt-1.1.28.win32 iconv=no \
1227           lib=c:\libxmlt-2.9.2.win32\lib \
1228           include=c:\libxmlt-2.9.2.win32\include\libxml2
1229       nmake
1230       nmake install
1231      </screen>
1232     </para>
1233    </sect2>
1234
1235   </sect1>
1236  </chapter>
1237  <!--
1238      ### Still to document:
1239      ZOOM_connection_errcode(c)
1240      ZOOM_connection_errmsg(c)
1241      ZOOM_connection_addinfo(c)
1242      ZOOM_connection_addinfo(c)
1243      ZOOM_connection_diagset(c);
1244      ZOOM_connection_save_apdu_wrbuf
1245      ZOOM_diag_str(error)
1246      ZOOM_resultset_record_immediate(s, pos)
1247      ZOOM_resultset_cache_reset(r)
1248      ZOOM_options_set_callback(opt, function, handle)
1249      ZOOM_options_create_with_parent2(parent1, parent2)
1250      ZOOM_options_getl(opt, name, len)
1251      ZOOM_options_setl(opt, name, value, len)
1252      ZOOM_options_get_bool(opt, name, defa)
1253      ZOOM_options_get_int(opt, name, defa)
1254      ZOOM_options_set_int(opt, name, value)
1255  -->
1256  <chapter id="zoom">
1257   <title>ZOOM</title>
1258   <para>
1259    &zoom; is an acronym for 'Z39.50 Object-Orientation Model' and is
1260    an initiative started by Mike Taylor (Mike is from the UK, which
1261    explains the peculiar name of the model). The goal of &zoom; is to
1262    provide a common Z39.50 client API not bound to a particular
1263    programming language or toolkit.
1264   </para>
1265   <para>
1266    From YAZ version 2.1.12, <ulink url="&url.sru;">SRU</ulink> is supported.
1267    You can make SRU ZOOM connections by specifying scheme
1268    <literal>http://</literal> for the hostname for a connection.
1269    The dialect of SRU used is specified by the value of the
1270    connection's <literal>sru</literal> option, which may be SRU over
1271    HTTP GET (<literal>get</literal>),
1272    SRU over HTTP POST (<literal>post</literal>), (SRU over
1273    SOAP) (<literal>soap</literal>) or <literal>solr</literal>
1274    (<ulink url="&url.solr;">Solr</ulink> Web Service).
1275    Using the facility for embedding options in target strings, a
1276    connection can be forced to use SRU rather the SRW (the default) by
1277    prefixing the target string with <literal>sru=get,</literal>, like this:
1278    <literal>sru=get,http://sru.miketaylor.org.uk:80/sru.pl</literal>
1279   </para>
1280   <para>
1281    <ulink url="&url.solr;">Solr</ulink>  protocol support was added to
1282    YAZ in version 4.1.0, as a dialect of a SRU protocol, since both are
1283    HTTP based protocols.
1284   </para>
1285   <para>
1286    The lack of a simple Z39.50 client API for &yaz; has become more
1287    and more apparent over time. So when the first &zoom; specification
1288    became available,
1289    an implementation for &yaz; was quickly developed. For the first time, it is
1290    now as easy (or easier!) to develop clients than servers with &yaz;. This
1291    chapter describes the &zoom; C binding. Before going further, please
1292    reconsider whether C is the right programming language for the job.
1293    There are other language bindings available for &yaz;, and still
1294    more
1295    are in active development. See the
1296    <ulink url="&url.zoom;">ZOOM web-site</ulink> for
1297    more information.
1298   </para>
1299   <para>
1300    In order to fully understand this chapter you should read and
1301    try the example programs <literal>zoomtst1.c</literal>,
1302    <literal>zoomtst2.c</literal>, .. in the <literal>zoom</literal>
1303    directory.
1304   </para>
1305   <para>
1306    The C language misses features found in object oriented languages
1307    such as C++, Java, etc. For example, you'll have to manually,
1308    destroy all objects you create, even though you may think of them as
1309    temporary. Most objects has a <literal>_create</literal> - and a
1310    <literal>_destroy</literal> variant.
1311    All objects are in fact pointers to internal stuff, but you don't see
1312    that because of typedefs. All destroy methods should gracefully ignore a
1313    <literal>NULL</literal> pointer.
1314   </para>
1315   <para>
1316    In each of the sections below you'll find a sub section called
1317    protocol behavior, that describes how the API maps to the Z39.50
1318    protocol.
1319   </para>
1320   <sect1 id="zoom-connections">
1321    <title>Connections</title>
1322    <para>The Connection object is a session with a target.
1323    </para>
1324    <synopsis>
1325     #include &lt;yaz/zoom.h>
1326
1327     ZOOM_connection ZOOM_connection_new(const char *host, int portnum);
1328
1329     ZOOM_connection ZOOM_connection_create(ZOOM_options options);
1330
1331     void ZOOM_connection_connect(ZOOM_connection c, const char *host,
1332                                  int portnum);
1333     void ZOOM_connection_destroy(ZOOM_connection c);
1334    </synopsis>
1335    <para>
1336     Connection objects are created with either function
1337     <function>ZOOM_connection_new</function> or
1338     <function>ZOOM_connection_create</function>.
1339     The former creates and automatically attempts to establish a network
1340     connection with the target. The latter doesn't establish
1341     a connection immediately, thus allowing you to specify options
1342     before establishing network connection using the function
1343     <function>ZOOM_connection_connect</function>.
1344     If the port number, <literal>portnum</literal>, is zero, the
1345     <literal>host</literal> is consulted for a port specification.
1346     If no port is given, 210 is used. A colon denotes the beginning of
1347     a port number in the host string. If the host string includes a
1348     slash, the following part specifies a database for the connection.
1349    </para>
1350    <para>
1351     You can prefix the host with a scheme followed by colon. The
1352     default scheme is <literal>tcp</literal> (Z39.50 protocol).
1353     The scheme <literal>http</literal> selects SRU/get over HTTP by default,
1354     but can overridded to use SRU/post, SRW and the Solr protocol.
1355    </para>
1356    <para>
1357     You can prefix the scheme-qualified host-string with one or more
1358     comma-separated
1359     <literal><parameter>key</parameter>=<parameter>value</parameter></literal>
1360     sequences, each of which represents an option to be set into the
1361     connection structure <emphasis>before</emphasis> the
1362     protocol-level connection is forged and the initialization
1363     handshake takes place.  This facility can be used to provide
1364     authentication credentials, as in host-strings such as:
1365     <literal>user=admin,password=halfAm4n,tcp:localhost:8017/db</literal>
1366    </para>
1367    <para>
1368     Connection objects should be destroyed using the function
1369     <function>ZOOM_connection_destroy</function>.
1370    </para>
1371    <synopsis>
1372     void ZOOM_connection_option_set(ZOOM_connection c,
1373                                     const char *key, const char *val);
1374
1375     void ZOOM_connection_option_setl(ZOOM_connection c,
1376                                      const char *key,
1377                                      const char *val, int len);
1378
1379     const char *ZOOM_connection_option_get(ZOOM_connection c,
1380                                            const char *key);
1381     const char *ZOOM_connection_option_getl(ZOOM_connection c,
1382                                             const char *key,
1383                                             int *lenp);
1384    </synopsis>
1385    <para>
1386     The functions <function>ZOOM_connection_option_set</function> and
1387     <function>ZOOM_connection_option_setl</function> allows you to
1388     set an option given by <parameter>key</parameter> to the value
1389     <parameter>value</parameter> for the connection.
1390     For <function>ZOOM_connection_option_set</function>, the
1391     value is assumed to be a 0-terminated string. Function
1392     <function>ZOOM_connection_option_setl</function> specifies a
1393     value of a certain size (len).
1394    </para>
1395    <para>
1396     Functions <function>ZOOM_connection_option_get</function> and
1397     <function>ZOOM_connection_option_getl</function> returns
1398     the value for an option given by <parameter>key</parameter>.
1399    </para>
1400    <table id="zoom-connection-options" frame="top">
1401     <title>ZOOM Connection Options</title>
1402     <tgroup cols="3">
1403      <colspec colwidth="4*" colname="name"></colspec>
1404      <colspec colwidth="7*" colname="description"></colspec>
1405      <colspec colwidth="3*" colname="default"></colspec>
1406      <thead>
1407       <row>
1408        <entry>Option</entry>
1409        <entry>Description</entry>
1410        <entry>Default</entry>
1411       </row>
1412      </thead>
1413      <tbody>
1414       <row><entry>
1415        implementationName</entry><entry>Name of Your client
1416       </entry><entry>none</entry></row>
1417       <row><entry>
1418        user</entry><entry>Authentication user name
1419       </entry><entry>none</entry></row>
1420       <row><entry>
1421        group</entry><entry>Authentication group name
1422       </entry><entry>none</entry></row>
1423       <row><entry>
1424        password</entry><entry>Authentication password.
1425       </entry><entry>none</entry></row>
1426       <row><entry>
1427        authenticationMode</entry><entry>How authentication is encoded.
1428       </entry><entry>basic</entry></row>
1429       <row><entry>
1430        host</entry><entry>Target host. This setting is "read-only".
1431        It's automatically set internally when connecting to a target.
1432       </entry><entry>none</entry></row>
1433       <row><entry>
1434        proxy</entry><entry>Proxy host. If set, the logical host
1435        is encoded in the otherInfo area of the Z39.50 Init PDU
1436        with OID 1.2.840.10003.10.1000.81.1.
1437       </entry><entry>none</entry></row>
1438       <row><entry>
1439        clientIP</entry><entry>Client IP. If set, is
1440        encoded in the otherInfo area of a Z39.50 PDU with OID
1441        1.2.840.10003.10.1000.81.3. Holds the original IP addreses
1442        of a client. Is used of ZOOM is used in a gateway of some sort.
1443       </entry><entry>none</entry></row>
1444       <row><entry>
1445        async</entry><entry>If true (1) the connection operates in
1446        asynchronous operation which means that all calls are non-blocking
1447        except
1448        <link linkend="zoom.events"><function>ZOOM_event</function></link>.
1449       </entry><entry>0</entry></row>
1450       <row><entry>
1451        maximumRecordSize</entry><entry> Maximum size of single record.
1452       </entry><entry>1 MB</entry></row>
1453       <row><entry>
1454        preferredMessageSize</entry><entry> Maximum size of multiple records.
1455       </entry><entry>1 MB</entry></row>
1456       <row><entry>
1457        lang</entry><entry> Language for negotiation.
1458       </entry><entry>none</entry></row>
1459       <row><entry>
1460        charset</entry><entry> Character set for negotiation.
1461       </entry><entry>none</entry></row>
1462       <row><entry>
1463        serverImplementationId</entry><entry>
1464        Implementation ID of server.  (The old targetImplementationId
1465        option is also supported for the benefit of old applications.)
1466       </entry><entry>none</entry></row>
1467       <row><entry>
1468        targetImplementationName</entry><entry>
1469        Implementation Name of server.  (The old
1470        targetImplementationName option is also supported for the
1471        benefit of old applications.)
1472       </entry><entry>none</entry></row>
1473       <row><entry>
1474        serverImplementationVersion</entry><entry>
1475        Implementation Version of server.  (the old
1476        targetImplementationVersion option is also supported for the
1477        benefit of old applications.)
1478       </entry><entry>none</entry></row>
1479       <row><entry>
1480        databaseName</entry><entry>One or more database names
1481        separated by character plus (<literal>+</literal>), which to
1482        be used by subsequent search requests on this Connection.
1483       </entry><entry>Default</entry></row>
1484       <row><entry>
1485        piggyback</entry><entry>True (1) if piggyback should be
1486        used in searches; false (0) if not.
1487       </entry><entry>1</entry></row>
1488       <row><entry>
1489        smallSetUpperBound</entry><entry>If hits is less than or equal to this
1490        value, then target will return all records using small element set name
1491       </entry><entry>0</entry></row>
1492       <row><entry>
1493        largeSetLowerBound</entry><entry>If hits is greater than this
1494        value, the target will return no records.
1495       </entry><entry>1</entry></row>
1496       <row><entry>
1497        mediumSetPresentNumber</entry><entry>This value represents
1498        the number of records to be returned as part of a search when when
1499        hits is less than or equal to large set lower bound and if hits
1500        is greater than small set upper bound.
1501       </entry><entry>0</entry></row>
1502       <row><entry>
1503        smallSetElementSetName</entry><entry>
1504        The element set name to be used for small result sets.
1505       </entry><entry>none</entry></row>
1506       <row><entry>
1507        mediumSetElementSetName</entry><entry>
1508        The element set name to be for medium-sized result sets.
1509       </entry><entry>none</entry></row>
1510       <row><entry>
1511        init_opt_search, init_opt_present, init_opt_delSet, etc.</entry><entry>
1512        After a successful Init, these options may be interrogated to
1513        discover whether the server claims to support the specified
1514        operations.
1515       </entry><entry>none</entry></row>
1516       <row>
1517        <entry>sru</entry><entry>
1518        SRU/Solr transport type. Must be either <literal>soap</literal>,
1519        <literal>get</literal>, <literal>post</literal>, or
1520        <literal>solr</literal>.
1521       </entry><entry>soap</entry></row>
1522       <row><entry>
1523        sru_version</entry><entry>
1524        SRU/SRW version. Should be <literal>1.1</literal>, or
1525        <literal>1.2</literal>. This is , prior to connect, the version
1526        to offer (highest version). And following connect (in fact
1527        first operation), holds the negotiated version with the server
1528        (same or lower version).
1529       </entry><entry>1.2</entry></row>
1530       <row id="zoom.facets.option"><entry>
1531        facets</entry><entry>
1532        Requested or recommend facets may be given before a search is sent.
1533        The value of this setting is described in <xref linkend="facets"/>
1534        For inspection of the facets returned, refer to the functions
1535        described in <xref linkend="zoom.facets"/>.
1536       </entry><entry>none</entry></row>
1537       <row><entry>
1538        apdulog</entry><entry>
1539        If set to a true value such as "1", a log of low-level
1540        protocol packets is emitted on standard error stream.  This
1541        can be very useful for debugging.
1542       </entry><entry>0</entry></row>
1543       <row><entry>
1544        saveAPDU</entry><entry>
1545        If set to a true value such as "1", a log of low-level
1546        protocol packets is saved. The log can be retrieved by reading
1547        option APDU. Setting saveAPDU always has the side effect of
1548        resetting the currently saved log. This setting is
1549        <emphasis>write-only</emphasis>. If read, NULL will be returned.
1550        It is only recognized in
1551        <function>ZOOM_connection_option_set</function>.
1552       </entry><entry>0</entry></row>
1553       <row><entry>
1554        APDU</entry><entry>
1555        Returns the log of protocol packets. Will be empty if logging
1556        is not enabled (see saveAPDU above). This setting is
1557        <emphasis>read-only</emphasis>. It is only recognized if used
1558        in call to <function>ZOOM_connection_option_get</function> or
1559        <function>ZOOM_connection_option_getl</function>.
1560       </entry><entry></entry></row>
1561       <row><entry>
1562        memcached</entry><entry>
1563        If given and non-empty,
1564        <ulink url="&url.libmemcached;">libMemcached</ulink>
1565        will be configured for the connection.
1566        This option is inspected by ZOOM when a connection is established.
1567        If the <literal>memcached</literal> option is given
1568        and YAZ is compiled without libMemcached support, an internal
1569        diagnostic (10018) will be thrown.
1570        libMemcached support is available for YAZ 5.0.13 or later. If this
1571        option is supplied for an earlier version of YAZ, it is
1572        <emphasis>ignored</emphasis>.
1573        The value of this option is a list options - each is of the
1574        form <literal>--name=value</literal>.
1575        Option <literal>--server=</literal>host[:port] specifies a memcached
1576        server. It may be repeated for multiple memcached servers.
1577        Option <literal>--expire=</literal>seconds sets expiry time in seconds
1578        for how long result sets are to be cached.
1579       </entry><entry>none</entry></row>
1580       <row><entry>
1581        redis</entry><entry>
1582        If given and non-empty,
1583        a <ulink url="&url.redis;">redis</ulink> context will be created
1584        for the connection.
1585        This option is inspected by ZOOM when a connection is established.
1586        If the <literal>redis</literal> option is given
1587        and YAZ is compiled without redis support, an internal
1588        diagnostic (10018) will be thrown.
1589        redis support is available for YAZ 5.2.0 or later. If this
1590        option is supplied for an earlier version of YAZ, it is
1591        <emphasis>ignored</emphasis>.
1592        The value of this option is a set options, similar to that
1593        of the memcached setting. At this stage only --server=host[:port]
1594        and --expire=seconds is supported.
1595       </entry><entry>none</entry></row>
1596      </tbody>
1597     </tgroup>
1598    </table>
1599    <para>
1600     If either option <literal>lang</literal> or <literal>charset</literal>
1601     is set, then
1602     <ulink url="&url.z39.50.charneg;">
1603      Character Set and Language Negotiation</ulink> is in effect.
1604    </para>
1605    <synopsis>
1606      int ZOOM_connection_error(ZOOM_connection c, const char **cp,
1607                                const char **addinfo);
1608      int ZOOM_connection_error_x(ZOOM_connection c, const char **cp,
1609                                  const char **addinfo, const char **dset);
1610    </synopsis>
1611    <para>
1612     Function <function>ZOOM_connection_error</function> checks for
1613     errors for the last operation(s) performed. The function returns
1614     zero if no errors occurred; non-zero otherwise indicating the error.
1615     Pointers <parameter>cp</parameter> and <parameter>addinfo</parameter>
1616     holds messages for the error and additional-info if passed as
1617     non-<literal>NULL</literal>. Function
1618     <function>ZOOM_connection_error_x</function> is an extended version
1619     of <function>ZOOM_connection_error</function> that is capable of
1620     returning name of diagnostic set in <parameter>dset</parameter>.
1621    </para>
1622    <sect2 id="zoom-connection-z39.50">
1623     <title>Z39.50 Protocol behavior</title>
1624     <para>
1625      The calls <function>ZOOM_connection_new</function> and
1626      <function>ZOOM_connection_connect</function> establishes a TCP/IP
1627      connection and sends an Initialize Request to the target if
1628      possible. In addition, the calls waits for an Initialize Response
1629      from the target and the result is inspected (OK or rejected).
1630     </para>
1631     <para>
1632      If <literal>proxy</literal> is set then the client will establish
1633      a TCP/IP connection with the peer as specified by the
1634      <literal>proxy</literal> host and the hostname as part of the
1635      connect calls will be set as part of the Initialize Request.
1636      The proxy server will then "forward" the PDU's transparently
1637      to the target behind the proxy.
1638     </para>
1639     <para>
1640      For the authentication parameters, if option <literal>user</literal>
1641      is set and both options <literal>group</literal> and
1642      <literal>pass</literal> are unset, then Open style
1643      authentication is used (Version 2/3) in which case the username
1644      is usually followed by a slash, then by a password.
1645      If either <literal>group</literal>
1646      or <literal>pass</literal> is set then idPass authentication
1647      (Version 3 only) is used. If none of the options are set, no
1648      authentication parameters are set as part of the Initialize Request
1649      (obviously).
1650     </para>
1651     <para>
1652      When option <literal>async</literal> is 1, it really means that
1653      all network operations are postponed (and queued) until the
1654      function <literal>ZOOM_event</literal> is invoked. When doing so
1655      it doesn't make sense to check for errors after
1656      <literal>ZOOM_connection_new</literal> is called since that
1657      operation "connecting - and init" is still incomplete and the
1658      API cannot tell the outcome (yet).
1659     </para>
1660     </sect2>
1661    <sect2 id="zoom.sru.init.behavior">
1662     <title>SRU/Solr Protocol behavior</title>
1663     <para>
1664      The HTTP based protocols (SRU, SRW, Solr) doesn't feature an
1665      Inititialize Request, so  the connection phase merely establishes a
1666      TCP/IP connection with the HTTP server.
1667     </para>
1668     <para>Most of the ZOOM connection options do not
1669      affect SRU/Solr and they are ignored. However, future versions
1670      of &yaz; might honor <literal>implementationName</literal> and
1671      put that as part of User-Agent header for HTTP requests.
1672      </para>
1673     <para>
1674      The <literal>charset</literal> is used in the Content-Type header
1675      of HTTP requests.
1676     </para>
1677     <para>
1678      Setting <literal>authentcationMode</literal> specifies how
1679      authentication parameters are encoded for HTTP. The default is
1680      "<literal>basic</literal>" where <literal>user</literal> and
1681      <literal>password</literal> are encoded by using HTTP basic
1682      authentication.
1683      </para>
1684     <para>
1685      If <literal>authentcationMode</literal> is "<literal>url</literal>", then
1686      user and password are encoded in the URL by parameters
1687      <literal>x-username</literal> and <literal>x-password</literal> as
1688      given by the SRU standard.
1689     </para>
1690    </sect2>
1691   </sect1>
1692   <sect1 id="zoom.query">
1693    <title>Queries</title>
1694    <para>
1695     Query objects represents queries.
1696    </para>
1697    <synopsis>
1698      ZOOM_query ZOOM_query_create(void);
1699
1700      void ZOOM_query_destroy(ZOOM_query q);
1701
1702      int ZOOM_query_prefix(ZOOM_query q, const char *str);
1703
1704      int ZOOM_query_cql(ZOOM_query s, const char *str);
1705
1706      int ZOOM_query_sortby(ZOOM_query q, const char *criteria);
1707
1708      int ZOOM_query_sortby2(ZOOM_query q, const char *strategy,
1709                             const char *criteria);
1710    </synopsis>
1711    <para>
1712     Create query objects using <function>ZOOM_query_create</function>
1713     and destroy them by calling <function>ZOOM_query_destroy</function>.
1714     RPN-queries can be specified in <link linkend="PQF">PQF</link>
1715     notation by using the
1716     function <function>ZOOM_query_prefix</function>.
1717     The <function>ZOOM_query_cql</function> specifies a CQL
1718     query to be sent to the server/target.
1719     More query types will be added in future versions of &yaz;, such as
1720     <link linkend="CCL">CCL</link> to RPN-mapping, native CCL query,
1721     etc. In addition to a search, a sort criteria may be set. Function
1722     <function>ZOOM_query_sortby</function> enables Z39.50 sorting and
1723     it takes sort criteria using the same string notation as
1724     yaz-client's <link linkend="sortspec">sort command</link>.
1725    </para>
1726    <para id="zoom.query.sortby2">
1727     <function>ZOOM_query_sortby2</function> is similar to
1728     <function>ZOOM_query_sortby</function> but allows a strategy for
1729     sorting. The reason for the strategy parameter is that some
1730     protocols offers multiple ways of performing sorting.
1731     For example, Z39.50 has the standard sort, which is performed after
1732     search on an existing result set.
1733     It's also possible to use CQL in Z39.50 as the query type and use
1734     CQL's SORTBY keyword. Finally, Index Data's
1735     Zebra server also allows sorting to be specified as part of RPN (Type 7).
1736    </para>
1737    <table id="zoom-sort-strategy" frame="top">
1738     <title>ZOOM sort strategy</title>
1739     <tgroup cols="2">
1740      <colspec colwidth="2*" colname="name"/>
1741      <colspec colwidth="5*" colname="description"/>
1742      <thead>
1743       <row>
1744        <entry>Name</entry>
1745        <entry>Description</entry>
1746       </row>
1747      </thead>
1748      <tbody>
1749       <row>
1750        <entry>z39.50</entry><entry>Z39.50 resultset sort</entry>
1751       </row>
1752       <row>
1753        <entry>type7</entry><entry>Sorting embedded in RPN(Type-7)</entry>
1754       </row>
1755       <row>
1756        <entry>cql</entry><entry>CQL SORTBY</entry>
1757       </row>
1758       <row>
1759        <entry>sru11</entry><entry>SRU sortKeys parameter</entry>
1760       </row>
1761       <row>
1762        <entry>solr</entry><entry>Solr sort</entry>
1763       </row>
1764       <row>
1765        <entry>embed</entry><entry>type7 for Z39.50, cql for SRU,
1766         solr for Solr protocol</entry>
1767       </row>
1768      </tbody>
1769     </tgroup>
1770    </table>
1771   </sect1>
1772   <sect1 id="zoom.resultsets"><title>Result sets</title>
1773    <para>
1774     The result set object is a container for records returned from
1775     a target.
1776    </para>
1777    <synopsis>
1778      ZOOM_resultset ZOOM_connection_search(ZOOM_connection, ZOOM_query q);
1779
1780      ZOOM_resultset ZOOM_connection_search_pqf(ZOOM_connection c,
1781                                                const char *q);
1782      void ZOOM_resultset_destroy(ZOOM_resultset r);
1783    </synopsis>
1784    <para>
1785     Function <function>ZOOM_connection_search</function> creates
1786     a result set given a connection and query.
1787     Destroy a result set by calling
1788     <function>ZOOM_resultset_destroy</function>.
1789     Simple clients may using PQF only may use function
1790     <function>ZOOM_connection_search_pqf</function> in which case
1791     creating query objects is not necessary.
1792    </para>
1793    <synopsis>
1794      void ZOOM_resultset_option_set(ZOOM_resultset r,
1795                                     const char *key, const char *val);
1796
1797      const char *ZOOM_resultset_option_get(ZOOM_resultset r, const char *key);
1798
1799      size_t ZOOM_resultset_size(ZOOM_resultset r);
1800    </synopsis>
1801    <para>
1802     Functions <function>ZOOM_resultset_options_set</function> and
1803     <function>ZOOM_resultset_get</function> sets and gets an option
1804     for a result set similar to <function>ZOOM_connection_option_get</function>
1805     and <function>ZOOM_connection_option_set</function>.
1806    </para>
1807    <para>
1808     The number of hits also called result-count is returned by
1809     function <function>ZOOM_resultset_size</function>.
1810    </para>
1811    <table id="zoom.resultset.options"
1812     frame="top"><title>ZOOM Result set Options</title>
1813     <tgroup cols="3">
1814      <colspec colwidth="4*" colname="name"></colspec>
1815      <colspec colwidth="7*" colname="description"></colspec>
1816      <colspec colwidth="2*" colname="default"></colspec>
1817      <thead>
1818       <row>
1819        <entry>Option</entry>
1820        <entry>Description</entry>
1821        <entry>Default</entry>
1822       </row>
1823      </thead>
1824      <tbody>
1825       <row><entry>
1826         start</entry><entry>Offset of first record to be
1827         retrieved from target. First record has offset 0 unlike the
1828         protocol specifications where first record has position 1.
1829         This option affects ZOOM_resultset_search and
1830         ZOOM_resultset_search_pqf and must be set before any of
1831         these functions are invoked. If a range of
1832         records must be fetched manually after search,
1833         function ZOOM_resultset_records should be used.
1834        </entry><entry>0</entry></row>
1835       <row><entry>
1836         count</entry><entry>Number of records to be retrieved.
1837         This option affects ZOOM_resultset_search and
1838         ZOOM_resultset_search_pqf and must be set before any of
1839         these functions are invoked.
1840        </entry><entry>0</entry></row>
1841       <row><entry>
1842         presentChunk</entry><entry>The number of records to be
1843         requested from the server in each chunk (present request). The
1844         value 0 means to request all the records in a single chunk.
1845         (The old <literal>step</literal>
1846         option is also supported for the benefit of old applications.)
1847        </entry><entry>0</entry></row>
1848       <row><entry>
1849         elementSetName</entry><entry>Element-Set name of records.
1850         Most targets should honor element set name <literal>B</literal>
1851         and <literal>F</literal> for brief and full respectively.
1852        </entry><entry>none</entry></row>
1853       <row><entry>
1854         preferredRecordSyntax</entry><entry>Preferred Syntax, such as
1855         <literal>USMARC</literal>, <literal>SUTRS</literal>, etc.
1856        </entry><entry>none</entry></row>
1857       <row><entry>
1858         schema</entry><entry>Schema for retrieval, such as
1859         <literal>Gils-schema</literal>, <literal>Geo-schema</literal>, etc.
1860        </entry><entry>none</entry></row>
1861       <row><entry>
1862         setname</entry><entry>Name of Result Set (Result Set ID).
1863         If this option isn't set, the ZOOM module will automatically
1864         allocate a result set name.
1865        </entry><entry>default</entry></row>
1866       <row><entry>
1867         rpnCharset</entry><entry>Character set for RPN terms.
1868         If this is set, ZOOM C will assume that the ZOOM application is
1869         running UTF-8. Terms in RPN queries are then converted to the
1870         rpnCharset. If this is unset, ZOOM C will not assume any encoding
1871         of RPN terms and no conversion is performed.
1872        </entry><entry>none</entry></row>
1873      </tbody>
1874     </tgroup>
1875    </table>
1876    <para>
1877     For servers that support Search Info report, the following
1878     options may be read using <function>ZOOM_resultset_get</function>.
1879     This detailed information is read after a successful search has
1880     completed.
1881    </para>
1882    <para>
1883     This information is a list of of items, where each item is
1884     information about a term or subquery. All items in the list
1885     are prefixed by
1886     <literal>SearchResult.</literal><replaceable>no</replaceable>
1887     where no presents the item number (0=first, 1=second).
1888     Read <literal>searchresult.size</literal> to determine the
1889     number of items.
1890    </para>
1891    <table id="zoom.search.info.report.options"
1892     frame="top"><title>Search Info Report Options</title>
1893     <tgroup cols="2">
1894      <colspec colwidth="4*" colname="name"></colspec>
1895      <colspec colwidth="7*" colname="description"></colspec>
1896      <thead>
1897       <row>
1898        <entry>Option</entry>
1899        <entry>Description</entry>
1900       </row>
1901      </thead>
1902      <tbody>
1903       <row>
1904        <entry>searchresult.size</entry>
1905        <entry>
1906         number of search result entries. This option is-nonexistant
1907         if no entries are returned by the server.
1908        </entry>
1909       </row>
1910       <row>
1911        <entry>searchresult.<replaceable>no</replaceable>.id</entry>
1912        <entry>sub query ID</entry>
1913       </row>
1914       <row>
1915        <entry>searchresult.<replaceable>no</replaceable>.count</entry>
1916        <entry>result count for item (number of hits)</entry>
1917       </row>
1918       <row>
1919        <entry>searchresult.<replaceable>no</replaceable>.subquery.term</entry>
1920        <entry>subquery term</entry>
1921       </row>
1922       <row>
1923        <entry>
1924         searchresult.<replaceable>no</replaceable>.interpretation.term
1925        </entry>
1926        <entry>interpretation term</entry>
1927       </row>
1928       <row>
1929        <entry>
1930         searchresult.<replaceable>no</replaceable>.recommendation.term
1931        </entry>
1932        <entry>recommendation term</entry>
1933       </row>
1934      </tbody>
1935     </tgroup>
1936    </table>
1937    <sect2 id="zoom.z3950.resultset.sort">
1938     <title>Z39.50 Result-set Sort</title>
1939     <synopsis>
1940      void ZOOM_resultset_sort(ZOOM_resultset r,
1941                               const char *sort_type, const char *sort_spec);
1942
1943      int ZOOM_resultset_sort1(ZOOM_resultset r,
1944                               const char *sort_type, const char *sort_spec);
1945     </synopsis>
1946     <para>
1947      <function>ZOOM_resultset_sort</function> and
1948      <function>ZOOM_resultset_sort1</function> both sort an existing
1949      result-set. The sort_type parameter is not use. Set it to "yaz".
1950      The sort_spec is same notation as ZOOM_query_sortby and identical
1951      to that offered by yaz-client's
1952      <link linkend="sortspec">sort command</link>.
1953     </para>
1954     <para>
1955      These functions only work for Z39.50. Use the more generic utility
1956      <link linkend="zoom.query.sortby2">
1957       <function>ZOOM_query_sortby2</function></link>
1958      for other protocols (and even Z39.50).
1959     </para>
1960    </sect2>
1961    <sect2 id="zoom.z3950.resultset.behavior">
1962     <title>Z39.50 Protocol behavior</title>
1963     <para>
1964      The creation of a result set involves at least a SearchRequest
1965      - SearchResponse protocol handshake. Following that, if a sort
1966      criteria was specified as part of the query, a SortRequest -
1967      SortResponse handshake takes place. Note that it is necessary to
1968      perform sorting before any retrieval takes place, so no records will
1969      be returned from the target as part of the SearchResponse because these
1970      would be unsorted. Hence, piggyback is disabled when sort criteria
1971      are set. Following Search - and a possible sort - Retrieval takes
1972      place - as one or more Present Requests/Response pairs being
1973      transferred.
1974      </para>
1975     <para>
1976      The API allows for two different modes for retrieval. A high level
1977      mode which is somewhat more powerful and a low level one.
1978      The low level is enabled when searching on a Connection object
1979      for which the settings
1980      <literal>smallSetUpperBound</literal>,
1981      <literal>mediumSetPresentNumber</literal> and
1982      <literal>largeSetLowerBound</literal> are set. The low level mode
1983      thus allows you to precisely set how records are returned as part
1984      of a search response as offered by the Z39.50 protocol.
1985      Since the client may be retrieving records as part of the
1986      search response, this mode doesn't work well if sorting is used.
1987      </para>
1988     <para>
1989      The high-level mode allows you to fetch a range of records from
1990      the result set with a given start offset. When you use this mode
1991      the client will automatically use piggyback if that is possible
1992      with the target and perform one or more present requests as needed.
1993      Even if the target returns fewer records as part of a present response
1994      because of a record size limit, etc. the client will repeat sending
1995      present requests. As an example, if option <literal>start</literal>
1996      is 0 (default) and <literal>count</literal> is 4, and
1997      <literal>piggyback</literal> is 1 (default) and no sorting criteria
1998      is specified, then the client will attempt to retrieve the 4
1999      records as part the search response (using piggyback). On the other
2000      hand, if either <literal>start</literal> is positive or if
2001      a sorting criteria is set, or if <literal>piggyback</literal>
2002      is 0, then the client will not perform piggyback but send Present
2003      Requests instead.
2004     </para>
2005     <para>
2006      If either of the options <literal>mediumSetElementSetName</literal> and
2007      <literal>smallSetElementSetName</literal> are unset, the value
2008      of option <literal>elementSetName</literal> is used for piggyback
2009      searches. This means that for the high-level mode you only have
2010      to specify one elementSetName option rather than three.
2011      </para>
2012    </sect2>
2013    <sect2 id="zoom.sru.resultset.behavior">
2014     <title>SRU Protocol behavior</title>
2015     <para>
2016      Current version of &yaz; does not take advantage of a result set id
2017      returned by the SRU server. Future versions might do, however.
2018      Since, the ZOOM driver does not save result set IDs any
2019      present (retrieval) is transformed to a SRU SearchRetrieveRequest
2020      with same query but, possibly, different offsets.
2021     </para>
2022     <para>
2023      Option <literal>schema</literal> specifies SRU schema
2024      for retrieval. However, options <literal>elementSetName</literal> and
2025      <literal>preferredRecordSyntax</literal> are ignored.
2026     </para>
2027     <para>
2028      Options <literal>start</literal> and <literal>count</literal>
2029      are supported by SRU.
2030      The remaining options
2031      <literal>piggyback</literal>,
2032      <literal>smallSetUpperBound</literal>,
2033      <literal>largeSetLowerBound</literal>,
2034      <literal>mediumSetPresentNumber</literal>,
2035      <literal>mediumSetElementSetName</literal>,
2036       <literal>smallSetElementSetName</literal> are
2037      unsupported.
2038     </para>
2039     <para>
2040      SRU supports CQL queries, <emphasis>not</emphasis> PQF.
2041      If PQF is used, however, the PQF query is transferred anyway
2042      using non-standard element <literal>pQuery</literal> in
2043      SRU SearchRetrieveRequest.
2044     </para>
2045     <para>
2046      Solr queries has to be done in Solr query format.
2047     </para>
2048     <para>
2049      Unfortunately, SRU or Solr does not define a database setting. Hence,
2050      <literal>databaseName</literal> is unsupported and ignored.
2051      However, the path part in host parameter for functions
2052      <function>ZOOM_connecton_new</function> and
2053      <function>ZOOM_connection_connect</function> acts as a
2054      database (at least for the &yaz; SRU server).
2055     </para>
2056    </sect2>
2057   </sect1>
2058   <sect1 id="zoom.records">
2059    <title>Records</title>
2060    <para>
2061     A record object is a retrieval record on the client side -
2062     created from result sets.
2063    </para>
2064    <synopsis>
2065      void ZOOM_resultset_records(ZOOM_resultset r,
2066                                  ZOOM_record *recs,
2067                                  size_t start, size_t count);
2068      ZOOM_record ZOOM_resultset_record(ZOOM_resultset s, size_t pos);
2069
2070      const char *ZOOM_record_get(ZOOM_record rec, const char *type,
2071                                  size_t *len);
2072
2073      int ZOOM_record_error(ZOOM_record rec, const char **msg,
2074                            const char **addinfo, const char **diagset);
2075
2076      ZOOM_record ZOOM_record_clone(ZOOM_record rec);
2077
2078      void ZOOM_record_destroy(ZOOM_record rec);
2079    </synopsis>
2080    <para>
2081     References to temporary records are returned by functions
2082     <function>ZOOM_resultset_records</function> or
2083     <function>ZOOM_resultset_record</function>.
2084     </para>
2085    <para>
2086     If a persistent reference to a record is desired
2087     <function>ZOOM_record_clone</function> should be used.
2088     It returns a record reference that should be destroyed
2089     by a call to <function>ZOOM_record_destroy</function>.
2090    </para>
2091    <para>
2092     A single record is returned by function
2093     <function>ZOOM_resultset_record</function> that takes a
2094     position as argument. First record has position zero.
2095     If no record could be obtained <literal>NULL</literal> is returned.
2096    </para>
2097    <para>
2098     Error information for a record can be checked with
2099     <function>ZOOM_record_error</function> which returns non-zero
2100     (error code) if record is in error, called <emphasis>Surrogate
2101      Diagnostics</emphasis> in Z39.50.
2102    </para>
2103    <para>
2104     Function <function>ZOOM_resultset_records</function> retrieves
2105     a number of records from a result set. Parameter <literal>start</literal>
2106     and <literal>count</literal> specifies the range of records to
2107     be returned. Upon completion array
2108     <literal>recs[0], ..recs[count-1]</literal>
2109     holds record objects for the records. The array of records
2110      <literal>recs</literal> should be allocated prior the call
2111     <function>ZOOM_resultset_records</function>. Note that for those
2112     records that couldn't be retrieved from the target
2113     <literal>recs[ ..]</literal> is set to <literal>NULL</literal>.
2114    </para>
2115    <para id="zoom.record.get">
2116     In order to extract information about a single record,
2117     <function>ZOOM_record_get</function> is provided. The
2118     function returns a pointer to certain record information. The
2119     nature (type) of the pointer depends on the parameter,
2120     <parameter>type</parameter>.
2121    </para>
2122    <para>
2123     The <parameter>type</parameter> is a string of the format:
2124    </para>
2125    <para>
2126     <replaceable>format</replaceable>[;charset=<replaceable>from</replaceable>[/<replaceable>opacfrom</replaceable>][,<replaceable>to</replaceable>]][;format=<replaceable>v</replaceable>]
2127    </para>
2128    <para>
2129     where <replaceable>format</replaceable> specifies the format of the
2130     returned record, <replaceable>from</replaceable>
2131     specifies the character set of the record in its original form
2132     (as returned by the server), <replaceable>to</replaceable> specifies
2133     the output (returned)
2134     character set encoding.
2135     If <replaceable>to</replaceable> is omitted UTF-8 is assumed.
2136     If charset is not given, then no character set conversion takes place.
2137    </para>
2138
2139    <para>OPAC records may be returned in a different
2140      set from the bibliographic MARC record. If this is this the case,
2141     <replaceable>opacfrom</replaceable> should be set to the character set
2142     of the OPAC record part.
2143    </para>
2144    <note>
2145      <para>
2146        Specifying the OPAC record character set requires YAZ 4.1.5 or later.
2147      </para>
2148    </note>
2149    <para>
2150     The format argument controls whether record data should be XML
2151     pretty-printed (post process operation).
2152     It is enabled only if format value <replaceable>v</replaceable> is
2153     <literal>1</literal> and the record content is XML well-formed.
2154    </para>
2155    <para>
2156     In addition, for certain types, the length
2157     <literal>len</literal> passed will be set to the size in bytes of
2158     the returned information.
2159     </para>
2160    <para>
2161     The following are the supported values for <replaceable>form</replaceable>.
2162     <variablelist>
2163      <varlistentry><term><literal>database</literal></term>
2164       <listitem><para>Database of record is returned
2165         as a C null-terminated string. Return type
2166         <literal>const char *</literal>.
2167        </para></listitem>
2168      </varlistentry>
2169      <varlistentry><term><literal>syntax</literal></term>
2170       <listitem><para>The transfer syntax of the record is returned
2171         as a C null-terminated string containing the symbolic name of
2172         the record syntax, e.g. <literal>Usmarc</literal>. Return type
2173         is
2174         <literal>const char *</literal>.
2175        </para></listitem>
2176      </varlistentry>
2177      <varlistentry><term><literal>schema</literal></term>
2178       <listitem><para>The schema of the record is returned
2179         as a C null-terminated string. Return type is
2180         <literal>const char *</literal>.
2181        </para></listitem>
2182      </varlistentry>
2183      <varlistentry><term><literal>render</literal></term>
2184       <listitem><para>The record is returned in a display friendly
2185         format. Upon completion buffer is returned
2186         (type <literal>const char *</literal>) and length is stored in
2187         <literal>*len</literal>.
2188        </para></listitem>
2189      </varlistentry>
2190      <varlistentry><term><literal>raw</literal></term>
2191       <listitem><para>The record is returned in the internal
2192         YAZ specific format. For GRS-1, Explain, and others, the
2193         raw data is returned as type
2194         <literal>Z_External *</literal> which is just the type for
2195         the member <literal>retrievalRecord</literal> in
2196         type <literal>NamePlusRecord</literal>.
2197         For SUTRS and octet aligned record (including all MARCs) the
2198         octet buffer is returned and the length of the buffer.
2199        </para></listitem>
2200      </varlistentry>
2201      <varlistentry><term><literal>xml</literal></term>
2202       <listitem><para>The record is returned in XML if possible.
2203         SRU, Solr and Z39.50 records with transfer syntax XML are
2204         returned verbatim. MARC records are returned in
2205         <ulink url="&url.marcxml;">
2206          MARCXML
2207          </ulink>
2208         (converted from ISO2709 to MARCXML by YAZ).
2209         OPAC records are also converted to XML and the
2210         bibliographic record is converted to MARCXML (when possible).
2211         GRS-1 records are not supported for this form.
2212         Upon completion, the XML buffer is returned
2213         (type <literal>const char *</literal>) and length is stored in
2214         <literal>*len</literal>.
2215        </para></listitem>
2216      </varlistentry>
2217      <varlistentry><term><literal>opac</literal></term>
2218       <listitem><para>OPAC information for record is returned in XML
2219         if an OPAC record is present at the position given. If no
2220         OPAC record is present, a NULL pointer is returned.
2221        </para></listitem>
2222      </varlistentry>
2223      <varlistentry><term><literal>txml</literal></term>
2224       <listitem><para>The record is returned in TurboMARC if possible.
2225         SRU and Z39.50 records with transfer syntax XML are
2226         returned verbatim. MARC records are returned in
2227         <link linkend="tools.turbomarc">
2228          TurboMARC
2229         </link>
2230         (converted from ISO2709 to TurboMARC by YAZ).
2231         Upon completion, the XML buffer is returned
2232         (type <literal>const char *</literal>) and length is stored in
2233         <literal>*len</literal>.
2234        </para></listitem>
2235      </varlistentry>
2236      <varlistentry><term><literal>json</literal></term>
2237       <listitem><para>Like xml, but MARC records are converted to
2238         <ulink url="&url.marc_in_json;">MARC-in-JSON</ulink>.
2239        </para></listitem>
2240      </varlistentry>
2241
2242     </variablelist>
2243    </para>
2244    <para>
2245     Most
2246     <ulink url="&url.marc21;">MARC21</ulink>
2247     records uses the
2248     <ulink url="&url.marc8;">MARC-8</ulink>
2249     character set encoding.
2250     An application that wishes to display in Latin-1 would use
2251     <screen>
2252      render; charset=marc8,iso-8859-1
2253     </screen>
2254    </para>
2255    <sect2 id="zoom.z3950.record.behavior">
2256     <title>Z39.50 Protocol behavior</title>
2257     <para>
2258      The functions <function>ZOOM_resultset_record</function> and
2259      <function>ZOOM_resultset_records</function> inspects the client-side
2260      record cache. Records not found in cache are fetched using
2261      Present.
2262      The functions may block (and perform network I/O)  - even though option
2263      <literal>async</literal> is 1, because they return records objects.
2264      (and there's no way to return records objects without retrieving them!).
2265      </para>
2266     <para>
2267      There is a trick, however, in the usage of function
2268      <function>ZOOM_resultset_records</function> that allows for
2269      delayed retrieval (and makes it non-blocking). By using
2270      a null pointer for <parameter>recs</parameter> you're indicating
2271      you're not interested in getting records objects
2272      <emphasis>now</emphasis>.
2273     </para>
2274    </sect2>
2275    <sect2 id="zoom.sru.record.behavior">
2276     <title>SRU/Solr Protocol behavior</title>
2277     <para>
2278      The ZOOM driver for SRU/Solr treats records returned by a SRU/Solr server
2279      as if they where Z39.50 records with transfer syntax XML and
2280      no element set name or database name.
2281     </para>
2282    </sect2>
2283   </sect1>
2284   <sect1 id="zoom.facets"><title>Facets</title>
2285    <para>
2286     Facet operations is not part of the official ZOOM specification, but
2287     is an Index Data extension for YAZ-based Z39.50 targets,
2288     <ulink url="&url.solr;">Solr</ulink> and SRU 2.0 targets.
2289
2290     Facets may be requestd by the
2291      <link linkend="zoom.facets.option">facets</link> option before a
2292     search is sent.
2293     For inspection of the returned facets, the following functions are
2294     available:
2295    </para>
2296    <synopsis>
2297     ZOOM_facet_field *ZOOM_resultset_facets(ZOOM_resultset r);
2298
2299     ZOOM_facet_field ZOOM_resultset_get_facet_field(ZOOM_resultset r,
2300                                                     const char *facet_name);
2301
2302     ZOOM_facet_field ZOOM_resultset_get_facet_field_by_index(ZOOM_resultset r,
2303                                                              int pos);
2304
2305     size_t ZOOM_resultset_facets_size(ZOOM_resultset r);
2306
2307     const char *ZOOM_facet_field_name(ZOOM_facet_field facet_field);
2308
2309     size_t ZOOM_facet_field_term_count(ZOOM_facet_field facet_field);
2310
2311     const char *ZOOM_facet_field_get_term(ZOOM_facet_field facet_field,
2312                                           size_t idx, int *freq);
2313    </synopsis>
2314    <para>
2315     References to temporary structures are returned by all functions.
2316     They are only valid as long the Result set is valid.
2317     <function>ZOOM_resultset_get_facet_field</function> or
2318     <function>ZOOM_resultset_get_facet_field_by_index</function>.
2319     <function>ZOOM_resultset_facets</function>.
2320     <function>ZOOM_facet_field_name</function>.
2321     <function>ZOOM_facet_field_get_term</function>.
2322     </para>
2323    <para id="zoom.resultset.get_facet_field">
2324     A single Facet field  is returned by function
2325     <function>ZOOM_resultset_get_facet_field</function> or
2326     <function>ZOOM_resultset_get_facet_field_by_index</function> that takes
2327     a  result set and facet name or positive index respectively. First
2328     facet has position zero. If no facet could be obtained (invalid name
2329     or index out of bounds) <literal>NULL</literal> is returned.
2330    </para>
2331    <para id="zoom.resultset.facets">
2332     An array of facets field can be returned by
2333     <function>ZOOM_resultset_facets</function>. The length of the array is
2334     given by <function>ZOOM_resultset_facets_size</function>. The array is
2335     zero-based and last entry will be at
2336     <function>ZOOM_resultset_facets_size(result_set)</function>-1.
2337    </para>
2338    <para id="zoom.resultset.facets_names">
2339     It is possible to interate over facets by name, by calling
2340     <function>ZOOM_resultset_facets_names</function>.
2341     This will return an const array of char * where each string can be used
2342     as parameter for <function>ZOOM_resultset_get_facet_field</function>.
2343    </para>
2344    <para>
2345    Function <function>ZOOM_facet_field_name</function> gets the request
2346     facet name from a returned facet field.
2347    </para>
2348    <para>
2349     Function <function>ZOOM_facet_field_get_term</function> returns the
2350     idx'th term and term count for a facet field.
2351     Idx must between 0 and
2352     <function>ZOOM_facet_field_term_count</function>-1, otherwise the
2353     returned reference will be <literal>NULL</literal>. On a valid idx, the
2354     value of the freq reference will be the term count.
2355     The <literal>freq</literal> parameter must be valid pointer to integer.
2356    </para>
2357    </sect1>
2358   <sect1 id="zoom.scan"><title>Scan</title>
2359    <para>
2360     This section describes an interface for Scan. Scan is not an
2361     official part of the ZOOM model yet. The result of a scan operation
2362     is the <literal>ZOOM_scanset</literal> which is a set of terms
2363     returned by a target.
2364    </para>
2365
2366    <para>
2367     The Scan interface is supported for both Z39.50, SRU and Solr.
2368    </para>
2369
2370    <synopsis>
2371     ZOOM_scanset ZOOM_connection_scan(ZOOM_connection c,
2372                                       const char *startpqf);
2373
2374     ZOOM_scanset ZOOM_connection_scan1(ZOOM_connection c,
2375                                        ZOOM_query q);
2376
2377     size_t ZOOM_scanset_size(ZOOM_scanset scan);
2378
2379     const char *ZOOM_scanset_term(ZOOM_scanset scan, size_t pos,
2380                                   size_t *occ, size_t *len);
2381
2382     const char *ZOOM_scanset_display_term(ZOOM_scanset scan, size_t pos,
2383                                           size_t *occ, size_t *len);
2384
2385     void ZOOM_scanset_destroy(ZOOM_scanset scan);
2386
2387     const char *ZOOM_scanset_option_get(ZOOM_scanset scan,
2388                                         const char *key);
2389
2390     void ZOOM_scanset_option_set(ZOOM_scanset scan, const char *key,
2391                                  const char *val);
2392     </synopsis>
2393    <para>
2394     The scan set is created by function
2395     <function>ZOOM_connection_scan</function> which performs a scan
2396     operation on the connection using the specified
2397     <parameter>startpqf</parameter>.
2398     If the operation was successful, the size of the scan set can be
2399     retrieved by a call to <function>ZOOM_scanset_size</function>.
2400     Like result sets, the items are numbered 0,..size-1.
2401     To obtain information about a particular scan term, call function
2402     <function>ZOOM_scanset_term</function>. This function takes
2403     a scan set offset <literal>pos</literal> and returns a pointer
2404     to a <emphasis>raw term</emphasis> or <literal>NULL</literal> if
2405     non-present.
2406     If present, the <literal>occ</literal> and <literal>len</literal>
2407     are set to the number of occurrences and the length
2408     of the actual term respectively.
2409     <function>ZOOM_scanset_display_term</function> is similar to
2410     <function>ZOOM_scanset_term</function> except that it returns
2411     the <emphasis>display term</emphasis> rather than the raw term.
2412     In a few cases, the term is different from display term. Always
2413     use the display term for display and the raw term for subsequent
2414     scan operations (to get more terms, next scan result, etc).
2415    </para>
2416    <para>
2417     A scan set may be freed by a call to function
2418     <function>ZOOM_scanset_destroy</function>.
2419     Functions <function>ZOOM_scanset_option_get</function> and
2420     <function>ZOOM_scanset_option_set</function> retrieves and sets
2421     an option respectively.
2422    </para>
2423    <para>
2424     The <parameter>startpqf</parameter> is a subset of PQF, namely
2425     the Attributes+Term part. Multiple <literal>@attr</literal> can
2426     be used. For example to scan in title (complete) phrases:
2427     <literallayout>
2428      @attr 1=4 @attr 6=2 "science o"
2429     </literallayout>
2430    </para>
2431    <para>
2432     The <function>ZOOM_connecton_scan1</function> is a newer and
2433     more generic alternative to <function>ZOOM_connection_scan</function>
2434     which allows to use both CQL and PQF for Scan.
2435    </para>
2436    <table frame="top" id="zoom.scanset.options">
2437     <title>ZOOM Scan Set Options</title>
2438     <tgroup cols="3">
2439      <colspec colwidth="4*" colname="name"></colspec>
2440      <colspec colwidth="7*" colname="description"></colspec>
2441      <colspec colwidth="2*" colname="default"></colspec>
2442      <thead>
2443       <row>
2444        <entry>Option</entry>
2445        <entry>Description</entry>
2446        <entry>Default</entry>
2447       </row>
2448      </thead>
2449      <tbody>
2450       <row><entry>
2451         number</entry><entry>Number of Scan Terms requested in next scan.
2452         After scan it holds the actual number of terms returned.
2453        </entry><entry>20</entry></row>
2454       <row><entry>
2455         position</entry><entry>Preferred Position of term in response
2456         in next scan; actual position after completion of scan.
2457        </entry><entry>1</entry></row>
2458       <row><entry>
2459         stepSize</entry><entry>Step Size
2460        </entry><entry>0</entry></row>
2461       <row><entry>
2462         scanStatus</entry><entry>An integer indicating the Scan Status
2463         of last scan.
2464        </entry><entry>0</entry></row>
2465       <row><entry>
2466         rpnCharset</entry><entry>Character set for RPN terms.
2467         If this is set, ZOOM C will assume that the ZOOM application is
2468         running UTF-8. Terms in RPN queries are then converted to the
2469         rpnCharset. If this is unset, ZOOM C will not assume any encoding
2470         of RPN terms and no conversion is performed.
2471        </entry><entry>none</entry></row>
2472      </tbody>
2473     </tgroup>
2474    </table>
2475   </sect1>
2476   <sect1 id="zoom.extendedservices">
2477    <title>Extended Services</title>
2478    <para>
2479     ZOOM offers an interface to a subset of the Z39.50 extended services
2480     as well as a few privately defined ones:
2481    </para>
2482    <itemizedlist>
2483     <listitem>
2484      <para>
2485       Z39.50 Item Order (ILL).
2486       See <xref linkend="zoom.item.order"/>.
2487      </para>
2488     </listitem>
2489     <listitem>
2490      <para>
2491       Record Update. This allows a client to insert, modify or delete
2492       records.
2493       See <xref linkend="zoom.record.update"/>.
2494      </para>
2495     </listitem>
2496     <listitem>
2497      <para>
2498       Database Create. This a non-standard feature. Allows a client
2499       to create a database.
2500       See <xref linkend="zoom.database.create"/>.
2501      </para>
2502     </listitem>
2503     <listitem>
2504      <para>
2505       Database Drop. This a non-standard feature. Allows a client
2506       to delete/drop a database.
2507       See <xref linkend="zoom.database.drop"/>.
2508      </para>
2509      </listitem>
2510     <listitem>
2511      <para>
2512       Commit operation. This a non-standard feature. Allows a client
2513       to commit operations.
2514       See <xref linkend="zoom.commit"/>.
2515      </para>
2516     </listitem>
2517     <!-- all the ILL PDU options should go here too -->
2518    </itemizedlist>
2519    <para>
2520     To create an extended service operation a <literal>ZOOM_package</literal>
2521     must be created. The operation is a five step operation. The
2522     package is created, package is configured by means of options,
2523     the package is send, result is inspected (by means of options),
2524     the package is destroyed.
2525    </para>
2526    <synopsis>
2527     ZOOM_package ZOOM_connection_package(ZOOM_connection c,
2528                                          ZOOM_options options);
2529
2530     const char *ZOOM_package_option_get(ZOOM_package p,
2531                                         const char *key);
2532     void ZOOM_package_option_set(ZOOM_package p, const char *key,
2533                                  const char *val);
2534     void ZOOM_package_send(ZOOM_package p, const char *type);
2535
2536     void ZOOM_package_destroy(ZOOM_package p);
2537    </synopsis>
2538    <para>
2539     The <function>ZOOM_connection_package</function> creates a
2540     package for the connection given using the options specified.
2541    </para>
2542    <para>
2543     Functions <function>ZOOM_package_option_get</function> and
2544     <function>ZOOM_package_option_set</function> gets and sets
2545     options.
2546    </para>
2547    <para>
2548     <function>ZOOM_package_send</function> sends
2549     the package the via connection specified in
2550     <function>ZOOM_connection_package</function>.
2551     The <parameter>type</parameter> specifies the actual extended service
2552     package type to be sent.
2553    </para>
2554    <table frame="top" id="zoom.extendedservices.options">
2555     <title>Extended Service Common Options</title>
2556     <tgroup cols="3">
2557      <colspec colwidth="4*" colname="name"></colspec>
2558      <colspec colwidth="7*" colname="description"></colspec>
2559      <colspec colwidth="3*" colname="default"></colspec>
2560      <thead>
2561       <row>
2562        <entry>Option</entry>
2563        <entry>Description</entry>
2564        <entry>Default</entry>
2565       </row>
2566      </thead>
2567      <tbody>
2568       <row>
2569        <entry>package-name</entry>
2570        <entry>Extended Service Request package name. Must be specified
2571        as part of a request</entry>
2572        <entry>none</entry>
2573       </row>
2574       <row>
2575        <entry>user-id</entry>
2576        <entry>User ID of Extended Service Package. Is a request option</entry>
2577        <entry>none</entry>
2578       </row>
2579       <row>
2580        <entry>function</entry>
2581        <entry>
2582         Function of package - one of <literal>create</literal>,
2583         <literal>delete</literal>, <literal>modify</literal>. Is
2584         a request option.
2585        </entry>
2586        <entry><literal>create</literal></entry>
2587       </row>
2588       <row>
2589        <entry>waitAction</entry>
2590        <entry>
2591         Wait action for package. Possible values:
2592         <literal>wait</literal>, <literal>waitIfPossible</literal>,
2593         <literal>dontWait</literal> or <literal>dontReturnPackage</literal>.
2594        </entry>
2595        <entry><literal>waitIfPossible</literal></entry>
2596       </row>
2597       <row>
2598        <entry>targetReference</entry>
2599        <entry>
2600         Target Reference. This is part of the response as returned
2601         by the server. Read it after a successful operation.
2602        </entry>
2603        <entry><literal>none</literal></entry>
2604       </row>
2605      </tbody>
2606     </tgroup>
2607    </table>
2608    <sect2 id="zoom.item.order">
2609     <title>Item Order</title>
2610     <para>
2611      For Item Order, type must be set to <literal>itemorder</literal> in
2612      <function>ZOOM_package_send</function>.
2613     </para>
2614
2615     <table frame="top" id="zoom.item.order.options">
2616      <title>Item Order Options</title>
2617      <tgroup cols="3">
2618       <colspec colwidth="4*" colname="name"></colspec>
2619       <colspec colwidth="7*" colname="description"></colspec>
2620       <colspec colwidth="3*" colname="default"></colspec>
2621       <thead>
2622        <row>
2623         <entry>Option</entry>
2624         <entry>Description</entry>
2625         <entry>Default</entry>
2626        </row>
2627       </thead>
2628       <tbody>
2629        <row>
2630         <entry>contact-name</entry>
2631         <entry>ILL contact name</entry>
2632         <entry>none</entry>
2633        </row>
2634        <row>
2635         <entry>contact-phone</entry>
2636         <entry>ILL contact phone</entry>
2637         <entry>none</entry>
2638        </row>
2639        <row>
2640         <entry>contact-email</entry>
2641         <entry>ILL contact email</entry>
2642         <entry>none</entry>
2643        </row>
2644        <row>
2645         <entry>itemorder-item</entry>
2646         <entry>Position for item (record) requested. An integer</entry>
2647         <entry>1</entry>
2648        </row>
2649       </tbody>
2650      </tgroup>
2651     </table>
2652    </sect2>
2653    <sect2 id="zoom.record.update">
2654     <title>Record Update</title>
2655     <para>
2656      For Record Update, type must be set to <literal>update</literal> in
2657      <function>ZOOM_package_send</function>.
2658     </para>
2659     <table frame="top" id="zoom.record.update.options">
2660      <title>Record Update Options</title>
2661      <tgroup cols="3">
2662       <colspec colwidth="4*" colname="name"></colspec>
2663       <colspec colwidth="7*" colname="description"></colspec>
2664       <colspec colwidth="3*" colname="default"></colspec>
2665       <thead>
2666        <row>
2667         <entry>Option</entry>
2668         <entry>Description</entry>
2669         <entry>Default</entry>
2670        </row>
2671       </thead>
2672       <tbody>
2673        <row>
2674         <entry>action</entry>
2675         <entry>
2676          The update action. One of
2677          <literal>specialUpdate</literal>,
2678          <literal>recordInsert</literal>,
2679          <literal>recordReplace</literal>,
2680          <literal>recordDelete</literal>,
2681          <literal>elementUpdate</literal>.
2682         </entry>
2683         <entry><literal>specialUpdate (recordInsert for updateVersion=1 which does not support specialUpdate)</literal></entry>
2684        </row>
2685        <row>
2686         <entry>recordIdOpaque</entry>
2687         <entry>Opaque Record ID</entry>
2688         <entry>none</entry>
2689        </row>
2690        <row>
2691         <entry>recordIdNumber</entry>
2692         <entry>Record ID number</entry>
2693         <entry>none</entry>
2694        </row>
2695        <row>
2696         <entry>record</entry>
2697         <entry>The record itself</entry>
2698         <entry>none</entry>
2699        </row>
2700        <row>
2701         <entry>recordOpaque</entry>
2702         <entry>Specifies an opaque record which is
2703           encoded as an ASN.1 ANY type with the OID as tiven by option
2704           <literal>syntax</literal> (see below).
2705           Option <literal>recordOpaque</literal> is an alternative
2706           to record - and <literal>record</literal> option (above) is
2707           ignored if recordOpaque is set. This option is only available in
2708           YAZ 3.0.35 and later and is meant to facilitate Updates with
2709           servers from OCLC.
2710         </entry>
2711         <entry>none</entry>
2712        </row>
2713        <row>
2714         <entry>syntax</entry>
2715         <entry>The record syntax (transfer syntax). Is a string that
2716          is a known record syntax.
2717         </entry>
2718         <entry>no syntax</entry>
2719        </row>
2720        <row>
2721         <entry>databaseName</entry>
2722         <entry>Database from connection object</entry>
2723         <entry>Default</entry>
2724        </row>
2725        <row>
2726         <entry>correlationInfo.note</entry>
2727         <entry>Correlation Info Note (string)</entry>
2728         <entry>none</entry>
2729        </row>
2730        <row>
2731         <entry>correlationInfo.id</entry>
2732         <entry>Correlation Info ID (integer)</entry>
2733         <entry>none</entry>
2734        </row>
2735        <row>
2736         <entry>elementSetName</entry>
2737         <entry>Element Set for Record</entry>
2738         <entry>none</entry>
2739        </row>
2740        <row>
2741         <entry>updateVersion</entry>
2742         <entry>Record Update version which holds one of the values
2743          1, 2 or 3. Each version has a distinct OID:
2744          1.2.840.10003.9.5
2745          (<ulink url="&url.z39.50.extupdate1;">first version</ulink>) ,
2746          1.2.840.10003.9.5.1
2747          (second version) and
2748          1.2.840.10003.9.5.1.1
2749          (<ulink url="&url.z39.50.extupdate3;">third and
2750           newest version</ulink>).
2751         </entry>
2752         <entry>3</entry>
2753        </row>
2754       </tbody>
2755      </tgroup>
2756     </table>
2757
2758    </sect2>
2759
2760    <sect2 id="zoom.database.create"><title>Database Create</title>
2761     <para>
2762      For Database Create, type must be set to <literal>create</literal> in
2763      <function>ZOOM_package_send</function>.
2764     </para>
2765
2766     <table frame="top" id="zoom.database.create.options">
2767      <title>Database Create Options</title>
2768      <tgroup cols="3">
2769       <colspec colwidth="4*" colname="name"></colspec>
2770       <colspec colwidth="7*" colname="description"></colspec>
2771       <colspec colwidth="3*" colname="default"></colspec>
2772       <thead>
2773        <row>
2774         <entry>Option</entry>
2775         <entry>Description</entry>
2776         <entry>Default</entry>
2777        </row>
2778       </thead>
2779       <tbody>
2780        <row>
2781         <entry>databaseName</entry>
2782         <entry>Database from connection object</entry>
2783         <entry>Default</entry>
2784        </row>
2785       </tbody>
2786      </tgroup>
2787     </table>
2788    </sect2>
2789    <sect2 id="zoom.database.drop">
2790     <title>Database Drop</title>
2791     <para>
2792      For Database Drop, type must be set to <literal>drop</literal> in
2793      <function>ZOOM_package_send</function>.
2794     </para>
2795     <table frame="top" id="zoom.database.drop.options">
2796      <title>Database Drop Options</title>
2797      <tgroup cols="3">
2798       <colspec colwidth="4*" colname="name"></colspec>
2799       <colspec colwidth="7*" colname="description"></colspec>
2800       <colspec colwidth="3*" colname="default"></colspec>
2801       <thead>
2802        <row>
2803         <entry>Option</entry>
2804         <entry>Description</entry>
2805         <entry>Default</entry>
2806        </row>
2807       </thead>
2808       <tbody>
2809        <row>
2810         <entry>databaseName</entry>
2811         <entry>Database from connection object</entry>
2812         <entry>Default</entry>
2813        </row>
2814       </tbody>
2815      </tgroup>
2816     </table>
2817    </sect2>
2818    <sect2 id="zoom.commit">
2819     <title>Commit Operation</title>
2820     <para>
2821      For Commit, type must be set to <literal>commit</literal> in
2822      <function>ZOOM_package_send</function>.
2823     </para>
2824    </sect2>
2825    <sect2 id="zoom.extended.services.behavior">
2826     <title>Protocol behavior</title>
2827     <para>
2828      All the extended services are Z39.50-only.
2829     </para>
2830     <note>
2831      <para>
2832       The database create, drop and commit services are privately defined
2833       operations.
2834       Refer to <filename>esadmin.asn</filename> in YAZ for the ASN.1
2835       definitions.
2836      </para>
2837     </note>
2838    </sect2>
2839   </sect1>
2840   <sect1 id="zoom.options">
2841    <title>Options</title>
2842    <para>
2843     Most &zoom; objects provide a way to specify options to change behavior.
2844     From an implementation point of view a set of options is just like
2845     an associative array / hash.
2846    </para>
2847    <synopsis>
2848      ZOOM_options ZOOM_options_create(void);
2849
2850      ZOOM_options ZOOM_options_create_with_parent(ZOOM_options parent);
2851
2852      void ZOOM_options_destroy(ZOOM_options opt);
2853    </synopsis>
2854    <synopsis>
2855      const char *ZOOM_options_get(ZOOM_options opt, const char *name);
2856
2857      void ZOOM_options_set(ZOOM_options opt, const char *name,
2858                            const char *v);
2859    </synopsis>
2860    <synopsis>
2861      typedef const char *(*ZOOM_options_callback)
2862                             (void *handle, const char *name);
2863
2864      ZOOM_options_callback
2865              ZOOM_options_set_callback(ZOOM_options opt,
2866                                        ZOOM_options_callback c,
2867                                        void *handle);
2868    </synopsis>
2869   </sect1>
2870   <sect1 id="zoom.queryconversions">
2871    <title>Query conversions</title>
2872    <synopsis>
2873     int ZOOM_query_cql2rpn(ZOOM_query s, const char *cql_str,
2874                            ZOOM_connection conn);
2875
2876     int ZOOM_query_ccl2rpn(ZOOM_query s, const char *ccl_str,
2877                            const char *config,
2878                            int *ccl_error, const char **error_string,
2879                            int *error_pos);
2880    </synopsis>
2881    <para>
2882     <function>ZOOM_query_cql2rpn</function> translates the CQL string,
2883     client-side, into RPN which may be passed to the server.
2884     This is useful for server's that don't themselves
2885     support CQL, for which <function>ZOOM_query_cql</function> is useless.
2886     `conn' is used  only as a place to stash diagnostics if compilation
2887     fails; if this information is not needed, a null pointer may be used.
2888     The CQL conversion is driven by option <literal>cqlfile</literal> from
2889     connection conn. This specifies a conversion file (eg pqf.properties)
2890     which <emphasis>must</emphasis> be present.
2891    </para>
2892    <para>
2893     <function>ZOOM_query_ccl2rpn</function> translates the CCL string,
2894     client-side, into RPN which may be passed to the server.
2895     The conversion is driven by the specification given by
2896     <literal>config</literal>. Upon completion 0 is returned on success; -1
2897     is returned on on failure. Om failure <literal>error_string</literal> and
2898     <literal>error_pos</literal> holds error message and position of
2899     first error in original CCL string.
2900    </para>
2901   </sect1>
2902   <sect1 id="zoom.events"><title>Events</title>
2903    <para>
2904     If you're developing non-blocking applications, you have to deal
2905     with events.
2906    </para>
2907    <synopsis>
2908     int ZOOM_event(int no, ZOOM_connection *cs);
2909    </synopsis>
2910    <para>
2911     The <function>ZOOM_event</function> executes pending events for
2912     a number of connections. Supply the number of connections in
2913     <literal>no</literal> and an array of connections in
2914     <literal>cs</literal> (<literal>cs[0] ... cs[no-1]</literal>).
2915     A pending event could be a sending a search, receiving a response,
2916     etc.
2917     When an event has occurred for one of the connections, this function
2918     returns a positive integer <literal>n</literal> denoting that an event
2919     occurred for connection <literal>cs[n-1]</literal>.
2920     When no events are pending for the connections, a value of zero is
2921     returned.
2922     To ensure that all outstanding requests are performed call this function
2923     repeatedly until zero is returned.
2924    </para>
2925    <para>
2926     If <function>ZOOM_event</function> returns and returns non-zero, the
2927     last event that occurred can be expected.
2928    </para>
2929    <synopsis>
2930     int ZOOM_connection_last_event(ZOOM_connection cs);
2931    </synopsis>
2932    <para>
2933     <function>ZOOM_connection_last_event</function> returns an event type
2934     (integer) for the last event.
2935    </para>
2936
2937    <table frame="top" id="zoom.event.ids">
2938     <title>ZOOM Event IDs</title>
2939     <tgroup cols="2">
2940      <colspec colwidth="4*" colname="name"></colspec>
2941      <colspec colwidth="7*" colname="description"></colspec>
2942      <thead>
2943       <row>
2944        <entry>Event</entry>
2945        <entry>Description</entry>
2946       </row>
2947      </thead>
2948      <tbody>
2949       <row>
2950        <entry>ZOOM_EVENT_NONE</entry>
2951        <entry>No event has occurred</entry>
2952       </row>
2953       <row>
2954        <entry>ZOOM_EVENT_CONNECT</entry>
2955        <entry>TCP/IP connect has initiated</entry>
2956       </row>
2957       <row>
2958        <entry>ZOOM_EVENT_SEND_DATA</entry>
2959        <entry>Data has been transmitted (sending)</entry>
2960       </row>
2961       <row>
2962        <entry>ZOOM_EVENT_RECV_DATA</entry>
2963        <entry>Data has been received)</entry>
2964       </row>
2965       <row>
2966        <entry>ZOOM_EVENT_TIMEOUT</entry>
2967        <entry>Timeout</entry>
2968       </row>
2969       <row>
2970        <entry>ZOOM_EVENT_UNKNOWN</entry>
2971        <entry>Unknown event</entry>
2972       </row>
2973       <row>
2974        <entry>ZOOM_EVENT_SEND_APDU</entry>
2975        <entry>An APDU has been transmitted (sending)</entry>
2976       </row>
2977       <row>
2978        <entry>ZOOM_EVENT_RECV_APDU</entry>
2979        <entry>An APDU has been received</entry>
2980       </row>
2981       <row>
2982        <entry>ZOOM_EVENT_RECV_RECORD</entry>
2983        <entry>A result-set record has been received</entry>
2984       </row>
2985       <row>
2986        <entry>ZOOM_EVENT_RECV_SEARCH</entry>
2987        <entry>A search result been received</entry>
2988       </row>
2989      </tbody>
2990     </tgroup>
2991    </table>
2992   </sect1>
2993  </chapter>
2994  <chapter id="server">
2995   <title>Generic server</title>
2996   <sect1 id="server.introduction"><title>Introduction</title>
2997    <para>
2998     If you aren't into documentation, a good way to learn how the
2999     back end interface works is to look at the <filename>backend.h</filename>
3000     file. Then, look at the small dummy-server in
3001     <filename>ztest/ztest.c</filename>. The <filename>backend.h</filename>
3002     file also makes a good reference, once you've chewed your way through
3003     the prose of this file.
3004    </para>
3005    <para>
3006     If you have a database system that you would like to make available by
3007     means of Z39.50 or SRU, &yaz; basically offers your two options. You
3008     can use the APIs provided by the &asn;, &odr;, and &comstack;
3009     modules to
3010     create and decode PDUs, and exchange them with a client.
3011     Using this low-level interface gives you access to all fields and
3012     options of the protocol, and you can construct your server as close
3013     to your existing database as you like.
3014     It is also a fairly involved process, requiring
3015     you to set up an event-handling mechanism, protocol state machine,
3016     etc. To simplify server implementation, we have implemented a compact
3017     and simple, but reasonably full-functioned server-frontend that will
3018     handle most of the protocol mechanics, while leaving you to
3019     concentrate on your database interface.
3020    </para>
3021    <note>
3022     <para>
3023      The backend interface was designed in anticipation of a specific
3024      integration task, while still attempting to achieve some degree of
3025      generality. We realize fully that there are points where the
3026      interface can be improved significantly. If you have specific
3027      functions or parameters that you think could be useful, send us a
3028      mail (or better, sign on to the mailing list referred to in the
3029      top-level README file). We will try to fit good suggestions into future
3030      releases, to the extent that it can be done without requiring
3031      too many structural changes in existing applications.
3032     </para>
3033    </note>
3034    <note>
3035     <para>
3036      The &yaz; server does not support XCQL.
3037      </para>
3038    </note>
3039   </sect1>
3040   <sect1 id="server.frontend">
3041    <title>The Database Frontend</title>
3042    <para>
3043     We refer to this software as a generic database frontend. Your
3044     database system is the <emphasis>backend database</emphasis>, and the
3045     interface between the two is called the <emphasis>backend API</emphasis>.
3046     The backend API consists of a small number of function handlers and
3047     structure definitions. You are required to provide the
3048     <function>main()</function> routine for the server (which can be
3049     quite simple), as well as a set of handlers to match each of the
3050     prototypes.
3051     The interface functions that you write can use any mechanism you like
3052     to communicate with your database system: You might link the whole
3053     thing together with your database application and access it by
3054     function calls; you might use IPC to talk to a database server
3055     somewhere; or you might link with third-party software that handles
3056     the communication for you (like a commercial database client library).
3057     At any rate, the handlers will perform the tasks of:
3058    </para>
3059    <itemizedlist>
3060     <listitem><para>
3061      Initialization.
3062     </para></listitem>
3063     <listitem><para>
3064      Searching.
3065     </para></listitem>
3066     <listitem><para>
3067      Fetching records.
3068     </para></listitem>
3069     <listitem><para>
3070      Scanning the database index (optional - if you wish to implement SCAN).
3071     </para></listitem>
3072     <listitem><para>
3073      Extended Services (optional).
3074     </para></listitem>
3075     <listitem><para>
3076      Result-Set Delete (optional).
3077     </para></listitem>
3078     <listitem><para>
3079      Result-Set Sort (optional).
3080     </para></listitem>
3081     <listitem><para>
3082      Return Explain for SRU (optional).
3083     </para></listitem>
3084    </itemizedlist>
3085    <para>
3086     (more functions will be added in time to support as much of
3087     Z39.50-1995 as possible).
3088    </para>
3089   </sect1>
3090   <sect1 id="server.backend">
3091    <title>The Backend API</title>
3092    <para>
3093     The header file that you need to use the interface are in the
3094     <filename>include/yaz</filename> directory. It's called
3095     <filename>backend.h</filename>. It will include other files from
3096     the <filename>include/yaz</filename> directory, so you'll
3097     probably want to use the -I option of your compiler to tell it
3098     where to find the files. When you run
3099     <literal>make</literal> in the top-level &yaz; directory,
3100     everything you need to create your server is to link with the
3101     <filename>lib/libyaz.la</filename> library.
3102    </para>
3103   </sect1>
3104   <sect1 id="server.main">
3105    <title>Your main() Routine</title>
3106    <para>
3107     As mentioned, your <function>main()</function> routine can be quite brief.
3108     If you want to initialize global parameters, or read global configuration
3109     tables, this is the place to do it. At the end of the routine, you should
3110     call the function
3111    </para>
3112    <synopsis>
3113 int statserv_main(int argc, char **argv,
3114                   bend_initresult *(*bend_init)(bend_initrequest *r),
3115                   void (*bend_close)(void *handle));
3116    </synopsis>
3117    <para>
3118     The third and fourth arguments are pointers to handlers. Handler
3119     <function>bend_init</function> is called whenever the server receives
3120     an Initialize Request, so it serves as a Z39.50 session initializer. The
3121     <function>bend_close</function> handler is called when the session is
3122     closed.
3123    </para>
3124    <para>
3125     <function>statserv_main</function> will establish listening sockets
3126     according to the parameters given. When connection requests are received,
3127     the event handler will typically <function>fork()</function> and
3128     create a sub-process to handle a new connection.
3129     Alternatively the server may be setup to create threads for each
3130     connection.
3131     If you do use global variables and forking, you should be aware, then,
3132     that these cannot be shared between associations, unless you explicitly
3133     disable forking by command line parameters.
3134    </para>
3135    <para>
3136     The server provides a mechanism for controlling some of its behavior
3137     without using command-line options. The function
3138    </para>
3139    <synopsis>
3140     statserv_options_block *statserv_getcontrol(void);
3141    </synopsis>
3142    <para>
3143     will return a pointer to a <literal>struct statserv_options_block</literal>
3144     describing the current default settings of the server. The structure
3145     contains these elements:
3146     <variablelist>
3147      <varlistentry>
3148       <term><literal>int dynamic</literal></term>
3149       <listitem><para>
3150        A boolean value, which determines whether the server
3151        will fork on each incoming request (TRUE), or not (FALSE). Default is
3152        TRUE. This flag is only read by UNIX-based servers (WIN32 based servers
3153        doesn't fork).
3154      </para></listitem>
3155      </varlistentry>
3156      <varlistentry>
3157       <term><literal>int threads</literal></term>
3158       <listitem><para>
3159        A boolean value, which determines whether the server
3160        will create a thread on each incoming request (TRUE), or not (FALSE).
3161        Default is FALSE. This flag is only read by UNIX-based servers
3162        that offer POSIX Threads support.
3163        WIN32-based servers always operate in threaded mode.
3164      </para></listitem>
3165      </varlistentry>
3166      <varlistentry>
3167       <term><literal>int inetd</literal></term>
3168       <listitem><para>
3169        A boolean value, which determines whether the server
3170        will operates under a UNIX INET daemon (inetd). Default is FALSE.
3171      </para></listitem>
3172      </varlistentry>
3173      <varlistentry>
3174       <term><literal>char logfile[ODR_MAXNAME+1]</literal></term>
3175       <listitem><para>File for diagnostic output (&quot;&quot;: stderr).
3176      </para></listitem>
3177      </varlistentry>
3178      <varlistentry>
3179       <term><literal>char apdufile[ODR_MAXNAME+1]</literal></term>
3180       <listitem><para>
3181        Name of file for logging incoming and outgoing APDUs
3182        (&quot;&quot;: don't log APDUs, &quot;-&quot;:
3183        <literal>stderr</literal>).
3184      </para></listitem>
3185      </varlistentry>
3186      <varlistentry>
3187       <term><literal>char default_listen[1024]</literal></term>
3188       <listitem><para>Same form as the command-line specification of
3189       listener address. &quot;&quot;: no default listener address.
3190       Default is to listen at &quot;tcp:@:9999&quot;. You can only
3191       specify one default listener address in this fashion.
3192      </para></listitem>
3193      </varlistentry>
3194      <varlistentry>
3195       <term><literal>enum oid_proto default_proto;</literal></term>
3196       <listitem><para>Either <literal>PROTO_Z3950</literal> or
3197       <literal>PROTO_SR</literal>.
3198       Default is <literal>PROTO_Z39_50</literal>.
3199      </para></listitem>
3200      </varlistentry>
3201      <varlistentry>
3202       <term><literal>int idle_timeout;</literal></term>
3203       <listitem><para>Maximum session idle-time, in minutes. Zero indicates
3204       no (infinite) timeout. Default is 15 minutes.
3205      </para></listitem>
3206      </varlistentry>
3207      <varlistentry>
3208       <term><literal>int maxrecordsize;</literal></term>
3209       <listitem><para>Maximum permissible record (message) size. Default
3210       is 64 MB. This amount of memory will only be allocated if a
3211       client requests a very large amount of records in one operation
3212       (or a big record).
3213       Set it to a lower number if you are worried about resource
3214       consumption on your host system.
3215      </para></listitem>
3216      </varlistentry>
3217      <varlistentry>
3218       <term><literal>char configname[ODR_MAXNAME+1]</literal></term>
3219       <listitem><para>Passed to the backend when a new connection is received.
3220      </para></listitem>
3221      </varlistentry>
3222      <varlistentry>
3223       <term><literal>char setuid[ODR_MAXNAME+1]</literal></term>
3224       <listitem><para>Set user id to the user specified, after binding
3225       the listener addresses.
3226      </para></listitem>
3227      </varlistentry>
3228      <varlistentry>
3229       <term>
3230        <literal>void (*bend_start)(struct statserv_options_block *p)</literal>
3231       </term>
3232       <listitem><para>Pointer to function which is called after the
3233       command line options have been parsed - but before the server
3234       starts listening.
3235       For forked UNIX servers this handler is called in the mother
3236       process; for threaded servers this handler is called in the
3237       main thread.
3238       The default value of this pointer is NULL in which case it
3239       isn't invoked by the frontend server.
3240       When the server operates as an NT service this handler is called
3241       whenever the service is started.
3242       </para></listitem>
3243      </varlistentry>
3244      <varlistentry>
3245       <term>
3246        <literal>void (*bend_stop)(struct statserv_options_block *p)</literal>
3247       </term>
3248       <listitem><para>Pointer to function which is called whenever the server
3249       has stopped listening for incoming connections. This function pointer
3250       has a default value of NULL in which case it isn't called.
3251       When the server operates as an NT service this handler is called
3252       whenever the service is stopped.
3253       </para></listitem>
3254      </varlistentry>
3255      <varlistentry>
3256       <term><literal>void *handle</literal></term>
3257       <listitem><para>User defined pointer (default value NULL).
3258       This is a per-server handle that can be used to specify "user-data".
3259       Do not confuse this with the session-handle as returned by bend_init.
3260       </para></listitem>
3261      </varlistentry>
3262     </variablelist>
3263    </para>
3264    <para>
3265     The pointer returned by <literal>statserv_getcontrol</literal> points to
3266     a static area. You are allowed to change the contents of the structure,
3267     but the changes will not take effect before you call
3268    </para>
3269    <synopsis>
3270 void statserv_setcontrol(statserv_options_block *block);
3271    </synopsis>
3272    <note>
3273     <para>
3274      that you should generally update this structure before calling
3275      <function>statserv_main()</function>.
3276     </para>
3277    </note>
3278   </sect1>
3279   <sect1 id="server.backendfunctions">
3280    <title>The Backend Functions</title>
3281    <para>
3282     For each service of the protocol, the backend interface declares one or
3283     two functions. You are required to provide implementations of the
3284     functions representing the services that you wish to implement.
3285    </para>
3286    <sect2 id="server.init">
3287     <title>Init</title>
3288     <synopsis>
3289 bend_initresult (*bend_init)(bend_initrequest *r);
3290     </synopsis>
3291     <para>
3292      This handler is called once for each new connection request, after
3293      a new process/thread has been created, and an Initialize Request has
3294      been received from the client. The pointer to the
3295      <function>bend_init</function> handler is passed in the call to
3296      <function>statserv_start</function>.
3297     </para>
3298     <para>
3299      This handler is also called when operating in SRU mode - when
3300      a connection has been made (even though SRU does not offer
3301      this service).
3302     </para>
3303     <para>
3304      Unlike previous versions of YAZ, the <function>bend_init</function> also
3305      serves as a handler that defines the Z39.50 services that the backend
3306      wish to support. Pointers to <emphasis>all</emphasis> service handlers,
3307      including search - and fetch must be specified here in this handler.
3308     </para>
3309     <para>
3310      The request - and result structures are defined as
3311     </para>
3312     <synopsis>
3313 typedef struct bend_initrequest
3314 {
3315     /** \brief user/name/password to be read */
3316     Z_IdAuthentication *auth;
3317     /** \brief encoding stream (for results) */
3318     ODR stream;
3319     /** \brief printing stream */
3320     ODR print;
3321     /** \brief decoding stream (use stream for results) */
3322     ODR decode;
3323     /** \brief reference ID */
3324     Z_ReferenceId *referenceId;
3325     /** \brief peer address of client */
3326     char *peer_name;
3327
3328     /** \brief character set and language negotiation
3329
3330     see include/yaz/z-charneg.h
3331     */
3332     Z_CharSetandLanguageNegotiation *charneg_request;
3333
3334     /** \brief character negotiation response */
3335     Z_External *charneg_response;
3336
3337     /** \brief character set (encoding) for query terms
3338
3339     This is NULL by default. It should be set to the native character
3340     set that the backend assumes for query terms */
3341     char *query_charset;
3342
3343     /** \brief whehter query_charset also applies to recors
3344
3345     Is 0 (No) by default. Set to 1 (yes) if records is in the same
3346     character set as queries. If in doubt, use 0 (No).
3347     */
3348     int records_in_same_charset;
3349
3350     char *implementation_id;
3351     char *implementation_name;
3352     char *implementation_version;
3353
3354     /** \brief Z39.50 sort handler */
3355     int (*bend_sort)(void *handle, bend_sort_rr *rr);
3356     /** \brief SRU/Z39.50 search handler */
3357     int (*bend_search)(void *handle, bend_search_rr *rr);
3358     /** \brief SRU/Z39.50 fetch handler */
3359     int (*bend_fetch)(void *handle, bend_fetch_rr *rr);
3360     /** \brief SRU/Z39.50 present handler */
3361     int (*bend_present)(void *handle, bend_present_rr *rr);
3362     /** \brief Z39.50 extended services handler */
3363     int (*bend_esrequest) (void *handle, bend_esrequest_rr *rr);
3364     /** \brief Z39.50 delete result set handler */
3365     int (*bend_delete)(void *handle, bend_delete_rr *rr);
3366     /** \brief Z39.50 scan handler */
3367     int (*bend_scan)(void *handle, bend_scan_rr *rr);
3368     /** \brief Z39.50 segment facility handler */
3369     int (*bend_segment)(void *handle, bend_segment_rr *rr);
3370     /** \brief SRU explain handler */
3371     int (*bend_explain)(void *handle, bend_explain_rr *rr);
3372     /** \brief SRU scan handler */
3373     int (*bend_srw_scan)(void *handle, bend_scan_rr *rr);
3374     /** \brief SRU record update handler */
3375     int (*bend_srw_update)(void *handle, bend_update_rr *rr);
3376
3377     /** \brief whether named result sets are supported (0=disable, 1=enable) */
3378     int named_result_sets;
3379 } bend_initrequest;
3380
3381 typedef struct bend_initresult
3382 {
3383     int errcode;               /* 0==OK */
3384     char *errstring;           /* system error string or NULL */
3385     void *handle;              /* private handle to the backend module */
3386 } bend_initresult;
3387     </synopsis>
3388     <para>
3389      In general, the server frontend expects that the
3390      <literal>bend_*result</literal> pointer that you return is valid at
3391      least until the next call to a <literal>bend_* function</literal>.
3392      This applies to all of the functions described herein. The parameter
3393      structure passed to you in the call belongs to the server frontend, and
3394      you should not make assumptions about its contents after the current
3395      function call has completed. In other words, if you want to retain any
3396      of the contents of a request structure, you should copy them.
3397     </para>
3398     <para>
3399      The <literal>errcode</literal> should be zero if the initialization of
3400      the backend went well. Any other value will be interpreted as an error.
3401      The <literal>errstring</literal> isn't used in the current version, but
3402      one option would be to stick it in the initResponse as a VisibleString.
3403      The <literal>handle</literal> is the most important parameter. It should
3404      be set to some value that uniquely identifies the current session to
3405      the backend implementation. It is used by the frontend server in any
3406      future calls to a backend function.
3407      The typical use is to set it to point to a dynamically allocated state
3408      structure that is private to your backend module.
3409     </para>
3410     <para>
3411      The <literal>auth</literal> member holds the authentication information
3412      part of the Z39.50 Initialize Request. Interpret this if your serves
3413      requires authentication.
3414     </para>
3415     <para>
3416      The members <literal>peer_name</literal>,
3417      <literal>implementation_id</literal>,
3418      <literal>implementation_name</literal> and
3419      <literal>implementation_version</literal> holds
3420      DNS of client, ID of implementor, name
3421      of client (Z39.50) implementation - and version.
3422     </para>
3423     <para>
3424      The <literal>bend_</literal> - members are set to NULL when
3425      <function>bend_init</function> is called. Modify the pointers by
3426      setting them to point to backend functions.
3427     </para>
3428    </sect2>
3429    <sect2 id="server.search.retrieve">
3430     <title>Search and Retrieve</title>
3431     <para>
3432      We now describe the handlers that are required to support search -
3433      and retrieve. You must support two functions - one for search - and one
3434      for fetch (retrieval of one record). If desirable you can provide a
3435      third handler which is called when a present request is received which
3436      allows you to optimize retrieval of multiple-records.
3437     </para>
3438     <synopsis>
3439 int (*bend_search) (void *handle, bend_search_rr *rr);
3440
3441 typedef struct {
3442     char *setname;             /* name to give to this set */
3443     int replace_set;           /* replace set, if it already exists */
3444     int num_bases;             /* number of databases in list */
3445     char **basenames;          /* databases to search */
3446     Z_ReferenceId *referenceId;/* reference ID */
3447     Z_Query *query;            /* query structure */
3448     ODR stream;                /* encode stream */
3449     ODR decode;                /* decode stream */
3450     ODR print;                 /* print stream */
3451
3452     bend_request request;
3453     bend_association association;
3454     int *fd;
3455     int hits;                  /* number of hits */
3456     int errcode;               /* 0==OK */
3457     char *errstring;           /* system error string or NULL */
3458     Z_OtherInformation *search_info; /* additional search info */
3459     char *srw_sortKeys;        /* holds SRU/SRW sortKeys info */
3460     char *srw_setname;         /* holds SRU/SRW generated resultsetID */
3461     int *srw_setnameIdleTime;  /* holds SRU/SRW life-time */
3462     int estimated_hit_count;   /* if hit count is estimated */
3463     int partial_resultset;     /* if result set is partial */
3464 } bend_search_rr;
3465     </synopsis>
3466     <para>
3467      The <function>bend_search</function> handler is a fairly close
3468      approximation of a protocol Z39.50 Search Request - and Response PDUs
3469      The <literal>setname</literal> is the resultSetName from the protocol.
3470      You are required to establish a mapping between the set name and whatever
3471      your backend database likes to use.
3472      Similarly, the <literal>replace_set</literal> is a boolean value
3473      corresponding to the resultSetIndicator field in the protocol.
3474      <literal>num_bases/basenames</literal> is a length of/array of character
3475      pointers to the database names provided by the client.
3476      The <literal>query</literal> is the full query structure as defined in
3477      the protocol ASN.1 specification.
3478      It can be either of the possible query types, and it's up to you to
3479      determine if you can handle the provided query type.
3480      Rather than reproduce the C interface here, we'll refer you to the
3481      structure definitions in the file
3482      <filename>include/yaz/z-core.h</filename>. If you want to look at the
3483      attributeSetId OID of the RPN query, you can either match it against
3484      your own internal tables, or you can use the <link linkend="tools.oid">
3485      OID tools</link>.
3486     </para>
3487     <para>
3488      The structure contains a number of hits, and an
3489      <literal>errcode/errstring</literal> pair. If an error occurs
3490      during the search, or if you're unhappy with the request, you should
3491      set the errcode to a value from the BIB-1 diagnostic set. The value
3492      will then be returned to the user in a nonsurrogate diagnostic record
3493      in the response. The <literal>errstring</literal>, if provided, will
3494      go in the addinfo field. Look at the protocol definition for the
3495      defined error codes, and the suggested uses of the addinfo field.
3496     </para>
3497     <para>
3498      The <function>bend_search</function> handler is also called when
3499      the frontend server receives a SRU SearchRetrieveRequest.
3500      For SRU, a CQL query is usually provided by the client.
3501      The CQL query is available as part of <literal>Z_Query</literal>
3502      structure (note that CQL is now part of Z39.50 via an external).
3503      To support CQL in existing implementations that only do Type-1,
3504      we refer to the CQL-to-PQF tool described
3505      <link linkend="cql.to.pqf">here</link>.
3506     </para>
3507     <para>
3508      To maintain backwards compatibility, the frontend server
3509      of yaz always assume that error codes are BIB-1 diagnostics.
3510      For SRU operation, a Bib-1 diagnostic code is mapped to
3511      SRU diagnostic.
3512     </para>
3513     <synopsis>
3514 int (*bend_fetch) (void *handle, bend_fetch_rr *rr);
3515
3516 typedef struct bend_fetch_rr {
3517     char *setname;             /* set name */
3518     int number;                /* record number */
3519     Z_ReferenceId *referenceId;/* reference ID */
3520     Odr_oid *request_format;        /* format, transfer syntax (OID) */
3521     Z_RecordComposition *comp; /* Formatting instructions */
3522     ODR stream;                /* encoding stream - memory source if req */
3523     ODR print;                 /* printing stream */
3524
3525     char *basename;            /* name of database that provided record */
3526     int len;                   /* length of record or -1 if structured */
3527     char *record;              /* record */
3528     int last_in_set;           /* is it?  */
3529     Odr_oid *output_format;        /* response format/syntax (OID) */
3530     int errcode;               /* 0==success */
3531     char *errstring;           /* system error string or NULL */
3532     int surrogate_flag;        /* surrogate diagnostic */
3533     char *schema;              /* string record schema input/output */
3534 } bend_fetch_rr;
3535     </synopsis>
3536     <para>
3537      The frontend server calls the <function>bend_fetch</function> handler
3538      when it needs database records to fulfill a Z39.50 Search Request, a
3539      Z39.50 Present Request or a SRU SearchRetrieveRequest.
3540      The <literal>setname</literal> is simply the name of the result set
3541      that holds the reference to the desired record.
3542      The <literal>number</literal> is the offset into the set (with 1
3543      being the first record in the set). The <literal>format</literal> field
3544      is the record format requested by the client (See
3545      <xref linkend="tools.oid"/>).
3546      A value of NULL for <literal>format</literal> indicates that the
3547      client did not request a specific format.
3548      The <literal>stream</literal> argument is an &odr; stream which
3549      should be used for allocating space for structured data records.
3550      The stream will be reset when all records have been assembled, and
3551      the response package has been transmitted.
3552      For unstructured data, the backend is responsible for maintaining a
3553      static or dynamic buffer for the record between calls.
3554     </para>
3555     <para>
3556      If a SRU SearchRetrieveRequest is received by the frontend server,
3557      the <literal>referenceId</literal> is NULL and the
3558      <literal>format</literal> (transfer syntax) is the OID for XML.
3559      The schema for SRU is stored in both the
3560      <literal>Z_RecordComposition</literal>
3561      structure and <literal>schema</literal> (simple string).
3562     </para>
3563     <para>
3564      In the structure, the <literal>basename</literal> is the name of the
3565      database that holds the
3566      record. <literal>len</literal> is the length of the record returned, in
3567      bytes, and <literal>record</literal> is a pointer to the record.
3568      <literal>last_in_set</literal> should be nonzero only if the record
3569      returned is the last one in the given result set.
3570      <literal>errcode</literal> and <literal>errstring</literal>, if
3571      given, will be interpreted as a global error pertaining to the
3572      set, and will be returned in a non-surrogate-diagnostic.
3573      If you wish to return the error as a surrogate-diagnostic
3574      (local error) you can do this by setting
3575      <literal>surrogate_flag</literal> to 1 also.
3576     </para>
3577     <para>
3578      If the <literal>len</literal> field has the value -1, then
3579      <literal>record</literal> is assumed to point to a constructed data
3580      type. The <literal>format</literal> field will be used to determine
3581      which encoder should be used to serialize the data.
3582     </para>
3583     <note>
3584      <para>
3585       If your backend generates structured records, it should use
3586       <function>odr_malloc()</function> on the provided stream for allocating
3587       data: This allows the frontend server to keep track of the record sizes.
3588      </para>
3589     </note>
3590     <para>
3591      The <literal>format</literal> field is mapped to an object identifier
3592      in the direct reference of the resulting EXTERNAL representation
3593      of the record.
3594     </para>
3595     <note>
3596      <para>
3597       The current version of &yaz; only supports the direct reference mode.
3598      </para>
3599     </note>
3600     <synopsis>
3601 int (*bend_present) (void *handle, bend_present_rr *rr);
3602
3603 typedef struct {
3604     char *setname;             /* set name */
3605     int start;
3606     int number;                /* record number */
3607     Odr_oid *format;           /* format, transfer syntax (OID) */
3608     Z_ReferenceId *referenceId;/* reference ID */
3609     Z_RecordComposition *comp; /* Formatting instructions */
3610     ODR stream;                /* encoding stream - memory source if required */
3611     ODR print;                 /* printing stream */
3612     bend_request request;
3613     bend_association association;
3614
3615     int hits;                  /* number of hits */
3616     int errcode;               /* 0==OK */
3617     char *errstring;           /* system error string or NULL */
3618 } bend_present_rr;
3619     </synopsis>
3620     <para>
3621      The <function>bend_present</function> handler is called when
3622      the server receives a Z39.50 Present Request.
3623      The <literal>setname</literal>,
3624      <literal>start</literal> and <literal>number</literal> is the
3625      name of the result set - start position - and number of records to
3626      be retrieved respectively. <literal>format</literal> and
3627      <literal>comp</literal> is the preferred transfer syntax and element
3628      specifications of the present request.
3629     </para>
3630     <para>
3631      Note that this is handler serves as a supplement for
3632      <function>bend_fetch</function> and need not to be defined in order to
3633      support search - and retrieve.
3634     </para>
3635    </sect2>
3636    <sect2 id="server.delete">
3637     <title>Delete</title>
3638     <para>
3639      For back-ends that supports delete of a result set only one handler
3640      must be defined.
3641     </para>
3642     <synopsis>
3643 int (*bend_delete)(void *handle, bend_delete_rr *rr);
3644
3645 typedef struct bend_delete_rr {
3646     int function;
3647     int num_setnames;
3648     char **setnames;
3649     Z_ReferenceId *referenceId;
3650     int delete_status;      /* status for the whole operation */
3651     int *statuses;          /* status each set - indexed as setnames */
3652     ODR stream;
3653     ODR print;
3654 } bend_delete_rr;
3655     </synopsis>
3656     <note>
3657      <para>
3658       The delete set function definition is rather primitive, mostly because
3659       we have had no practical need for it as of yet. If someone wants
3660       to provide a full delete service, we'd be happy to add the
3661       extra parameters that are required. Are there clients out there
3662       that will actually delete sets they no longer need?
3663      </para>
3664     </note>
3665    </sect2>
3666    <sect2 id="server.scan">
3667     <title>Scan</title>
3668     <para>
3669      For servers that wish to offer the scan service one handler
3670      must be defined.
3671     </para>
3672     <synopsis>
3673 int (*bend_scan)(void *handle, bend_scan_rr *rr);
3674
3675 typedef enum {
3676     BEND_SCAN_SUCCESS,  /* ok */
3677     BEND_SCAN_PARTIAL   /* not all entries could be found */
3678 } bend_scan_status;
3679
3680 typedef struct bend_scan_rr {
3681     int num_bases;      /* number of elements in databaselist */
3682     char **basenames;   /* databases to search */
3683     Odr_oid *attributeset;
3684     Z_ReferenceId *referenceId; /* reference ID */
3685     Z_AttributesPlusTerm *term;
3686     ODR stream;         /* encoding stream - memory source if required */
3687     ODR print;          /* printing stream */
3688
3689     int *step_size;     /* step size */
3690     int term_position;  /* desired index of term in result list/returned */
3691     int num_entries;    /* number of entries requested/returned */
3692
3693     /* scan term entries. The called handler does not have
3694        to allocate this. Size of entries is num_entries (see above) */
3695     struct scan_entry *entries;
3696     bend_scan_status status;
3697     int errcode;
3698     char *errstring;
3699     char *scanClause;   /* CQL scan clause */
3700     char *setname;      /* Scan in result set (NULL if omitted) */
3701 } bend_scan_rr;
3702     </synopsis>
3703    <para>
3704     This backend server handles both Z39.50 scan
3705     and SRU scan. In order for a handler to distinguish between SRU (CQL) scan
3706     Z39.50 Scan , it must check for a non-NULL value of
3707     <literal>scanClause</literal>.
3708    </para>
3709    <note>
3710     <para>
3711      if designed today, it would be a choice using a union or similar,
3712      but that would break binary compatibility with existing servers.
3713     </para>
3714     </note>
3715    </sect2>
3716   </sect1>
3717   <sect1 id="server.invocation">
3718    <title>Application Invocation</title>
3719    <para>
3720     The finished application has the following
3721     invocation syntax (by way of <function>statserv_main()</function>):
3722    </para>
3723    &gfs-synopsis;
3724    <para>
3725     The options are:
3726     &gfs-options;
3727    </para>
3728    <para>
3729     A listener specification consists of a transport mode followed by a
3730     colon (:) followed by a listener address. The transport mode is
3731     either <literal>tcp</literal>, <literal>unix:</literal> or
3732     <literal>ssl</literal>.
3733    </para>
3734    <para>
3735     For TCP and SSL, an address has the form
3736    </para>
3737    <synopsis>
3738     hostname | IP-number [: portnumber]
3739    </synopsis>
3740    <para>
3741     The port number defaults to 210 (standard Z39.50 port).
3742    </para>
3743    <para>
3744     For UNIX, the address is the filename of socket.
3745    </para>
3746    <para>
3747     For TCP/IP and SSL, the special hostnames <literal>@</literal>,
3748     maps to <literal>IN6ADDR_ANY_INIT</literal> with
3749     IPV4 binding as well (bindv6only=0),
3750     The special hostname <literal>@4</literal> binds to
3751     <literal>INADDR_ANY</literal> (IPV4 only listener).
3752     The special hostname <literal>@6</literal> binds to
3753     <literal>IN6ADDR_ANY_INIT</literal> with bindv6only=1 (IPV6 only listener).
3754    </para>
3755    <example id="server.example.running.unix">
3756     <title>Running the GFS on Unix</title>
3757     <para>
3758      Assuming the server application <replaceable>appname</replaceable> is
3759      started as root, the following will make it listen on port 210.
3760      The server will change identity to <literal>nobody</literal>
3761      and write its log to <filename>/var/log/app.log</filename>.
3762      <screen>
3763       application -l /var/log/app.log -u nobody tcp:@:210
3764      </screen>
3765     </para>
3766     <para>
3767      The server will accept Z39.50 requests and offer SRU service on port 210.
3768     </para>
3769    </example>
3770    <example id="server.example.apache.sru">
3771     <title>Setting up Apache as SRU Frontend</title>
3772     <para>
3773      If you use <ulink url="&url.apache;">Apache</ulink>
3774      as your public web server and want to offer HTTP port 80
3775      access to the YAZ server on 210, you can use the
3776      <ulink url="&url.apache.directive.proxypass;">
3777       <literal>ProxyPass</literal></ulink>
3778      directive.
3779      If you have virtual host
3780      <literal>srw.mydomain</literal> you can use the following directives
3781      in Apache's httpd.conf:
3782      <screen>
3783       &lt;VirtualHost *>
3784        ErrorLog /home/srw/logs/error_log
3785        TransferLog /home/srw/logs/access_log
3786        ProxyPass / http://srw.mydomain:210/
3787       &lt;/VirtualHost>
3788      </screen>
3789     </para>
3790     <para>
3791      The above for the Apache 1.3 series.
3792     </para>
3793    </example>
3794    <example id="server.example.local.access">
3795     <title>Running a server with local access only</title>
3796     <para>
3797      Servers that is only being accessed from the local host should listen
3798      on UNIX file socket rather than a Internet socket. To listen on
3799      <filename>/tmp/mysocket</filename> start the server as follows:
3800      <screen>
3801       application unix:/tmp/mysocket
3802      </screen>
3803     </para>
3804    </example>
3805   </sect1>
3806   <sect1 id="server.vhosts">
3807    <title>GFS Configuration and Virtual Hosts</title>
3808    &gfs-virtual;
3809   </sect1>
3810  </chapter>
3811  <chapter id="asn">
3812   <title>The Z39.50 ASN.1 Module</title>
3813   <sect1 id="asn.introduction">
3814    <title>Introduction</title>
3815    <para>
3816     The &asn; module provides you with a set of C struct definitions for the
3817     various PDUs of the Z39.50 protocol, as well as for the complex types
3818     appearing within the PDUs. For the primitive data types, the C
3819     representation often takes the form of an ordinary C language type,
3820     such as <literal>Odr_int</literal> which is equivalent to an integral
3821     C integer. For ASN.1 constructs that have no direct
3822     representation in C, such as general octet strings and bit strings,
3823     the &odr; module (see section <link linkend="odr">The ODR Module</link>)
3824     provides auxiliary definitions.
3825    </para>
3826    <para>
3827     The &asn; module is located in sub directory <filename>z39.50</filename>.
3828     There you'll find C files that implements encoders and decoders for the
3829     Z39.50 types. You'll also find the protocol definitions:
3830     <filename>z3950v3.asn</filename>, <filename>esupdate.asn</filename>,
3831     and others.
3832    </para>
3833   </sect1>
3834   <sect1 id="asn.preparing">
3835    <title>Preparing PDUs</title>
3836    <para>
3837     A structure representing a complex ASN.1 type doesn't in itself contain the
3838     members of that type. Instead, the structure contains
3839     <emphasis>pointers</emphasis> to the members of the type.
3840     This is necessary, in part, to allow a mechanism for specifying which
3841     of the optional structure (SEQUENCE) members are present, and which
3842     are not. It follows that you will need to somehow provide space for
3843     the individual members of the structure, and set the pointers to
3844     refer to the members.
3845    </para>
3846    <para>
3847     The conversion routines don't care how you allocate and maintain your
3848     C structures - they just follow the pointers that you provide.
3849     Depending on the complexity of your application, and your personal
3850     taste, there are at least three different approaches that you may take
3851     when you allocate the structures.
3852    </para>
3853    <para>
3854     You can use static or automatic local variables in the function that
3855     prepares the PDU. This is a simple approach, and it provides the most
3856     efficient form of memory management. While it works well for flat
3857     PDUs like the InitReqest, it will generally not be sufficient for say,
3858     the generation of an arbitrarily complex RPN query structure.
3859    </para>
3860    <para>
3861     You can individually create the structure and its members using the
3862     <function>malloc(2)</function> function. If you want to ensure that
3863     the data is freed when it is no longer needed, you will have to
3864     define a function that individually releases each member of a
3865     structure before freeing the structure itself.
3866    </para>
3867    <para>
3868     You can use the <function>odr_malloc()</function> function (see
3869     <xref linkend="odr.use"/> for details). When you use
3870     <function>odr_malloc()</function>, you can release all of the
3871     allocated data in a single operation, independent of any pointers and
3872     relations between the data. <function>odr_malloc()</function> is based on a
3873     &quot;nibble-memory&quot;
3874     scheme, in which large portions of memory are allocated, and then
3875     gradually handed out with each call to <function>odr_malloc()</function>.
3876     The next time you call <function>odr_reset()</function>, all of the
3877     memory allocated since the last call is recycled for future use (actually,
3878     it is placed on a free-list).
3879    </para>
3880    <para>
3881     You can combine all of the methods described here. This will often be
3882     the most practical approach. For instance, you might use
3883     <function>odr_malloc()</function> to allocate an entire structure and
3884     some of its elements, while you leave other elements pointing to global
3885     or per-session default variables.
3886    </para>
3887    <para>
3888     The &asn; module provides an important aid in creating new PDUs. For
3889     each of the PDU types (say, <function>Z_InitRequest</function>), a
3890     function is provided that allocates and initializes an instance of
3891     that PDU type for you. In the case of the InitRequest, the function is
3892     simply named <function>zget_InitRequest()</function>, and it sets up
3893     reasonable default value for all of the mandatory members. The optional
3894     members are generally initialized to null pointers. This last aspect
3895     is very important: it ensures that if the PDU definitions are
3896     extended after you finish your implementation (to accommodate
3897     new versions of the protocol, say), you won't get into trouble with
3898     uninitialized pointers in your structures. The functions use
3899     <function>odr_malloc()</function> to
3900     allocate the PDUs and its members, so you can free everything again with a
3901     single call to <function>odr_reset()</function>. We strongly recommend
3902     that you use the <literal>zget_*</literal>
3903     functions whenever you are preparing a PDU (in a C++ API, the
3904     <literal>zget_</literal>
3905     functions would probably be promoted to constructors for the
3906     individual types).
3907    </para>
3908    <para>
3909    The prototype for the individual PDU types generally look like this:
3910    </para>
3911    <synopsis>
3912     Z_&lt;type> *zget_&lt;type>(ODR o);
3913    </synopsis>
3914    <para>
3915     eg.:
3916    </para>
3917    <synopsis>
3918     Z_InitRequest *zget_InitRequest(ODR o);
3919    </synopsis>
3920    <para>
3921    The &odr; handle should generally be your encoding stream, but it
3922     needn't be.
3923    </para>
3924    <para>
3925     As well as the individual PDU functions, a function
3926     <function>zget_APDU()</function> is provided, which allocates
3927     a top-level Z-APDU of the type requested:
3928    </para>
3929    <synopsis>
3930     Z_APDU *zget_APDU(ODR o, int which);
3931    </synopsis>
3932    <para>
3933     The <varname>which</varname> parameter is (of course) the discriminator
3934     belonging to the <varname>Z_APDU</varname> <literal>CHOICE</literal> type.
3935     All of the interface described here is provided by the &asn; module, and
3936     you access it through the <filename>proto.h</filename> header file.
3937    </para>
3938   </sect1>
3939   <sect1 id="asn.external">
3940    <title>EXTERNAL Data</title>
3941    <para>
3942     In order to achieve extensibility and adaptability to different
3943     application domains, the new version of the protocol defines many
3944     structures outside of the main ASN.1 specification, referencing them
3945     through ASN.1 EXTERNAL constructs. To simplify the construction and
3946     access to the externally referenced data, the &asn; module defines a
3947     specialized version of the EXTERNAL construct, called
3948     <literal>Z_External</literal>.It is defined thus:
3949    </para>
3950    <screen>
3951 typedef struct Z_External
3952 {
3953     Odr_oid *direct_reference;
3954     int *indirect_reference;
3955     char *descriptor;
3956     enum
3957     {
3958         /* Generic types */
3959         Z_External_single = 0,
3960         Z_External_octet,
3961         Z_External_arbitrary,
3962
3963         /* Specific types */
3964         Z_External_SUTRS,
3965         Z_External_explainRecord,
3966         Z_External_resourceReport1,
3967         Z_External_resourceReport2
3968
3969     ...
3970
3971     } which;
3972     union
3973     {
3974         /* Generic types */
3975         Odr_any *single_ASN1_type;
3976         Odr_oct *octet_aligned;
3977         Odr_bitmask *arbitrary;
3978
3979         /* Specific types */
3980         Z_SUTRS *sutrs;
3981         Z_ExplainRecord *explainRecord;
3982         Z_ResourceReport1 *resourceReport1;
3983         Z_ResourceReport2 *resourceReport2;
3984
3985         ...
3986
3987     } u;
3988 } Z_External;
3989    </screen>
3990    <para>
3991     When decoding, the &asn; module will attempt to determine which
3992     syntax describes the data by looking at the reference fields
3993     (currently only the direct-reference). For ASN.1 structured data, you
3994     need only consult the <literal>which</literal> field to determine the
3995     type of data. You can the access  the data directly through the union.
3996     When constructing data for encoding, you set the union pointer to point
3997     to the data, and set the <literal>which</literal> field accordingly.
3998     Remember also to set the direct (or indirect) reference to the correct
3999     OID for the data type.
4000     For non-ASN.1 data such as MARC records, use the
4001     <literal>octet_aligned</literal> arm of the union.
4002    </para>
4003    <para>
4004     Some servers return ASN.1 structured data values (eg. database
4005     records) as BER-encoded records placed in the
4006     <literal>octet-aligned</literal> branch of the EXTERNAL CHOICE.
4007     The ASN-module will <emphasis>not</emphasis> automatically decode
4008     these records. To help you decode the records in the application, the
4009     function
4010    </para>
4011    <screen>
4012    Z_ext_typeent *z_ext_gettypebyref(const oid *oid);
4013    </screen>
4014    <para>
4015     Can be used to retrieve information about the known, external data
4016     types. The function return a pointer to a static area, or NULL, if no
4017     match for the given direct reference is found. The
4018     <literal>Z_ext_typeent</literal>
4019     is defined as:
4020    </para>
4021    <screen>
4022 typedef struct Z_ext_typeent
4023 {
4024     int oid[OID_SIZE]; /* the direct-reference OID. */
4025     int what;          /* discriminator value for the external CHOICE */
4026     Odr_fun fun;       /* decoder function */
4027 } Z_ext_typeent;
4028    </screen>
4029    <para>
4030     The <literal>what</literal> member contains the
4031     <literal>Z_External</literal> union discriminator value for the
4032     given type: For the SUTRS record syntax, the value would be
4033     <literal>Z_External_sutrs</literal>.
4034     The <literal>fun</literal> member contains a pointer to the
4035     function which encodes/decodes the given type. Again, for the SUTRS
4036     record syntax, the value of <literal>fun</literal> would be
4037     <literal>z_SUTRS</literal> (a function pointer).
4038    </para>
4039    <para>
4040     If you receive an EXTERNAL which contains an octet-string value that
4041     you suspect of being an ASN.1-structured data value, you can use
4042     <literal>z_ext_gettypebyref</literal> to look for the provided
4043     direct-reference.
4044     If the return value is different from NULL, you can use the provided
4045     function to decode the BER string (see <xref linkend="odr.use"/>
4046     ).
4047    </para>
4048    <para>
4049     If you want to <emphasis>send</emphasis> EXTERNALs containing
4050     ASN.1-structured values in the occtet-aligned branch of the CHOICE, this
4051     is possible too. However, on the encoding phase, it requires a somewhat
4052     involved juggling around of the various buffers involved.
4053    </para>
4054    <para>
4055     If you need to add new, externally defined data types, you must update
4056     the struct above, in the source file <filename>prt-ext.h</filename>, as
4057     well as the encoder/decoder in the file <filename>prt-ext.c</filename>.
4058     When changing the latter, remember to update both the
4059     <literal>arm</literal> arrary and the list
4060     <literal>type_table</literal>, which drives the CHOICE biasing that
4061     is necessary to tell the different, structured types apart
4062     on decoding.
4063    </para>
4064    <note>
4065     <para>
4066      Eventually, the EXTERNAL processing will most likely
4067      automatically insert the correct OIDs or indirect-refs. First,
4068      however, we need to determine how application-context management
4069      (specifically the presentation-context-list) should fit into the
4070      various modules.
4071     </para>
4072    </note>
4073   </sect1>
4074   <sect1 id="asn.pdu">