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"
5 <!ENTITY % local SYSTEM "local.ent">
7 <!ENTITY % entities SYSTEM "entities.ent">
9 <!ENTITY % idcommon SYSTEM "common/common.ent">
14 <title>YAZ User's Guide and Reference</title>
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>
22 <releaseinfo>&version;</releaseinfo>
24 <year>©right-year;</year>
25 <holder>Index Data</holder>
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
34 The documentation can be used on its own, or as a reference when
35 looking at the example applications provided with the package.
40 <imagedata fileref="common/id.png" format="PNG"/>
43 <imagedata fileref="common/id.eps" format="EPS"/>
48 <chapter id="introduction">
49 <title>Introduction</title>
51 &yaz; is a C/C++ library for information retrieval applications
52 using the Z39.50/SRU/Solr protocols for information retrieval.
60 <ulink url="&url.z39.50;">Z39.50</ulink> version 3 support.
61 Amendments and Z39.50-2002 revision is supported.
67 <ulink url="&url.sru;">SRU GET/POST/SOAP</ulink>
68 version 1.1, 1.2 and 2.0 (over HTTP and HTTPS).
73 Includes BER encoders/decoders for the
74 <ulink url="&url.ill;">ISO ILL</ulink>
81 <ulink url="&url.solr;">Solr</ulink> Web Service version 1.4.x
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>.
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).
104 <ulink url="&url.zoom;">ZOOM</ulink> C API implementing
105 Z39.50, SRU and Solr Web Service.
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.
119 Portable code. &yaz; compiles out-of-the box on most Unixes and
120 on Windows using Microsoft Visual C++.
125 Fast operation. The C based BER encoders/decoders as well
126 as the server component of &yaz; is very fast.
131 Liberal license that allows for commercial use of &yaz;.
137 <sect1 id="introduction.reading">
138 <title>Reading this Manual</title>
140 Most implementors only need to read a fraction of the
141 material in thie manual, so a quick walkthrough of the chapters
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
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
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.
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
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.
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.
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
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>
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"/>).
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.
221 <sect1 id="introduction.api">
222 <title>The API</title>
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>
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.
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
247 The YAZ toolkit modules is shown in figure <xref linkend="yaz.layer"/>.
249 <figure id="yaz.layer">
250 <title>YAZ layers</title>
253 <imagedata fileref="apilayer.png" format="PNG"/>
256 <imagedata fileref="apilayer.eps" format="EPS"/>
261 There are four layers.
264 <para>A client or server application (or both).
265 This layer includes ZOOM and the generic frontend server.
270 The second layer provides a C represenation of the
271 protocol units (packages) for Z39.50 ASN.1, ILL ASN.1,
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.
285 The lowest layer is &comstack; which exchanges the encoded packages
286 with a peer process over a network.
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.
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
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
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>
323 (note the lower-case "z" in the function name)
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"/>.
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.
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.
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;.
364 <chapter id="installation">
365 <title>Compilation and Installation</title>
366 <sect1 id="installation-introduction">
367 <title>Introduction</title>
369 The latest version of the software will generally be found at:
372 <ulink url="&url.yaz.download;"/>
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
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.
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>,
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),
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.
408 We maintain a mailing-list for the purpose of announcing new releases and
409 bug-fixes, as well as general discussion. Subscribe by
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
417 <sect1 id="installation.unix"><title>UNIX</title>
420 <ulink url="&url.debian;">Debian GNU/Linux</ulink> (i386 and amd64),
421 <ulink url="&url.ubuntu;">Ubuntu</ulink> (i386 and amd64)
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.
428 YAZ is also part of several packages repositories. Some of them are
433 Solaris CSW: <ulink url="http://www.opencsw.org/packages/yaz/"/>
438 Solaris: <ulink url="http://unixpackages.com"/>
443 FreeBSD: <ulink url="http://www.freshports.org/net/yaz"/>
448 Debian: <ulink url="http://packages.debian.org/search?keywords=yaz"/>
453 Ubuntu: <ulink url="https://launchpad.net/ubuntu/+source/yaz"/>
459 <ulink url="http://ftp.netbsd.org/pub/pkgsrc/current/pkgsrc/net/yaz/README.html"/>
463 <sect2 id="installation.source.unix">
464 <title>Compiling from source on Unix</title>
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>.
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
475 <ulink url="&url.libiconv;">GNU libiconv</ulink>.
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.
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.
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;.
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;.
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
515 Generally it should be sufficient to run configure without options,
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:
530 CC=/opt/ccs/bin/cc CFLAGS=-O ./configure
533 To customize &yaz;, the configure script also accepts a set of options.
534 The most important are:
538 <literal>--prefix</literal>=<replaceable>prefix</replaceable>
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.
550 <literal>--enable-tcpd</literal>
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
560 <refentrytitle>hosts_access</refentrytitle>
561 <manvolnum>5</manvolnum>
565 <refentrytitle>tcpd</refentrytitle>
566 <manvolnum>8</manvolnum>
573 <literal>--enable-threads</literal>
576 <para>&yaz; will be built using POSIX threads.
577 Specifically, <constant>_REENTRANT</constant> will be defined during
584 <literal>--disable-shared</literal>
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>.
596 <literal>--disable-shared</literal>
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>.
608 <literal>--with-iconv</literal>[=<replaceable>prefix</replaceable>]
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;
622 <literal>--with-xslt</literal>[=<replaceable>prefix</replaceable>]
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;
639 <literal>--with-xml2</literal>[=<replaceable>prefix</replaceable>]
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;
653 Note that option <literal>--with-xslt</literal>
654 also enables libxml2.
660 <literal>--with-gnutls</literal>[=<replaceable>prefix</replaceable>]
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
672 <literal>--with-icu</literal>[=<replaceable>prefix</replaceable>]
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.
685 <literal>--with-libgcrypt</literal>[=<replaceable>prefix</replaceable>]
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.
697 <literal>--with-memcached</literal>
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.
711 <literal>--with-redis</literal>
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.
726 When configured, build the software by typing:
732 The following files are generated by the make process:
735 <term><filename>src/libyaz.la</filename></term>
737 Main &yaz; library. This is no ordinary library. It's
739 By default, &yaz; creates a static library in
740 <filename>lib/.libs/libyaz.a</filename>.
744 <term><filename>src/libyaz_server.la</filename></term>
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.
752 <term><filename>src/libyaz_icu.la</filename></term>
754 Functions that wrap the ICU library.
758 <term><filename>ztest/yaz-ztest</filename></term>
759 <listitem><para>Test Z39.50 server.
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.
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
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.
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
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.
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
804 <term><filename>util/yaz-url</filename></term>
805 <listitem><para>This program is a simple HTTP page fetcher ala
810 <term><filename>zoom/zoomsh</filename></term>
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.
819 <term><filename>zoom/zoomtst1</filename>,
820 <filename>zoom/zoomtst2</filename>, ..</term>
822 Several small applications that demonstrates the ZOOM API.
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:
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>.
842 If you wish to perform an un-installation of &yaz;, use:
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>.
854 <sect2 id="installation-linking-yaz-unix">
855 <title>How to make apps using YAZ on UNIX</title>
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.
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.
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:
881 YAZCONFIG=/usr/local/bin/yaz-config
882 CFLAGS=`$(YAZCONFIG) --cflags`
883 LIBS=`$(YAZCONFIG) --libs`
885 $(CC) $(CFLAGS) -o myprog myprog.o $(LIBS)
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
896 #include <yaz/proto.h>
898 and <emphasis>not</emphasis>
900 #include <proto.h>
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.
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
919 CFLAGS=`$(YAZCONFIG) --cflags threads`
920 LIBS=`$(YAZCONFIG) --libs threads`
922 There is no need specify POSIX thread libraries in your Makefile.
923 The <literal>LIBS</literal> variable includes that as well.
927 <sect1 id="installation.win32">
928 <title>Windows</title>
929 <para>The easiest way to install YAZ on Windows is by downloading
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.
936 <sect2 id="installation.win32.source">
937 <title>Compiling from Source on Windows</title>
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 2013.
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:
952 <term><literal>DEBUG</literal></term>
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).
962 <term><literal>HAVE_TCL</literal>, <literal>TCL</literal></term>
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>.
971 If you do not have Tcl installed, set
972 <literal>HAVE_TCL</literal> to 0.
976 <term><literal>HAVE_BISON</literal>,
977 <literal>BISON</literal></term>
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>).
986 A Windows version of GNU Bison is part of
987 <ulink url="&url.gitwindows;">Git for Windows</ulink>.
991 <term><literal>HAVE_ICONV</literal>,
992 <literal>ICONV_DIR</literal></term>
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.
1000 <term><literal>HAVE_LIBXML2</literal>,
1001 <literal>LIBXML2_DIR</literal></term>
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.
1010 You can get pre-compiled Libxml2+Libxslt DLLs and headers from
1011 <ulink url="&url.libxml2.download.windows;">here</ulink>.
1012 Should you with to compile those libraries yourself, refer to
1013 to <xref linkend="installation.windows.libxml2"/>
1018 <term><literal>HAVE_LIBXSLT</literal>,
1019 <literal>LIBXSLT_DIR</literal></term>
1022 If <literal>HAVE_LIBXSLT</literal> is set to 1, YAZ is compiled
1023 with XSLT support. In this configuration, set
1024 <literal>LIBXSLT_DIR</literal> to the
1025 <ulink url="&url.libxslt;">libxslt</ulink> source directory.
1029 libxslt depends libxml2.
1035 <term><literal>HAVE_ICU</literal>,
1036 <literal>ICU_DIR</literal></term>
1039 If <literal>HAVE_ICU</literal> is set to 1, YAZ is compiled
1040 with <ulink url="&url.icu;">ICU</ulink> support.
1041 In this configuration, set
1042 <literal>ICU_DIR</literal> to the
1043 <ulink url="&url.icu;">ICU</ulink> source directory.
1050 When satisfied with the settings in the makefile, type
1057 If the <filename>nmake</filename> command is not found on your system
1058 you probably haven't defined the environment variables required to
1059 use that tool. To fix that, find and run the batch file
1060 <filename>vcvars32.bat</filename>. You need to run it from within
1061 the command prompt or set the environment variables "globally";
1062 otherwise it doesn't work.
1066 If you wish to recompile &yaz; - for example if you modify
1067 settings in the <filename>makefile</filename> you can delete
1068 object files, etc by running.
1074 The following files are generated upon successful compilation:
1077 <term><filename>bin/yaz&soversion;.dll</filename> /
1078 <filename>bin/yaz&soversion;d.dll</filename></term>
1080 &yaz; Release/Debug DLL.
1084 <term><filename>lib/yaz&soversion;.lib</filename> /
1085 <filename>lib/yaz&soversion;d.lib</filename></term>
1087 Import library for <filename>yaz&soversion;.dll</filename> /
1088 <filename>yaz&soversion;d.dll</filename>.
1092 <term><filename>bin/yaz_cond&soversion;.dll</filename> /
1093 <filename>bin/yaz_cond&soversion;d.dll</filename></term>
1095 Release/Debug DLL for condition variable utilities (condvar.c).
1099 <term><filename>lib/yaz_cond&soversion;.lib</filename> /
1100 <filename>lib/yaz_cond&soversion;d.lib</filename></term>
1102 Import library for <filename>yaz_cond&soversion;.dll</filename> /
1103 <filename>yaz_cond&soversion;d.dll</filename>.
1107 <term><filename>bin/yaz_icu&soversion;.dll</filename> /
1108 <filename>bin/yaz_icu&soversion;d.dll</filename></term>
1110 Release/Debug DLL for the ICU wrapper utility.
1111 Only build if HAVE_ICU is 1.
1115 <term><filename>lib/yaz_icu&soversion;.lib</filename> /
1116 <filename>lib/yaz_icu&soversion;d.lib</filename></term>
1118 Import library for <filename>yaz_icu&soversion;.dll</filename> /
1119 <filename>yaz_icu&soversion;d.dll</filename>.
1123 <term><filename>bin/yaz-ztest.exe</filename></term>
1125 Z39.50 multi-threaded test/example server. It's a WIN32
1126 console application.
1130 <term><filename>bin/yaz-client.exe</filename></term>
1132 &yaz; Z39.50 client application. It's a WIN32 console application.
1133 See chapter <link linkend="yaz-client">YAZ client</link> for more
1138 <term><filename>bin/yaz-icu.exe</filename></term>
1139 <listitem><para>This program exposes the ICU wrapper library if that
1140 is enabled for YAZ. Only if ICU is available this program is
1145 <term><filename>bin/zoomsh.exe</filename></term>
1147 Simple console application implemented on top of the
1148 <link linkend="zoom">ZOOM</link> functions.
1149 The application is a command line shell that allows you to enter
1150 simple commands to perform ZOOM operations.
1154 <term><filename>bin/zoomtst1.exe</filename>,
1155 <filename>bin/zoomtst2.exe</filename>, ..</term>
1157 Several small applications that demonstrates the ZOOM API.
1164 <sect2 id="installation-linking-yaz-win32">
1165 <title>How to make apps using YAZ on Windows</title>
1167 This section will go though the process of linking your Windows
1168 applications with &yaz;.
1171 Some people are confused by the fact that we use the nmake
1172 tool to build &yaz;. They think they have to do that too - in order
1173 to make their Windows applications work with &yaz;. The good news is that
1174 you don't have to. You can use the integrated environment of
1175 Visual Studio if desired for your own application.
1178 When setting up a project or Makefile you have to set the following:
1181 <term>include path</term>
1183 Set it to the <filename>include</filename> directory of &yaz;.
1187 <term>import library <filename>yaz&soversion;.lib</filename></term>
1189 You must link with this library. It's located in the
1190 sub directory <filename>lib</filename> of &yaz;.
1191 If you want to link with the debug version of &yaz;, you must
1192 link against <filename>yaz&soversion;d.lib</filename> instead.
1196 <term>dynamic link library
1197 <filename>yaz&soversion;.dll</filename>
1200 This DLL must be in your execution path when you invoke
1201 your application. Specifically, you should distribute this
1202 DLL with your application.
1209 <sect2 id="installation.windows.libxml2">
1210 <title>Compiling Libxml2 and Libxslt on windows</title>
1212 Download libxml2 and Libxslt source and unpack it.
1213 In the example below we install Libxml2 2.9.2 and Libxslt 1.1.28
1214 for 32-bit, so we use the destination directories
1215 libxml2.2.9.2.win32 and libxslt-1.1.28.win32 to reflect both
1216 version and architecture.
1219 cscript configure.js prefix=c:\libxml2-2.9.2.win32 iconv=no
1225 For Libxslt it is similar. We must ensure that compilation of
1226 Libxslt links against the already installed libxml2.
1229 cscript configure.js prefix=c:\libxslt-1.1.28.win32 iconv=no \
1230 lib=c:\libxmlt-2.9.2.win32\lib \
1231 include=c:\libxmlt-2.9.2.win32\include\libxml2
1241 ### Still to document:
1242 ZOOM_connection_errcode(c)
1243 ZOOM_connection_errmsg(c)
1244 ZOOM_connection_addinfo(c)
1245 ZOOM_connection_addinfo(c)
1246 ZOOM_connection_diagset(c);
1247 ZOOM_connection_save_apdu_wrbuf
1248 ZOOM_diag_str(error)
1249 ZOOM_resultset_record_immediate(s, pos)
1250 ZOOM_resultset_cache_reset(r)
1251 ZOOM_options_set_callback(opt, function, handle)
1252 ZOOM_options_create_with_parent2(parent1, parent2)
1253 ZOOM_options_getl(opt, name, len)
1254 ZOOM_options_setl(opt, name, value, len)
1255 ZOOM_options_get_bool(opt, name, defa)
1256 ZOOM_options_get_int(opt, name, defa)
1257 ZOOM_options_set_int(opt, name, value)
1262 &zoom; is an acronym for 'Z39.50 Object-Orientation Model' and is
1263 an initiative started by Mike Taylor (Mike is from the UK, which
1264 explains the peculiar name of the model). The goal of &zoom; is to
1265 provide a common Z39.50 client API not bound to a particular
1266 programming language or toolkit.
1269 From YAZ version 2.1.12, <ulink url="&url.sru;">SRU</ulink> is supported.
1270 You can make SRU ZOOM connections by specifying scheme
1271 <literal>http://</literal> for the hostname for a connection.
1272 The dialect of SRU used is specified by the value of the
1273 connection's <literal>sru</literal> option, which may be SRU over
1274 HTTP GET (<literal>get</literal>),
1275 SRU over HTTP POST (<literal>post</literal>), (SRU over
1276 SOAP) (<literal>soap</literal>) or <literal>solr</literal>
1277 (<ulink url="&url.solr;">Solr</ulink> Web Service).
1278 Using the facility for embedding options in target strings, a
1279 connection can be forced to use SRU rather the SRW (the default) by
1280 prefixing the target string with <literal>sru=get,</literal>, like this:
1281 <literal>sru=get,http://sru.miketaylor.org.uk:80/sru.pl</literal>
1284 <ulink url="&url.solr;">Solr</ulink> protocol support was added to
1285 YAZ in version 4.1.0, as a dialect of a SRU protocol, since both are
1286 HTTP based protocols.
1289 The lack of a simple Z39.50 client API for &yaz; has become more
1290 and more apparent over time. So when the first &zoom; specification
1292 an implementation for &yaz; was quickly developed. For the first time, it is
1293 now as easy (or easier!) to develop clients than servers with &yaz;. This
1294 chapter describes the &zoom; C binding. Before going further, please
1295 reconsider whether C is the right programming language for the job.
1296 There are other language bindings available for &yaz;, and still
1298 are in active development. See the
1299 <ulink url="&url.zoom;">ZOOM web-site</ulink> for
1303 In order to fully understand this chapter you should read and
1304 try the example programs <literal>zoomtst1.c</literal>,
1305 <literal>zoomtst2.c</literal>, .. in the <literal>zoom</literal>
1309 The C language misses features found in object oriented languages
1310 such as C++, Java, etc. For example, you'll have to manually,
1311 destroy all objects you create, even though you may think of them as
1312 temporary. Most objects has a <literal>_create</literal> - and a
1313 <literal>_destroy</literal> variant.
1314 All objects are in fact pointers to internal stuff, but you don't see
1315 that because of typedefs. All destroy methods should gracefully ignore a
1316 <literal>NULL</literal> pointer.
1319 In each of the sections below you'll find a sub section called
1320 protocol behavior, that describes how the API maps to the Z39.50
1323 <sect1 id="zoom-connections">
1324 <title>Connections</title>
1325 <para>The Connection object is a session with a target.
1328 #include <yaz/zoom.h>
1330 ZOOM_connection ZOOM_connection_new(const char *host, int portnum);
1332 ZOOM_connection ZOOM_connection_create(ZOOM_options options);
1334 void ZOOM_connection_connect(ZOOM_connection c, const char *host,
1336 void ZOOM_connection_destroy(ZOOM_connection c);
1339 Connection objects are created with either function
1340 <function>ZOOM_connection_new</function> or
1341 <function>ZOOM_connection_create</function>.
1342 The former creates and automatically attempts to establish a network
1343 connection with the target. The latter doesn't establish
1344 a connection immediately, thus allowing you to specify options
1345 before establishing network connection using the function
1346 <function>ZOOM_connection_connect</function>.
1347 If the port number, <literal>portnum</literal>, is zero, the
1348 <literal>host</literal> is consulted for a port specification.
1349 If no port is given, 210 is used. A colon denotes the beginning of
1350 a port number in the host string. If the host string includes a
1351 slash, the following part specifies a database for the connection.
1354 You can prefix the host with a scheme followed by colon. The
1355 default scheme is <literal>tcp</literal> (Z39.50 protocol).
1356 The scheme <literal>http</literal> selects SRU/get over HTTP by default,
1357 but can overridded to use SRU/post, SRW and the Solr protocol.
1360 You can prefix the scheme-qualified host-string with one or more
1362 <literal><parameter>key</parameter>=<parameter>value</parameter></literal>
1363 sequences, each of which represents an option to be set into the
1364 connection structure <emphasis>before</emphasis> the
1365 protocol-level connection is forged and the initialization
1366 handshake takes place. This facility can be used to provide
1367 authentication credentials, as in host-strings such as:
1368 <literal>user=admin,password=halfAm4n,tcp:localhost:8017/db</literal>
1371 Connection objects should be destroyed using the function
1372 <function>ZOOM_connection_destroy</function>.
1375 void ZOOM_connection_option_set(ZOOM_connection c,
1376 const char *key, const char *val);
1378 void ZOOM_connection_option_setl(ZOOM_connection c,
1380 const char *val, int len);
1382 const char *ZOOM_connection_option_get(ZOOM_connection c,
1384 const char *ZOOM_connection_option_getl(ZOOM_connection c,
1389 The functions <function>ZOOM_connection_option_set</function> and
1390 <function>ZOOM_connection_option_setl</function> allows you to
1391 set an option given by <parameter>key</parameter> to the value
1392 <parameter>value</parameter> for the connection.
1393 For <function>ZOOM_connection_option_set</function>, the
1394 value is assumed to be a 0-terminated string. Function
1395 <function>ZOOM_connection_option_setl</function> specifies a
1396 value of a certain size (len).
1399 Functions <function>ZOOM_connection_option_get</function> and
1400 <function>ZOOM_connection_option_getl</function> returns
1401 the value for an option given by <parameter>key</parameter>.
1403 <table id="zoom-connection-options" frame="top">
1404 <title>ZOOM Connection Options</title>
1406 <colspec colwidth="4*" colname="name"></colspec>
1407 <colspec colwidth="7*" colname="description"></colspec>
1408 <colspec colwidth="3*" colname="default"></colspec>
1411 <entry>Option</entry>
1412 <entry>Description</entry>
1413 <entry>Default</entry>
1418 implementationName</entry><entry>Name of Your client
1419 </entry><entry>none</entry></row>
1421 user</entry><entry>Authentication user name
1422 </entry><entry>none</entry></row>
1424 group</entry><entry>Authentication group name
1425 </entry><entry>none</entry></row>
1427 password</entry><entry>Authentication password.
1428 </entry><entry>none</entry></row>
1430 authenticationMode</entry><entry>How authentication is encoded.
1431 </entry><entry>basic</entry></row>
1433 host</entry><entry>Target host. This setting is "read-only".
1434 It's automatically set internally when connecting to a target.
1435 </entry><entry>none</entry></row>
1437 proxy</entry><entry>Proxy host. If set, the logical host
1438 is encoded in the otherInfo area of the Z39.50 Init PDU
1439 with OID 1.2.840.10003.10.1000.81.1.
1440 </entry><entry>none</entry></row>
1442 clientIP</entry><entry>Client IP. If set, is
1443 encoded in the otherInfo area of a Z39.50 PDU with OID
1444 1.2.840.10003.10.1000.81.3. Holds the original IP addreses
1445 of a client. Is used of ZOOM is used in a gateway of some sort.
1446 </entry><entry>none</entry></row>
1448 async</entry><entry>If true (1) the connection operates in
1449 asynchronous operation which means that all calls are non-blocking
1451 <link linkend="zoom.events"><function>ZOOM_event</function></link>.
1452 </entry><entry>0</entry></row>
1454 maximumRecordSize</entry><entry> Maximum size of single record.
1455 </entry><entry>1 MB</entry></row>
1457 preferredMessageSize</entry><entry> Maximum size of multiple records.
1458 </entry><entry>1 MB</entry></row>
1460 lang</entry><entry> Language for negotiation.
1461 </entry><entry>none</entry></row>
1463 charset</entry><entry> Character set for negotiation.
1464 </entry><entry>none</entry></row>
1466 serverImplementationId</entry><entry>
1467 Implementation ID of server. (The old targetImplementationId
1468 option is also supported for the benefit of old applications.)
1469 </entry><entry>none</entry></row>
1471 targetImplementationName</entry><entry>
1472 Implementation Name of server. (The old
1473 targetImplementationName option is also supported for the
1474 benefit of old applications.)
1475 </entry><entry>none</entry></row>
1477 serverImplementationVersion</entry><entry>
1478 Implementation Version of server. (the old
1479 targetImplementationVersion option is also supported for the
1480 benefit of old applications.)
1481 </entry><entry>none</entry></row>
1483 databaseName</entry><entry>One or more database names
1484 separated by character plus (<literal>+</literal>), which to
1485 be used by subsequent search requests on this Connection.
1486 </entry><entry>Default</entry></row>
1488 piggyback</entry><entry>True (1) if piggyback should be
1489 used in searches; false (0) if not.
1490 </entry><entry>1</entry></row>
1492 smallSetUpperBound</entry><entry>If hits is less than or equal to this
1493 value, then target will return all records using small element set name
1494 </entry><entry>0</entry></row>
1496 largeSetLowerBound</entry><entry>If hits is greater than this
1497 value, the target will return no records.
1498 </entry><entry>1</entry></row>
1500 mediumSetPresentNumber</entry><entry>This value represents
1501 the number of records to be returned as part of a search when when
1502 hits is less than or equal to large set lower bound and if hits
1503 is greater than small set upper bound.
1504 </entry><entry>0</entry></row>
1506 smallSetElementSetName</entry><entry>
1507 The element set name to be used for small result sets.
1508 </entry><entry>none</entry></row>
1510 mediumSetElementSetName</entry><entry>
1511 The element set name to be for medium-sized result sets.
1512 </entry><entry>none</entry></row>
1514 init_opt_search, init_opt_present, init_opt_delSet, etc.</entry><entry>
1515 After a successful Init, these options may be interrogated to
1516 discover whether the server claims to support the specified
1518 </entry><entry>none</entry></row>
1520 <entry>sru</entry><entry>
1521 SRU/Solr transport type. Must be either <literal>soap</literal>,
1522 <literal>get</literal>, <literal>post</literal>, or
1523 <literal>solr</literal>.
1524 </entry><entry>soap</entry></row>
1526 sru_version</entry><entry>
1527 SRU/SRW version. Should be <literal>1.1</literal>, or
1528 <literal>1.2</literal>. This is , prior to connect, the version
1529 to offer (highest version). And following connect (in fact
1530 first operation), holds the negotiated version with the server
1531 (same or lower version).
1532 </entry><entry>1.2</entry></row>
1533 <row id="zoom.facets.option"><entry>
1534 facets</entry><entry>
1535 Requested or recommend facets may be given before a search is sent.
1536 The value of this setting is described in <xref linkend="facets"/>
1537 For inspection of the facets returned, refer to the functions
1538 described in <xref linkend="zoom.facets"/>.
1539 </entry><entry>none</entry></row>
1541 apdulog</entry><entry>
1542 If set to a true value such as "1", a log of low-level
1543 protocol packets is emitted on standard error stream. This
1544 can be very useful for debugging.
1545 </entry><entry>0</entry></row>
1547 saveAPDU</entry><entry>
1548 If set to a true value such as "1", a log of low-level
1549 protocol packets is saved. The log can be retrieved by reading
1550 option APDU. Setting saveAPDU always has the side effect of
1551 resetting the currently saved log. This setting is
1552 <emphasis>write-only</emphasis>. If read, NULL will be returned.
1553 It is only recognized in
1554 <function>ZOOM_connection_option_set</function>.
1555 </entry><entry>0</entry></row>
1558 Returns the log of protocol packets. Will be empty if logging
1559 is not enabled (see saveAPDU above). This setting is
1560 <emphasis>read-only</emphasis>. It is only recognized if used
1561 in call to <function>ZOOM_connection_option_get</function> or
1562 <function>ZOOM_connection_option_getl</function>.
1563 </entry><entry></entry></row>
1565 memcached</entry><entry>
1566 If given and non-empty,
1567 <ulink url="&url.libmemcached;">libMemcached</ulink>
1568 will be configured for the connection.
1569 This option is inspected by ZOOM when a connection is established.
1570 If the <literal>memcached</literal> option is given
1571 and YAZ is compiled without libMemcached support, an internal
1572 diagnostic (10018) will be thrown.
1573 libMemcached support is available for YAZ 5.0.13 or later. If this
1574 option is supplied for an earlier version of YAZ, it is
1575 <emphasis>ignored</emphasis>.
1576 The value of this option is a list options - each is of the
1577 form <literal>--name=value</literal>.
1578 Option <literal>--server=</literal>host[:port] specifies a memcached
1579 server. It may be repeated for multiple memcached servers.
1580 Option <literal>--expire=</literal>seconds sets expiry time in seconds
1581 for how long result sets are to be cached.
1582 </entry><entry>none</entry></row>
1584 redis</entry><entry>
1585 If given and non-empty,
1586 a <ulink url="&url.redis;">redis</ulink> context will be created
1588 This option is inspected by ZOOM when a connection is established.
1589 If the <literal>redis</literal> option is given
1590 and YAZ is compiled without redis support, an internal
1591 diagnostic (10018) will be thrown.
1592 redis support is available for YAZ 5.2.0 or later. If this
1593 option is supplied for an earlier version of YAZ, it is
1594 <emphasis>ignored</emphasis>.
1595 The value of this option is a set options, similar to that
1596 of the memcached setting. At this stage only --server=host[:port]
1597 and --expire=seconds is supported.
1598 </entry><entry>none</entry></row>
1603 If either option <literal>lang</literal> or <literal>charset</literal>
1605 <ulink url="&url.z39.50.charneg;">
1606 Character Set and Language Negotiation</ulink> is in effect.
1609 int ZOOM_connection_error(ZOOM_connection c, const char **cp,
1610 const char **addinfo);
1611 int ZOOM_connection_error_x(ZOOM_connection c, const char **cp,
1612 const char **addinfo, const char **dset);
1615 Function <function>ZOOM_connection_error</function> checks for
1616 errors for the last operation(s) performed. The function returns
1617 zero if no errors occurred; non-zero otherwise indicating the error.
1618 Pointers <parameter>cp</parameter> and <parameter>addinfo</parameter>
1619 holds messages for the error and additional-info if passed as
1620 non-<literal>NULL</literal>. Function
1621 <function>ZOOM_connection_error_x</function> is an extended version
1622 of <function>ZOOM_connection_error</function> that is capable of
1623 returning name of diagnostic set in <parameter>dset</parameter>.
1625 <sect2 id="zoom-connection-z39.50">
1626 <title>Z39.50 Protocol behavior</title>
1628 The calls <function>ZOOM_connection_new</function> and
1629 <function>ZOOM_connection_connect</function> establishes a TCP/IP
1630 connection and sends an Initialize Request to the target if
1631 possible. In addition, the calls waits for an Initialize Response
1632 from the target and the result is inspected (OK or rejected).
1635 If <literal>proxy</literal> is set then the client will establish
1636 a TCP/IP connection with the peer as specified by the
1637 <literal>proxy</literal> host and the hostname as part of the
1638 connect calls will be set as part of the Initialize Request.
1639 The proxy server will then "forward" the PDU's transparently
1640 to the target behind the proxy.
1643 For the authentication parameters, if option <literal>user</literal>
1644 is set and both options <literal>group</literal> and
1645 <literal>pass</literal> are unset, then Open style
1646 authentication is used (Version 2/3) in which case the username
1647 is usually followed by a slash, then by a password.
1648 If either <literal>group</literal>
1649 or <literal>pass</literal> is set then idPass authentication
1650 (Version 3 only) is used. If none of the options are set, no
1651 authentication parameters are set as part of the Initialize Request
1655 When option <literal>async</literal> is 1, it really means that
1656 all network operations are postponed (and queued) until the
1657 function <literal>ZOOM_event</literal> is invoked. When doing so
1658 it doesn't make sense to check for errors after
1659 <literal>ZOOM_connection_new</literal> is called since that
1660 operation "connecting - and init" is still incomplete and the
1661 API cannot tell the outcome (yet).
1664 <sect2 id="zoom.sru.init.behavior">
1665 <title>SRU/Solr Protocol behavior</title>
1667 The HTTP based protocols (SRU, SRW, Solr) doesn't feature an
1668 Inititialize Request, so the connection phase merely establishes a
1669 TCP/IP connection with the HTTP server.
1671 <para>Most of the ZOOM connection options do not
1672 affect SRU/Solr and they are ignored. However, future versions
1673 of &yaz; might honor <literal>implementationName</literal> and
1674 put that as part of User-Agent header for HTTP requests.
1677 The <literal>charset</literal> is used in the Content-Type header
1681 Setting <literal>authentcationMode</literal> specifies how
1682 authentication parameters are encoded for HTTP. The default is
1683 "<literal>basic</literal>" where <literal>user</literal> and
1684 <literal>password</literal> are encoded by using HTTP basic
1688 If <literal>authentcationMode</literal> is "<literal>url</literal>", then
1689 user and password are encoded in the URL by parameters
1690 <literal>x-username</literal> and <literal>x-password</literal> as
1691 given by the SRU standard.
1695 <sect1 id="zoom.query">
1696 <title>Queries</title>
1698 Query objects represents queries.
1701 ZOOM_query ZOOM_query_create(void);
1703 void ZOOM_query_destroy(ZOOM_query q);
1705 int ZOOM_query_prefix(ZOOM_query q, const char *str);
1707 int ZOOM_query_cql(ZOOM_query s, const char *str);
1709 int ZOOM_query_sortby(ZOOM_query q, const char *criteria);
1711 int ZOOM_query_sortby2(ZOOM_query q, const char *strategy,
1712 const char *criteria);
1715 Create query objects using <function>ZOOM_query_create</function>
1716 and destroy them by calling <function>ZOOM_query_destroy</function>.
1717 RPN-queries can be specified in <link linkend="PQF">PQF</link>
1718 notation by using the
1719 function <function>ZOOM_query_prefix</function>.
1720 The <function>ZOOM_query_cql</function> specifies a CQL
1721 query to be sent to the server/target.
1722 More query types will be added in future versions of &yaz;, such as
1723 <link linkend="CCL">CCL</link> to RPN-mapping, native CCL query,
1724 etc. In addition to a search, a sort criteria may be set. Function
1725 <function>ZOOM_query_sortby</function> enables Z39.50 sorting and
1726 it takes sort criteria using the same string notation as
1727 yaz-client's <link linkend="sortspec">sort command</link>.
1729 <para id="zoom.query.sortby2">
1730 <function>ZOOM_query_sortby2</function> is similar to
1731 <function>ZOOM_query_sortby</function> but allows a strategy for
1732 sorting. The reason for the strategy parameter is that some
1733 protocols offers multiple ways of performing sorting.
1734 For example, Z39.50 has the standard sort, which is performed after
1735 search on an existing result set.
1736 It's also possible to use CQL in Z39.50 as the query type and use
1737 CQL's SORTBY keyword. Finally, Index Data's
1738 Zebra server also allows sorting to be specified as part of RPN (Type 7).
1740 <table id="zoom-sort-strategy" frame="top">
1741 <title>ZOOM sort strategy</title>
1743 <colspec colwidth="2*" colname="name"/>
1744 <colspec colwidth="5*" colname="description"/>
1748 <entry>Description</entry>
1753 <entry>z39.50</entry><entry>Z39.50 resultset sort</entry>
1756 <entry>type7</entry><entry>Sorting embedded in RPN(Type-7)</entry>
1759 <entry>cql</entry><entry>CQL SORTBY</entry>
1762 <entry>sru11</entry><entry>SRU sortKeys parameter</entry>
1765 <entry>solr</entry><entry>Solr sort</entry>
1768 <entry>embed</entry><entry>type7 for Z39.50, cql for SRU,
1769 solr for Solr protocol</entry>
1775 <sect1 id="zoom.resultsets"><title>Result sets</title>
1777 The result set object is a container for records returned from
1781 ZOOM_resultset ZOOM_connection_search(ZOOM_connection, ZOOM_query q);
1783 ZOOM_resultset ZOOM_connection_search_pqf(ZOOM_connection c,
1785 void ZOOM_resultset_destroy(ZOOM_resultset r);
1788 Function <function>ZOOM_connection_search</function> creates
1789 a result set given a connection and query.
1790 Destroy a result set by calling
1791 <function>ZOOM_resultset_destroy</function>.
1792 Simple clients may using PQF only may use function
1793 <function>ZOOM_connection_search_pqf</function> in which case
1794 creating query objects is not necessary.
1797 void ZOOM_resultset_option_set(ZOOM_resultset r,
1798 const char *key, const char *val);
1800 const char *ZOOM_resultset_option_get(ZOOM_resultset r, const char *key);
1802 size_t ZOOM_resultset_size(ZOOM_resultset r);
1805 Functions <function>ZOOM_resultset_options_set</function> and
1806 <function>ZOOM_resultset_get</function> sets and gets an option
1807 for a result set similar to <function>ZOOM_connection_option_get</function>
1808 and <function>ZOOM_connection_option_set</function>.
1811 The number of hits also called result-count is returned by
1812 function <function>ZOOM_resultset_size</function>.
1814 <table id="zoom.resultset.options"
1815 frame="top"><title>ZOOM Result set Options</title>
1817 <colspec colwidth="4*" colname="name"></colspec>
1818 <colspec colwidth="7*" colname="description"></colspec>
1819 <colspec colwidth="2*" colname="default"></colspec>
1822 <entry>Option</entry>
1823 <entry>Description</entry>
1824 <entry>Default</entry>
1829 start</entry><entry>Offset of first record to be
1830 retrieved from target. First record has offset 0 unlike the
1831 protocol specifications where first record has position 1.
1832 This option affects ZOOM_resultset_search and
1833 ZOOM_resultset_search_pqf and must be set before any of
1834 these functions are invoked. If a range of
1835 records must be fetched manually after search,
1836 function ZOOM_resultset_records should be used.
1837 </entry><entry>0</entry></row>
1839 count</entry><entry>Number of records to be retrieved.
1840 This option affects ZOOM_resultset_search and
1841 ZOOM_resultset_search_pqf and must be set before any of
1842 these functions are invoked.
1843 </entry><entry>0</entry></row>
1845 presentChunk</entry><entry>The number of records to be
1846 requested from the server in each chunk (present request). The
1847 value 0 means to request all the records in a single chunk.
1848 (The old <literal>step</literal>
1849 option is also supported for the benefit of old applications.)
1850 </entry><entry>0</entry></row>
1852 elementSetName</entry><entry>Element-Set name of records.
1853 Most targets should honor element set name <literal>B</literal>
1854 and <literal>F</literal> for brief and full respectively.
1855 </entry><entry>none</entry></row>
1857 preferredRecordSyntax</entry><entry>Preferred Syntax, such as
1858 <literal>USMARC</literal>, <literal>SUTRS</literal>, etc.
1859 </entry><entry>none</entry></row>
1861 schema</entry><entry>Schema for retrieval, such as
1862 <literal>Gils-schema</literal>, <literal>Geo-schema</literal>, etc.
1863 </entry><entry>none</entry></row>
1865 setname</entry><entry>Name of Result Set (Result Set ID).
1866 If this option isn't set, the ZOOM module will automatically
1867 allocate a result set name.
1868 </entry><entry>default</entry></row>
1870 rpnCharset</entry><entry>Character set for RPN terms.
1871 If this is set, ZOOM C will assume that the ZOOM application is
1872 running UTF-8. Terms in RPN queries are then converted to the
1873 rpnCharset. If this is unset, ZOOM C will not assume any encoding
1874 of RPN terms and no conversion is performed.
1875 </entry><entry>none</entry></row>
1880 For servers that support Search Info report, the following
1881 options may be read using <function>ZOOM_resultset_get</function>.
1882 This detailed information is read after a successful search has
1886 This information is a list of of items, where each item is
1887 information about a term or subquery. All items in the list
1889 <literal>SearchResult.</literal><replaceable>no</replaceable>
1890 where no presents the item number (0=first, 1=second).
1891 Read <literal>searchresult.size</literal> to determine the
1894 <table id="zoom.search.info.report.options"
1895 frame="top"><title>Search Info Report Options</title>
1897 <colspec colwidth="4*" colname="name"></colspec>
1898 <colspec colwidth="7*" colname="description"></colspec>
1901 <entry>Option</entry>
1902 <entry>Description</entry>
1907 <entry>searchresult.size</entry>
1909 number of search result entries. This option is-nonexistant
1910 if no entries are returned by the server.
1914 <entry>searchresult.<replaceable>no</replaceable>.id</entry>
1915 <entry>sub query ID</entry>
1918 <entry>searchresult.<replaceable>no</replaceable>.count</entry>
1919 <entry>result count for item (number of hits)</entry>
1922 <entry>searchresult.<replaceable>no</replaceable>.subquery.term</entry>
1923 <entry>subquery term</entry>
1927 searchresult.<replaceable>no</replaceable>.interpretation.term
1929 <entry>interpretation term</entry>
1933 searchresult.<replaceable>no</replaceable>.recommendation.term
1935 <entry>recommendation term</entry>
1940 <sect2 id="zoom.z3950.resultset.sort">
1941 <title>Z39.50 Result-set Sort</title>
1943 void ZOOM_resultset_sort(ZOOM_resultset r,
1944 const char *sort_type, const char *sort_spec);
1946 int ZOOM_resultset_sort1(ZOOM_resultset r,
1947 const char *sort_type, const char *sort_spec);
1950 <function>ZOOM_resultset_sort</function> and
1951 <function>ZOOM_resultset_sort1</function> both sort an existing
1952 result-set. The sort_type parameter is not use. Set it to "yaz".
1953 The sort_spec is same notation as ZOOM_query_sortby and identical
1954 to that offered by yaz-client's
1955 <link linkend="sortspec">sort command</link>.
1958 These functions only work for Z39.50. Use the more generic utility
1959 <link linkend="zoom.query.sortby2">
1960 <function>ZOOM_query_sortby2</function></link>
1961 for other protocols (and even Z39.50).
1964 <sect2 id="zoom.z3950.resultset.behavior">
1965 <title>Z39.50 Protocol behavior</title>
1967 The creation of a result set involves at least a SearchRequest
1968 - SearchResponse protocol handshake. Following that, if a sort
1969 criteria was specified as part of the query, a SortRequest -
1970 SortResponse handshake takes place. Note that it is necessary to
1971 perform sorting before any retrieval takes place, so no records will
1972 be returned from the target as part of the SearchResponse because these
1973 would be unsorted. Hence, piggyback is disabled when sort criteria
1974 are set. Following Search - and a possible sort - Retrieval takes
1975 place - as one or more Present Requests/Response pairs being
1979 The API allows for two different modes for retrieval. A high level
1980 mode which is somewhat more powerful and a low level one.
1981 The low level is enabled when searching on a Connection object
1982 for which the settings
1983 <literal>smallSetUpperBound</literal>,
1984 <literal>mediumSetPresentNumber</literal> and
1985 <literal>largeSetLowerBound</literal> are set. The low level mode
1986 thus allows you to precisely set how records are returned as part
1987 of a search response as offered by the Z39.50 protocol.
1988 Since the client may be retrieving records as part of the
1989 search response, this mode doesn't work well if sorting is used.
1992 The high-level mode allows you to fetch a range of records from
1993 the result set with a given start offset. When you use this mode
1994 the client will automatically use piggyback if that is possible
1995 with the target and perform one or more present requests as needed.
1996 Even if the target returns fewer records as part of a present response
1997 because of a record size limit, etc. the client will repeat sending
1998 present requests. As an example, if option <literal>start</literal>
1999 is 0 (default) and <literal>count</literal> is 4, and
2000 <literal>piggyback</literal> is 1 (default) and no sorting criteria
2001 is specified, then the client will attempt to retrieve the 4
2002 records as part the search response (using piggyback). On the other
2003 hand, if either <literal>start</literal> is positive or if
2004 a sorting criteria is set, or if <literal>piggyback</literal>
2005 is 0, then the client will not perform piggyback but send Present
2009 If either of the options <literal>mediumSetElementSetName</literal> and
2010 <literal>smallSetElementSetName</literal> are unset, the value
2011 of option <literal>elementSetName</literal> is used for piggyback
2012 searches. This means that for the high-level mode you only have
2013 to specify one elementSetName option rather than three.
2016 <sect2 id="zoom.sru.resultset.behavior">
2017 <title>SRU Protocol behavior</title>
2019 Current version of &yaz; does not take advantage of a result set id
2020 returned by the SRU server. Future versions might do, however.
2021 Since, the ZOOM driver does not save result set IDs any
2022 present (retrieval) is transformed to a SRU SearchRetrieveRequest
2023 with same query but, possibly, different offsets.
2026 Option <literal>schema</literal> specifies SRU schema
2027 for retrieval. However, options <literal>elementSetName</literal> and
2028 <literal>preferredRecordSyntax</literal> are ignored.
2031 Options <literal>start</literal> and <literal>count</literal>
2032 are supported by SRU.
2033 The remaining options
2034 <literal>piggyback</literal>,
2035 <literal>smallSetUpperBound</literal>,
2036 <literal>largeSetLowerBound</literal>,
2037 <literal>mediumSetPresentNumber</literal>,
2038 <literal>mediumSetElementSetName</literal>,
2039 <literal>smallSetElementSetName</literal> are
2043 SRU supports CQL queries, <emphasis>not</emphasis> PQF.
2044 If PQF is used, however, the PQF query is transferred anyway
2045 using non-standard element <literal>pQuery</literal> in
2046 SRU SearchRetrieveRequest.
2049 Solr queries has to be done in Solr query format.
2052 Unfortunately, SRU or Solr does not define a database setting. Hence,
2053 <literal>databaseName</literal> is unsupported and ignored.
2054 However, the path part in host parameter for functions
2055 <function>ZOOM_connecton_new</function> and
2056 <function>ZOOM_connection_connect</function> acts as a
2057 database (at least for the &yaz; SRU server).
2061 <sect1 id="zoom.records">
2062 <title>Records</title>
2064 A record object is a retrieval record on the client side -
2065 created from result sets.
2068 void ZOOM_resultset_records(ZOOM_resultset r,
2070 size_t start, size_t count);
2071 ZOOM_record ZOOM_resultset_record(ZOOM_resultset s, size_t pos);
2073 const char *ZOOM_record_get(ZOOM_record rec, const char *type,
2076 int ZOOM_record_error(ZOOM_record rec, const char **msg,
2077 const char **addinfo, const char **diagset);
2079 ZOOM_record ZOOM_record_clone(ZOOM_record rec);
2081 void ZOOM_record_destroy(ZOOM_record rec);
2084 References to temporary records are returned by functions
2085 <function>ZOOM_resultset_records</function> or
2086 <function>ZOOM_resultset_record</function>.
2089 If a persistent reference to a record is desired
2090 <function>ZOOM_record_clone</function> should be used.
2091 It returns a record reference that should be destroyed
2092 by a call to <function>ZOOM_record_destroy</function>.
2095 A single record is returned by function
2096 <function>ZOOM_resultset_record</function> that takes a
2097 position as argument. First record has position zero.
2098 If no record could be obtained <literal>NULL</literal> is returned.
2101 Error information for a record can be checked with
2102 <function>ZOOM_record_error</function> which returns non-zero
2103 (error code) if record is in error, called <emphasis>Surrogate
2104 Diagnostics</emphasis> in Z39.50.
2107 Function <function>ZOOM_resultset_records</function> retrieves
2108 a number of records from a result set. Parameter <literal>start</literal>
2109 and <literal>count</literal> specifies the range of records to
2110 be returned. Upon completion array
2111 <literal>recs[0], ..recs[count-1]</literal>
2112 holds record objects for the records. The array of records
2113 <literal>recs</literal> should be allocated prior the call
2114 <function>ZOOM_resultset_records</function>. Note that for those
2115 records that couldn't be retrieved from the target
2116 <literal>recs[ ..]</literal> is set to <literal>NULL</literal>.
2118 <para id="zoom.record.get">
2119 In order to extract information about a single record,
2120 <function>ZOOM_record_get</function> is provided. The
2121 function returns a pointer to certain record information. The
2122 nature (type) of the pointer depends on the parameter,
2123 <parameter>type</parameter>.
2126 The <parameter>type</parameter> is a string of the format:
2129 <replaceable>format</replaceable>[;charset=<replaceable>from</replaceable>[/<replaceable>opacfrom</replaceable>][,<replaceable>to</replaceable>]][;format=<replaceable>v</replaceable>][;base64=<replaceable>xpath</replaceable>]
2132 If <literal>charset</literal> is given, then <replaceable>from</replaceable>
2133 specifies the character set of the record in its original form
2134 (as returned by the server), <replaceable>to</replaceable> specifies
2135 the output (returned) character set encoding.
2136 If <replaceable>to</replaceable> is omitted, then UTF-8 is assumed.
2137 If charset is not given, then no character set conversion takes place.
2138 OPAC records may be returned in a different
2139 set from the bibliographic MARC record. If this is this the case,
2140 <replaceable>opacfrom</replaceable> should be set to the character set
2141 of the OPAC record part.
2145 The <literal>format</literal> is generic but can only be used to
2146 specify XML indentation when the value <replaceable>v</replaceable>
2147 is 1 (<literal>format=1</literal>).
2150 The <literal>base64</literal> allows a full record to be extracted
2151 from base64-encoded string in an XML document.
2155 Specifying the OPAC record character set requires YAZ 4.1.5 or later.
2158 Specifying the base64 parameter requires YAZ 4.2.35 or later.
2162 The format argument controls whether record data should be XML
2163 pretty-printed (post process operation).
2164 It is enabled only if format value <replaceable>v</replaceable> is
2165 <literal>1</literal> and the record content is XML well-formed.
2168 In addition, for certain types, the length
2169 <literal>len</literal> passed will be set to the size in bytes of
2170 the returned information.
2173 The following are the supported values for <replaceable>form</replaceable>.
2175 <varlistentry><term><literal>database</literal></term>
2176 <listitem><para>Database of record is returned
2177 as a C null-terminated string. Return type
2178 <literal>const char *</literal>.
2181 <varlistentry><term><literal>syntax</literal></term>
2182 <listitem><para>The transfer syntax of the record is returned
2183 as a C null-terminated string containing the symbolic name of
2184 the record syntax, e.g. <literal>Usmarc</literal>. Return type
2186 <literal>const char *</literal>.
2189 <varlistentry><term><literal>schema</literal></term>
2190 <listitem><para>The schema of the record is returned
2191 as a C null-terminated string. Return type is
2192 <literal>const char *</literal>.
2195 <varlistentry><term><literal>render</literal></term>
2196 <listitem><para>The record is returned in a display friendly
2197 format. Upon completion buffer is returned
2198 (type <literal>const char *</literal>) and length is stored in
2199 <literal>*len</literal>.
2202 <varlistentry><term><literal>raw</literal></term>
2203 <listitem><para>The record is returned in the internal
2204 YAZ specific format. For GRS-1, Explain, and others, the
2205 raw data is returned as type
2206 <literal>Z_External *</literal> which is just the type for
2207 the member <literal>retrievalRecord</literal> in
2208 type <literal>NamePlusRecord</literal>.
2209 For SUTRS and octet aligned record (including all MARCs) the
2210 octet buffer is returned and the length of the buffer.
2213 <varlistentry><term><literal>xml</literal></term>
2214 <listitem><para>The record is returned in XML if possible.
2215 SRU, Solr and Z39.50 records with transfer syntax XML are
2216 returned verbatim. MARC records are returned in
2217 <ulink url="&url.marcxml;">
2220 (converted from ISO2709 to MARCXML by YAZ).
2221 OPAC records are also converted to XML and the
2222 bibliographic record is converted to MARCXML (when possible).
2223 GRS-1 records are not supported for this form.
2224 Upon completion, the XML buffer is returned
2225 (type <literal>const char *</literal>) and length is stored in
2226 <literal>*len</literal>.
2229 <varlistentry><term><literal>opac</literal></term>
2230 <listitem><para>OPAC information for record is returned in XML
2231 if an OPAC record is present at the position given. If no
2232 OPAC record is present, a NULL pointer is returned.
2235 <varlistentry><term><literal>txml</literal></term>
2236 <listitem><para>The record is returned in TurboMARC if possible.
2237 SRU and Z39.50 records with transfer syntax XML are
2238 returned verbatim. MARC records are returned in
2239 <link linkend="tools.turbomarc">
2242 (converted from ISO2709 to TurboMARC by YAZ).
2243 Upon completion, the XML buffer is returned
2244 (type <literal>const char *</literal>) and length is stored in
2245 <literal>*len</literal>.
2248 <varlistentry><term><literal>json</literal></term>
2249 <listitem><para>Like xml, but MARC records are converted to
2250 <ulink url="&url.marc_in_json;">MARC-in-JSON</ulink>.
2258 <ulink url="&url.marc21;">MARC21</ulink>
2260 <ulink url="&url.marc8;">MARC-8</ulink>
2261 character set encoding.
2262 An application that wishes to display in Latin-1 would use
2264 render; charset=marc8,iso-8859-1
2267 <sect2 id="zoom.z3950.record.behavior">
2268 <title>Z39.50 Protocol behavior</title>
2270 The functions <function>ZOOM_resultset_record</function> and
2271 <function>ZOOM_resultset_records</function> inspects the client-side
2272 record cache. Records not found in cache are fetched using
2274 The functions may block (and perform network I/O) - even though option
2275 <literal>async</literal> is 1, because they return records objects.
2276 (and there's no way to return records objects without retrieving them!).
2279 There is a trick, however, in the usage of function
2280 <function>ZOOM_resultset_records</function> that allows for
2281 delayed retrieval (and makes it non-blocking). By using
2282 a null pointer for <parameter>recs</parameter> you're indicating
2283 you're not interested in getting records objects
2284 <emphasis>now</emphasis>.
2287 <sect2 id="zoom.sru.record.behavior">
2288 <title>SRU/Solr Protocol behavior</title>
2290 The ZOOM driver for SRU/Solr treats records returned by a SRU/Solr server
2291 as if they where Z39.50 records with transfer syntax XML and
2292 no element set name or database name.
2296 <sect1 id="zoom.facets"><title>Facets</title>
2298 Facet operations is not part of the official ZOOM specification, but
2299 is an Index Data extension for YAZ-based Z39.50 targets,
2300 <ulink url="&url.solr;">Solr</ulink> and SRU 2.0 targets.
2302 Facets may be requestd by the
2303 <link linkend="zoom.facets.option">facets</link> option before a
2305 For inspection of the returned facets, the following functions are
2309 ZOOM_facet_field *ZOOM_resultset_facets(ZOOM_resultset r);
2311 ZOOM_facet_field ZOOM_resultset_get_facet_field(ZOOM_resultset r,
2312 const char *facet_name);
2314 ZOOM_facet_field ZOOM_resultset_get_facet_field_by_index(ZOOM_resultset r,
2317 size_t ZOOM_resultset_facets_size(ZOOM_resultset r);
2319 const char *ZOOM_facet_field_name(ZOOM_facet_field facet_field);
2321 size_t ZOOM_facet_field_term_count(ZOOM_facet_field facet_field);
2323 const char *ZOOM_facet_field_get_term(ZOOM_facet_field facet_field,
2324 size_t idx, int *freq);
2327 References to temporary structures are returned by all functions.
2328 They are only valid as long the Result set is valid.
2329 <function>ZOOM_resultset_get_facet_field</function> or
2330 <function>ZOOM_resultset_get_facet_field_by_index</function>.
2331 <function>ZOOM_resultset_facets</function>.
2332 <function>ZOOM_facet_field_name</function>.
2333 <function>ZOOM_facet_field_get_term</function>.
2335 <para id="zoom.resultset.get_facet_field">
2336 A single Facet field is returned by function
2337 <function>ZOOM_resultset_get_facet_field</function> or
2338 <function>ZOOM_resultset_get_facet_field_by_index</function> that takes
2339 a result set and facet name or positive index respectively. First
2340 facet has position zero. If no facet could be obtained (invalid name
2341 or index out of bounds) <literal>NULL</literal> is returned.
2343 <para id="zoom.resultset.facets">
2344 An array of facets field can be returned by
2345 <function>ZOOM_resultset_facets</function>. The length of the array is
2346 given by <function>ZOOM_resultset_facets_size</function>. The array is
2347 zero-based and last entry will be at
2348 <function>ZOOM_resultset_facets_size(result_set)</function>-1.
2350 <para id="zoom.resultset.facets_names">
2351 It is possible to interate over facets by name, by calling
2352 <function>ZOOM_resultset_facets_names</function>.
2353 This will return an const array of char * where each string can be used
2354 as parameter for <function>ZOOM_resultset_get_facet_field</function>.
2357 Function <function>ZOOM_facet_field_name</function> gets the request
2358 facet name from a returned facet field.
2361 Function <function>ZOOM_facet_field_get_term</function> returns the
2362 idx'th term and term count for a facet field.
2363 Idx must between 0 and
2364 <function>ZOOM_facet_field_term_count</function>-1, otherwise the
2365 returned reference will be <literal>NULL</literal>. On a valid idx, the
2366 value of the freq reference will be the term count.
2367 The <literal>freq</literal> parameter must be valid pointer to integer.
2370 <sect1 id="zoom.scan"><title>Scan</title>
2372 This section describes an interface for Scan. Scan is not an
2373 official part of the ZOOM model yet. The result of a scan operation
2374 is the <literal>ZOOM_scanset</literal> which is a set of terms
2375 returned by a target.
2379 The Scan interface is supported for both Z39.50, SRU and Solr.
2383 ZOOM_scanset ZOOM_connection_scan(ZOOM_connection c,
2384 const char *startpqf);
2386 ZOOM_scanset ZOOM_connection_scan1(ZOOM_connection c,
2389 size_t ZOOM_scanset_size(ZOOM_scanset scan);
2391 const char *ZOOM_scanset_term(ZOOM_scanset scan, size_t pos,
2392 size_t *occ, size_t *len);
2394 const char *ZOOM_scanset_display_term(ZOOM_scanset scan, size_t pos,
2395 size_t *occ, size_t *len);
2397 void ZOOM_scanset_destroy(ZOOM_scanset scan);
2399 const char *ZOOM_scanset_option_get(ZOOM_scanset scan,
2402 void ZOOM_scanset_option_set(ZOOM_scanset scan, const char *key,
2406 The scan set is created by function
2407 <function>ZOOM_connection_scan</function> which performs a scan
2408 operation on the connection using the specified
2409 <parameter>startpqf</parameter>.
2410 If the operation was successful, the size of the scan set can be
2411 retrieved by a call to <function>ZOOM_scanset_size</function>.
2412 Like result sets, the items are numbered 0,..size-1.
2413 To obtain information about a particular scan term, call function
2414 <function>ZOOM_scanset_term</function>. This function takes
2415 a scan set offset <literal>pos</literal> and returns a pointer
2416 to a <emphasis>raw term</emphasis> or <literal>NULL</literal> if
2418 If present, the <literal>occ</literal> and <literal>len</literal>
2419 are set to the number of occurrences and the length
2420 of the actual term respectively.
2421 <function>ZOOM_scanset_display_term</function> is similar to
2422 <function>ZOOM_scanset_term</function> except that it returns
2423 the <emphasis>display term</emphasis> rather than the raw term.
2424 In a few cases, the term is different from display term. Always
2425 use the display term for display and the raw term for subsequent
2426 scan operations (to get more terms, next scan result, etc).
2429 A scan set may be freed by a call to function
2430 <function>ZOOM_scanset_destroy</function>.
2431 Functions <function>ZOOM_scanset_option_get</function> and
2432 <function>ZOOM_scanset_option_set</function> retrieves and sets
2433 an option respectively.
2436 The <parameter>startpqf</parameter> is a subset of PQF, namely
2437 the Attributes+Term part. Multiple <literal>@attr</literal> can
2438 be used. For example to scan in title (complete) phrases:
2440 @attr 1=4 @attr 6=2 "science o"
2444 The <function>ZOOM_connecton_scan1</function> is a newer and
2445 more generic alternative to <function>ZOOM_connection_scan</function>
2446 which allows to use both CQL and PQF for Scan.
2448 <table frame="top" id="zoom.scanset.options">
2449 <title>ZOOM Scan Set Options</title>
2451 <colspec colwidth="4*" colname="name"></colspec>
2452 <colspec colwidth="7*" colname="description"></colspec>
2453 <colspec colwidth="2*" colname="default"></colspec>
2456 <entry>Option</entry>
2457 <entry>Description</entry>
2458 <entry>Default</entry>
2463 number</entry><entry>Number of Scan Terms requested in next scan.
2464 After scan it holds the actual number of terms returned.
2465 </entry><entry>20</entry></row>
2467 position</entry><entry>Preferred Position of term in response
2468 in next scan; actual position after completion of scan.
2469 </entry><entry>1</entry></row>
2471 stepSize</entry><entry>Step Size
2472 </entry><entry>0</entry></row>
2474 scanStatus</entry><entry>An integer indicating the Scan Status
2476 </entry><entry>0</entry></row>
2478 rpnCharset</entry><entry>Character set for RPN terms.
2479 If this is set, ZOOM C will assume that the ZOOM application is
2480 running UTF-8. Terms in RPN queries are then converted to the
2481 rpnCharset. If this is unset, ZOOM C will not assume any encoding
2482 of RPN terms and no conversion is performed.
2483 </entry><entry>none</entry></row>
2488 <sect1 id="zoom.extendedservices">
2489 <title>Extended Services</title>
2491 ZOOM offers an interface to a subset of the Z39.50 extended services
2492 as well as a few privately defined ones:
2497 Z39.50 Item Order (ILL).
2498 See <xref linkend="zoom.item.order"/>.
2503 Record Update. This allows a client to insert, modify or delete
2505 See <xref linkend="zoom.record.update"/>.
2510 Database Create. This a non-standard feature. Allows a client
2511 to create a database.
2512 See <xref linkend="zoom.database.create"/>.
2517 Database Drop. This a non-standard feature. Allows a client
2518 to delete/drop a database.
2519 See <xref linkend="zoom.database.drop"/>.
2524 Commit operation. This a non-standard feature. Allows a client
2525 to commit operations.
2526 See <xref linkend="zoom.commit"/>.
2529 <!-- all the ILL PDU options should go here too -->
2532 To create an extended service operation a <literal>ZOOM_package</literal>
2533 must be created. The operation is a five step operation. The
2534 package is created, package is configured by means of options,
2535 the package is send, result is inspected (by means of options),
2536 the package is destroyed.
2539 ZOOM_package ZOOM_connection_package(ZOOM_connection c,
2540 ZOOM_options options);
2542 const char *ZOOM_package_option_get(ZOOM_package p,
2544 void ZOOM_package_option_set(ZOOM_package p, const char *key,
2546 void ZOOM_package_send(ZOOM_package p, const char *type);
2548 void ZOOM_package_destroy(ZOOM_package p);
2551 The <function>ZOOM_connection_package</function> creates a
2552 package for the connection given using the options specified.
2555 Functions <function>ZOOM_package_option_get</function> and
2556 <function>ZOOM_package_option_set</function> gets and sets
2560 <function>ZOOM_package_send</function> sends
2561 the package the via connection specified in
2562 <function>ZOOM_connection_package</function>.
2563 The <parameter>type</parameter> specifies the actual extended service
2564 package type to be sent.
2566 <table frame="top" id="zoom.extendedservices.options">
2567 <title>Extended Service Common Options</title>
2569 <colspec colwidth="4*" colname="name"></colspec>
2570 <colspec colwidth="7*" colname="description"></colspec>
2571 <colspec colwidth="3*" colname="default"></colspec>
2574 <entry>Option</entry>
2575 <entry>Description</entry>
2576 <entry>Default</entry>
2581 <entry>package-name</entry>
2582 <entry>Extended Service Request package name. Must be specified
2583 as part of a request</entry>
2587 <entry>user-id</entry>
2588 <entry>User ID of Extended Service Package. Is a request option</entry>
2592 <entry>function</entry>
2594 Function of package - one of <literal>create</literal>,
2595 <literal>delete</literal>, <literal>modify</literal>. Is
2598 <entry><literal>create</literal></entry>
2601 <entry>waitAction</entry>
2603 Wait action for package. Possible values:
2604 <literal>wait</literal>, <literal>waitIfPossible</literal>,
2605 <literal>dontWait</literal> or <literal>dontReturnPackage</literal>.
2607 <entry><literal>waitIfPossible</literal></entry>
2610 <entry>targetReference</entry>
2612 Target Reference. This is part of the response as returned
2613 by the server. Read it after a successful operation.
2615 <entry><literal>none</literal></entry>
2620 <sect2 id="zoom.item.order">
2621 <title>Item Order</title>
2623 For Item Order, type must be set to <literal>itemorder</literal> in
2624 <function>ZOOM_package_send</function>.
2627 <table frame="top" id="zoom.item.order.options">
2628 <title>Item Order Options</title>
2630 <colspec colwidth="4*" colname="name"></colspec>
2631 <colspec colwidth="7*" colname="description"></colspec>
2632 <colspec colwidth="3*" colname="default"></colspec>
2635 <entry>Option</entry>
2636 <entry>Description</entry>
2637 <entry>Default</entry>
2642 <entry>contact-name</entry>
2643 <entry>ILL contact name</entry>
2647 <entry>contact-phone</entry>
2648 <entry>ILL contact phone</entry>
2652 <entry>contact-email</entry>
2653 <entry>ILL contact email</entry>
2657 <entry>itemorder-setname</entry>
2658 <entry>Name of result set for record</entry>
2659 <entry>default</entry>
2662 <entry>itemorder-item</entry>
2663 <entry>Position for item (record) requested. An integer</entry>
2670 There are two variants of item order: ILL-variant and
2671 XML document variant. In order to use the XML variant the setting
2672 <literal>doc</literal> must hold the XML item order document. If that
2673 setting is unset, the ILL-variant is used.
2676 <table frame="top" id="zoom.illrequest.options">
2677 <title>ILL Request Options</title>
2679 <colspec colwidth="4*" colname="name"></colspec>
2682 <entry>Option</entry>
2686 <row><entry>protocol-version-num</entry></row>
2687 <row><entry>transaction-id,initial-requester-id,person-or-institution-symbol,person</entry></row>
2688 <row><entry>transaction-id,initial-requester-id,person-or-institution-symbol,institution</entry></row>
2689 <row><entry>transaction-id,initial-requester-id,name-of-person-or-institution,name-of-person</entry></row>
2690 <row><entry>transaction-id,initial-requester-id,name-of-person-or-institution,name-of-institution</entry></row>
2691 <row><entry>transaction-id,transaction-group-qualifier</entry></row>
2692 <row><entry>transaction-id,transaction-qualifier</entry></row>
2693 <row><entry>transaction-id,sub-transaction-qualifier</entry></row>
2694 <row><entry>service-date-time,this,date</entry></row>
2695 <row><entry>service-date-time,this,time</entry></row>
2696 <row><entry>service-date-time,original,date</entry></row>
2697 <row><entry>service-date-time,original,time</entry></row>
2698 <row><entry>requester-id,person-or-institution-symbol,person</entry></row>
2699 <row><entry>requester-id,person-or-institution-symbol,institution</entry></row>
2700 <row><entry>requester-id,name-of-person-or-institution,name-of-person</entry></row>
2701 <row><entry>requester-id,name-of-person-or-institution,name-of-institution</entry></row>
2702 <row><entry>responder-id,person-or-institution-symbol,person</entry></row>
2703 <row><entry>responder-id,person-or-institution-symbol,institution</entry></row>
2704 <row><entry>responder-id,name-of-person-or-institution,name-of-person</entry></row>
2705 <row><entry>responder-id,name-of-person-or-institution,name-of-institution</entry></row>
2706 <row><entry>transaction-type</entry></row>
2707 <row><entry>delivery-address,postal-address,name-of-person-or-institution,name-of-person</entry></row>
2708 <row><entry>delivery-address,postal-address,name-of-person-or-institution,name-of-institution</entry></row>
2709 <row><entry>delivery-address,postal-address,extended-postal-delivery-address</entry></row>
2710 <row><entry>delivery-address,postal-address,street-and-number</entry></row>
2711 <row><entry>delivery-address,postal-address,post-office-box</entry></row>
2712 <row><entry>delivery-address,postal-address,city</entry></row>
2713 <row><entry>delivery-address,postal-address,region</entry></row>
2714 <row><entry>delivery-address,postal-address,country</entry></row>
2715 <row><entry>delivery-address,postal-address,postal-code</entry></row>
2716 <row><entry>delivery-address,electronic-address,telecom-service-identifier</entry></row>
2717 <row><entry>delivery-address,electronic-address,telecom-service-addreess</entry></row>
2718 <row><entry>billing-address,postal-address,name-of-person-or-institution,name-of-person</entry></row>
2719 <row><entry>billing-address,postal-address,name-of-person-or-institution,name-of-institution</entry></row>
2720 <row><entry>billing-address,postal-address,extended-postal-delivery-address</entry></row>
2721 <row><entry>billing-address,postal-address,street-and-number</entry></row>
2722 <row><entry>billing-address,postal-address,post-office-box</entry></row>
2723 <row><entry>billing-address,postal-address,city</entry></row>
2724 <row><entry>billing-address,postal-address,region</entry></row>
2725 <row><entry>billing-address,postal-address,country</entry></row>
2726 <row><entry>billing-address,postal-address,postal-code</entry></row>
2727 <row><entry>billing-address,electronic-address,telecom-service-identifier</entry></row>
2728 <row><entry>billing-address,electronic-address,telecom-service-addreess</entry></row>
2729 <row><entry>ill-service-type</entry></row>
2730 <row><entry>requester-optional-messages,can-send-RECEIVED</entry></row>
2731 <row><entry>requester-optional-messages,can-send-RETURNED</entry></row>
2732 <row><entry>requester-optional-messages,requester-SHIPPED</entry></row>
2733 <row><entry>requester-optional-messages,requester-CHECKED-IN</entry></row>
2734 <row><entry>search-type,level-of-service</entry></row>
2735 <row><entry>search-type,need-before-date</entry></row>
2736 <row><entry>search-type,expiry-date</entry></row>
2737 <row><entry>search-type,expiry-flag</entry></row>
2738 <row><entry>place-on-hold</entry></row>
2739 <row><entry>client-id,client-name</entry></row>
2740 <row><entry>client-id,client-status</entry></row>
2741 <row><entry>client-id,client-identifier</entry></row>
2742 <row><entry>item-id,item-type</entry></row>
2743 <row><entry>item-id,call-number</entry></row>
2744 <row><entry>item-id,author</entry></row>
2745 <row><entry>item-id,title</entry></row>
2746 <row><entry>item-id,sub-title</entry></row>
2747 <row><entry>item-id,sponsoring-body</entry></row>
2748 <row><entry>item-id,place-of-publication</entry></row>
2749 <row><entry>item-id,publisher</entry></row>
2750 <row><entry>item-id,series-title-number</entry></row>
2751 <row><entry>item-id,volume-issue</entry></row>
2752 <row><entry>item-id,edition</entry></row>
2753 <row><entry>item-id,publication-date</entry></row>
2754 <row><entry>item-id,publication-date-of-component</entry></row>
2755 <row><entry>item-id,author-of-article</entry></row>
2756 <row><entry>item-id,title-of-article</entry></row>
2757 <row><entry>item-id,pagination</entry></row>
2758 <row><entry>item-id,ISBN</entry></row>
2759 <row><entry>item-id,ISSN</entry></row>
2760 <row><entry>item-id,additional-no-letters</entry></row>
2761 <row><entry>item-id,verification-reference-source</entry></row>
2762 <row><entry>copyright-complicance</entry></row>
2763 <row><entry>retry-flag</entry></row>
2764 <row><entry>forward-flag</entry></row>
2765 <row><entry>requester-note</entry></row>
2766 <row><entry>forward-note</entry></row>
2771 <sect2 id="zoom.record.update">
2772 <title>Record Update</title>
2774 For Record Update, type must be set to <literal>update</literal> in
2775 <function>ZOOM_package_send</function>.
2777 <table frame="top" id="zoom.record.update.options">
2778 <title>Record Update Options</title>
2780 <colspec colwidth="4*" colname="name"></colspec>
2781 <colspec colwidth="7*" colname="description"></colspec>
2782 <colspec colwidth="3*" colname="default"></colspec>
2785 <entry>Option</entry>
2786 <entry>Description</entry>
2787 <entry>Default</entry>
2792 <entry>action</entry>
2794 The update action. One of
2795 <literal>specialUpdate</literal>,
2796 <literal>recordInsert</literal>,
2797 <literal>recordReplace</literal>,
2798 <literal>recordDelete</literal>,
2799 <literal>elementUpdate</literal>.
2801 <entry><literal>specialUpdate (recordInsert for updateVersion=1 which does not support specialUpdate)</literal></entry>
2804 <entry>recordIdOpaque</entry>
2805 <entry>Opaque Record ID</entry>
2809 <entry>recordIdNumber</entry>
2810 <entry>Record ID number</entry>
2814 <entry>record</entry>
2815 <entry>The record itself</entry>
2819 <entry>recordOpaque</entry>
2820 <entry>Specifies an opaque record which is
2821 encoded as an ASN.1 ANY type with the OID as tiven by option
2822 <literal>syntax</literal> (see below).
2823 Option <literal>recordOpaque</literal> is an alternative
2824 to record - and <literal>record</literal> option (above) is
2825 ignored if recordOpaque is set. This option is only available in
2826 YAZ 3.0.35 and later and is meant to facilitate Updates with
2832 <entry>syntax</entry>
2833 <entry>The record syntax (transfer syntax). Is a string that
2834 is a known record syntax.
2836 <entry>no syntax</entry>
2839 <entry>databaseName</entry>
2840 <entry>Database from connection object</entry>
2841 <entry>Default</entry>
2844 <entry>correlationInfo.note</entry>
2845 <entry>Correlation Info Note (string)</entry>
2849 <entry>correlationInfo.id</entry>
2850 <entry>Correlation Info ID (integer)</entry>
2854 <entry>elementSetName</entry>
2855 <entry>Element Set for Record</entry>
2859 <entry>updateVersion</entry>
2860 <entry>Record Update version which holds one of the values
2861 1, 2 or 3. Each version has a distinct OID:
2863 (<ulink url="&url.z39.50.extupdate1;">first version</ulink>) ,
2865 (second version) and
2866 1.2.840.10003.9.5.1.1
2867 (<ulink url="&url.z39.50.extupdate3;">third and
2868 newest version</ulink>).
2878 <sect2 id="zoom.database.create"><title>Database Create</title>
2880 For Database Create, type must be set to <literal>create</literal> in
2881 <function>ZOOM_package_send</function>.
2884 <table frame="top" id="zoom.database.create.options">
2885 <title>Database Create Options</title>
2887 <colspec colwidth="4*" colname="name"></colspec>
2888 <colspec colwidth="7*" colname="description"></colspec>
2889 <colspec colwidth="3*" colname="default"></colspec>
2892 <entry>Option</entry>
2893 <entry>Description</entry>
2894 <entry>Default</entry>
2899 <entry>databaseName</entry>
2900 <entry>Database from connection object</entry>
2901 <entry>Default</entry>
2907 <sect2 id="zoom.database.drop">
2908 <title>Database Drop</title>
2910 For Database Drop, type must be set to <literal>drop</literal> in
2911 <function>ZOOM_package_send</function>.
2913 <table frame="top" id="zoom.database.drop.options">
2914 <title>Database Drop Options</title>
2916 <colspec colwidth="4*" colname="name"></colspec>
2917 <colspec colwidth="7*" colname="description"></colspec>
2918 <colspec colwidth="3*" colname="default"></colspec>
2921 <entry>Option</entry>
2922 <entry>Description</entry>
2923 <entry>Default</entry>
2928 <entry>databaseName</entry>
2929 <entry>Database from connection object</entry>
2930 <entry>Default</entry>
2936 <sect2 id="zoom.commit">
2937 <title>Commit Operation</title>
2939 For Commit, type must be set to <literal>commit</literal> in
2940 <function>ZOOM_package_send</function>.
2943 <sect2 id="zoom.extended.services.behavior">
2944 <title>Protocol behavior</title>
2946 All the extended services are Z39.50-only.
2950 The database create, drop and commit services are privately defined
2952 Refer to <filename>esadmin.asn</filename> in YAZ for the ASN.1
2958 <sect1 id="zoom.options">
2959 <title>Options</title>
2961 Most &zoom; objects provide a way to specify options to change behavior.
2962 From an implementation point of view a set of options is just like
2963 an associative array / hash.
2966 ZOOM_options ZOOM_options_create(void);
2968 ZOOM_options ZOOM_options_create_with_parent(ZOOM_options parent);
2970 void ZOOM_options_destroy(ZOOM_options opt);
2973 const char *ZOOM_options_get(ZOOM_options opt, const char *name);
2975 void ZOOM_options_set(ZOOM_options opt, const char *name,
2979 typedef const char *(*ZOOM_options_callback)
2980 (void *handle, const char *name);
2982 ZOOM_options_callback
2983 ZOOM_options_set_callback(ZOOM_options opt,
2984 ZOOM_options_callback c,
2988 <sect1 id="zoom.queryconversions">
2989 <title>Query conversions</title>
2991 int ZOOM_query_cql2rpn(ZOOM_query s, const char *cql_str,
2992 ZOOM_connection conn);
2994 int ZOOM_query_ccl2rpn(ZOOM_query s, const char *ccl_str,
2996 int *ccl_error, const char **error_string,
3000 <function>ZOOM_query_cql2rpn</function> translates the CQL string,
3001 client-side, into RPN which may be passed to the server.
3002 This is useful for server's that don't themselves
3003 support CQL, for which <function>ZOOM_query_cql</function> is useless.
3004 `conn' is used only as a place to stash diagnostics if compilation
3005 fails; if this information is not needed, a null pointer may be used.
3006 The CQL conversion is driven by option <literal>cqlfile</literal> from
3007 connection conn. This specifies a conversion file (eg pqf.properties)
3008 which <emphasis>must</emphasis> be present.
3011 <function>ZOOM_query_ccl2rpn</function> translates the CCL string,
3012 client-side, into RPN which may be passed to the server.
3013 The conversion is driven by the specification given by
3014 <literal>config</literal>. Upon completion 0 is returned on success; -1
3015 is returned on on failure. Om failure <literal>error_string</literal> and
3016 <literal>error_pos</literal> holds error message and position of
3017 first error in original CCL string.
3020 <sect1 id="zoom.events"><title>Events</title>
3022 If you're developing non-blocking applications, you have to deal
3026 int ZOOM_event(int no, ZOOM_connection *cs);
3029 The <function>ZOOM_event</function> executes pending events for
3030 a number of connections. Supply the number of connections in
3031 <literal>no</literal> and an array of connections in
3032 <literal>cs</literal> (<literal>cs[0] ... cs[no-1]</literal>).
3033 A pending event could be a sending a search, receiving a response,
3035 When an event has occurred for one of the connections, this function
3036 returns a positive integer <literal>n</literal> denoting that an event
3037 occurred for connection <literal>cs[n-1]</literal>.
3038 When no events are pending for the connections, a value of zero is
3040 To ensure that all outstanding requests are performed call this function
3041 repeatedly until zero is returned.
3044 If <function>ZOOM_event</function> returns and returns non-zero, the
3045 last event that occurred can be expected.
3048 int ZOOM_connection_last_event(ZOOM_connection cs);
3051 <function>ZOOM_connection_last_event</function> returns an event type
3052 (integer) for the last event.
3055 <table frame="top" id="zoom.event.ids">
3056 <title>ZOOM Event IDs</title>
3058 <colspec colwidth="4*" colname="name"></colspec>
3059 <colspec colwidth="7*" colname="description"></colspec>
3062 <entry>Event</entry>
3063 <entry>Description</entry>
3068 <entry>ZOOM_EVENT_NONE</entry>
3069 <entry>No event has occurred</entry>
3072 <entry>ZOOM_EVENT_CONNECT</entry>
3073 <entry>TCP/IP connect has initiated</entry>
3076 <entry>ZOOM_EVENT_SEND_DATA</entry>
3077 <entry>Data has been transmitted (sending)</entry>
3080 <entry>ZOOM_EVENT_RECV_DATA</entry>
3081 <entry>Data has been received)</entry>
3084 <entry>ZOOM_EVENT_TIMEOUT</entry>
3085 <entry>Timeout</entry>
3088 <entry>ZOOM_EVENT_UNKNOWN</entry>
3089 <entry>Unknown event</entry>
3092 <entry>ZOOM_EVENT_SEND_APDU</entry>
3093 <entry>An APDU has been transmitted (sending)</entry>
3096 <entry>ZOOM_EVENT_RECV_APDU</entry>
3097 <entry>An APDU has been received</entry>
3100 <entry>ZOOM_EVENT_RECV_RECORD</entry>
3101 <entry>A result-set record has been received</entry>
3104 <entry>ZOOM_EVENT_RECV_SEARCH</entry>
3105 <entry>A search result been received</entry>
3112 <chapter id="server">
3113 <title>Generic server</title>
3114 <sect1 id="server.introduction"><title>Introduction</title>
3116 If you aren't into documentation, a good way to learn how the
3117 back end interface works is to look at the <filename>backend.h</filename>
3118 file. Then, look at the small dummy-server in
3119 <filename>ztest/ztest.c</filename>. The <filename>backend.h</filename>
3120 file also makes a good reference, once you've chewed your way through
3121 the prose of this file.
3124 If you have a database system that you would like to make available by
3125 means of Z39.50 or SRU, &yaz; basically offers your two options. You
3126 can use the APIs provided by the &asn;, &odr;, and &comstack;
3128 create and decode PDUs, and exchange them with a client.
3129 Using this low-level interface gives you access to all fields and
3130 options of the protocol, and you can construct your server as close
3131 to your existing database as you like.
3132 It is also a fairly involved process, requiring
3133 you to set up an event-handling mechanism, protocol state machine,
3134 etc. To simplify server implementation, we have implemented a compact
3135 and simple, but reasonably full-functioned server-frontend that will
3136 handle most of the protocol mechanics, while leaving you to
3137 concentrate on your database interface.
3141 The backend interface was designed in anticipation of a specific
3142 integration task, while still attempting to achieve some degree of
3143 generality. We realize fully that there are points where the
3144 interface can be improved significantly. If you have specific
3145 functions or parameters that you think could be useful, send us a
3146 mail (or better, sign on to the mailing list referred to in the
3147 top-level README file). We will try to fit good suggestions into future
3148 releases, to the extent that it can be done without requiring
3149 too many structural changes in existing applications.
3154 The &yaz; server does not support XCQL.
3158 <sect1 id="server.frontend">
3159 <title>The Database Frontend</title>
3161 We refer to this software as a generic database frontend. Your
3162 database system is the <emphasis>backend database</emphasis>, and the
3163 interface between the two is called the <emphasis>backend API</emphasis>.
3164 The backend API consists of a small number of function handlers and
3165 structure definitions. You are required to provide the
3166 <function>main()</function> routine for the server (which can be
3167 quite simple), as well as a set of handlers to match each of the
3169 The interface functions that you write can use any mechanism you like
3170 to communicate with your database system: You might link the whole
3171 thing together with your database application and access it by
3172 function calls; you might use IPC to talk to a database server
3173 somewhere; or you might link with third-party software that handles
3174 the communication for you (like a commercial database client library).
3175 At any rate, the handlers will perform the tasks of:
3188 Scanning the database index (optional - if you wish to implement SCAN).
3191 Extended Services (optional).
3194 Result-Set Delete (optional).
3197 Result-Set Sort (optional).
3200 Return Explain for SRU (optional).
3204 (more functions will be added in time to support as much of
3205 Z39.50-1995 as possible).
3208 <sect1 id="server.backend">
3209 <title>The Backend API</title>
3211 The header file that you need to use the interface are in the
3212 <filename>include/yaz</filename> directory. It's called
3213 <filename>backend.h</filename>. It will include other files from
3214 the <filename>include/yaz</filename> directory, so you'll
3215 probably want to use the -I option of your compiler to tell it
3216 where to find the files. When you run
3217 <literal>make</literal> in the top-level &yaz; directory,
3218 everything you need to create your server is to link with the
3219 <filename>lib/libyaz.la</filename> library.
3222 <sect1 id="server.main">
3223 <title>Your main() Routine</title>
3225 As mentioned, your <function>main()</function> routine can be quite brief.
3226 If you want to initialize global parameters, or read global configuration
3227 tables, this is the place to do it. At the end of the routine, you should
3231 int statserv_main(int argc, char **argv,
3232 bend_initresult *(*bend_init)(bend_initrequest *r),
3233 void (*bend_close)(void *handle));
3236 The third and fourth arguments are pointers to handlers. Handler
3237 <function>bend_init</function> is called whenever the server receives
3238 an Initialize Request, so it serves as a Z39.50 session initializer. The
3239 <function>bend_close</function> handler is called when the session is
3243 <function>statserv_main</function> will establish listening sockets
3244 according to the parameters given. When connection requests are received,
3245 the event handler will typically <function>fork()</function> and
3246 create a sub-process to handle a new connection.
3247 Alternatively the server may be setup to create threads for each
3249 If you do use global variables and forking, you should be aware, then,
3250 that these cannot be shared between associations, unless you explicitly
3251 disable forking by command line parameters.
3254 The server provides a mechanism for controlling some of its behavior
3255 without using command-line options. The function
3258 statserv_options_block *statserv_getcontrol(void);
3261 will return a pointer to a <literal>struct statserv_options_block</literal>
3262 describing the current default settings of the server. The structure
3263 contains these elements:
3266 <term><literal>int dynamic</literal></term>
3268 A boolean value, which determines whether the server
3269 will fork on each incoming request (TRUE), or not (FALSE). Default is
3270 TRUE. This flag is only read by UNIX-based servers (WIN32 based servers
3275 <term><literal>int threads</literal></term>
3277 A boolean value, which determines whether the server
3278 will create a thread on each incoming request (TRUE), or not (FALSE).
3279 Default is FALSE. This flag is only read by UNIX-based servers
3280 that offer POSIX Threads support.
3281 WIN32-based servers always operate in threaded mode.
3285 <term><literal>int inetd</literal></term>
3287 A boolean value, which determines whether the server
3288 will operates under a UNIX INET daemon (inetd). Default is FALSE.
3292 <term><literal>char logfile[ODR_MAXNAME+1]</literal></term>
3293 <listitem><para>File for diagnostic output ("": stderr).
3297 <term><literal>char apdufile[ODR_MAXNAME+1]</literal></term>
3299 Name of file for logging incoming and outgoing APDUs
3300 ("": don't log APDUs, "-":
3301 <literal>stderr</literal>).
3305 <term><literal>char default_listen[1024]</literal></term>
3306 <listitem><para>Same form as the command-line specification of
3307 listener address. "": no default listener address.
3308 Default is to listen at "tcp:@:9999". You can only
3309 specify one default listener address in this fashion.
3313 <term><literal>enum oid_proto default_proto;</literal></term>
3314 <listitem><para>Either <literal>PROTO_Z3950</literal> or
3315 <literal>PROTO_SR</literal>.
3316 Default is <literal>PROTO_Z39_50</literal>.
3320 <term><literal>int idle_timeout;</literal></term>
3321 <listitem><para>Maximum session idle-time, in minutes. Zero indicates
3322 no (infinite) timeout. Default is 15 minutes.
3326 <term><literal>int maxrecordsize;</literal></term>
3327 <listitem><para>Maximum permissible record (message) size. Default
3328 is 64 MB. This amount of memory will only be allocated if a
3329 client requests a very large amount of records in one operation
3331 Set it to a lower number if you are worried about resource
3332 consumption on your host system.
3336 <term><literal>char configname[ODR_MAXNAME+1]</literal></term>
3337 <listitem><para>Passed to the backend when a new connection is received.
3341 <term><literal>char setuid[ODR_MAXNAME+1]</literal></term>
3342 <listitem><para>Set user id to the user specified, after binding
3343 the listener addresses.
3348 <literal>void (*bend_start)(struct statserv_options_block *p)</literal>
3350 <listitem><para>Pointer to function which is called after the
3351 command line options have been parsed - but before the server
3353 For forked UNIX servers this handler is called in the mother
3354 process; for threaded servers this handler is called in the
3356 The default value of this pointer is NULL in which case it
3357 isn't invoked by the frontend server.
3358 When the server operates as an NT service this handler is called
3359 whenever the service is started.
3364 <literal>void (*bend_stop)(struct statserv_options_block *p)</literal>
3366 <listitem><para>Pointer to function which is called whenever the server
3367 has stopped listening for incoming connections. This function pointer
3368 has a default value of NULL in which case it isn't called.
3369 When the server operates as an NT service this handler is called
3370 whenever the service is stopped.
3374 <term><literal>void *handle</literal></term>
3375 <listitem><para>User defined pointer (default value NULL).
3376 This is a per-server handle that can be used to specify "user-data".
3377 Do not confuse this with the session-handle as returned by bend_init.
3383 The pointer returned by <literal>statserv_getcontrol</literal> points to
3384 a static area. You are allowed to change the contents of the structure,
3385 but the changes will not take effect before you call
3388 void statserv_setcontrol(statserv_options_block *block);
3392 that you should generally update this structure before calling
3393 <function>statserv_main()</function>.
3397 <sect1 id="server.backendfunctions">
3398 <title>The Backend Functions</title>
3400 For each service of the protocol, the backend interface declares one or
3401 two functions. You are required to provide implementations of the
3402 functions representing the services that you wish to implement.
3404 <sect2 id="server.init">
3407 bend_initresult (*bend_init)(bend_initrequest *r);
3410 This handler is called once for each new connection request, after
3411 a new process/thread has been created, and an Initialize Request has
3412 been received from the client. The pointer to the
3413 <function>bend_init</function> handler is passed in the call to
3414 <function>statserv_start</function>.
3417 This handler is also called when operating in SRU mode - when
3418 a connection has been made (even though SRU does not offer
3422 Unlike previous versions of YAZ, the <function>bend_init</function> also
3423 serves as a handler that defines the Z39.50 services that the backend
3424 wish to support. Pointers to <emphasis>all</emphasis> service handlers,
3425 including search - and fetch must be specified here in this handler.
3428 The request - and result structures are defined as
3431 typedef struct bend_initrequest
3433 /** \brief user/name/password to be read */
3434 Z_IdAuthentication *auth;
3435 /** \brief encoding stream (for results) */
3437 /** \brief printing stream */
3439 /** \brief decoding stream (use stream for results) */
3441 /** \brief reference ID */
3442 Z_ReferenceId *referenceId;
3443 /** \brief peer address of client */
3446 /** \brief character set and language negotiation
3448 see include/yaz/z-charneg.h
3450 Z_CharSetandLanguageNegotiation *charneg_request;
3452 /** \brief character negotiation response */
3453 Z_External *charneg_response;
3455 /** \brief character set (encoding) for query terms
3457 This is NULL by default. It should be set to the native character
3458 set that the backend assumes for query terms */
3459 char *query_charset;
3461 /** \brief whehter query_charset also applies to recors
3463 Is 0 (No) by default. Set to 1 (yes) if records is in the same
3464 character set as queries. If in doubt, use 0 (No).
3466 int records_in_same_charset;
3468 char *implementation_id;
3469 char *implementation_name;
3470 char *implementation_version;
3472 /** \brief Z39.50 sort handler */
3473 int (*bend_sort)(void *handle, bend_sort_rr *rr);
3474 /** \brief SRU/Z39.50 search handler */
3475 int (*bend_search)(void *handle, bend_search_rr *rr);
3476 /** \brief SRU/Z39.50 fetch handler */
3477 int (*bend_fetch)(void *handle, bend_fetch_rr *rr);
3478 /** \brief SRU/Z39.50 present handler */
3479 int (*bend_present)(void *handle, bend_present_rr *rr);
3480 /** \brief Z39.50 extended services handler */
3481 int (*bend_esrequest) (void *handle, bend_esrequest_rr *rr);
3482 /** \brief Z39.50 delete result set handler */
3483 int (*bend_delete)(void *handle, bend_delete_rr *rr);
3484 /** \brief Z39.50 scan handler */
3485 int (*bend_scan)(void *handle, bend_scan_rr *rr);
3486 /** \brief Z39.50 segment facility handler */
3487 int (*bend_segment)(void *handle, bend_segment_rr *rr);
3488 /** \brief SRU explain handler */
3489 int (*bend_explain)(void *handle, bend_explain_rr *rr);
3490 /** \brief SRU scan handler */
3491 int (*bend_srw_scan)(void *handle, bend_scan_rr *rr);
3492 /** \brief SRU record update handler */
3493 int (*bend_srw_update)(void *handle, bend_update_rr *rr);
3495 /** \brief whether named result sets are supported (0=disable, 1=enable) */
3496 int named_result_sets;
3499 typedef struct bend_initresult
3501 int errcode; /* 0==OK */
3502 char *errstring; /* system error string or NULL */
3503 void *handle; /* private handle to the backend module */
3507 In general, the server frontend expects that the
3508 <literal>bend_*result</literal> pointer that you return is valid at
3509 least until the next call to a <literal>bend_* function</literal>.
3510 This applies to all of the functions described herein. The parameter
3511 structure passed to you in the call belongs to the server frontend, and
3512 you should not make assumptions about its contents after the current
3513 function call has completed. In other words, if you want to retain any
3514 of the contents of a request structure, you should copy them.
3517 The <literal>errcode</literal> should be zero if the initialization of
3518 the backend went well. Any other value will be interpreted as an error.
3519 The <literal>errstring</literal> isn't used in the current version, but
3520 one option would be to stick it in the initResponse as a VisibleString.
3521 The <literal>handle</literal> is the most important parameter. It should
3522 be set to some value that uniquely identifies the current session to
3523 the backend implementation. It is used by the frontend server in any
3524 future calls to a backend function.
3525 The typical use is to set it to point to a dynamically allocated state
3526 structure that is private to your backend module.
3529 The <literal>auth</literal> member holds the authentication information
3530 part of the Z39.50 Initialize Request. Interpret this if your serves
3531 requires authentication.
3534 The members <literal>peer_name</literal>,
3535 <literal>implementation_id</literal>,
3536 <literal>implementation_name</literal> and
3537 <literal>implementation_version</literal> holds
3538 DNS of client, ID of implementor, name
3539 of client (Z39.50) implementation - and version.
3542 The <literal>bend_</literal> - members are set to NULL when
3543 <function>bend_init</function> is called. Modify the pointers by
3544 setting them to point to backend functions.
3547 <sect2 id="server.search.retrieve">
3548 <title>Search and Retrieve</title>
3550 We now describe the handlers that are required to support search -
3551 and retrieve. You must support two functions - one for search - and one
3552 for fetch (retrieval of one record). If desirable you can provide a
3553 third handler which is called when a present request is received which
3554 allows you to optimize retrieval of multiple-records.
3557 int (*bend_search) (void *handle, bend_search_rr *rr);
3560 char *setname; /* name to give to this set */
3561 int replace_set; /* replace set, if it already exists */
3562 int num_bases; /* number of databases in list */
3563 char **basenames; /* databases to search */
3564 Z_ReferenceId *referenceId;/* reference ID */
3565 Z_Query *query; /* query structure */
3566 ODR stream; /* encode stream */
3567 ODR decode; /* decode stream */
3568 ODR print; /* print stream */
3570 bend_request request;
3571 bend_association association;
3573 int hits; /* number of hits */
3574 int errcode; /* 0==OK */
3575 char *errstring; /* system error string or NULL */
3576 Z_OtherInformation *search_info; /* additional search info */
3577 char *srw_sortKeys; /* holds SRU/SRW sortKeys info */
3578 char *srw_setname; /* holds SRU/SRW generated resultsetID */
3579 int *srw_setnameIdleTime; /* holds SRU/SRW life-time */
3580 int estimated_hit_count; /* if hit count is estimated */
3581 int partial_resultset; /* if result set is partial */
3585 The <function>bend_search</function> handler is a fairly close
3586 approximation of a protocol Z39.50 Search Request - and Response PDUs
3587 The <literal>setname</literal> is the resultSetName from the protocol.
3588 You are required to establish a mapping between the set name and whatever
3589 your backend database likes to use.
3590 Similarly, the <literal>replace_set</literal> is a boolean value
3591 corresponding to the resultSetIndicator field in the protocol.
3592 <literal>num_bases/basenames</literal> is a length of/array of character
3593 pointers to the database names provided by the client.
3594 The <literal>query</literal> is the full query structure as defined in
3595 the protocol ASN.1 specification.
3596 It can be either of the possible query types, and it's up to you to
3597 determine if you can handle the provided query type.
3598 Rather than reproduce the C interface here, we'll refer you to the
3599 structure definitions in the file
3600 <filename>include/yaz/z-core.h</filename>. If you want to look at the
3601 attributeSetId OID of the RPN query, you can either match it against
3602 your own internal tables, or you can use the <link linkend="tools.oid">
3606 The structure contains a number of hits, and an
3607 <literal>errcode/errstring</literal> pair. If an error occurs
3608 during the search, or if you're unhappy with the request, you should
3609 set the errcode to a value from the BIB-1 diagnostic set. The value
3610 will then be returned to the user in a nonsurrogate diagnostic record
3611 in the response. The <literal>errstring</literal>, if provided, will
3612 go in the addinfo field. Look at the protocol definition for the
3613 defined error codes, and the suggested uses of the addinfo field.
3616 The <function>bend_search</function> handler is also called when
3617 the frontend server receives a SRU SearchRetrieveRequest.
3618 For SRU, a CQL query is usually provided by the client.
3619 The CQL query is available as part of <literal>Z_Query</literal>
3620 structure (note that CQL is now part of Z39.50 via an external).
3621 To support CQL in existing implementations that only do Type-1,
3622 we refer to the CQL-to-PQF tool described
3623 <link linkend="cql.to.pqf">here</link>.
3626 To maintain backwards compatibility, the frontend server
3627 of yaz always assume that error codes are BIB-1 diagnostics.
3628 For SRU operation, a Bib-1 diagnostic code is mapped to
3632 int (*bend_fetch) (void *handle, bend_fetch_rr *rr);
3634 typedef struct bend_fetch_rr {
3635 char *setname; /* set name */
3636 int number; /* record number */
3637 Z_ReferenceId *referenceId;/* reference ID */
3638 Odr_oid *request_format; /* format, transfer syntax (OID) */
3639 Z_RecordComposition *comp; /* Formatting instructions */
3640 ODR stream; /* encoding stream - memory source if req */
3641 ODR print; /* printing stream */
3643 char *basename; /* name of database that provided record */
3644 int len; /* length of record or -1 if structured */
3645 char *record; /* record */
3646 int last_in_set; /* is it? */
3647 Odr_oid *output_format; /* response format/syntax (OID) */
3648 int errcode; /* 0==success */
3649 char *errstring; /* system error string or NULL */
3650 int surrogate_flag; /* surrogate diagnostic */
3651 char *schema; /* string record schema input/output */
3655 The frontend server calls the <function>bend_fetch</function> handler
3656 when it needs database records to fulfill a Z39.50 Search Request, a
3657 Z39.50 Present Request or a SRU SearchRetrieveRequest.
3658 The <literal>setname</literal> is simply the name of the result set
3659 that holds the reference to the desired record.
3660 The <literal>number</literal> is the offset into the set (with 1
3661 being the first record in the set). The <literal>format</literal> field
3662 is the record format requested by the client (See
3663 <xref linkend="tools.oid"/>).
3664 A value of NULL for <literal>format</literal> indicates that the
3665 client did not request a specific format.
3666 The <literal>stream</literal> argument is an &odr; stream which
3667 should be used for allocating space for structured data records.
3668 The stream will be reset when all records have been assembled, and
3669 the response package has been transmitted.
3670 For unstructured data, the backend is responsible for maintaining a
3671 static or dynamic buffer for the record between calls.
3674 If a SRU SearchRetrieveRequest is received by the frontend server,
3675 the <literal>referenceId</literal> is NULL and the
3676 <literal>format</literal> (transfer syntax) is the OID for XML.
3677 The schema for SRU is stored in both the
3678 <literal>Z_RecordComposition</literal>
3679 structure and <literal>schema</literal> (simple string).
3682 In the structure, the <literal>basename</literal> is the name of the
3683 database that holds the
3684 record. <literal>len</literal> is the length of the record returned, in
3685 bytes, and <literal>record</literal> is a pointer to the record.
3686 <literal>last_in_set</literal> should be nonzero only if the record
3687 returned is the last one in the given result set.
3688 <literal>errcode</literal> and <literal>errstring</literal>, if
3689 given, will be interpreted as a global error pertaining to the
3690 set, and will be returned in a non-surrogate-diagnostic.
3691 If you wish to return the error as a surrogate-diagnostic
3692 (local error) you can do this by setting
3693 <literal>surrogate_flag</literal> to 1 also.
3696 If the <literal>len</literal> field has the value -1, then
3697 <literal>record</literal> is assumed to point to a constructed data
3698 type. The <literal>format</literal> field will be used to determine
3699 which encoder should be used to serialize the data.
3703 If your backend generates structured records, it should use
3704 <function>odr_malloc()</function> on the provided stream for allocating
3705 data: This allows the frontend server to keep track of the record sizes.
3709 The <literal>format</literal> field is mapped to an object identifier
3710 in the direct reference of the resulting EXTERNAL representation
3715 The current version of &yaz; only supports the direct reference mode.
3719 int (*bend_present) (void *handle, bend_present_rr *rr);
3722 char *setname; /* set name */
3724 int number; /* record number */
3725 Odr_oid *format; /* format, transfer syntax (OID) */
3726 Z_ReferenceId *referenceId;/* reference ID */
3727 Z_RecordComposition *comp; /* Formatting instructions */
3728 ODR stream; /* encoding stream - memory source if required */
3729 ODR print; /* printing stream */
3730 bend_request request;
3731 bend_association association;
3733 int hits; /* number of hits */
3734 int errcode; /* 0==OK */
3735 char *errstring; /* system error string or NULL */
3739 The <function>bend_present</function> handler is called when
3740 the server receives a Z39.50 Present Request.
3741 The <literal>setname</literal>,
3742 <literal>start</literal> and <literal>number</literal> is the
3743 name of the result set - start position - and number of records to
3744 be retrieved respectively. <literal>format</literal> and
3745 <literal>comp</literal> is the preferred transfer syntax and element
3746 specifications of the present request.
3749 Note that this is handler serves as a supplement for
3750 <function>bend_fetch</function> and need not to be defined in order to
3751 support search - and retrieve.
3754 <sect2 id="server.delete">
3755 <title>Delete</title>
3757 For back-ends that supports delete of a result set only one handler
3761 int (*bend_delete)(void *handle, bend_delete_rr *rr);
3763 typedef struct bend_delete_rr {
3767 Z_ReferenceId *referenceId;
3768 int delete_status; /* status for the whole operation */
3769 int *statuses; /* status each set - indexed as setnames */
3776 The delete set function definition is rather primitive, mostly because
3777 we have had no practical need for it as of yet. If someone wants
3778 to provide a full delete service, we'd be happy to add the
3779 extra parameters that are required. Are there clients out there
3780 that will actually delete sets they no longer need?
3784 <sect2 id="server.scan">
3787 For servers that wish to offer the scan service one handler
3791 int (*bend_scan)(void *handle, bend_scan_rr *rr);
3794 BEND_SCAN_SUCCESS, /* ok */
3795 BEND_SCAN_PARTIAL /* not all entries could be found */
3798 typedef struct bend_scan_rr {
3799 int num_bases; /* number of elements in databaselist */
3800 char **basenames; /* databases to search */
3801 Odr_oid *attributeset;
3802 Z_ReferenceId *referenceId; /* reference ID */
3803 Z_AttributesPlusTerm *term;
3804 ODR stream; /* encoding stream - memory source if required */
3805 ODR print; /* printing stream */
3807 int *step_size; /* step size */
3808 int term_position; /* desired index of term in result list/returned */
3809 int num_entries; /* number of entries requested/returned */
3811 /* scan term entries. The called handler does not have
3812 to allocate this. Size of entries is num_entries (see above) */
3813 struct scan_entry *entries;
3814 bend_scan_status status;
3817 char *scanClause; /* CQL scan clause */
3818 char *setname; /* Scan in result set (NULL if omitted) */
3822 This backend server handles both Z39.50 scan
3823 and SRU scan. In order for a handler to distinguish between SRU (CQL) scan
3824 Z39.50 Scan , it must check for a non-NULL value of
3825 <literal>scanClause</literal>.
3829 if designed today, it would be a choice using a union or similar,
3830 but that would break binary compatibility with existing servers.
3835 <sect1 id="server.invocation">
3836 <title>Application Invocation</title>
3838 The finished application has the following
3839 invocation syntax (by way of <function>statserv_main()</function>):
3847 A listener specification consists of a transport mode followed by a
3848 colon (:) followed by a listener address. The transport mode is
3849 either <literal>tcp</literal>, <literal>unix:</literal> or
3850 <literal>ssl</literal>.
3853 For TCP and SSL, an address has the form
3856 hostname | IP-number [: portnumber]
3859 The port number defaults to 210 (standard Z39.50 port).
3862 For UNIX, the address is the filename of socket.
3865 For TCP/IP and SSL, the special hostnames <literal>@</literal>,
3866 maps to <literal>IN6ADDR_ANY_INIT</literal> with
3867 IPV4 binding as well (bindv6only=0),
3868 The special hostname <literal>@4</literal> binds to
3869 <literal>INADDR_ANY</literal> (IPV4 only listener).
3870 The special hostname <literal>@6</literal> binds to
3871 <literal>IN6ADDR_ANY_INIT</literal> with bindv6only=1 (IPV6 only listener).
3873 <example id="server.example.running.unix">
3874 <title>Running the GFS on Unix</title>
3876 Assuming the server application <replaceable>appname</replaceable> is
3877 started as root, the following will make it listen on port 210.
3878 The server will change identity to <literal>nobody</literal>
3879 and write its log to <filename>/var/log/app.log</filename>.
3881 application -l /var/log/app.log -u nobody tcp:@:210
3885 The server will accept Z39.50 requests and offer SRU service on port 210.
3888 <example id="server.example.apache.sru">
3889 <title>Setting up Apache as SRU Frontend</title>
3891 If you use <ulink url="&url.apache;">Apache</ulink>
3892 as your public web server and want to offer HTTP port 80
3893 access to the YAZ server on 210, you can use the
3894 <ulink url="&url.apache.directive.proxypass;">
3895 <literal>ProxyPass</literal></ulink>
3897 If you have virtual host
3898 <literal>srw.mydomain</literal> you can use the following directives
3899 in Apache's httpd.conf:
3902 ErrorLog /home/srw/logs/error_log
3903 TransferLog /home/srw/logs/access_log
3904 ProxyPass / http://srw.mydomain:210/
3909 The above for the Apache 1.3 series.
3912 <example id="server.example.local.access">
3913 <title>Running a server with local access only</title>
3915 Servers that is only being accessed from the local host should listen
3916 on UNIX file socket rather than a Internet socket. To listen on
3917 <filename>/tmp/mysocket</filename> start the server as follows:
3919 application unix:/tmp/mysocket
3924 <sect1 id="server.vhosts">
3925 <title>GFS Configuration and Virtual Hosts</title>
3930 <title>The Z39.50 ASN.1 Module</title>
3931 <sect1 id="asn.introduction">
3932 <title>Introduction</title>
3934 The &asn; module provides you with a set of C struct definitions for the
3935 various PDUs of the Z39.50 protocol, as well as for the complex types
3936 appearing within the PDUs. For the primitive data types, the C
3937 representation often takes the form of an ordinary C language type,
3938 such as <literal>Odr_int</literal> which is equivalent to an integral
3939 C integer. For ASN.1 constructs that have no direct
3940 representation in C, such as general octet strings and bit strings,
3941 the &odr; module (see section <link linkend="odr">The ODR Module</link>)
3942 provides auxiliary definitions.
3945 The &asn; module is located in sub directory <filename>z39.50</filename>.
3946 There you'll find C files that implements encoders and decoders for the
3947 Z39.50 types. You'll also find the protocol definitions:
3948 <filename>z3950v3.asn</filename>, <filename>esupdate.asn</filename>,
3952 <sect1 id="asn.preparing">
3953 <title>Preparing PDUs</title>
3955 A structure representing a complex ASN.1 type doesn't in itself contain the
3956 members of that type. Instead, the structure contains
3957 <emphasis>pointers</emphasis> to the members of the type.
3958 This is necessary, in part, to allow a mechanism for specifying which
3959 of the optional structure (SEQUENCE) members are present, and which
3960 are not. It follows that you will need to somehow provide space for
3961 the individual members of the structure, and set the pointers to
3962 refer to the members.
3965 The conversion routines don't care how you allocate and maintain your
3966 C structures - they just follow the pointers that you provide.
3967 Depending on the complexity of your application, and your personal
3968 taste, there are at least three different approaches that you may take
3969 when you allocate the structures.
3972 You can use static or automatic local variables in the function that
3973 prepares the PDU. This is a simple approach, and it provides the most
3974 efficient form of memory management. While it works well for flat
3975 PDUs like the InitReqest, it will generally not be sufficient for say,
3976 the generation of an arbitrarily complex RPN query structure.
3979 You can individually create the structure and its members using the
3980 <function>malloc(2)</function> function. If you want to ensure that
3981 the data is freed when it is no longer needed, you will have to
3982 define a function that individually releases each member of a
3983 structure before freeing the structure itself.
3986 You can use the <function>odr_malloc()</function> function (see
3987 <xref linkend="odr.use"/> for details). When you use
3988 <function>odr_malloc()</function>, you can release all of the
3989 allocated data in a single operation, independent of any pointers and
3990 relations between the data. <function>odr_malloc()</function> is based on a
3991 "nibble-memory"
3992 scheme, in which large portions of memory are allocated, and then
3993 gradually handed out with each call to <function>odr_malloc()</function>.
3994 The next time you call <function>odr_reset()</function>, all of the
3995 memory allocated since the last call is recycled for future use (actually,
3996 it is placed on a free-list).
3999 You can combine all of the methods described here. This will often be
4000 the most practical approach. For instance, you might use
4001 <function>odr_malloc()</function> to allocate an entire structure and
4002 some of its elements, while you leave other elements pointing to global
4003 or per-session default variables.
4006 The &asn; module provides an important aid in creating new PDUs. For
4007 each of the PDU types (say, <function>Z_InitRequest</function>), a
4008 function is provided that allocates and initializes an instance of
4009 that PDU type for you. In the case of the InitRequest, the function is
4010 simply named <function>zget_InitRequest()</function>, and it sets up
4011 reasonable default value for all of the mandatory members. The optional
4012 members are generally initialized to null pointers. This last aspect
4013 is very important: it ensures that if the PDU definitions are
4014 extended after you finish your implementation (to accommodate
4015 new versions of the protocol, say), you won't get into trouble with
4016 uninitialized pointers in your structures. The functions use
4017 <function>odr_malloc()</function> to
4018 allocate the PDUs and its members, so you can free everything again with a
4019 single call to <function>odr_reset()</function>. We strongly recommend
4020 that you use the <literal>zget_*</literal>
4021 functions whenever you are preparing a PDU (in a C++ API, the
4022 <literal>zget_</literal>
4023 functions would probably be promoted to constructors for the
4027 The prototype for the individual PDU types generally look like this:
4030 Z_<type> *zget_<type>(ODR o);
4036 Z_InitRequest *zget_InitRequest(ODR o);
4039 The &odr; handle should generally be your encoding stream, but it
4043 As well as the individual PDU functions, a function
4044 <function>zget_APDU()</function> is provided, which allocates
4045 a top-level Z-APDU of the type requested:
4048 Z_APDU *zget_APDU(ODR o, int which);
4051 The <varname>which</varname> parameter is (of course) the discriminator
4052 belonging to the <varname>Z_APDU</varname> <literal>CHOICE</literal> type.
4053 All of the interface described here is provided by the &asn; module, and
4054 you access it through the <filename>proto.h</filename> header file.
4057 <sect1 id="asn.external">
4058 <title>EXTERNAL Data</title>
4060 In order to achieve extensibility and adaptability to different
4061 application domains, the new version of the protocol defines many
4062 structures outside of the main ASN.1 specification, referencing them
4063 through ASN.1 EXTERNAL constructs. To simplify the construction and
4064 access to the externally referenced data, the &asn; module defines a
4065 specialized version of the EXTERNAL construct, called
4066 <literal>Z_External</literal>.It is defined thus:
4069 typedef struct Z_External
4071 Odr_oid *direct_reference;
4072 int *indirect_reference;
4077 Z_External_single = 0,
4079 Z_External_arbitrary,
4081 /* Specific types */
4083 Z_External_explainRecord,
4084 Z_External_resourceReport1,
4085 Z_External_resourceReport2
4093 Odr_any *single_ASN1_type;
4094 Odr_oct *octet_aligned;
4095 Odr_bitmask *arbitrary;
4097 /* Specific types */
4099 Z_ExplainRecord *explainRecord;
4100 Z_ResourceReport1 *resourceReport1;
4101 Z_ResourceReport2 *resourceReport2;
4109 When decoding, the &asn; module will attempt to determine which
4110 syntax describes the data by looking at the reference fields
4111 (currently only the direct-reference). For ASN.1 structured data, you
4112 need only consult the <literal>which</literal> field to determine the
4113 type of data. You can the access the data directly through the union.
4114 When constructing data for encoding, you set the union pointer to point
4115 to the data, and set the <literal>which</literal> field accordingly.
4116 Remember also to set the direct (or indirect) reference to the correct
4117 OID for the data type.
4118 For non-ASN.1 data such as MARC records, use the
4119 <literal>octet_aligned</literal> arm of the union.
4122 Some servers return ASN.1 structured data values (eg. database
4123 records) as BER-encoded records placed in the
4124 <literal>octet-aligned</literal> branch of the EXTERNAL CHOICE.
4125 The ASN-module will <emphasis>not</emphasis> automatically decode
4126 these records. To help you decode the records in the application, the
4130 Z_ext_typeent *z_ext_gettypebyref(const oid *oid);
4133 Can be used to retrieve information about the known, external data
4134 types. The function return a pointer to a static area, or NULL, if no
4135 match for the given direct reference is found. The
4136 <literal>Z_ext_typeent</literal>
4140 typedef struct Z_ext_typeent
4142 int oid[OID_SIZE]; /* the direct-reference OID. */
4143 int what; /* discriminator value for the external CHOICE */
4144 Odr_fun fun; /* decoder function */
4148 The <literal>what</literal> member contains the
4149 <literal>Z_External</literal> union discriminator value for the
4150 given type: For the SUTRS record syntax, the value would be
4151 <literal>Z_External_sutrs</literal>.
4152 The <literal>fun</literal> member contains a pointer to the
4153 function which encodes/decodes the given type. Again, for the SUTRS
4154 record syntax, the value of <literal>fun</literal> would be
4155 <literal>z_SUTRS</literal> (a function pointer).
4158 If you receive an EXTERNAL which contains an octet-string value that
4159 you suspect of being an ASN.1-structured data value, you can use
4160 <literal>z_ext_gettypebyref</literal> to look for the provided
4162 If the return value is different from NULL, you can use the provided
4163 function to decode the BER string (see <xref linkend="odr.use"/>
4167 If you want to <emphasis>send</emphasis> EXTERNALs containing
4168 ASN.1-structured values in the occtet-aligned branch of the CHOICE, this
4169 is possible too. However, on the encoding phase, it requires a somewhat
4170 involved juggling around of the various buffers involved.
4173 If you need to add new, externally defined data types, you must update
4174 the struct above, in the source file <filename>prt-ext.h</filename>, as
4175 well as the encoder/decoder in the file <filename>prt-ext.c</filename>.
4176 When changing the latter, remember to update both the
4177 <literal>arm</literal> arrary and the list
4178 <literal>type_table</literal>, which drives the CHOICE biasing that
4179 is necessary to tell the different, structured types apart
4184 Eventually, the EXTERNAL processing will most likely
4185 automatically insert the correct OIDs or indirect-refs. First,
4186 however, we need to determine how application-context management
4187 (specifically the presentation-context-list) should fit into the
4192 <sect1 id="asn.pdu">
4193 <title>PDU Contents Table</title>
4195 We include, for reference, a listing of the fields of each top-level
4196 PDU, as well as their default settings.
4198 <table frame="top" id="asn.default.initialize.request">
4199 <title>Default settings for PDU Initialize Request</title>
4201 <colspec colwidth="7*" colname="field"></colspec>
4202 <colspec colwidth="5*" colname="type"></colspec>
4203 <colspec colwidth="7*" colname="value"></colspec>
4206 <entry>Field</entry>
4208 <entry>Default Value</entry>
4213 referenceId</entry><entry>Z_ReferenceId</entry><entry>NULL
4216 protocolVersion</entry><entry>Odr_bitmask</entry><entry>Empty bitmask
4219 options</entry><entry>Odr_bitmask</entry><entry>Empty bitmask
4222 preferredMessageSize</entry><entry>Odr_int</entry><entry>30*1024
4225 maximumRecordSize</entry><entry>Odr_int</entry><entry>30*1024
4228 idAuthentication</entry><entry>Z_IdAuthentication</entry><entry>NULL
4231 implementationId</entry><entry>char*</entry><entry>"81"
4234 implementationName</entry><entry>char*</entry><entry>"YAZ"
4237 implementationVersion</entry><entry>char*</entry><entry>YAZ_VERSION
4240 userInformationField</entry><entry>Z_UserInformation</entry><entry>NULL
4243 otherInfo</entry><entry>Z_OtherInformation</entry><entry>NULL
4248 <table frame="top" id="asn.default.initialize.response">
4249 <title>Default settings for PDU Initialize Response</title>
4251 <colspec colwidth="7*" colname="field"></colspec>
4252 <colspec colwidth="5*" colname="type"></colspec>
4253 <colspec colwidth="7*" colname="value"></colspec>
4256 <entry>Field</entry>
4258 <entry>Default Value</entry>
4263 referenceId</entry><entry>Z_ReferenceId</entry><entry>NULL
4266 protocolVersion</entry><entry>Odr_bitmask</entry><entry>Empty bitmask
4269 options</entry><entry>Odr_bitmask</entry><entry>Empty bitmask
4272 preferredMessageSize</entry><entry>Odr_int</entry><entry>30*1024
4275 maximumRecordSize</entry><entry>Odr_int</entry><entry>30*1024
4278 result</entry><entry>Odr_bool</entry><entry>TRUE
4281 implementationId</entry><entry>char*</entry><entry>"id)"
4284 implementationName</entry><entry>char*</entry><entry>"YAZ"
4287 implementationVersion</entry><entry>char*</entry><entry>YAZ_VERSION
4290 userInformationField</entry><entry>Z_UserInformation</entry><entry>NULL
4293 otherInfo</entry><entry>Z_OtherInformation</entry><entry>NULL
4298 <table frame="top" id="asn.default.search.request">
4299 <title>Default settings for PDU Search Request</title>
4301 <colspec colwidth="7*" colname="field"></colspec>
4302 <colspec colwidth="5*" colname="type"></colspec>
4303 <colspec colwidth="7*" colname="value"></colspec>
4306 <entry>Field</entry>
4308 <entry>Default Value</entry>
4313 referenceId</entry><entry>Z_ReferenceId</entry><entry>NULL
4316 smallSetUpperBound</entry><entry>Odr_int</entry><entry>0
4319 largeSetLowerBound</entry><entry>Odr_int</entry><entry>1
4322 mediumSetPresentNumber</entry><entry>Odr_int</entry><entry>0
4325 replaceIndicator</entry><entry>Odr_bool</entry><entry>TRUE
4328 resultSetName</entry><entry>char *</entry><entry>"default"
4331 num_databaseNames</entry><entry>Odr_int</entry><entry>0
4334 databaseNames</entry><entry>char **</entry><entry>NULL
4337 smallSetElementSetNames</entry><entry>Z_ElementSetNames
4341 mediumSetElementSetNames</entry><entry>Z_ElementSetNames
4345 preferredRecordSyntax</entry><entry>Odr_oid</entry><entry>NULL
4348 query</entry><entry>Z_Query</entry><entry>NULL
4351 additionalSearchInfo</entry><entry>Z_OtherInformation
4355 otherInfo</entry><entry>Z_OtherInformation</entry><entry>NULL
4360 <table frame="top" id="asn.default.search.response">
4361 <title>Default settings for PDU Search Response</title>
4363 <colspec colwidth="7*" colname="field"></colspec>
4364 <colspec colwidth="5*" colname="type"></colspec>
4365 <colspec colwidth="7*" colname="value"></colspec>
4368 <entry>Field</entry>
4370 <entry>Default Value</entry>
4375 referenceId</entry><entry>Z_ReferenceId</entry><entry>NULL
4378 resultCount</entry><entry>Odr_int</entry><entry>0
4381 numberOfRecordsReturned</entry><entry>Odr_int</entry><entry>0
4384 nextResultSetPosition</entry><entry>Odr_int</entry><entry>0
4387 searchStatus</entry><entry>Odr_bool</entry><entry>TRUE
4390 resultSetStatus</entry><entry>Odr_int</entry><entry>NULL
4393 presentStatus</entry><entry>Odr_int</entry><entry>NULL
4396 records</entry><entry>Z_Records</entry><entry>NULL
4399 additionalSearchInfo</entry>
4400 <entry>Z_OtherInformation</entry><entry>NULL
4403 otherInfo</entry><entry>Z_OtherInformation</entry><entry>NULL
4408 <table frame="top" id="asn.default.present.request">
4409 <title>Default settings for PDU Present Request</title>
4411 <colspec colwidth="7*" colname="field"></colspec>
4412 <colspec colwidth="5*" colname="type"></colspec>
4413 <colspec colwidth="7*" colname="value"></colspec>
4416 <entry>Field</entry>
4418 <entry>Default Value</entry>
4423 referenceId</entry><entry>Z_ReferenceId</entry><entry>NULL
4426 resultSetId</entry><entry>char*</entry><entry>"default"
4429 resultSetStartPoint</entry><entry>Odr_int</entry><entry>1
4432 numberOfRecordsRequested</entry><entry>Odr_int</entry><entry>10
4435 num_ranges</entry><entry>Odr_int</entry><entry>0
4438 additionalRanges</entry><entry>Z_Range</entry><entry>NULL
4441 recordComposition</entry><entry>Z_RecordComposition</entry><entry>NULL
4444 preferredRecordSyntax</entry><entry>Odr_oid</entry><entry>NULL
4447 maxSegmentCount</entry><entry>Odr_int</entry><entry>NULL
4450 maxRecordSize</entry><entry>Odr_int</entry><entry>NULL
4453 maxSegmentSize</entry><entry>Odr_int</entry><entry>NULL
4456 otherInfo</entry><entry>Z_OtherInformation</entry><entry>NULL
4461 <table frame="top" id="asn.default.present.response">
4462 <title>Default settings for PDU Present Response</title>
4464 <colspec colwidth="7*" colname="field"></colspec>
4465 <colspec colwidth="5*" colname="type"></colspec>
4466 <colspec colwidth="7*" colname="value"></colspec>
4469 <entry>Field</entry>
4471 <entry>Default Value</entry>
4476 referenceId</entry><entry>Z_ReferenceId</entry><entry>NULL
4479 numberOfRecordsReturned</entry><entry>Odr_int</entry><entry>0
4482 nextResultSetPosition</entry><entry>Odr_int</entry><entry>0
4485 presentStatus</entry><entry>Odr_int</entry><entry>Z_PresentStatus_success
4488 records</entry><entry>Z_Records</entry><entry>NULL
4491 otherInfo</entry><entry>Z_OtherInformation</entry><entry>NULL
4496 <table frame="top" id="asn.default.delete.result.set.request">
4497 <title>Default settings for Delete Result Set Request</title>
4499 <colspec colwidth="7*" colname="field"></colspec>
4500 <colspec colwidth="5*" colname="type"></colspec>
4501 <colspec colwidth="7*" colname="value"></colspec>
4504 <entry>Field</entry>
4506 <entry>Default Value</entry>
4510 <row><entry>referenceId
4511 </entry><entry>Z_ReferenceId</entry><entry>NULL
4514 deleteFunction</entry><entry>Odr_int</entry><entry>Z_DeleteResultSetRequest_list
4517 num_ids</entry><entry>Odr_int</entry><entry>0
4520 resultSetList</entry><entry>char**</entry><entry>NULL
4523 otherInfo</entry><entry>Z_OtherInformation</entry><entry>NULL
4528 <table frame="top" id="asn.default.delete.result.set.response">
4529 <title>Default settings for Delete Result Set Response</title>
4531 <colspec colwidth="7*" colname="field"></colspec>
4532 <colspec colwidth="5*" colname="type"></colspec>
4533 <colspec colwidth="7*" colname="value"></colspec>
4536 <entry>Field</entry>
4538 <entry>Default Value</entry>
4543 referenceId</entry><entry>Z_ReferenceId</entry><entry>NULL
4546 deleteOperationStatus</entry><entry>Odr_int</entry>
4547 <entry>Z_DeleteStatus_success</entry></row>
4549 num_statuses</entry><entry>Odr_int</entry><entry>0
4552 deleteListStatuses</entry><entry>Z_ListStatus**</entry><entry>NULL
4555 numberNotDeleted</entry><entry>Odr_int</entry><entry>NULL
4558 num_bulkStatuses</entry><entry>Odr_int</entry><entry>0
4561 bulkStatuses</entry><entry>Z_ListStatus</entry><entry>NUL
4564 deleteMessage</entry><entry>char*</entry><entry>NULL
4567 otherInfo</entry><entry>Z_OtherInformation</entry><entry>NULL
4572 <table frame="top" id="asn.default.scan.request">
4573 <title>Default settings for Scan Request</title>
4575 <colspec colwidth="7*" colname="field"></colspec>
4576 <colspec colwidth="5*" colname="type"></colspec>
4577 <colspec colwidth="7*" colname="value"></colspec>
4580 <entry>Field</entry>
4582 <entry>Default Value</entry>
4587 referenceId</entry><entry>Z_ReferenceId</entry><entry>NULL
4590 num_databaseNames</entry><entry>Odr_int</entry><entry>0
4593 databaseNames</entry><entry>char**</entry><entry>NULL
4596 attributeSet</entry><entry>Odr_oid</entry><entry>NULL
4599 termListAndStartPoint</entry><entry>Z_AttributesPlus...
4600 </entry><entry>NULL</entry></row>
4602 stepSize</entry><entry>Odr_int</entry><entry>NULL
4605 numberOfTermsRequested</entry><entry>Odr_int</entry><entry>20
4608 preferredPositionInResponse</entry><entry>Odr_int</entry><entry>NULL
4611 otherInfo</entry><entry>Z_OtherInformation</entry><entry>NULL
4616 <table frame="top" id="asn.default.scan.response">
4617 <title>Default settings for Scan Response</title>
4619 <colspec colwidth="7*" colname="field"></colspec>
4620 <colspec colwidth="5*" colname="type"></colspec>
4621 <colspec colwidth="7*" colname="value"></colspec>
4624 <entry>Field</entry>
4626 <entry>Default Value</entry>
4631 referenceId</entry><entry>Z_ReferenceId</entry><entry>NULL
4634 stepSize</entry><entry>Odr_int</entry><entry>NULL
4637 scanStatus</entry><entry>Odr_int</entry><entry>Z_Scan_success
4640 numberOfEntriesReturned</entry><entry>Odr_int</entry><entry>0
4643 positionOfTerm</entry><entry>Odr_int</entry><entry>NULL
4646 entries</entry><entry>Z_ListEntris</entry><entry>NULL
4649 attributeSet</entry><entry>Odr_oid</entry><entry>NULL
4652 otherInfo</entry><entry>Z_OtherInformation</entry><entry>NULL
4657 <table frame="top" id="asn.default.trigger.resource.control.request">
4658 <title>Default settings for Trigger Resource Control Request</title>
4660 <colspec colwidth="7*" colname="field"></colspec>
4661 <colspec colwidth="5*" colname="type"></colspec>
4662 <colspec colwidth="7*" colname="value"></colspec>
4665 <entry>Field</entry>
4667 <entry>Default Value</entry>
4672 referenceId</entry><entry>Z_ReferenceId</entry><entry>NULL
4675 requestedAction</entry><entry>Odr_int</entry><entry>
4676 Z_TriggerResourceCtrl_resou..
4679 prefResourceReportFormat</entry><entry>Odr_oid</entry><entry>NULL
4682 resultSetWanted</entry><entry>Odr_bool</entry><entry>NULL
4685 otherInfo</entry><entry>Z_OtherInformation</entry><entry>NULL
4690 <table frame="top" id="asn.default.resource.control.request">
4691 <title>Default settings for Resource Control Request</title>
4693 <colspec colwidth="7*" colname="field"></colspec>
4694 <colspec colwidth="5*" colname="type"></colspec>
4695 <colspec colwidth="7*" colname="value"></colspec>
4698 <entry>Field</entry>
4700 <entry>Default Value</entry>
4705 referenceId</entry><entry>Z_ReferenceId</entry><entry>NULL
4708 suspendedFlag</entry><entry>Odr_bool</entry><entry>NULL
4711 resourceReport</entry><entry>Z_External</entry><entry>NULL
4714 partialResultsAvailable</entry><entry>Odr_int</entry><entry>NULL
4717 responseRequired</entry><entry>Odr_bool</entry><entry>FALSE
4720 triggeredRequestFlag</entry><entry>Odr_bool</entry><entry>NULL
4723 otherInfo</entry><entry>Z_OtherInformation</entry><entry>NULL
4728 <table frame="top" id="asn.default.resource.control.response">
4729 <title>Default settings for Resource Control Response</title>
4731 <colspec colwidth="7*" colname="field"></colspec>
4732 <colspec colwidth="5*" colname="type"></colspec>
4733 <colspec colwidth="7*" colname="value"></colspec>
4736 <entry>Field</entry>
4738 <entry>Default Value</entry>
4743 referenceId</entry><entry>Z_ReferenceId</entry><entry>NULL
4746 continueFlag</entry><entry>bool_t</entry><entry>TRUE
4749 resultSetWanted</entry><entry>bool_t</entry><entry>NULL
4752 otherInfo</entry><entry>Z_OtherInformation</entry><entry>NULL
4757 <table frame="top" id="asn.default.access.control.request">
4758 <title>Default settings for Access Control Request</title>
4760 <colspec colwidth="7*" colname="field"></colspec>
4761 <colspec colwidth="5*" colname="type"></colspec>
4762 <colspec colwidth="7*" colname="value"></colspec>
4765 <entry>Field</entry>
4767 <entry>Default Value</entry>
4772 referenceId</entry><entry>Z_ReferenceId</entry><entry>NULL
4775 which</entry><entry>enum</entry><entry>Z_AccessRequest_simpleForm;
4778 u</entry><entry>union</entry><entry>NULL
4781 otherInfo</entry><entry>Z_OtherInformation</entry><entry>NULL
4786 <table frame="top" id="asn.default.access.control.response">
4787 <title>Default settings for Access Control Response</title>
4789 <colspec colwidth="7*" colname="field"></colspec>
4790 <colspec colwidth="5*" colname="type"></colspec>
4791 <colspec colwidth="7*" colname="value"></colspec>
4794 <entry>Field</entry>
4796 <entry>Default Value</entry>
4801 referenceId</entry><entry>Z_ReferenceId</entry><entry>NULL
4804 which</entry><entry>enum</entry><entry>Z_AccessResponse_simpleForm
4807 u</entry><entry>union</entry><entry>NULL
4810 diagnostic</entry><entry>Z_DiagRec</entry><entry>NULL
4813 otherInfo</entry><entry>Z_OtherInformation</entry><entry>NULL
4818 <table frame="top" id="asn.default.segment">
4819 <title>Default settings for Segment</title>
4821 <colspec colwidth="7*" colname="field"></colspec>
4822 <colspec colwidth="5*" colname="type"></colspec>
4823 <colspec colwidth="7*" colname="value"></colspec>
4826 <entry>Field</entry>
4828 <entry>Default Value</entry>
4833 referenceId</entry><entry>Z_ReferenceId</entry><entry>NULL
4836 numberOfRecordsReturned</entry><entry>Odr_int</entry><entry>value=0
4839 num_segmentRecords</entry><entry>Odr_int</entry><entry>0
4842 segmentRecords</entry><entry>Z_NamePlusRecord</entry><entry>NULL
4844 <row><entry>otherInfo</entry><entry>Z_OtherInformation</entry><entry>NULL
4849 <table frame="top" id="asn.default.close">
4850 <title>Default settings for Close</title>
4852 <colspec colwidth="7*" colname="field"></colspec>
4853 <colspec colwidth="5*" colname="type"></colspec>
4854 <colspec colwidth="7*" colname="value"></colspec>
4857 <entry>Field</entry>
4859 <entry>Default Value</entry>
4864 referenceId</entry><entry>Z_ReferenceId</entry><entry>NULL
4867 closeReason</entry><entry>Odr_int</entry><entry>Z_Close_finished
4870 diagnosticInformation</entry><entry>char*</entry><entry>NULL
4873 resourceReportFormat</entry><entry>Odr_oid</entry><entry>NULL
4876 resourceFormat</entry><entry>Z_External</entry><entry>NULL
4879 otherInfo</entry><entry>Z_OtherInformation</entry><entry>NULL
4887 <title>SOAP and SRU</title>
4888 <sect1 id="soap.introduction">
4889 <title>Introduction</title>
4891 &yaz; uses a very simple implementation of
4892 <ulink url="&url.soap;">SOAP</ulink> that only,
4893 currenly, supports what is sufficient to offer SRU SOAP functionality.
4894 The implementation uses the
4895 <ulink url="&url.libxml2.api.tree;">tree API</ulink> of
4896 libxml2 to encode and decode SOAP packages.
4899 Like the Z39.50 ASN.1 module, the &yaz; SRU implementation uses
4900 simple C structs to represent SOAP packages as well as
4904 <sect1 id="soap.http">
4907 &yaz; only offers HTTP as transport carrier for SOAP, but it is
4908 relatively easy to change that.
4911 The following definition of <literal>Z_GDU</literal> (Generic Data
4912 Unit) allows for both HTTP and Z39.50 in one packet.
4915 #include <yaz/zgdu.h>
4917 #define Z_GDU_Z3950 1
4918 #define Z_GDU_HTTP_Request 2
4919 #define Z_GDU_HTTP_Response 3
4924 Z_HTTP_Request *HTTP_Request;
4925 Z_HTTP_Response *HTTP_Response;
4930 The corresponding Z_GDU encoder/decoder is <function>z_GDU</function>.
4931 The <literal>z3950</literal> is any of the known BER encoded Z39.50
4933 <literal>HTTP_Request</literal> and <literal>HTTP_Response</literal>
4934 is the HTTP Request and Response respectively.
4937 <sect1 id="soap.xml">
4938 <title>SOAP Packages</title>
4940 Every SOAP package in &yaz; is represented as follows:
4942 #include <yaz/soap.h>
4956 #define Z_SOAP_fault 1
4957 #define Z_SOAP_generic 2
4958 #define Z_SOAP_error 3
4962 Z_SOAP_Fault *fault;
4963 Z_SOAP_Generic *generic;
4964 Z_SOAP_Fault *soap_error;
4971 The <literal>fault</literal> and <literal>soap_error</literal>
4972 arms represent both a SOAP fault - struct
4973 <literal>Z_SOAP_Fault</literal>. Any other generic
4974 (valid) package is represented by <literal>Z_SOAP_Generic</literal>.
4977 The <literal>ns</literal> as part of <literal>Z_SOAP</literal>
4978 is the namespace for SOAP itself and reflects the SOAP
4979 version. For version 1.1 it is
4980 <literal>http://schemas.xmlsoap.org/soap/envelope/</literal>,
4981 for version 1.2 it is
4982 <literal>http://www.w3.org/2001/06/soap-envelope</literal>.
4985 int z_soap_codec(ODR o, Z_SOAP **pp,
4986 char **content_buf, int *content_len,
4987 Z_SOAP_Handler *handlers);
4990 The <literal>content_buf</literal> and <literal>content_len</literal>
4991 is XML buffer and length of buffer respectively.
4994 The <literal>handlers</literal> is a list of SOAP codec
4995 handlers - one handler for each service namespace. For SRU SOAP, the
4996 namespace would be <literal>http://www.loc.gov/zing/srw/v1.0/</literal>.
4999 When decoding, the <function>z_soap_codec</function>
5000 inspects the XML content
5001 and tries to match one of the services namespaces of the
5002 supplied handlers. If there is a match a handler function
5003 is invoked which decodes that particular SOAP package.
5004 If successful, the returned <literal>Z_SOAP</literal> package will be
5005 of type <literal>Z_SOAP_Generic</literal>.
5006 Member <literal>no</literal> is
5007 set the offset of handler that matched; <literal>ns</literal>
5008 is set to namespace of matching handler; the void pointer
5009 <literal>p</literal> is set to the C data structure assocatiated
5013 When a NULL namespace is met (member <literal>ns</literal> bwlow),
5014 that specifies end-of-list.
5017 Each handler is defined as follows:
5025 The <literal>ns</literal> is namespace of service associated with
5026 handler <literal>f</literal>. <literal>client_data</literal>
5027 is user-defined data which is passed to handler.
5030 The prototype for a SOAP service handler is:
5032 int handler(ODR o, void * ptr, void **handler_data,
5033 void *client_data, const char *ns);
5035 The <parameter>o</parameter> specifies the mode (decode/encode)
5036 as usual. The second argument, <parameter>ptr</parameter>,
5037 is a libxml2 tree node pointer (<literal>xmlNodePtr</literal>)
5038 and is a pointer to the <literal>Body</literal> element
5039 of the SOAP package. The <parameter>handler_data</parameter>
5040 is an opaque pointer to a C definitions associated with the
5041 SOAP service. <parameter>client_data</parameter> is the pointer
5042 which was set as part of the <literal>Z_SOAP_handler</literal>.
5043 Finally, <parameter>ns</parameter> the service namespace.
5046 <sect1 id="soap.srw">
5049 SRU SOAP is just one implementation of a SOAP handler as described
5050 in the previous section.
5051 The encoder/decoder handler for SRU is defined as
5054 #include <yaz/srw.h>
5056 int yaz_srw_codec(ODR o, void * pptr,
5057 Z_SRW_GDU **handler_data,
5058 void *client_data, const char *ns);
5060 Here, <literal>Z_SRW_GDU</literal> is either
5061 searchRetrieveRequest or a searchRetrieveResponse.
5065 The xQuery and xSortKeys are not handled yet by
5066 the SRW implementation of &yaz;. Explain is also missing.
5067 Future versions of &yaz; will include these features.
5071 The definition of searchRetrieveRequest is:
5075 #define Z_SRW_query_type_cql 1
5076 #define Z_SRW_query_type_xcql 2
5077 #define Z_SRW_query_type_pqf 3
5085 #define Z_SRW_sort_type_none 1
5086 #define Z_SRW_sort_type_sort 2
5087 #define Z_SRW_sort_type_xSort 3
5095 int *maximumRecords;
5097 char *recordPacking;
5099 } Z_SRW_searchRetrieveRequest;
5101 Please observe that data of type xsd:string is represented
5102 as a char pointer (<literal>char *</literal>). A null pointer
5103 means that the element is absent.
5104 Data of type xsd:integer is representd as a pointer to
5105 an int (<literal>int *</literal>). Again, a null pointer
5106 us used for absent elements.
5109 The SearchRetrieveResponse has the following definition.
5112 int * numberOfRecords;
5114 int * resultSetIdleTime;
5116 Z_SRW_record *records;
5119 Z_SRW_diagnostic *diagnostics;
5120 int num_diagnostics;
5121 int *nextRecordPosition;
5122 } Z_SRW_searchRetrieveResponse;
5124 The <literal>num_records</literal> and <literal>num_diagnostics</literal>
5125 is number of returned records and diagnostics respectively and also
5126 correspond to the "size of" arrays <literal>records</literal>
5127 and <literal>diagnostics</literal>.
5130 A retrieval record is defined as follows:
5134 char *recordData_buf;
5136 int *recordPosition;
5139 The record data is defined as a buffer of some length so that
5140 data can be of any type. SRW 1.0 currenly doesn't allow for this
5141 (only XML), but future versions might do.
5144 And, a diagnostic as:
5154 <chapter id="tools">
5155 <title>Supporting Tools</title>
5157 In support of the service API - primarily the ASN module, which
5158 provides the pro-grammatic interface to the Z39.50 APDUs, &yaz; contains
5159 a collection of tools that support the development of applications.
5161 <sect1 id="tools.query">
5162 <title>Query Syntax Parsers</title>
5164 Since the type-1 (RPN) query structure has no direct, useful string
5165 representation, every origin application needs to provide some form of
5166 mapping from a local query notation or representation to a
5167 <token>Z_RPNQuery</token> structure. Some programmers will prefer to
5168 construct the query manually, perhaps using
5169 <function>odr_malloc()</function> to simplify memory management.
5170 The &yaz; distribution includes three separate, query-generating tools
5171 that may be of use to you.
5174 <title>Prefix Query Format</title>
5176 Since RPN or reverse polish notation is really just a fancy way of
5177 describing a suffix notation format (operator follows operands), it
5178 would seem that the confusion is total when we now introduce a prefix
5179 notation for RPN. The reason is one of simple laziness - it's somewhat
5180 simpler to interpret a prefix format, and this utility was designed
5181 for maximum simplicity, to provide a baseline representation for use
5182 in simple test applications and scripting environments (like Tcl). The
5183 demonstration client included with YAZ uses the PQF.
5187 The PQF have been adopted by other parties developing Z39.50
5188 software. It is often referred to as Prefix Query Notation
5193 The PQF is defined by the pquery module in the YAZ library.
5194 There are two sets of function that have similar behavior. First
5195 set operates on a PQF parser handle, second set doesn't. First set
5196 set of functions are more flexible than the second set. Second set
5197 is obsolete and is only provided to ensure backwards compatibility.
5200 First set of functions all operate on a PQF parser handle:
5203 #include <yaz/pquery.h>
5205 YAZ_PQF_Parser yaz_pqf_create(void);
5207 void yaz_pqf_destroy(YAZ_PQF_Parser p);
5209 Z_RPNQuery *yaz_pqf_parse(YAZ_PQF_Parser p, ODR o, const char *qbuf);
5211 Z_AttributesPlusTerm *yaz_pqf_scan(YAZ_PQF_Parser p, ODR o,
5212 Odr_oid **attributeSetId, const char *qbuf);
5214 int yaz_pqf_error(YAZ_PQF_Parser p, const char **msg, size_t *off);
5217 A PQF parser is created and destructed by functions
5218 <function>yaz_pqf_create</function> and
5219 <function>yaz_pqf_destroy</function> respectively.
5220 Function <function>yaz_pqf_parse</function> parses query given
5221 by string <literal>qbuf</literal>. If parsing was successful,
5222 a Z39.50 RPN Query is returned which is created using ODR stream
5223 <literal>o</literal>. If parsing failed, a NULL pointer is
5225 Function <function>yaz_pqf_scan</function> takes a scan query in
5226 <literal>qbuf</literal>. If parsing was successful, the function
5227 returns attributes plus term pointer and modifies
5228 <literal>attributeSetId</literal> to hold attribute set for the
5229 scan request - both allocated using ODR stream <literal>o</literal>.
5230 If parsing failed, yaz_pqf_scan returns a NULL pointer.
5231 Error information for bad queries can be obtained by a call to
5232 <function>yaz_pqf_error</function> which returns an error code and
5233 modifies <literal>*msg</literal> to point to an error description,
5234 and modifies <literal>*off</literal> to the offset within last
5235 query were parsing failed.
5238 The second set of functions are declared as follows:
5241 #include <yaz/pquery.h>
5243 Z_RPNQuery *p_query_rpn(ODR o, oid_proto proto, const char *qbuf);
5245 Z_AttributesPlusTerm *p_query_scan(ODR o, oid_proto proto,
5246 Odr_oid **attributeSetP, const char *qbuf);
5248 int p_query_attset(const char *arg);
5251 The function <function>p_query_rpn()</function> takes as arguments an
5252 &odr; stream (see section <link linkend="odr">The ODR Module</link>)
5253 to provide a memory source (the structure created is released on
5254 the next call to <function>odr_reset()</function> on the stream), a
5255 protocol identifier (one of the constants <token>PROTO_Z3950</token> and
5256 <token>PROTO_SR</token>), an attribute set reference, and
5257 finally a null-terminated string holding the query string.
5260 If the parse went well, <function>p_query_rpn()</function> returns a
5261 pointer to a <literal>Z_RPNQuery</literal> structure which can be
5262 placed directly into a <literal>Z_SearchRequest</literal>.
5263 If parsing failed, due to syntax error, a NULL pointer is returned.
5266 The <literal>p_query_attset</literal> specifies which attribute set
5267 to use if the query doesn't specify one by the
5268 <literal>@attrset</literal> operator.
5269 The <literal>p_query_attset</literal> returns 0 if the argument is a
5270 valid attribute set specifier; otherwise the function returns -1.
5273 The grammar of the PQF is as follows:
5276 query ::= top-set query-struct.
5278 top-set ::= [ '@attrset' string ]
5280 query-struct ::= attr-spec | simple | complex | '@term' term-type query
5282 attr-spec ::= '@attr' [ string ] string query-struct
5284 complex ::= operator query-struct query-struct.
5286 operator ::= '@and' | '@or' | '@not' | '@prox' proximity.
5288 simple ::= result-set | term.
5290 result-set ::= '@set' string.
5294 proximity ::= exclusion distance ordered relation which-code unit-code.
5296 exclusion ::= '1' | '0' | 'void'.
5298 distance ::= integer.
5300 ordered ::= '1' | '0'.
5302 relation ::= integer.
5304 which-code ::= 'known' | 'private' | integer.
5306 unit-code ::= integer.
5308 term-type ::= 'general' | 'numeric' | 'string' | 'oid' | 'datetime' | 'null'.
5311 You will note that the syntax above is a fairly faithful
5312 representation of RPN, except for the Attribute, which has been
5313 moved a step away from the term, allowing you to associate one or more
5314 attributes with an entire query structure. The parser will
5315 automatically apply the given attributes to each term as required.
5318 The @attr operator is followed by an attribute specification
5319 (<literal>attr-spec</literal> above). The specification consists
5320 of an optional attribute set, an attribute type-value pair and
5321 a sub-query. The attribute type-value pair is packed in one string:
5322 an attribute type, an equals sign, and an attribute value, like this:
5323 <literal>@attr 1=1003</literal>.
5324 The type is always an integer but the value may be either an
5325 integer or a string (if it doesn't start with a digit character).
5326 A string attribute-value is encoded as a Type-1 ``complex''
5327 attribute with the list of values containing the single string
5328 specified, and including no semantic indicators.
5331 Version 3 of the Z39.50 specification defines various encoding of terms.
5332 Use <literal>@term </literal> <replaceable>type</replaceable>
5333 <replaceable>string</replaceable>,
5334 where type is one of: <literal>general</literal>,
5335 <literal>numeric</literal> or <literal>string</literal>
5336 (for InternationalString).
5337 If no term type has been given, the <literal>general</literal> form
5338 is used. This is the only encoding allowed in both versions 2 and 3
5339 of the Z39.50 standard.
5341 <sect3 id="PQF-prox">
5342 <title>Using Proximity Operators with PQF</title>
5345 This is an advanced topic, describing how to construct
5346 queries that make very specific requirements on the
5347 relative location of their operands.
5348 You may wish to skip this section and go straight to
5349 <link linkend="pqf-examples">the example PQF queries</link>.
5354 Most Z39.50 servers do not support proximity searching, or
5355 support only a small subset of the full functionality that
5356 can be expressed using the PQF proximity operator. Be
5357 aware that the ability to <emphasis>express</emphasis> a
5358 query in PQF is no guarantee that any given server will
5359 be able to <emphasis>execute</emphasis> it.
5365 The proximity operator <literal>@prox</literal> is a special
5366 and more restrictive version of the conjunction operator
5367 <literal>@and</literal>. Its semantics are described in
5368 section 3.7.2 (Proximity) of Z39.50 the standard itself, which
5369 can be read on-line at
5370 <ulink url="&url.z39.50.proximity;"/>
5373 In PQF, the proximity operation is represented by a sequence
5376 @prox <replaceable>exclusion</replaceable> <replaceable>distance</replaceable> <replaceable>ordered</replaceable> <replaceable>relation</replaceable> <replaceable>which-code</replaceable> <replaceable>unit-code</replaceable>
5378 in which the meanings of the parameters are as described in in
5379 the standard, and they can take the following values:
5382 <formalpara><title>exclusion</title>
5384 0 = false (i.e. the proximity condition specified by the
5385 remaining parameters must be satisfied) or
5386 1 = true (the proximity condition specified by the
5387 remaining parameters must <emphasis>not</emphasis> be
5393 <formalpara><title>distance</title><para>
5394 An integer specifying the difference between the locations
5395 of the operands: e.g. two adjacent words would have
5396 distance=1 since their locations differ by one unit.
5398 </formalpara></listitem>
5400 <formalpara><title>ordered</title><para>
5401 1 = ordered (the operands must occur in the order the
5402 query specifies them) or
5403 0 = unordered (they may appear in either order).
5408 <formalpara><title>relation</title><para>
5409 Recognised values are
5411 2 (lessThanOrEqual),
5413 4 (greaterThanOrEqual),
5420 <formalpara><title>which-code</title><para>
5421 <literal>known</literal>
5423 <literal>k</literal>
5424 (the unit-code parameter is taken from the well-known list
5425 of alternatives described in below) or
5426 <literal>private</literal>
5428 <literal>p</literal>
5429 (the unit-code paramater has semantics specific to an
5430 out-of-band agreement such as a profile).
5435 <formalpara><title>unit-code</title><para>
5436 If the which-code parameter is <literal>known</literal>
5437 then the recognised values are
5447 10 (elementType) and
5449 If which-code is <literal>private</literal> then the
5450 acceptable values are determined by the profile.
5455 (The numeric values of the relation and well-known unit-code
5456 parameters are taken straight from
5457 <ulink url="&url.z39.50.proximity.asn1;"
5458 >the ASN.1</ulink> of the proximity structure in the standard.)
5461 <sect3 id="pqf-examples">
5462 <title>PQF queries</title>
5463 <example id="example.pqf.simple.terms">
5464 <title>PQF queries using simple terms</title>
5473 <example id="pqf.example.pqf.boolean.operators">
5474 <title>PQF boolean operators</title>
5477 @or "dylan" "zimmerman"
5479 @and @or dylan zimmerman when
5481 @and when @or dylan zimmerman
5485 <example id="example.pqf.result.sets">
5486 <title>PQF references to result sets</title>
5491 @and @set seta @set setb
5495 <example id="example.pqf.attributes">
5496 <title>Attributes for terms</title>
5501 @attr 1=4 @attr 4=1 "self portrait"
5503 @attrset exp1 @attr 1=1 CategoryList
5505 @attr gils 1=2008 Copenhagen
5507 @attr 1=/book/title computer
5511 <example id="example.pqf.proximity">
5512 <title>PQF Proximity queries</title>
5515 @prox 0 3 1 2 k 2 dylan zimmerman
5517 Here the parameters 0, 3, 1, 2, k and 2 represent exclusion,
5518 distance, ordered, relation, which-code and unit-code, in that
5522 <para>exclusion = 0: the proximity condition must hold</para>
5525 <para>distance = 3: the terms must be three units apart</para>
5529 ordered = 1: they must occur in the order they are specified
5534 relation = 2: lessThanOrEqual (to the distance of 3 units)
5539 which-code is ``known'', so the standard unit-codes are used
5543 <para>unit-code = 2: word.</para>
5546 So the whole proximity query means that the words
5547 <literal>dylan</literal> and <literal>zimmerman</literal> must
5548 both occur in the record, in that order, differing in position
5549 by three or fewer words (i.e. with two or fewer words between
5550 them.) The query would find ``Bob Dylan, aka. Robert
5551 Zimmerman'', but not ``Bob Dylan, born as Robert Zimmerman''
5552 since the distance in this case is four.
5555 <example id="example.pqf.search.term.type">
5556 <title>PQF specification of search term type</title>
5559 @term string "a UTF-8 string, maybe?"
5563 <example id="example.pqf.mixed.queries">
5564 <title>PQF mixed queries</title>
5567 @or @and bob dylan @set Result-1
5569 @attr 4=1 @and @attr 1=1 "bob dylan" @attr 1=4 "slow train coming"
5571 @and @attr 2=4 @attr gils 1=2038 -114 @attr 2=2 @attr gils 1=2039 -109
5573 The last of these examples is a spatial search: in
5574 <ulink url="http://www.gils.net/prof_v2.html#sec_7_4"
5575 >the GILS attribute set</ulink>,
5577 2038 indicates West Bounding Coordinate and
5578 2030 indicates East Bounding Coordinate,
5579 so the query is for areas extending from -114 degrees
5580 to no more than -109 degrees.
5585 <sect2 id="CCL"><title>CCL</title>
5587 Not all users enjoy typing in prefix query structures and numerical
5588 attribute values, even in a minimalistic test client. In the library
5589 world, the more intuitive Common Command Language - CCL (ISO 8777)
5590 has enjoyed some popularity - especially before the widespread
5591 availability of graphical interfaces. It is still useful in
5592 applications where you for some reason or other need to provide a
5593 symbolic language for expressing boolean query structures.
5595 <sect3 id="ccl.syntax">
5596 <title>CCL Syntax</title>
5598 The CCL parser obeys the following grammar for the FIND argument.
5599 The syntax is annotated by in the lines prefixed by
5600 <literal>--</literal>.
5603 CCL-Find ::= CCL-Find Op Elements
5606 Op ::= "and" | "or" | "not"
5607 -- The above means that Elements are separated by boolean operators.
5609 Elements ::= '(' CCL-Find ')'
5612 | Qualifiers Relation Terms
5613 | Qualifiers Relation '(' CCL-Find ')'
5614 | Qualifiers '=' string '-' string
5615 -- Elements is either a recursive definition, a result set reference, a
5616 -- list of terms, qualifiers followed by terms, qualifiers followed
5617 -- by a recursive definition or qualifiers in a range (lower - upper).
5619 Set ::= 'set' = string
5620 -- Reference to a result set
5622 Terms ::= Terms Prox Term
5624 -- Proximity of terms.
5626 Term ::= Term string
5628 -- This basically means that a term may include a blank
5630 Qualifiers ::= Qualifiers ',' string
5632 -- Qualifiers is a list of strings separated by comma
5634 Relation ::= '=' | '>=' | '<=' | '<>' | '>' | '<'
5635 -- Relational operators. This really doesn't follow the ISO8777
5639 -- Proximity operator
5642 <example id="example.ccl.queries">
5643 <title>CCL queries</title>
5645 The following queries are all valid:
5656 (dylan and bob) or set=1
5665 Assuming that the qualifiers <literal>ti</literal>,
5666 <literal>au</literal>
5667 and <literal>date</literal> are defined we may use:
5672 au=(bob dylan and slow train coming)
5674 date>1980 and (ti=((self portrait)))
5678 <sect3 id="ccl.qualifiers">
5679 <title>CCL Qualifiers</title>
5681 Qualifiers are used to direct the search to a particular searchable
5682 index, such as title (ti) and author indexes (au). The CCL standard
5683 itself doesn't specify a particular set of qualifiers, but it does
5684 suggest a few short-hand notations. You can customize the CCL parser
5685 to support a particular set of qualifiers to reflect the current target
5686 profile. Traditionally, a qualifier would map to a particular
5687 use-attribute within the BIB-1 attribute set. It is also
5688 possible to set other attributes, such as the structure
5692 A CCL profile is a set of predefined CCL qualifiers that may be
5693 read from a file or set in the CCL API.
5694 The YAZ client reads its CCL qualifiers from a file named
5695 <filename>default.bib</filename>. There are four types of
5696 lines in a CCL profile: qualifier specification,
5697 qualifier alias, comments and directives.
5699 <sect4 id="ccl.qualifier.specification">
5700 <title>Qualifier specification</title>
5702 A qualifier specification is of the form:
5705 <replaceable>qualifier-name</replaceable>
5706 [<replaceable>attributeset</replaceable><literal>,</literal>]<replaceable>type</replaceable><literal>=</literal><replaceable>val</replaceable>
5707 [<replaceable>attributeset</replaceable><literal>,</literal>]<replaceable>type</replaceable><literal>=</literal><replaceable>val</replaceable> ...
5710 where <replaceable>qualifier-name</replaceable> is the name of the
5711 qualifier to be used (eg. <literal>ti</literal>),
5712 <replaceable>type</replaceable> is attribute type in the attribute
5713 set (Bib-1 is used if no attribute set is given) and
5714 <replaceable>val</replaceable> is attribute value.
5715 The <replaceable>type</replaceable> can be specified as an
5716 integer or as it be specified either as a single-letter:
5717 <literal>u</literal> for use,
5718 <literal>r</literal> for relation,<literal>p</literal> for position,
5719 <literal>s</literal> for structure,<literal>t</literal> for truncation
5720 or <literal>c</literal> for completeness.
5721 The attributes for the special qualifier name <literal>term</literal>
5722 are used when no CCL qualifier is given in a query.
5723 <table id="ccl.common.bib1.attributes">
5724 <title>Common Bib-1 attributes</title>
5726 <colspec colwidth="2*" colname="type"></colspec>
5727 <colspec colwidth="9*" colname="description"></colspec>
5731 <entry>Description</entry>
5736 <entry><literal>u=</literal><replaceable>value</replaceable></entry>
5738 Use attribute (1). Common use attributes are
5739 1 Personal-name, 4 Title, 7 ISBN, 8 ISSN, 30 Date,
5740 62 Subject, 1003 Author), 1016 Any. Specify value
5745 <entry><literal>r=</literal><replaceable>value</replaceable></entry>
5747 Relation attribute (2). Common values are
5748 1 <, 2 <=, 3 =, 4 >=, 5 >, 6 <>,
5749 100 phonetic, 101 stem, 102 relevance, 103 always matches.
5753 <entry><literal>p=</literal><replaceable>value</replaceable></entry>
5755 Position attribute (3). Values: 1 first in field, 2
5756 first in any subfield, 3 any position in field.
5760 <entry><literal>s=</literal><replaceable>value</replaceable></entry>
5762 Structure attribute (4). Values: 1 phrase, 2 word,
5763 3 key, 4 year, 5 date, 6 word list, 100 date (un),
5764 101 name (norm), 102 name (un), 103 structure, 104 urx,
5765 105 free-form-text, 106 document-text, 107 local-number,
5766 108 string, 109 numeric string.
5770 <entry><literal>t=</literal><replaceable>value</replaceable></entry>
5772 Truncation attribute (5). Values: 1 right, 2 left,
5773 3 left& right, 100 none, 101 process #, 102 regular-1,
5774 103 regular-2, 104 CCL.
5778 <entry><literal>c=</literal><replaceable>value</replaceable></entry>
5780 Completeness attribute (6). Values: 1 incomplete subfield,
5781 2 complete subfield, 3 complete field.
5789 Refer to <xref linkend="bib1"/> or the complete
5790 <ulink url="&url.z39.50.attset.bib1;">list of Bib-1 attributes</ulink>
5793 It is also possible to specify non-numeric attribute values,
5794 which are used in combination with certain types.
5795 The special combinations are:
5796 <table id="ccl.special.attribute.combos">
5797 <title>Special attribute combos</title>
5799 <colspec colwidth="2*" colname="name"></colspec>
5800 <colspec colwidth="9*" colname="description"></colspec>
5804 <entry>Description</entry>
5809 <entry><literal>s=pw</literal></entry>
5811 The structure is set to either word or phrase depending
5812 on the number of tokens in a term (phrase-word).
5816 <entry><literal>s=al</literal></entry>
5818 Each token in the term is ANDed. (and-list).
5819 This does not set the structure at all.
5822 <row><entry><literal>s=ol</literal></entry>
5824 Each token in the term is ORed. (or-list).
5825 This does not set the structure at all.
5828 <row><entry><literal>s=ag</literal></entry>
5830 Tokens that appears as phrases (with blank in them) gets
5831 structure phrase attached (4=1). Tokens that appear to be words
5832 gets structure word attached (4=2). Phrases and words are
5833 ANDed. This is a variant of s=al and s=pw, with the main
5834 difference that words are not split (with operator AND)
5835 but instead kept in one RPN token. This facility appeared
5839 <row><entry><literal>r=o</literal></entry>
5841 Allows ranges and the operators greather-than, less-than, ...
5843 This sets Bib-1 relation attribute accordingly (relation
5844 ordered). A query construct is only treated as a range if
5845 dash is used and that is surrounded by white-space. So
5846 <literal>-1980</literal> is treated as term
5847 <literal>"-1980"</literal> not <literal><= 1980</literal>.
5848 If <literal>- 1980</literal> is used, however, that is
5852 <row><entry><literal>r=r</literal></entry>
5854 Similar to <literal>r=o</literal> but assumes that terms
5855 are non-negative (not prefixed with <literal>-</literal>).
5856 Thus, a dash will always be treated as a range.
5857 The construct <literal>1980-1990</literal> is
5858 treated as a range with <literal>r=r</literal> but as a
5859 single term <literal>"1980-1990"</literal> with
5860 <literal>r=o</literal>. The special attribute
5861 <literal>r=r</literal> is available in YAZ 2.0.24 or later.
5864 <row><entry><literal>r=omiteq</literal></entry>
5866 This will omit relation=equals (@attr 2=3) when r=o / r=r
5867 is used. This is useful for servers that somehow breaks
5868 when an explicit relation=equals is used. Omitting the
5869 relation is usually safe because "equals" is the default
5870 behavior. This tweak was added in YAZ version 5.1.2.
5873 <row><entry><literal>t=l</literal></entry>
5875 Allows term to be left-truncated.
5876 If term is of the form <literal>?x</literal>, the resulting
5877 Type-1 term is <literal>x</literal> and truncation is left.
5880 <row><entry><literal>t=r</literal></entry>
5882 Allows term to be right-truncated.
5883 If term is of the form <literal>x?</literal>, the resulting
5884 Type-1 term is <literal>x</literal> and truncation is right.
5887 <row><entry><literal>t=n</literal></entry>
5889 If term is does not include <literal>?</literal>, the
5890 truncation attribute is set to none (100).
5893 <row><entry><literal>t=b</literal></entry>
5895 Allows term to be both left&right truncated.
5896 If term is of the form <literal>?x?</literal>, the
5897 resulting term is <literal>x</literal> and trunctation is
5898 set to both left&right.
5901 <row><entry><literal>t=x</literal></entry>
5903 Allows masking anywhere in a term, thus fully supporting
5904 # (mask one character) and ? (zero or more of any).
5905 If masking is used, trunction is set to 102 (regexp-1 in term)
5906 and the term is converted accordingly to a regular expression.
5909 <row><entry><literal>t=z</literal></entry>
5911 Allows masking anywhere in a term, thus fully supporting
5912 # (mask one character) and ? (zero or more of any).
5913 If masking is used, trunction is set to 104 (Z39.58 in term)
5914 and the term is converted accordingly to Z39.58 masking term -
5915 actually the same truncation as CCL itself.
5922 <example id="example.ccl.profile">
5923 <title>CCL profile</title>
5925 Consider the following definition:
5935 <literal>ti</literal> and <literal>au</literal> both set
5936 structure attribute to phrase (s=1).
5937 <literal>ti</literal>
5938 sets the use-attribute to 4. <literal>au</literal> sets the
5940 When no qualifiers are used in the query the structure-attribute is
5941 set to free-form-text (105) (rule for <literal>term</literal>).
5942 The <literal>date</literal> sets the relation attribute to
5943 the relation used in the CCL query and sets the use attribute
5947 You can combine attributes. To Search for "ranked title" you
5950 ti,ranked=knuth computer
5952 which will set relation=ranked, use=title, structure=phrase.
5959 is a valid query. But
5967 <sect4 id="ccl.qualifier.alias">
5968 <title>Qualifier alias</title>
5970 A qualifier alias is of the form:
5973 <replaceable>q</replaceable>
5974 <replaceable>q1</replaceable> <replaceable>q2</replaceable> ..
5977 which declares <replaceable>q</replaceable> to
5978 be an alias for <replaceable>q1</replaceable>,
5979 <replaceable>q2</replaceable>... such that the CCL
5980 query <replaceable>q=x</replaceable> is equivalent to
5981 <replaceable>q1=x or q2=x or ...</replaceable>.
5984 <sect4 id="ccl.comments">
5985 <title>Comments</title>
5987 Lines with white space or lines that begin with
5988 character <literal>#</literal> are treated as comments.
5991 <sect4 id="ccl.directives">
5992 <title>Directives</title>
5994 Directive specifications takes the form
5996 <para><literal>@</literal><replaceable>directive</replaceable> <replaceable>value</replaceable>
5998 <table id="ccl.directives.table">
5999 <title>CCL directives</title>
6001 <colspec colwidth="2*" colname="name"></colspec>
6002 <colspec colwidth="8*" colname="description"></colspec>
6003 <colspec colwidth="1*" colname="default"></colspec>
6007 <entry>Description</entry>
6008 <entry>Default</entry>
6013 <entry>truncation</entry>
6014 <entry>Truncation character</entry>
6015 <entry><literal>?</literal></entry>
6019 <entry>Masking character. Requires YAZ 4.2.58 or later</entry>
6020 <entry><literal>#</literal></entry>
6023 <entry>field</entry>
6024 <entry>Specifies how multiple fields are to be
6025 combined. There are two modes: <literal>or</literal>:
6026 multiple qualifier fields are ORed,
6027 <literal>merge</literal>: attributes for the qualifier
6028 fields are merged and assigned to one term.
6030 <entry><literal>merge</literal></entry>
6034 <entry>Specifies if CCL operators and qualifiers should be
6035 compared with case sensitivity or not. Specify 1 for
6036 case sensitive; 0 for case insensitive.</entry>
6037 <entry><literal>1</literal></entry>
6041 <entry>Specifies token for CCL operator AND.</entry>
6042 <entry><literal>and</literal></entry>
6046 <entry>Specifies token for CCL operator OR.</entry>
6047 <entry><literal>or</literal></entry>
6051 <entry>Specifies token for CCL operator NOT.</entry>
6052 <entry><literal>not</literal></entry>
6056 <entry>Specifies token for CCL operator SET.</entry>
6057 <entry><literal>set</literal></entry>
6064 <sect3 id="ccl.api">
6065 <title>CCL API</title>
6067 All public definitions can be found in the header file
6068 <filename>ccl.h</filename>. A profile identifier is of type
6069 <literal>CCL_bibset</literal>. A profile must be created with the call
6070 to the function <function>ccl_qual_mk</function> which returns a profile
6071 handle of type <literal>CCL_bibset</literal>.
6074 To read a file containing qualifier definitions the function
6075 <function>ccl_qual_file</function> may be convenient. This function
6076 takes an already opened <literal>FILE</literal> handle pointer as
6077 argument along with a <literal>CCL_bibset</literal> handle.
6080 To parse a simple string with a FIND query use the function
6083 struct ccl_rpn_node *ccl_find_str(CCL_bibset bibset, const char *str,
6084 int *error, int *pos);
6087 which takes the CCL profile (<literal>bibset</literal>) and query
6088 (<literal>str</literal>) as input. Upon successful completion the RPN
6089 tree is returned. If an error occur, such as a syntax error, the integer
6090 pointed to by <literal>error</literal> holds the error code and
6091 <literal>pos</literal> holds the offset inside query string in which
6095 An English representation of the error may be obtained by calling
6096 the <literal>ccl_err_msg</literal> function. The error codes are
6097 listed in <filename>ccl.h</filename>.
6100 To convert the CCL RPN tree (type
6101 <literal>struct ccl_rpn_node *</literal>)
6102 to the Z_RPNQuery of YAZ the function <function>ccl_rpn_query</function>
6103 must be used. This function which is part of YAZ is implemented in
6104 <filename>yaz-ccl.c</filename>.
6105 After calling this function the CCL RPN tree is probably no longer
6106 needed. The <literal>ccl_rpn_delete</literal> destroys the CCL RPN tree.
6109 A CCL profile may be destroyed by calling the
6110 <function>ccl_qual_rm</function> function.
6113 The token names for the CCL operators may be changed by setting the
6114 globals (all type <literal>char *</literal>)
6115 <literal>ccl_token_and</literal>, <literal>ccl_token_or</literal>,
6116 <literal>ccl_token_not</literal> and <literal>ccl_token_set</literal>.
6117 An operator may have aliases, i.e. there may be more than one name for
6118 the operator. To do this, separate each alias with a space character.
6125 <ulink url="&url.cql;">CQL</ulink>
6126 - Common Query Language - was defined for the
6127 <ulink url="&url.sru;">SRU</ulink> protocol.
6128 In many ways CQL has a similar syntax to CCL.
6129 The objective of CQL is different. Where CCL aims to be
6130 an end-user language, CQL is <emphasis>the</emphasis> protocol
6131 query language for SRU.
6135 If you are new to CQL, read the
6136 <ulink url="&url.cql.intro;">Gentle Introduction</ulink>.
6140 The CQL parser in &yaz; provides the following:
6144 It parses and validates a CQL query.
6149 It generates a C structure that allows you to convert
6150 a CQL query to some other query language, such as SQL.
6155 The parser converts a valid CQL query to PQF, thus providing a
6156 way to use CQL for both SRU servers and Z39.50 targets at the
6162 The parser converts CQL to XCQL.
6163 XCQL is an XML representation of CQL.
6164 XCQL is part of the SRU specification. However, since SRU
6165 supports CQL only, we don't expect XCQL to be widely used.
6166 Furthermore, CQL has the advantage over XCQL that it is
6172 <sect3 id="cql.parsing">
6173 <title>CQL parsing</title>
6175 A CQL parser is represented by the <literal>CQL_parser</literal>
6176 handle. Its contents should be considered &yaz; internal (private).
6178 #include <yaz/cql.h>
6180 typedef struct cql_parser *CQL_parser;
6182 CQL_parser cql_parser_create(void);
6183 void cql_parser_destroy(CQL_parser cp);
6185 A parser is created by <function>cql_parser_create</function> and
6186 is destroyed by <function>cql_parser_destroy</function>.
6189 To parse a CQL query string, the following function
6192 int cql_parser_string(CQL_parser cp, const char *str);
6194 A CQL query is parsed by the <function>cql_parser_string</function>
6195 which takes a query <parameter>str</parameter>.
6196 If the query was valid (no syntax errors), then zero is returned;
6197 otherwise -1 is returned to indicate a syntax error.
6201 int cql_parser_stream(CQL_parser cp,
6202 int (*getbyte)(void *client_data),
6203 void (*ungetbyte)(int b, void *client_data),
6206 int cql_parser_stdio(CQL_parser cp, FILE *f);
6208 The functions <function>cql_parser_stream</function> and
6209 <function>cql_parser_stdio</function> parses a CQL query
6210 - just like <function>cql_parser_string</function>.
6211 The only difference is that the CQL query can be
6212 fed to the parser in different ways.
6213 The <function>cql_parser_stream</function> uses a generic
6214 byte stream as input. The <function>cql_parser_stdio</function>
6215 uses a <literal>FILE</literal> handle which is opened for reading.
6218 <sect3 id="cql.tree">
6219 <title>CQL tree</title>
6221 The the query string is valid, the CQL parser
6222 generates a tree representing the structure of the
6227 struct cql_node *cql_parser_result(CQL_parser cp);
6229 <function>cql_parser_result</function> returns the
6230 a pointer to the root node of the resulting tree.
6233 Each node in a CQL tree is represented by a
6234 <literal>struct cql_node</literal>.
6235 It is defined as follows:
6237 #define CQL_NODE_ST 1
6238 #define CQL_NODE_BOOL 2
6239 #define CQL_NODE_SORT 3
6249 struct cql_node *modifiers;
6253 struct cql_node *left;
6254 struct cql_node *right;
6255 struct cql_node *modifiers;
6259 struct cql_node *next;
6260 struct cql_node *modifiers;
6261 struct cql_node *search;
6266 There are three node types: search term (ST), boolean (BOOL)
6268 A modifier is treated as a search term too.
6271 The search term node has five members:
6275 <literal>index</literal>: index for search term.
6276 If an index is unspecified for a search term,
6277 <literal>index</literal> will be NULL.
6282 <literal>index_uri</literal>: index URi for search term
6283 or NULL if none could be resolved for the index.
6288 <literal>term</literal>: the search term itself.
6293 <literal>relation</literal>: relation for search term.
6298 <literal>relation_uri</literal>: relation URI for search term.
6303 <literal>modifiers</literal>: relation modifiers for search
6304 term. The <literal>modifiers</literal> list itself of cql_nodes
6305 each of type <literal>ST</literal>.
6311 The boolean node represents <literal>and</literal>,
6312 <literal>or</literal>, <literal>not</literal> +
6317 <literal>left</literal> and <literal>right</literal>: left
6318 - and right operand respectively.
6323 <literal>modifiers</literal>: proximity arguments.
6329 The sort node represents both the SORTBY clause.
6332 <sect3 id="cql.to.pqf">
6333 <title>CQL to PQF conversion</title>
6335 Conversion to PQF (and Z39.50 RPN) is tricky by the fact
6336 that the resulting RPN depends on the Z39.50 target
6337 capabilities (combinations of supported attributes).
6338 In addition, the CQL and SRU operates on index prefixes
6339 (URI or strings), whereas the RPN uses Object Identifiers
6343 The CQL library of &yaz; defines a <literal>cql_transform_t</literal>
6344 type. It represents a particular mapping between CQL and RPN.
6345 This handle is created and destroyed by the functions:
6347 cql_transform_t cql_transform_open_FILE (FILE *f);
6348 cql_transform_t cql_transform_open_fname(const char *fname);
6349 void cql_transform_close(cql_transform_t ct);
6351 The first two functions create a tranformation handle from
6352 either an already open FILE or from a filename respectively.
6355 The handle is destroyed by <function>cql_transform_close</function>
6356 in which case no further reference of the handle is allowed.
6359 When a <literal>cql_transform_t</literal> handle has been created
6360 you can convert to RPN.
6362 int cql_transform_buf(cql_transform_t ct,
6363 struct cql_node *cn, char *out, int max);
6365 This function converts the CQL tree <literal>cn</literal>
6366 using handle <literal>ct</literal>.
6367 For the resulting PQF, you supply a buffer <literal>out</literal>
6368 which must be able to hold at at least <literal>max</literal>
6372 If conversion failed, <function>cql_transform_buf</function>
6373 returns a non-zero SRU error code; otherwise zero is returned
6374 (conversion successful). The meanings of the numeric error
6375 codes are listed in the SRU specification somewhere (no
6376 direct link anymore).
6379 If conversion fails, more information can be obtained by calling
6381 int cql_transform_error(cql_transform_t ct, char **addinfop);
6383 This function returns the most recently returned numeric
6384 error-code and sets the string-pointer at
6385 <literal>*addinfop</literal> to point to a string containing
6386 additional information about the error that occurred: for
6387 example, if the error code is 15 (``Illegal or unsupported context
6388 set''), the additional information is the name of the requested
6389 context set that was not recognised.
6392 The SRU error-codes may be translated into brief human-readable
6393 error messages using
6395 const char *cql_strerror(int code);
6399 If you wish to be able to produce a PQF result in a different
6400 way, there are two alternatives.
6402 void cql_transform_pr(cql_transform_t ct,
6403 struct cql_node *cn,
6404 void (*pr)(const char *buf, void *client_data),
6407 int cql_transform_FILE(cql_transform_t ct,
6408 struct cql_node *cn, FILE *f);
6410 The former function produces output to a user-defined
6411 output stream. The latter writes the result to an already
6412 open <literal>FILE</literal>.
6415 <sect3 id="cql.to.rpn">
6416 <title>Specification of CQL to RPN mappings</title>
6418 The file supplied to functions
6419 <function>cql_transform_open_FILE</function>,
6420 <function>cql_transform_open_fname</function> follows
6421 a structure found in many Unix utilities.
6422 It consists of mapping specifications - one per line.
6423 Lines starting with <literal>#</literal> are ignored (comments).
6426 Each line is of the form
6428 <replaceable>CQL pattern</replaceable><literal> = </literal> <replaceable> RPN equivalent</replaceable>
6432 An RPN pattern is a simple attribute list. Each attribute pair
6435 [<replaceable>set</replaceable>] <replaceable>type</replaceable><literal>=</literal><replaceable>value</replaceable>
6437 The attribute <replaceable>set</replaceable> is optional.
6438 The <replaceable>type</replaceable> is the attribute type,
6439 <replaceable>value</replaceable> the attribute value.
6442 The character <literal>*</literal> (asterisk) has special meaning
6443 when used in the RPN pattern.
6444 Each occurrence of <literal>*</literal> is substituted with the
6445 CQL matching name (index, relation, qualifier etc).
6446 This facility can be used to copy a CQL name verbatim to the RPN result.
6449 The following CQL patterns are recognized:
6453 <literal>index.</literal><replaceable>set</replaceable><literal>.</literal><replaceable>name</replaceable>
6457 This pattern is invoked when a CQL index, such as
6458 dc.title is converted. <replaceable>set</replaceable>
6459 and <replaceable>name</replaceable> are the context set and index
6461 Typically, the RPN specifies an equivalent use attribute.
6464 For terms not bound by an index the pattern
6465 <literal>index.cql.serverChoice</literal> is used.
6466 Here, the prefix <literal>cql</literal> is defined as
6467 <literal>http://www.loc.gov/zing/cql/cql-indexes/v1.0/</literal>.
6468 If this pattern is not defined, the mapping will fail.
6472 <literal>index.</literal><replaceable>set</replaceable><literal>.*</literal>
6473 is used when no other index pattern is matched.
6479 <literal>qualifier.</literal><replaceable>set</replaceable><literal>.</literal><replaceable>name</replaceable>
6484 For backwards compatibility, this is recognised as a synonym of
6485 <literal>index.</literal><replaceable>set</replaceable><literal>.</literal><replaceable>name</replaceable>
6491 <literal>relation.</literal><replaceable>relation</replaceable>
6495 This pattern specifies how a CQL relation is mapped to RPN.
6496 <replaceable>pattern</replaceable> is name of relation
6497 operator. Since <literal>=</literal> is used as
6498 separator between CQL pattern and RPN, CQL relations
6499 including <literal>=</literal> cannot be
6500 used directly. To avoid a conflict, the names
6501 <literal>ge</literal>,
6502 <literal>eq</literal>,
6503 <literal>le</literal>,
6504 must be used for CQL operators, greater-than-or-equal,
6505 equal, less-than-or-equal respectively.
6506 The RPN pattern is supposed to include a relation attribute.
6509 For terms not bound by a relation, the pattern
6510 <literal>relation.scr</literal> is used. If the pattern
6511 is not defined, the mapping will fail.
6514 The special pattern, <literal>relation.*</literal> is used
6515 when no other relation pattern is matched.
6521 <literal>relationModifier.</literal><replaceable>mod</replaceable>
6525 This pattern specifies how a CQL relation modifier is mapped to RPN.
6526 The RPN pattern is usually a relation attribute.
6532 <literal>structure.</literal><replaceable>type</replaceable>
6536 This pattern specifies how a CQL structure is mapped to RPN.
6537 Note that this CQL pattern is somewhat to similar to
6538 CQL pattern <literal>relation</literal>.
6539 The <replaceable>type</replaceable> is a CQL relation.
6542 The pattern, <literal>structure.*</literal> is used
6543 when no other structure pattern is matched.
6544 Usually, the RPN equivalent specifies a structure attribute.
6550 <literal>position.</literal><replaceable>type</replaceable>
6554 This pattern specifies how the anchor (position) of
6555 CQL is mapped to RPN.
6556 The <replaceable>type</replaceable> is one
6557 of <literal>first</literal>, <literal>any</literal>,
6558 <literal>last</literal>, <literal>firstAndLast</literal>.
6561 The pattern, <literal>position.*</literal> is used
6562 when no other position pattern is matched.
6568 <literal>set.</literal><replaceable>prefix</replaceable>
6572 This specification defines a CQL context set for a given prefix.
6573 The value on the right hand side is the URI for the set -
6574 <emphasis>not</emphasis> RPN. All prefixes used in
6575 index patterns must be defined this way.
6581 <literal>set</literal>
6585 This specification defines a default CQL context set for index names.
6586 The value on the right hand side is the URI for the set.
6592 <example id="example.cql.to.rpn.mapping">
6593 <title>CQL to RPN mapping file</title>
6595 This simple file defines two context sets, three indexes and three
6596 relations, a position pattern and a default structure.
6598 <programlisting><![CDATA[
6599 set.cql = http://www.loc.gov/zing/cql/context-sets/cql/v1.1/
6600 set.dc = http://www.loc.gov/zing/cql/dc-indexes/v1.0/
6602 index.cql.serverChoice = 1=1016
6603 index.dc.title = 1=4
6604 index.dc.subject = 1=21
6610 position.any = 3=3 6=1
6616 With the mappings above, the CQL query
6620 is converted to the PQF:
6622 @attr 1=1016 @attr 2=3 @attr 4=1 @attr 3=3 @attr 6=1 "computer"
6624 by rules <literal>index.cql.serverChoice</literal>,
6625 <literal>relation.scr</literal>, <literal>structure.*</literal>,
6626 <literal>position.any</literal>.
6633 is rejected, since <literal>position.right</literal> is
6639 >my = "http://www.loc.gov/zing/cql/dc-indexes/v1.0/" my.title = x
6643 @attr 1=4 @attr 2=3 @attr 4=1 @attr 3=3 @attr 6=1 "x"
6647 <example id="example.cql.to.rpn.string">
6648 <title>CQL to RPN string attributes</title>
6650 In this example we allow any index to be passed to RPN as
6653 <programlisting><![CDATA[
6654 # Identifiers for prefixes used in this file. (index.*)
6655 set.cql = info:srw/cql-context-set/1/cql-v1.1
6656 set.rpn = http://bogus/rpn
6657 set = http://bogus/rpn
6659 # The default index when none is specified by the query
6660 index.cql.serverChoice = 1=any
6669 The <literal>http://bogus/rpn</literal> context set is also the default
6670 so we can make queries such as
6674 which is converted to
6676 @attr 2=3 @attr 4=1 @attr 3=3 @attr 1=title "a"
6680 <example id="example.cql.to.rpn.bathprofile">
6681 <title>CQL to RPN using Bath Profile</title>
6683 The file <filename>etc/pqf.properties</filename> has mappings from
6684 the Bath Profile and Dublin Core to RPN.
6685 If YAZ is installed as a package it's usually located
6686 in <filename>/usr/share/yaz/etc</filename> and part of the
6687 development package, such as <literal>libyaz-dev</literal>.
6691 <sect3 id="cql.xcql">
6692 <title>CQL to XCQL conversion</title>
6694 Conversion from CQL to XCQL is trivial and does not
6695 require a mapping to be defined.
6696 There three functions to choose from depending on the
6697 way you wish to store the resulting output (XML buffer
6700 int cql_to_xml_buf(struct cql_node *cn, char *out, int max);
6701 void cql_to_xml(struct cql_node *cn,
6702 void (*pr)(const char *buf, void *client_data),
6704 void cql_to_xml_stdio(struct cql_node *cn, FILE *f);
6706 Function <function>cql_to_xml_buf</function> converts
6707 to XCQL and stores result in a user supplied buffer of a given
6711 <function>cql_to_xml</function> writes the result in
6712 a user defined output stream.
6713 <function>cql_to_xml_stdio</function> writes to a
6717 <sect3 id="rpn.to.cql">
6718 <title>PQF to CQL conversion</title>
6720 Conversion from PQF to CQL is offered by the two functions shown
6721 below. The former uses a generic stream for result. The latter
6722 puts result in a WRBUF (string container).
6724 #include <yaz/rpn2cql.h>
6726 int cql_transform_rpn2cql_stream(cql_transform_t ct,
6727 void (*pr)(const char *buf, void *client_data),
6731 int cql_transform_rpn2cql_wrbuf(cql_transform_t ct,
6735 The configuration is the same as used in CQL to PQF conversions.
6740 <sect1 id="tools.oid">
6741 <title>Object Identifiers</title>
6743 The basic YAZ representation of an OID is an array of integers,
6744 terminated with the value -1. This integer is of type
6745 <literal>Odr_oid</literal>.
6748 Fundamental OID operations and the type <literal>Odr_oid</literal>
6749 are defined in <filename>yaz/oid_util.h</filename>.
6752 An OID can either be declared as a automatic variable or it can
6753 allocated using the memory utilities or ODR/NMEM. It's
6754 guaranteed that an OID can fit in <literal>OID_SIZE</literal> integers.
6756 <example id="tools.oid.bib1.1"><title>Create OID on stack</title>
6758 We can create an OID for the Bib-1 attribute set with:
6760 Odr_oid bib1[OID_SIZE];
6772 And OID may also be filled from a string-based representation using
6773 dots (.). This is achieved by function
6775 int oid_dotstring_to_oid(const char *name, Odr_oid *oid);
6777 This functions returns 0 if name could be converted; -1 otherwise.
6779 <example id="tools.oid.bib1.2"><title>Using oid_oiddotstring_to_oid</title>
6781 We can fill the Bib-1 attribute set OID easier with:
6783 Odr_oid bib1[OID_SIZE];
6784 oid_oiddotstring_to_oid("1.2.840.10003.3.1", bib1);
6789 We can also allocate an OID dynamically on a ODR stream with:
6791 Odr_oid *odr_getoidbystr(ODR o, const char *str);
6793 This creates an OID from string-based representation using dots.
6794 This function take an &odr; stream as parameter. This stream is used to
6795 allocate memory for the data elements, which is released on a
6796 subsequent call to <function>odr_reset()</function> on that stream.
6798 <example id="tools.oid.bib1.3">
6799 <title>Using odr_getoidbystr</title>
6801 We can create a OID for the Bib-1 attribute set with:
6803 Odr_oid *bib1 = odr_getoidbystr(odr, "1.2.840.10003.3.1");
6810 char *oid_oid_to_dotstring(const Odr_oid *oid, char *oidbuf)
6812 does the reverse of <function>oid_oiddotstring_to_oid</function>. It
6813 converts an OID to the string-based representation using dots.
6814 The supplied char buffer <literal>oidbuf</literal> holds the resulting
6815 string and must be at least <literal>OID_STR_MAX</literal> in size.
6818 OIDs can be copied with <function>oid_oidcpy</function> which takes
6819 two OID lists as arguments. Alternativly, an OID copy can be allocated
6820 on a ODR stream with:
6822 Odr_oid *odr_oiddup(ODR odr, const Odr_oid *o);
6826 OIDs can be compared with <function>oid_oidcmp</function> which returns
6827 zero if the two OIDs provided are identical; non-zero otherwise.
6829 <sect2 id="tools.oid.database">
6830 <title>OID database</title>
6832 From YAZ version 3 and later, the oident system has been replaced
6833 by an OID database. OID database is a misnomer .. the old odient
6834 system was also a database.
6837 The OID database is really just a map between named Object Identifiers
6838 (string) and their OID raw equivalents. Most operations either
6839 convert from string to OID or other way around.
6842 Unfortunately, whenever we supply a string we must also specify the
6843 <emphasis>OID class</emphasis>. The class is necessary because some
6844 strings correspond to multiple OIDs. An example of such a string is
6845 <literal>Bib-1</literal> which may either be an attribute-set
6846 or a diagnostic-set.
6849 Applications using the YAZ database should include
6850 <filename>yaz/oid_db.h</filename>.
6853 A YAZ database handle is of type <literal>yaz_oid_db_t</literal>.
6854 Actually that's a pointer. You need not think deal with that.
6855 YAZ has a built-in database which can be considered "constant" for
6857 We can get hold that by using function <function>yaz_oid_std</function>.
6860 All functions with prefix <function>yaz_string_to_oid</function>
6861 converts from class + string to OID. We have variants of this
6862 operation due to different memory allocation strategies.
6865 All functions with prefix
6866 <function>yaz_oid_to_string</function> converts from OID to string
6869 <example id="tools.oid.bib1.4">
6870 <title>Create OID with YAZ DB</title>
6872 We can create an OID for the Bib-1 attribute set on the ODR stream
6876 yaz_string_to_oid_odr(yaz_oid_std(), CLASS_ATTSET, "Bib-1", odr);
6878 This is more complex than using <function>odr_getoidbystr</function>.
6879 You would only use <function>yaz_string_to_oid_odr</function> when the
6880 string (here Bib-1) is supplied by a user or configuration.
6884 <sect2 id="tools.oid.std">
6885 <title>Standard OIDs</title>
6887 All the object identifers in the standard OID database as returned
6888 by <function>yaz_oid_std</function> can referenced directly in a
6889 program as a constant OID.
6890 Each constant OID is prefixed with <literal>yaz_oid_</literal> -
6891 followed by OID class (lowercase) - then by OID name (normalized and
6895 See <xref linkend="list-oids"/> for list of all object identifiers
6897 These are declared in <filename>yaz/oid_std.h</filename> but are
6898 included by <filename>yaz/oid_db.h</filename> as well.
6900 <example id="tools.oid.bib1.5">
6901 <title>Use a built-in OID</title>
6903 We can allocate our own OID filled with the constant OID for
6906 Odr_oid *bib1 = odr_oiddup(o, yaz_oid_attset_bib1);
6912 <sect1 id="tools.nmem">
6913 <title>Nibble Memory</title>
6915 Sometimes when you need to allocate and construct a large,
6916 interconnected complex of structures, it can be a bit of a pain to
6917 release the associated memory again. For the structures describing the
6918 Z39.50 PDUs and related structures, it is convenient to use the
6919 memory-management system of the &odr; subsystem (see
6920 <xref linkend="odr.use"/>). However, in some circumstances
6921 where you might otherwise benefit from using a simple nibble memory
6922 management system, it may be impractical to use
6923 <function>odr_malloc()</function> and <function>odr_reset()</function>.
6924 For this purpose, the memory manager which also supports the &odr;
6925 streams is made available in the NMEM module. The external interface
6926 to this module is given in the <filename>nmem.h</filename> file.
6929 The following prototypes are given:
6932 NMEM nmem_create(void);
6933 void nmem_destroy(NMEM n);
6934 void *nmem_malloc(NMEM n, size_t size);
6935 void nmem_reset(NMEM n);
6936 size_t nmem_total(NMEM n);
6937 void nmem_init(void);
6938 void nmem_exit(void);
6941 The <function>nmem_create()</function> function returns a pointer to a
6942 memory control handle, which can be released again by
6943 <function>nmem_destroy()</function> when no longer needed.
6944 The function <function>nmem_malloc()</function> allocates a block of
6945 memory of the requested size. A call to <function>nmem_reset()</function>
6946 or <function>nmem_destroy()</function> will release all memory allocated
6947 on the handle since it was created (or since the last call to
6948 <function>nmem_reset()</function>. The function
6949 <function>nmem_total()</function> returns the number of bytes currently
6950 allocated on the handle.
6953 The nibble memory pool is shared amongst threads. POSIX
6954 mutex'es and WIN32 Critical sections are introduced to keep the
6955 module thread safe. Function <function>nmem_init()</function>
6956 initializes the nibble memory library and it is called automatically
6957 the first time the <literal>YAZ.DLL</literal> is loaded. &yaz; uses
6958 function <function>DllMain</function> to achieve this. You should
6959 <emphasis>not</emphasis> call <function>nmem_init</function> or
6960 <function>nmem_exit</function> unless you're absolute sure what
6961 you're doing. Note that in previous &yaz; versions you'd have to call
6962 <function>nmem_init</function> yourself.
6965 <sect1 id="tools.log">
6968 &yaz; has evolved a fairly complex log system which should be useful both
6969 for debugging &yaz; itself, debugging applications that use &yaz;, and for
6970 production use of those applications.
6973 The log functions are declared in header <filename>yaz/log.h</filename>
6974 and implemented in <filename>src/log.c</filename>.
6975 Due to name clash with syslog and some math utilities the logging
6976 interface has been modified as of YAZ 2.0.29. The obsolete interface
6977 is still available if in header file <filename>yaz/log.h</filename>.
6978 The key points of the interface are:
6981 void yaz_log(int level, const char *fmt, ...)
6982 void yaz_log_init(int level, const char *prefix, const char *name);
6983 void yaz_log_init_file(const char *fname);
6984 void yaz_log_init_level(int level);
6985 void yaz_log_init_prefix(const char *prefix);
6986 void yaz_log_time_format(const char *fmt);
6987 void yaz_log_init_max_size(int mx);
6989 int yaz_log_mask_str(const char *str);
6990 int yaz_log_module_level(const char *name);
6993 The reason for the whole log module is the <function>yaz_log</function>
6994 function. It takes a bitmask indicating the log levels, a
6995 <literal>printf</literal>-like format string, and a variable number of
6999 The <literal>log level</literal> is a bit mask, that says on which level(s)
7000 the log entry should be made, and optionally set some behaviour of the
7001 logging. In the most simple cases, it can be one of <literal>YLOG_FATAL,
7002 YLOG_DEBUG, YLOG_WARN, YLOG_LOG</literal>. Those can be combined with bits
7003 that modify the way the log entry is written:<literal>YLOG_ERRNO,
7004 YLOG_NOTIME, YLOG_FLUSH</literal>.
7005 Most of the rest of the bits are deprecated, and should not be used. Use
7006 the dynamic log levels instead.
7009 Applications that use &yaz;, should not use the LOG_LOG for ordinary
7010 messages, but should make use of the dynamic loglevel system. This consists
7011 of two parts, defining the loglevel and checking it.
7014 To define the log levels, the (main) program should pass a string to
7015 <function>yaz_log_mask_str</function> to define which log levels are to be
7016 logged. This string should be a comma-separated list of log level names,
7017 and can contain both hard-coded names and dynamic ones. The log level
7018 calculation starts with <literal>YLOG_DEFAULT_LEVEL</literal> and adds a bit
7019 for each word it meets, unless the word starts with a '-', in which case it
7020 clears the bit. If the string <literal>'none'</literal> is found,
7021 all bits are cleared. Typically this string comes from the command-line,
7022 often identified by <literal>-v</literal>. The
7023 <function>yaz_log_mask_str</function> returns a log level that should be
7024 passed to <function>yaz_log_init_level</function> for it to take effect.
7027 Each module should check what log bits it should be used, by calling
7028 <function>yaz_log_module_level</function> with a suitable name for the
7029 module. The name is cleared from a preceding path and an extension, if any,
7030 so it is quite possible to use <literal>__FILE__</literal> for it. If the
7031 name has been passed to <function>yaz_log_mask_str</function>, the routine
7032 returns a non-zero bitmask, which should then be used in consequent calls
7033 to yaz_log. (It can also be tested, so as to avoid unnecessary calls to
7034 yaz_log, in time-critical places, or when the log entry would take time
7038 Yaz uses the following dynamic log levels:
7039 <literal>server, session, request, requestdetail</literal> for the server
7041 <literal>zoom</literal> for the zoom client api.
7042 <literal>ztest</literal> for the simple test server.
7043 <literal>malloc, nmem, odr, eventl</literal> for internal
7044 debugging of yaz itself.
7045 Of course, any program using yaz is welcome to define as many new
7049 By default the log is written to stderr, but this can be changed by a call
7050 to <function>yaz_log_init_file</function> or
7051 <function>yaz_log_init</function>. If the log is directed to a file, the
7052 file size is checked at every write, and if it exceeds the limit given in
7053 <function>yaz_log_init_max_size</function>, the log is rotated. The
7054 rotation keeps one old version (with a <literal>.1</literal> appended to
7055 the name). The size defaults to 1GB. Setting it to zero will disable the
7059 A typical yaz-log looks like this
7060 13:23:14-23/11 yaz-ztest(1) [session] Starting session from tcp:127.0.0.1 (pid=30968)
7061 13:23:14-23/11 yaz-ztest(1) [request] Init from 'YAZ' (81) (ver 2.0.28) OK
7062 13:23:17-23/11 yaz-ztest(1) [request] Search Z: @attrset Bib-1 foo OK:7 hits
7063 13:23:22-23/11 yaz-ztest(1) [request] Present: [1] 2+2 OK 2 records returned
7064 13:24:13-23/11 yaz-ztest(1) [request] Close OK
7067 The log entries start with a time stamp. This can be omitted by setting the
7068 <literal>YLOG_NOTIME</literal> bit in the loglevel. This way automatic tests
7069 can be hoped to produce identical log files, that are easy to diff. The
7070 format of the time stamp can be set with
7071 <function>yaz_log_time_format</function>, which takes a format string just
7072 like <function>strftime</function>.
7075 Next in a log line comes the prefix, often the name of the program. For
7076 yaz-based servers, it can also contain the session number. Then
7077 comes one or more logbits in square brackets, depending on the logging
7078 level set by <function>yaz_log_init_level</function> and the loglevel
7079 passed to <function>yaz_log_init_level</function>. Finally comes the format
7080 string and additional values passed to <function>yaz_log</function>
7083 The log level <literal>YLOG_LOGLVL</literal>, enabled by the string
7084 <literal>loglevel</literal>, will log all the log-level affecting
7085 operations. This can come in handy if you need to know what other log
7086 levels would be useful. Grep the logfile for <literal>[loglevel]</literal>.
7089 The log system is almost independent of the rest of &yaz;, the only
7090 important dependence is of <filename>nmem</filename>, and that only for
7091 using the semaphore definition there.
7094 The dynamic log levels and log rotation were introduced in &yaz; 2.0.28. At
7095 the same time, the log bit names were changed from
7096 <literal>LOG_something</literal> to <literal>YLOG_something</literal>,
7097 to avoid collision with <filename>syslog.h</filename>.
7103 YAZ provides a fast utility for working with MARC records.
7104 Early versions of the MARC utility only allowed decoding of ISO2709.
7105 Today the utility may both encode - and decode to a varity of formats.
7108 #include <yaz/marcdisp.h>
7110 /* create handler */
7111 yaz_marc_t yaz_marc_create(void);
7113 void yaz_marc_destroy(yaz_marc_t mt);
7115 /* set XML mode YAZ_MARC_LINE, YAZ_MARC_SIMPLEXML, ... */
7116 void yaz_marc_xml(yaz_marc_t mt, int xmlmode);
7117 #define YAZ_MARC_LINE 0
7118 #define YAZ_MARC_SIMPLEXML 1
7119 #define YAZ_MARC_OAIMARC 2
7120 #define YAZ_MARC_MARCXML 3
7121 #define YAZ_MARC_ISO2709 4
7122 #define YAZ_MARC_XCHANGE 5
7123 #define YAZ_MARC_CHECK 6
7124 #define YAZ_MARC_TURBOMARC 7
7125 #define YAZ_MARC_JSON 8
7127 /* supply iconv handle for character set conversion .. */
7128 void yaz_marc_iconv(yaz_marc_t mt, yaz_iconv_t cd);
7130 /* set debug level, 0=none, 1=more, 2=even more, .. */
7131 void yaz_marc_debug(yaz_marc_t mt, int level);
7133 /* decode MARC in buf of size bsize. Returns >0 on success; <=0 on failure.
7134 On success, result in *result with size *rsize. */
7135 int yaz_marc_decode_buf(yaz_marc_t mt, const char *buf, int bsize,
7136 const char **result, size_t *rsize);
7138 /* decode MARC in buf of size bsize. Returns >0 on success; <=0 on failure.
7139 On success, result in WRBUF */
7140 int yaz_marc_decode_wrbuf(yaz_marc_t mt, const char *buf,
7141 int bsize, WRBUF wrbuf);
7146 The synopsis is just a basic subset of all functionality. Refer
7147 to the actual header file <filename>marcdisp.h</filename> for
7152 A MARC conversion handle must be created by using
7153 <function>yaz_marc_create</function> and destroyed
7154 by calling <function>yaz_marc_destroy</function>.
7157 All other function operate on a <literal>yaz_marc_t</literal> handle.
7158 The output is specified by a call to <function>yaz_marc_xml</function>.
7159 The <literal>xmlmode</literal> must be one of
7162 <term>YAZ_MARC_LINE</term>
7165 A simple line-by-line format suitable for display but not
7166 recommend for further (machine) processing.
7171 <term>YAZ_MARC_MARCXML</term>
7174 <ulink url="&url.marcxml;">MARCXML</ulink>.
7179 <term>YAZ_MARC_ISO2709</term>
7182 ISO2709 (sometimes just referred to as "MARC").
7187 <term>YAZ_MARC_XCHANGE</term>
7190 <ulink url="&url.marcxchange;">MarcXchange</ulink>.
7195 <term>YAZ_MARC_CHECK</term>
7198 Pseudo format for validation only. Does not generate
7199 any real output except diagnostics.
7204 <term>YAZ_MARC_TURBOMARC</term>
7207 XML format with same semantics as MARCXML but more compact
7208 and geared towards fast processing with XSLT. Refer to
7209 <xref linkend="tools.turbomarc"/> for more information.
7214 <term>YAZ_MARC_JSON</term>
7217 <ulink url="&url.marc_in_json;">MARC-in_JSON</ulink> format.
7224 The actual conversion functions are
7225 <function>yaz_marc_decode_buf</function> and
7226 <function>yaz_marc_decode_wrbuf</function> which decodes and encodes
7227 a MARC record. The former function operates on simple buffers, the
7228 stores the resulting record in a WRBUF handle (WRBUF is a simple string
7231 <example id="example.marc.display">
7232 <title>Display of MARC record</title>
7234 The following program snippet illustrates how the MARC API may
7235 be used to convert a MARC record to the line-by-line format:
7236 <programlisting><![CDATA[
7237 void print_marc(const char *marc_buf, int marc_buf_size)
7239 char *result; /* for result buf */
7240 size_t result_len; /* for size of result */
7241 yaz_marc_t mt = yaz_marc_create();
7242 yaz_marc_xml(mt, YAZ_MARC_LINE);
7243 yaz_marc_decode_buf(mt, marc_buf, marc_buf_size,
7244 &result, &result_len);
7245 fwrite(result, result_len, 1, stdout);
7246 yaz_marc_destroy(mt); /* note that result is now freed... */
7252 <sect2 id="tools.turbomarc">
7253 <title>TurboMARC</title>
7255 TurboMARC is yet another XML encoding of a MARC record. The format
7256 was designed for fast processing with XSLT.
7260 Pazpar2 uses XSLT to convert an XML encoded MARC record to an internal
7261 representation. This conversion mostly check the tag of a MARC field
7262 to determine the basic rules in the conversion. This check is
7263 costly when that is tag is encoded as an attribute in MARCXML.
7264 By having the tag value as the element instead, makes processing
7265 many times faster (at least for Libxslt).
7268 TurboMARC is encoded as follows:
7272 Record elements is part of namespace
7273 "<literal>http://www.indexdata.com/turbomarc</literal>".
7278 A record is enclosed in element <literal>r</literal>.
7283 A collection of records is enclosed in element
7284 <literal>collection</literal>.
7289 The leader is encoded as element <literal>l</literal> with the
7290 leader content as its (text) value.
7295 A control field is encoded as element <literal>c</literal> concatenated
7296 with the tag value of the control field if the tag value
7297 matches the regular expression <literal>[a-zA-Z0-9]*</literal>.
7298 If the tag value do not match the regular expression
7299 <literal>[a-zA-Z0-9]*</literal> the control field is encoded
7300 as element <literal>c</literal> and attribute <literal>code</literal>
7301 will hold the tag value.
7302 This rule ensure that in the rare cases where a tag value might
7303 result in a non-wellformed XML YAZ encode it as a coded attribute
7307 The control field content is the the text value of this element.
7308 Indicators are encoded as attribute names
7309 <literal>i1</literal>, <literal>i2</literal>, etc.. and
7310 corresponding values for each indicator.
7315 A data field is encoded as element <literal>d</literal> concatenated
7316 with the tag value of the data field or using the attribute
7317 <literal>code</literal> as described in the rules for control fields.
7318 The children of the data field element is subfield elements.
7319 Each subfield element is encoded as <literal>s</literal>
7320 concatenated with the sub field code.
7321 The text of the subfield element is the contents of the subfield.
7322 Indicators are encoded as attributes for the data field element similar
7323 to the encoding for control fields.
7330 <sect1 id="tools.retrieval">
7331 <title>Retrieval Facility</title>
7333 YAZ version 2.1.20 or later includes a Retrieval facility tool
7334 which allows a SRU/Z39.50 to describe itself and perform record
7335 conversions. The idea is the following:
7339 An SRU/Z39.50 client sends a retrieval request which includes
7340 a combination of the following parameters: syntax (format),
7341 schema (or element set name).
7346 The retrieval facility is invoked with parameters in a
7347 server/proxy. The retrieval facility matches the parameters a set of
7348 "supported" retrieval types.
7349 If there is no match, the retrieval signals an error
7350 (syntax and / or schema not supported).
7355 For a successful match, the backend is invoked with the same
7356 or altered retrieval parameters (syntax, schema). If
7357 a record is received from the backend, it is converted to the
7358 frontend name / syntax.
7363 The resulting record is sent back the client and tagged with
7364 the frontend syntax / schema.
7370 The Retrieval facility is driven by an XML configuration. The
7371 configuration is neither Z39.50 ZeeRex or SRU ZeeRex. But it
7372 should be easy to generate both of them from the XML configuration.
7373 (unfortunately the two versions
7374 of ZeeRex differ substantially in this regard).
7376 <sect2 id="tools.retrieval.format">
7377 <title>Retrieval XML format</title>
7379 All elements should be covered by namespace
7380 <literal>http://indexdata.com/yaz</literal> .
7381 The root element node must be <literal>retrievalinfo</literal>.
7384 The <literal>retrievalinfo</literal> must include one or
7385 more <literal>retrieval</literal> elements. Each
7386 <literal>retrieval</literal> defines specific combination of
7387 syntax, name and identifier supported by this retrieval service.
7390 The <literal>retrieval</literal> element may include any of the
7391 following attributes:
7393 <varlistentry><term><literal>syntax</literal> (REQUIRED)</term>
7396 Defines the record syntax. Possible values is any
7397 of the names defined in YAZ' OID database or a raw
7402 <varlistentry><term><literal>name</literal> (OPTIONAL)</term>
7405 Defines the name of the retrieval format. This can be
7406 any string. For SRU, the value, is equivalent to schema (short-hand);
7407 for Z39.50 it's equivalent to simple element set name.
7408 For YAZ 3.0.24 and later this name may be specified as a glob
7409 expression with operators
7410 <literal>*</literal> and <literal>?</literal>.
7414 <varlistentry><term><literal>identifier</literal> (OPTIONAL)</term>
7417 Defines the URI schema name of the retrieval format. This can be
7418 any string. For SRU, the value, is equivalent to URI schema.
7419 For Z39.50, there is no equivalent.
7426 The <literal>retrieval</literal> may include one
7427 <literal>backend</literal> element. If a <literal>backend</literal>
7428 element is given, it specifies how the records are retrieved by
7429 some backend and how the records are converted from the backend to
7433 The attributes, <literal>name</literal> and <literal>syntax</literal>
7434 may be specified for the <literal>backend</literal> element. These
7435 semantics of these attributes is equivalent to those for the
7436 <literal>retrieval</literal>. However, these values are passed to
7440 The <literal>backend</literal> element may includes one or more
7441 conversion instructions (as children elements). The supported
7444 <varlistentry><term><literal>marc</literal></term>
7447 The <literal>marc</literal> element specifies a conversion
7448 to - and from ISO2709 encoded MARC and
7449 <ulink url="&url.marcxml;">&acro.marcxml;</ulink>/MarcXchange.
7450 The following attributes may be specified:
7453 <term><literal>inputformat</literal> (REQUIRED)</term>
7456 Format of input. Supported values are
7457 <literal>marc</literal> (for ISO2709), <literal>xml</literal>
7458 (MARCXML/MarcXchange) and <literal>json</literal>
7459 (<ulink url="&url.marc_in_json;">MARC-in_JSON</ulink>).
7464 <term><literal>outputformat</literal> (REQUIRED)</term>
7467 Format of output. Supported values are
7468 <literal>line</literal> (MARC line format);
7469 <literal>marcxml</literal> (for MARCXML),
7470 <literal>marc</literal> (ISO2709),
7471 <literal>marcxhcange</literal> (for MarcXchange),
7472 or <literal>json</literal>
7473 (<ulink url="&url.marc_in_json;">MARC-in_JSON </ulink>).
7478 <term><literal>inputcharset</literal> (OPTIONAL)</term>
7481 Encoding of input. For XML input formats, this need not
7482 be given, but for ISO2709 based inputformats, this should
7483 be set to the encoding used. For MARC21 records, a common
7484 inputcharset value would be <literal>marc-8</literal>.
7489 <term><literal>outputcharset</literal> (OPTIONAL)</term>
7492 Encoding of output. If outputformat is XML based, it is
7493 strongly recommened to use <literal>utf-8</literal>.
7502 <term><literal>select</literal></term>
7505 The <literal>select</literal> selects one or more text nodes
7506 and decodes them as XML.
7507 The following attributes may be specified:
7509 <varlistentry><term><literal>path</literal> (REQUIRED)</term>
7512 X-Path expression for selecting text nodes.
7519 This conversion is available in YAZ 5.8.0 and later.
7524 <term><literal>solrmarc</literal></term>
7527 The <literal>solrmarc</literal> decodes solrmarc records.
7528 It assumes that the input is pure solrmarc text (no escaping)
7529 and will convert all sequences of the form #XX; to a single
7530 character of the hexadecimal value as given by XX. The output,
7531 presumably, is a valid ISO2709 buffer.
7534 This conversion is available in YAZ 5.0.21 and later.
7539 <term><literal>xslt</literal></term>
7542 The <literal>xslt</literal> element specifies a conversion
7543 via &acro.xslt;. The following attributes may be specified:
7545 <varlistentry><term><literal>stylesheet</literal> (REQUIRED)</term>
7559 <sect2 id="tools.retrieval.examples">
7560 <title>Retrieval Facility Examples</title>
7561 <example id="tools.retrieval.marc21">
7562 <title>MARC21 backend</title>
7564 A typical way to use the retrieval facility is to enable XML
7565 for servers that only supports ISO2709 encoded MARC21 records.
7567 <programlisting><![CDATA[
7569 <retrieval syntax="usmarc" name="F"/>
7570 <retrieval syntax="usmarc" name="B"/>
7571 <retrieval syntax="xml" name="marcxml"
7572 identifier="info:srw/schema/1/marcxml-v1.1">
7573 <backend syntax="usmarc" name="F">
7574 <marc inputformat="marc" outputformat="marcxml"
7575 inputcharset="marc-8"/>
7578 <retrieval syntax="xml" name="dc">
7579 <backend syntax="usmarc" name="F">
7580 <marc inputformat="marc" outputformat="marcxml"
7581 inputcharset="marc-8"/>
7582 <xslt stylesheet="MARC21slim2DC.xsl"/>
7589 This means that our frontend supports:
7593 MARC21 F(ull) records.
7598 MARC21 B(rief) records.
7608 Dublin core records.
7614 <example id="tools.retrieval.marcxml">
7615 <title>MARCXML backend</title>
7617 SRW/SRU and Solr backends returns records in XML.
7618 If they return MARCXML or MarcXchange, the retrieval module
7619 can convert those into ISO2709 formats, most commonly USMARC
7621 In this example, the backend returns MARCXML for schema="marcxml".
7623 <programlisting><![CDATA[
7625 <retrieval syntax="usmarc">
7626 <backend syntax="xml" name="marcxml">
7627 <marc inputformat="xml" outputformat="marc"
7628 outputcharset="marc-8"/>
7631 <retrieval syntax="xml" name="marcxml"
7632 identifier="info:srw/schema/1/marcxml-v1.1"/>
7633 <retrieval syntax="xml" name="dc">
7634 <backend syntax="xml" name="marcxml">
7635 <xslt stylesheet="MARC21slim2DC.xsl"/>
7642 This means that our frontend supports:
7646 MARC21 records (any element set name) in MARC-8 encoding.
7651 MARCXML records for element-set=marcxml
7656 Dublin core records for element-set=dc.
7663 <sect2 id="tools.retrieval.api">
7666 It should be easy to use the retrieval systems from applications. Refer
7668 <filename>yaz/retrieval.h</filename> and
7669 <filename>yaz/record_conv.h</filename>.
7673 <sect1 id="sorting">
7674 <title>Sorting</title>
7676 This chapter describes sorting and how it is supported in YAZ.
7677 Sorting applies to a result-set.
7679 <ulink url="http://www.loc.gov/z3950/agency/markup/05.html#3.2.7">
7680 Z39.50 sorting facility
7682 takes one or more input result-sets
7683 and one result-set as output. The most simple case is that
7684 the input-set is the same as the output-set.
7687 Z39.50 sorting has a separate APDU (service) that is, thus, performed
7688 following a search (two phases).
7691 In SRU/Solr, however, the model is different. Here, sorting is specified
7692 during the the search operation. Note, however, that SRU might
7693 perform sort as separate search, by referring to an existing result-set
7694 in the query (result-set reference).
7697 <title>Using the Z39.50 sort service</title>
7699 yaz-client and the ZOOM API supports the Z39.50 sort facility. In any
7700 case the sort sequence or sort critiera is using a string notation.
7701 This notation is a one-line notation suitable for being manually
7702 entered or generated and allows for easy logging (one liner).
7703 For the ZOOM API, the sort is specified in the call to ZOOM_query_sortby
7704 function. For yaz-client the sort is performed and specified using
7705 the sort and sort+ commands. For description of the sort criteria notation
7706 refer to the <link linkend="sortspec">sort command</link> in the
7710 The ZOOM API might choose one of several sort strategies for
7711 sorting. Refer to <xref linkend="zoom-sort-strategy"/>.
7715 <title>Type-7 sort</title>
7717 Type-7 sort is an extension to the Bib-1 based RPN query where the
7718 sort specification is embedded as an Attribute-Plus-Term.
7721 The objectives for introducing Type-7 sorting is that it allows
7722 a client to perform sorting even if it does not implement/support
7723 Z39.50 sort. Virtually all Z39.50 client software supports
7724 RPN queries. It also may improve performance because the sort
7725 critieria is specified along with the search query.
7728 The sort is triggered by the presence of type 7 and the value of type 7
7730 <ulink url="http://www.loc.gov/z3950/agency/asn1.html#SortKeySpec">
7733 The value for type 7 is 1 for ascending and 2 for descending.
7735 <ulink url="http://www.loc.gov/z3950/agency/asn1.html#SortElement">
7738 only the generic part is handled. If generic sortKey is of type
7739 sortField, then attribute type 1 is present and the value is
7740 sortField (InternationalString). If generic sortKey is of type
7741 sortAttributes, then the attributes in list is used . generic sortKey
7742 of type elementSpec is not supported.
7745 The term in the sorting Attribute-Plus-Term combo should hold
7746 an integer. The value is 0 for primary sorting criteria, 1 for second
7752 <title>Facets</title>
7754 YAZ supports facets for in Solr, SRU 2.0 and Z39.50 protocols.
7757 Like Type-1/RPN, YAZ supports a string notation for specifying
7758 facets. For the API this is performed by
7759 <function>yaz_pqf_parse_facet_list</function>.
7762 For ZOOM C the facets are given by option "facets"
7763 For yaz-client it is used for the facets command.
7766 The grammar of this specification is as follows:
7768 facet-spec ::= facet-list
7770 facet-list ::= facet-list ',' attr-spec | attr-spec
7772 attr-spec ::= attr-spec '@attr' string | '@attr' string
7775 The notation is inspired by PQF. The string following '@attr'
7776 may not include blanks and is of the form
7777 <replaceable>type</replaceable><literal>=</literal><replaceable>value</replaceable>,
7778 where <replaceable>type</replaceable> is an integer and
7779 <replaceable>value</replaceable> is a string or an integer.
7782 The Facets specification is not Bib-1. The following types apply:
7784 <table id="facet.attributes">
7785 <title>Facet attributes</title>
7787 <colspec colwidth="2*" colname="type"></colspec>
7788 <colspec colwidth="9*" colname="description"></colspec>
7792 <entry>Description</entry>
7799 Field-name. This is often a string, eg "Author", "Year", etc.
7805 Sort order. Value should be an integer.
7806 Value 0: count descending (frequency). Value 1: alpha ascending.
7812 Number of terms requested.
7827 <title>The ODR Module</title>
7828 <sect1 id="odr.introduction">
7829 <title>Introduction</title>
7831 &odr; is the BER-encoding/decoding subsystem of &yaz;. Care as been taken
7832 to isolate &odr; from the rest of the package - specifically from the
7833 transport interface. &odr; may be used in any context where basic
7834 ASN.1/BER representations are used.
7837 If you are only interested in writing a Z39.50 implementation based on
7838 the PDUs that are already provided with &yaz;, you only need to concern
7839 yourself with the section on managing ODR streams
7840 (<xref linkend="odr.use"/>). Only if you need to
7841 implement ASN.1 beyond that which has been provided, should you
7842 worry about the second half of the documentation
7843 (<xref linkend="odr.programming"/>).
7844 If you use one of the higher-level interfaces, you can skip this
7848 This is important, so we'll repeat it for emphasis: <emphasis>You do
7849 not need to read <xref linkend="odr.programming"/>
7850 to implement Z39.50 with &yaz;.</emphasis>
7853 If you need a part of the protocol that isn't already in &yaz;, you
7854 should contact the authors before going to work on it yourself: We
7855 might already be working on it. Conversely, if you implement a useful
7856 part of the protocol before us, we'd be happy to include it in a
7860 <sect1 id="odr.use">
7861 <title>Using ODR</title>
7862 <sect2 id="odr.streams">
7863 <title>ODR Streams</title>
7865 Conceptually, the ODR stream is the source of encoded data in the
7866 decoding mode; when encoding, it is the receptacle for the encoded
7867 data. Before you can use an ODR stream it must be allocated. This is
7868 done with the function
7871 ODR odr_createmem(int direction);
7874 The <function>odr_createmem()</function> function takes as argument one
7875 of three manifest constants: <literal>ODR_ENCODE</literal>,
7876 <literal>ODR_DECODE</literal>, or <literal>ODR_PRINT</literal>.
7877 An &odr; stream can be in only one mode - it is not possible to change
7878 its mode once it's selected. Typically, your program will allocate
7879 at least two ODR streams - one for decoding, and one for encoding.
7882 When you're done with the stream, you can use
7885 void odr_destroy(ODR o);
7888 to release the resources allocated for the stream.
7891 <sect2 id="odr.memory.management">
7892 <title id="memory">Memory Management</title>
7894 Two forms of memory management take place in the &odr; system. The first
7895 one, which has to do with allocating little bits of memory (sometimes
7896 quite large bits of memory, actually) when a protocol package is
7897 decoded, and turned into a complex of interlinked structures. This
7898 section deals with this system, and how you can use it for your own
7899 purposes. The next section deals with the memory management which is
7900 required when encoding data - to make sure that a large enough buffer is
7901 available to hold the fully encoded PDU.
7904 The &odr; module has its own memory management system, which is
7905 used whenever memory is required. Specifically, it is used to allocate
7906 space for data when decoding incoming PDUs. You can use the memory
7907 system for your own purposes, by using the function
7910 void *odr_malloc(ODR o, size_t size);
7913 You can't use the normal <function>free(2)</function> routine to free
7914 memory allocated by this function, and &odr; doesn't provide a parallel
7915 function. Instead, you can call
7918 void odr_reset(ODR o);
7921 when you are done with the
7922 memory: Everything allocated since the last call to
7923 <function>odr_reset()</function> is released.
7924 The <function>odr_reset()</function> call is also required to clear
7925 up an error condition on a stream.
7931 size_t odr_total(ODR o);
7934 returns the number of bytes allocated on the stream since the last call to
7935 <function>odr_reset()</function>.
7938 The memory subsystem of &odr; is fairly efficient at allocating and
7939 releasing little bits of memory. Rather than managing the individual,
7940 small bits of space, the system maintains a free-list of larger chunks
7941 of memory, which are handed out in small bits. This scheme is
7942 generally known as a <emphasis>nibble memory</emphasis> system.
7943 It is very useful for maintaining short-lived constructions such
7947 If you want to retain a bit of memory beyond the next call to
7948 <function>odr_reset()</function>, you can use the function
7951 ODR_MEM odr_extract_mem(ODR o);
7954 This function will give you control of the memory recently allocated
7955 on the ODR stream. The memory will live (past calls to
7956 <function>odr_reset()</function>), until you call the function
7959 void odr_release_mem(ODR_MEM p);
7962 The opaque <literal>ODR_MEM</literal> handle has no other purpose than
7963 referencing the memory block for you until you want to release it.
7966 You can use <function>odr_extract_mem()</function> repeatedly between
7967 allocating data, to retain individual control of separate chunks of data.
7970 <sect2 id="odr.encoding.and.decoding">
7971 <title>Encoding and Decoding Data</title>
7973 When encoding data, the ODR stream will write the encoded octet string
7974 in an internal buffer. To retrieve the data, use the function
7977 char *odr_getbuf(ODR o, int *len, int *size);
7980 The integer pointed to by len is set to the length of the encoded
7981 data, and a pointer to that data is returned. <literal>*size</literal>
7982 is set to the size of the buffer (unless <literal>size</literal> is null,
7983 signaling that you are not interested in the size). The next call to
7984 a primitive function using the same &odr; stream will overwrite the
7985 data, unless a different buffer has been supplied using the call
7988 void odr_setbuf(ODR o, char *buf, int len, int can_grow);
7991 which sets the encoding (or decoding) buffer used by
7992 <literal>o</literal> to <literal>buf</literal>, using the length
7993 <literal>len</literal>.
7994 Before a call to an encoding function, you can use
7995 <function>odr_setbuf()</function> to provide the stream with an encoding
7996 buffer of sufficient size (length). The <literal>can_grow</literal>
7997 parameter tells the encoding &odr; stream whether it is allowed to use
7998 <function>realloc(2)</function> to increase the size of the buffer when
7999 necessary. The default condition of a new encoding stream is equivalent
8000 to the results of calling
8003 odr_setbuf(stream, 0, 0, 1);
8006 In this case, the stream will allocate and reallocate memory as
8007 necessary. The stream reallocates memory by repeatedly doubling the
8008 size of the buffer - the result is that the buffer will typically
8009 reach its maximum, working size with only a small number of reallocation
8010 operations. The memory is freed by the stream when the latter is destroyed,
8011 unless it was assigned by the user with the <literal>can_grow</literal>
8012 parameter set to zero (in this case, you are expected to retain
8013 control of the memory yourself).
8016 To assume full control of an encoded buffer, you must first call
8017 <function>odr_getbuf()</function> to fetch the buffer and its length.
8018 Next, you should call <function>odr_setbuf()</function> to provide a
8019 different buffer (or a null pointer) to the stream. In the simplest
8020 case, you will reuse the same buffer over and over again, and you
8021 will just need to call <function>odr_getbuf()</function> after each
8022 encoding operation to get the length and address of the buffer.
8023 Note that the stream may reallocate the buffer during an encoding
8024 operation, so it is necessary to retrieve the correct address after
8025 each encoding operation.
8028 It is important to realize that the ODR stream will not release this
8029 memory when you call <function>odr_reset()</function>: It will
8030 merely update its internal pointers to prepare for the encoding of a
8032 When the stream is released by the <function>odr_destroy()</function>
8033 function, the memory given to it by <function>odr_setbuf</function> will
8034 be released <emphasis>only</emphasis> if the <literal>can_grow</literal>
8035 parameter to <function>odr_setbuf()</function> was nonzero. The
8036 <literal>can_grow</literal> parameter, in other words, is a way of
8037 signaling who is to own the buffer, you or the ODR stream. If you never call
8038 <function>odr_setbuf()</function> on your encoding stream, which is
8039 typically the case, the buffer allocated by the stream will belong to
8040 the stream by default.
8043 When you wish to decode data, you should first call
8044 <function>odr_setbuf()</function>, to tell the decoding stream
8045 where to find the encoded data, and how long the buffer is
8046 (the <literal>can_grow</literal> parameter is ignored by a decoding
8047 stream). After this, you can call the function corresponding to the
8048 data you wish to decode (eg, <function>odr_integer()</function> odr
8049 <function>z_APDU()</function>).
8051 <example id="example.odr.encoding.and.decoding.functions">
8052 <title>Encoding and decoding functions</title>
8054 int odr_integer(ODR o, Odr_int **p, int optional, const char *name);
8056 int z_APDU(ODR o, Z_APDU **p, int optional, const char *name);
8060 If the data is absent (or doesn't match the tag corresponding to
8061 the type), the return value will be either 0 or 1 depending on the
8062 <literal>optional</literal> flag. If <literal>optional</literal>
8063 is 0 and the data is absent, an error flag will be raised in the
8064 stream, and you'll need to call <function>odr_reset()</function> before
8065 you can use the stream again. If <literal>optional</literal> is
8066 nonzero, the pointer <emphasis>pointed</emphasis> to/ by
8067 <literal>p</literal> will be set to the null value, and the function
8069 The <literal>name</literal> argument is used to pretty-print the
8070 tag in question. It may be set to <literal>NULL</literal> if
8071 pretty-printing is not desired.
8074 If the data value is found where it's expected, the pointer
8075 <emphasis>pointed to</emphasis> by the <literal>p</literal> argument
8076 will be set to point to the decoded type.
8077 The space for the type will be allocated and owned by the &odr;
8078 stream, and it will live until you call
8079 <function>odr_reset()</function> on the stream. You cannot use
8080 <function>free(2)</function> to release the memory.
8081 You can decode several data elements (by repeated calls to
8082 <function>odr_setbuf()</function> and your decoding function), and
8083 new memory will be allocated each time. When you do call
8084 <function>odr_reset()</function>, everything decoded since the
8085 last call to <function>odr_reset()</function> will be released.
8087 <example id="example.odr.encoding.of.integer">
8088 <title>Encoding and decoding of an integer</title>
8090 The use of the double indirection can be a little confusing at first
8091 (its purpose will become clear later on, hopefully),
8092 so an example is in order. We'll encode an integer value, and
8093 immediately decode it again using a different stream. A useless, but
8094 informative operation.
8096 <programlisting><![CDATA[
8097 void do_nothing_useful(Odr_int value)
8100 Odr_int *valp, *resvalp;
8104 /* allocate streams */
8105 if (!(encode = odr_createmem(ODR_ENCODE)))
8107 if (!(decode = odr_createmem(ODR_DECODE)))
8111 if (odr_integer(encode, &valp, 0, 0) == 0)
8113 printf("encoding went bad\n");
8116 bufferp = odr_getbuf(encode, &len, 0);
8117 printf("length of encoded data is %d\n", len);
8119 /* now let's decode the thing again */
8120 odr_setbuf(decode, bufferp, len, 0);
8121 if (odr_integer(decode, &resvalp, 0, 0) == 0)
8123 printf("decoding went bad\n");
8126 /* ODR_INT_PRINTF format for printf (such as %d) */
8127 printf("the value is " ODR_INT_PRINTF "\n", *resvalp);
8130 odr_destroy(encode);
8131 odr_destroy(decode);
8136 This looks like a lot of work, offhand. In practice, the &odr; streams
8137 will typically be allocated once, in the beginning of your program
8138 (or at the beginning of a new network session), and the encoding
8139 and decoding will only take place in a few, isolated places in your
8140 program, so the overhead is quite manageable.
8144 <sect2 id="odr.printing">
8145 <title>Printing</title>
8147 When an ODR stream is created of type <literal>ODR_PRINT</literal>
8148 the ODR module will print the contents of a PDU in a readable format.
8149 By default output is written to the <literal>stderr</literal> stream.
8150 This behavior can be changed, however, by calling the function
8152 odr_setprint(ODR o, FILE *file);
8154 before encoders or decoders are being invoked.
8155 It is also possible to direct the output to a buffer (of indeed
8156 another file), by using the more generic mechanism:
8158 void odr_set_stream(ODR o, void *handle,
8159 void (*stream_write)(ODR o, void *handle, int type,
8160 const char *buf, int len),
8161 void (*stream_close)(void *handle));
8163 Here the user provides an opaque handle and two handlers,
8164 <replaceable>stream_write</replaceable> for writing,
8165 and <replaceable>stream_close</replaceable> which is supposed
8166 to close/free resources associated with handle.
8167 The <replaceable>stream_close</replaceable> handler is optional and
8168 if NULL for the function is provided, it will not be invoked.
8169 The <replaceable>stream_write</replaceable> takes the ODR handle
8170 as parameter, the user defined handle, a type
8171 <literal>ODR_OCTETSTRING</literal>, <literal>ODR_VISIBLESTRING</literal>
8172 which indicates the type of contents is being written.
8175 Another utility useful for diagnostics (error handling) or as
8176 part of the printing facilities is:
8178 const char **odr_get_element_path(ODR o);
8180 which returns a list of current elements that ODR deals with at the
8181 moment. For the returned array, say <literal>ar</literal>,
8182 <literal>ar[0]</literal> is the top level element,
8183 <literal>ar[n]</literal> is the last. The last element has the
8184 property that <literal>ar[n+1] == NULL</literal>.
8186 <example id="example.odr.element.path.record">
8187 <title>Element Path for record</title>
8189 For a database record part of a PresentResponse the
8190 array returned by <function>odr_get_element</function>
8191 is <literal>presentResponse</literal>, <literal>databaseOrSurDiagnostics</literal>, <literal>?</literal>, <literal>record</literal>, <literal>?</literal>, <literal>databaseRecord</literal> . The question mark appears due to
8192 unnamed constructions.
8196 <sect2 id="odr.diagnostics">
8197 <title>Diagnostics</title>
8199 The encoding/decoding functions all return 0 when an error occurs.
8200 Until you call <function>odr_reset()</function>, you cannot use the
8201 stream again, and any function called will immediately return 0.
8204 To provide information to the programmer or administrator, the function
8207 void odr_perror(ODR o, char *message);
8210 is provided, which prints the <literal>message</literal> argument to
8211 <literal>stderr</literal> along with an error message from the stream.
8214 You can also use the function
8217 int odr_geterror(ODR o);
8220 to get the current error number from the screen. The number will be
8221 one of these constants:
8223 <table frame="top" id="odr.error.codes">
8224 <title>ODR Error codes</title>
8229 <entry>Description</entry>
8234 <entry>OMEMORY</entry><entry>Memory allocation failed.</entry>
8237 <entry>OSYSERR</entry><entry>A system- or library call has failed.
8238 The standard diagnostic variable <literal>errno</literal> should be
8239 examined to determine the actual error.</entry>
8242 <entry>OSPACE</entry><entry>No more space for encoding.
8243 This will only occur when the user has explicitly provided a
8244 buffer for an encoding stream without allowing the system to
8245 allocate more space.</entry>
8248 <entry>OREQUIRED</entry><entry>This is a common protocol error; A
8249 required data element was missing during encoding or decoding.</entry>
8252 <entry>OUNEXPECTED</entry><entry>An unexpected data element was
8253 found during decoding.</entry>
8256 <entry>OOTHER</entry><entry>Other error. This is typically an
8257 indication of misuse of the &odr; system by the programmer, and also
8258 that the diagnostic system isn't as good as it should be, yet.</entry>
8264 The character string array
8270 can be indexed by the error code to obtain a human-readable
8271 representation of the problem.
8274 <sect2 id="odr.summary.and.synopsis">
8275 <title>Summary and Synopsis</title>
8277 #include <yaz/odr.h>
8279 ODR odr_createmem(int direction);
8281 void odr_destroy(ODR o);
8283 void odr_reset(ODR o);
8285 char *odr_getbuf(ODR o, int *len, int *size);
8287 void odr_setbuf(ODR o, char *buf, int len, int can_grow);
8289 void *odr_malloc(ODR o, int size);
8291 NMEM odr_extract_mem(ODR o);
8293 int odr_geterror(ODR o);
8295 void odr_perror(ODR o, const char *message);
8297 extern char *odr_errlist[];
8301 <sect1 id="odr.programming">
8302 <title>Programming with ODR</title>
8304 The API of &odr; is designed to reflect the structure of ASN.1, rather
8305 than BER itself. Future releases may be able to represent data in
8306 other external forms.
8310 There is an ASN.1 tutorial available at
8311 <ulink url="&url.asn.1.tutorial;">this site</ulink>.
8312 This site also has standards for ASN.1 (X.680) and BER (X.690)
8313 <ulink url="&url.asn.1.standards;">online</ulink>.
8317 The ODR interface is based loosely on that of the Sun Microsystems
8319 Specifically, each function which corresponds to an ASN.1 primitive
8320 type has a dual function. Depending on the settings of the ODR
8321 stream which is supplied as a parameter, the function may be used
8322 either to encode or decode data. The functions that can be built
8323 using these primitive functions, to represent more complex data types,
8324 share this quality. The result is that you only have to enter the
8325 definition for a type once - and you have the functionality of encoding,
8326 decoding (and pretty-printing) all in one unit.
8327 The resulting C source code is quite compact, and is a pretty
8328 straightforward representation of the source ASN.1 specification.
8331 In many cases, the model of the XDR functions works quite well in this
8333 In others, it is less elegant. Most of the hassle comes from the optional
8334 SEQUENCE members which don't exist in XDR.
8336 <sect2 id="odr.primitive.asn1.types">
8337 <title>The Primitive ASN.1 Types</title>
8339 ASN.1 defines a number of primitive types (many of which correspond
8340 roughly to primitive types in structured programming languages, such as C).
8342 <sect3 id="odr.integer">
8343 <title>INTEGER</title>
8345 The &odr; function for encoding or decoding (or printing) the ASN.1
8346 INTEGER type looks like this:
8349 int odr_integer(ODR o, Odr_int **p, int optional, const char *name);
8352 The <literal>Odr_int</literal> is just a simple integer.
8355 This form is typical of the primitive &odr; functions. They are named
8356 after the type of data that they encode or decode. They take an &odr;
8357 stream, an indirect reference to the type in question, and an
8358 <literal>optional</literal> flag (corresponding to the OPTIONAL keyword
8359 of ASN.1) as parameters. They all return an integer value of either one
8361 When you use the primitive functions to construct encoders for complex
8362 types of your own, you should follow this model as well. This
8363 ensures that your new types can be reused as elements in yet more
8367 The <literal>o</literal> parameter should obviously refer to a properly
8368 initialized &odr; stream of the right type (encoding/decoding/printing)
8369 for the operation that you wish to perform.
8372 When encoding or printing, the function first looks at
8373 <literal>* p</literal>. If <literal>* p</literal> (the pointer pointed
8374 to by <literal>p</literal>) is a null pointer, this is taken to mean that
8375 the data element is absent. If the <literal>optional</literal> parameter
8376 is nonzero, the function will return one (signifying success) without
8377 any further processing. If the <literal>optional</literal> is zero, an
8378 internal error flag is set in the &odr; stream, and the function will
8379 return 0. No further operations can be carried out on the stream without
8380 a call to the function <function>odr_reset()</function>.
8383 If <literal>*p</literal> is not a null pointer, it is expected to
8384 point to an instance of the data type. The data will be subjected to
8385 the encoding rules, and the result will be placed in the buffer held
8386 by the &odr; stream.
8389 The other ASN.1 primitives have similar functions that operate in
8393 <sect3 id="odr.boolean">
8394 <title>BOOLEAN</title>
8396 int odr_bool(ODR o, Odr_bool **p, int optional, const char *name);
8399 <sect3 id="odr.real">
8405 <sect3 id="odr.null">
8408 int odr_null(ODR o, Odr_null **p, int optional, const char *name);
8411 In this case, the value of **p is not important. If <literal>*p</literal>
8412 is different from the null pointer, the null value is present, otherwise
8416 <sect3 id="odr.octet.string">
8417 <title>OCTET STRING</title>
8419 typedef struct odr_oct
8425 int odr_octetstring(ODR o, Odr_oct **p, int optional,
8429 The <literal>buf</literal> field should point to the character array
8430 that holds the octetstring. The <literal>len</literal> field holds the
8432 The character array need not be null terminated.
8435 To make things a little easier, an alternative is given for string
8436 types that are not expected to contain embedded NULL characters (eg.
8440 int odr_cstring(ODR o, char **p, int optional, const char *name);
8443 Which encoded or decodes between OCTETSTRING representations and
8444 null-terminates C strings.
8447 Functions are provided for the derived string types, eg:
8450 int odr_visiblestring(ODR o, char **p, int optional,
8454 <sect3 id="odr.bit.string">
8455 <title>BIT STRING</title>
8457 int odr_bitstring(ODR o, Odr_bitmask **p, int optional,
8461 The opaque type <literal>Odr_bitmask</literal> is only suitable for
8462 holding relatively brief bit strings, eg. for options fields, etc.
8463 The constant <literal>ODR_BITMASK_SIZE</literal> multiplied by 8
8464 gives the maximum possible number of bits.
8467 A set of macros are provided for manipulating the
8468 <literal>Odr_bitmask</literal> type:
8471 void ODR_MASK_ZERO(Odr_bitmask *b);
8473 void ODR_MASK_SET(Odr_bitmask *b, int bitno);
8475 void ODR_MASK_CLEAR(Odr_bitmask *b, int bitno);
8477 int ODR_MASK_GET(Odr_bitmask *b, int bitno);
8480 The functions are modeled after the manipulation functions that
8481 accompany the <literal>fd_set</literal> type used by the
8482 <function>select(2)</function> call.
8483 <literal>ODR_MASK_ZERO</literal> should always be called first on a
8484 new bitmask, to initialize the bits to zero.
8487 <sect3 id="odr.object.identifier">
8488 <title>OBJECT IDENTIFIER</title>
8490 int odr_oid(ODR o, Odr_oid **p, int optional, const char *name);
8493 The C OID representation is simply an array of integers, terminated by
8494 the value -1 (the <literal>Odr_oid</literal> type is synonymous with
8495 the <literal>short</literal> type).
8496 We suggest that you use the OID database module (see
8497 <xref linkend="tools.oid.database"/>) to handle object identifiers
8498 in your application.
8502 <sect2 id="odr.tagging.primitive.types">
8503 <title>Tagging Primitive Types</title>
8505 The simplest way of tagging a type is to use the
8506 <function>odr_implicit_tag()</function> or
8507 <function>odr_explicit_tag()</function> macros:
8510 int odr_implicit_tag(ODR o, Odr_fun fun, int class, int tag,
8511 int optional, const char *name);
8513 int odr_explicit_tag(ODR o, Odr_fun fun, int class, int tag,
8514 int optional, const char *name);
8517 To create a type derived from the integer type by implicit tagging, you
8521 MyInt ::= [210] IMPLICIT INTEGER
8524 In the &odr; system, this would be written like:
8527 int myInt(ODR o, Odr_int **p, int optional, const char *name)
8529 return odr_implicit_tag(o, odr_integer, p,
8530 ODR_CONTEXT, 210, optional, name);
8534 The function <function>myInt()</function> can then be used like any of
8535 the primitive functions provided by &odr;. Note that the behavior of
8536 <function>odr_explicit_tag()</function>
8537 and <function>odr_implicit_tag()</function> macros
8538 act exactly the same as the functions they are applied to - they
8539 respond to error conditions, etc, in the same manner - they
8540 simply have three extra parameters. The class parameter may
8541 take one of the values: <literal>ODR_CONTEXT</literal>,
8542 <literal>ODR_PRIVATE</literal>, <literal>ODR_UNIVERSAL</literal>, or
8543 <literal>/ODR_APPLICATION</literal>.
8546 <sect2 id="odr.constructed.types">
8547 <title>Constructed Types</title>
8549 Constructed types are created by combining primitive types. The
8550 &odr; system only implements the SEQUENCE and SEQUENCE OF constructions
8551 (although adding the rest of the container types should be simple
8552 enough, if the need arises).
8555 For implementing SEQUENCEs, the functions
8558 int odr_sequence_begin(ODR o, void *p, int size, const char *name);
8559 int odr_sequence_end(ODR o);
8565 The <function>odr_sequence_begin()</function> function should be
8566 called in the beginning of a function that implements a SEQUENCE type.
8567 Its parameters are the &odr; stream, a pointer (to a pointer to the type
8568 you're implementing), and the <literal>size</literal> of the type
8569 (typically a C structure). On encoding, it returns 1 if
8570 <literal>* p</literal> is a null pointer. The <literal>size</literal>
8571 parameter is ignored. On decoding, it returns 1 if the type is found in
8572 the data stream. <literal>size</literal> bytes of memory are allocated,
8573 and <literal>*p</literal> is set to point to this space.
8574 <function>odr_sequence_end()</function> is called at the end of the
8575 complex function. Assume that a type is defined like this:
8578 MySequence ::= SEQUENCE {
8580 boolval BOOLEAN OPTIONAL
8584 The corresponding &odr; encoder/decoder function and the associated data
8585 structures could be written like this:
8588 typedef struct MySequence
8594 int mySequence(ODR o, MySequence **p, int optional, const char *name)
8596 if (odr_sequence_begin(o, p, sizeof(**p), name) == 0)
8597 return optional && odr_ok(o);
8599 odr_integer(o, &(*p)->intval, 0, "intval") &&
8600 odr_bool(o, &(*p)->boolval, 1, "boolval") &&
8601 odr_sequence_end(o);
8605 Note the 1 in the call to <function>odr_bool()</function>, to mark
8606 that the sequence member is optional.
8607 If either of the member types had been tagged, the macros
8608 <function>odr_implicit_tag()</function> or
8609 <function>odr_explicit_tag()</function>
8610 could have been used.
8611 The new function can be used exactly like the standard functions provided
8612 with &odr;. It will encode, decode or pretty-print a data value of the
8613 <literal>MySequence</literal> type. We like to name types with an
8614 initial capital, as done in ASN.1 definitions, and to name the
8615 corresponding function with the first character of the name in lower case.
8616 You could, of course, name your structures, types, and functions any way
8617 you please - as long as you're consistent, and your code is easily readable.
8618 <literal>odr_ok</literal> is just that - a predicate that returns the
8619 state of the stream. It is used to ensure that the behavior of the new
8620 type is compatible with the interface of the primitive types.
8623 <sect2 id="odr.tagging.constructed.types">
8624 <title>Tagging Constructed Types</title>
8627 See <xref linkend="odr.tagging.primitive.types"/> for information
8628 on how to tag the primitive types, as well as types that are
8632 <sect3 id="odr.implicit.tagging">
8633 <title>Implicit Tagging</title>
8635 Assume the type above had been defined as
8638 MySequence ::= [10] IMPLICIT SEQUENCE {
8640 boolval BOOLEAN OPTIONAL
8644 You would implement this in &odr; by calling the function
8647 int odr_implicit_settag(ODR o, int class, int tag);
8650 which overrides the tag of the type immediately following it. The
8651 macro <function>odr_implicit_tag()</function> works by calling
8652 <function>odr_implicit_settag()</function> immediately
8653 before calling the function pointer argument.
8654 Your type function could look like this:
8657 int mySequence(ODR o, MySequence **p, int optional, const char *name)
8659 if (odr_implicit_settag(o, ODR_CONTEXT, 10) == 0 ||
8660 odr_sequence_begin(o, p, sizeof(**p), name) == 0)
8661 return optional && odr_ok(o);
8663 odr_integer(o, &(*p)->intval, 0, "intval") &&
8664 odr_bool(o, &(*p)->boolval, 1, "boolval") &&
8665 odr_sequence_end(o);
8669 The definition of the structure <literal>MySequence</literal> would be
8673 <sect3 id="odr.explicit.tagging">
8674 <title>Explicit Tagging</title>
8676 Explicit tagging of constructed types is a little more complicated,
8677 since you are in effect adding a level of construction to the data.
8680 Assume the definition:
8683 MySequence ::= [10] IMPLICIT SEQUENCE {
8685 boolval BOOLEAN OPTIONAL
8689 Since the new type has an extra level of construction, two new functions
8690 are needed to encapsulate the base type:
8693 int odr_constructed_begin(ODR o, void *p, int class, int tag,
8696 int odr_constructed_end(ODR o);
8699 Assume that the IMPLICIT in the type definition above were replaced
8700 with EXPLICIT (or that the IMPLICIT keyword were simply deleted, which
8701 would be equivalent). The structure definition would look the same,
8702 but the function would look like this:
8705 int mySequence(ODR o, MySequence **p, int optional, const char *name)
8707 if (odr_constructed_begin(o, p, ODR_CONTEXT, 10, name) == 0)
8708 return optional && odr_ok(o);
8709 if (o->direction == ODR_DECODE)
8710 *p = odr_malloc(o, sizeof(**p));
8711 if (odr_sequence_begin(o, p, sizeof(**p), 0) == 0)
8713 *p = 0; /* this is almost certainly a protocol error */
8717 odr_integer(o, &(*p)->intval, 0, "intval") &&
8718 odr_bool(o, &(*p)->boolval, 1, "boolval") &&
8719 odr_sequence_end(o) &&
8720 odr_constructed_end(o);
8724 Notice that the interface here gets kind of nasty. The reason is
8725 simple: Explicitly tagged, constructed types are fairly rare in
8726 the protocols that we care about, so the
8727 esthetic annoyance (not to mention the dangers of a cluttered
8728 interface) is less than the time that would be required to develop a
8729 better interface. Nevertheless, it is far from satisfying, and it's a
8730 point that will be worked on in the future. One option for you would
8731 be to simply apply the <function>odr_explicit_tag()</function> macro to
8732 the first function, and not
8733 have to worry about <function>odr_constructed_*</function> yourself.
8734 Incidentally, as you might have guessed, the
8735 <function>odr_sequence_</function> functions are themselves
8736 implemented using the <function>/odr_constructed_</function> functions.
8740 <sect2 id="odr.sequence.of">
8741 <title>SEQUENCE OF</title>
8743 To handle sequences (arrays) of a specific type, the function
8746 int odr_sequence_of(ODR o, int (*fun)(ODR o, void *p, int optional),
8747 void *p, int *num, const char *name);
8750 The <literal>fun</literal> parameter is a pointer to the decoder/encoder
8751 function of the type. <literal>p</literal> is a pointer to an array of
8752 pointers to your type. <literal>num</literal> is the number of elements
8759 MyArray ::= SEQUENCE OF INTEGER
8762 The C representation might be
8765 typedef struct MyArray
8772 And the function might look like
8775 int myArray(ODR o, MyArray **p, int optional, const char *name)
8777 if (o->direction == ODR_DECODE)
8778 *p = odr_malloc(o, sizeof(**p));
8779 if (odr_sequence_of(o, odr_integer, &(*p)->elements,
8780 &(*p)->num_elements, name))
8783 return optional && odr_ok(o);
8787 <sect2 id="odr.choice.types">
8788 <title>CHOICE Types</title>
8790 The choice type is used fairly often in some ASN.1 definitions, so
8791 some work has gone into streamlining its interface.
8794 CHOICE types are handled by the function:
8797 int odr_choice(ODR o, Odr_arm arm[], void *p, void *whichp,
8801 The <literal>arm</literal> array is used to describe each of the possible
8802 types that the CHOICE type may assume. Internally in your application,
8803 the CHOICE type is represented as a discriminated union. That is, a
8804 C union accompanied by an integer (or enum) identifying the active
8806 <literal>whichp</literal> is a pointer to the union discriminator.
8807 When encoding, it is examined to determine the current type.
8808 When decoding, it is set to reference the type that was found in
8812 The Odr_arm type is defined thus:
8815 typedef struct odr_arm
8826 The interpretation of the fields are:
8830 <term>tagmode</term>
8831 <listitem><para>Either <literal>ODR_IMPLICIT</literal>,
8832 <literal>ODR_EXPLICIT</literal>, or <literal>ODR_NONE</literal> (-1)
8833 to mark no tagging.</para></listitem>
8837 <listitem><para>The value of the discriminator that corresponds to
8838 this CHOICE element. Typically, it will be a #defined constant, or
8839 an enum member.</para></listitem>
8843 <listitem><para>A pointer to a function that implements the type of
8844 the CHOICE member. It may be either a standard &odr; type or a type
8845 defined by yourself.</para></listitem>
8849 <listitem><para>Name of tag.</para></listitem>
8853 A handy way to prepare the array for use by the
8854 <function>odr_choice()</function> function is to
8855 define it as a static, initialized array in the beginning of your
8856 decoding/encoding function. Assume the type definition:
8859 MyChoice ::= CHOICE {
8861 tagged [99] IMPLICIT INTEGER,
8866 Your C type might look like
8869 typedef struct MyChoice
8886 And your function could look like this:
8889 int myChoice(ODR o, MyChoice **p, int optional, const char *name)
8891 static Odr_arm arm[] =
8893 {-1, -1, -1, MyChoice_untagged, odr_integer, "untagged"},
8894 {ODR_IMPLICIT, ODR_CONTEXT, 99, MyChoice_tagged, odr_integer,
8896 {-1, -1, -1, MyChoice_other, odr_boolean, "other"},
8900 if (o->direction == ODR_DECODE)
8901 *p = odr_malloc(o, sizeof(**p);
8903 return optional && odr_ok(o);
8905 if (odr_choice(o, arm, &(*p)->u, &(*p)->which), name)
8908 return optional && odr_ok(o);
8912 In some cases (say, a non-optional choice which is a member of a
8913 sequence), you can "embed" the union and its discriminator in the
8914 structure belonging to the enclosing type, and you won't need to
8915 fiddle with memory allocation to create a separate structure to
8916 wrap the discriminator and union.
8919 The corresponding function is somewhat nicer in the Sun XDR interface.
8920 Most of the complexity of this interface comes from the possibility of
8921 declaring sequence elements (including CHOICEs) optional.
8924 The ASN.1 specifications naturally requires that each member of a
8925 CHOICE have a distinct tag, so they can be told apart on decoding.
8926 Sometimes it can be useful to define a CHOICE that has multiple types
8927 that share the same tag. You'll need some other mechanism, perhaps
8928 keyed to the context of the CHOICE type. In effect, we would like to
8929 introduce a level of context-sensitiveness to our ASN.1 specification.
8930 When encoding an internal representation, we have no problem, as long
8931 as each CHOICE member has a distinct discriminator value. For
8932 decoding, we need a way to tell the choice function to look for a
8933 specific arm of the table. The function
8936 void odr_choice_bias(ODR o, int what);
8939 provides this functionality. When called, it leaves a notice for the next
8940 call to <function>odr_choice()</function> to be called on the decoding
8941 stream <literal>o</literal> that only the <literal>arm</literal> entry with
8942 a <literal>which</literal> field equal to <literal>what</literal>
8946 The most important application (perhaps the only one, really) is in
8947 the definition of application-specific EXTERNAL encoders/decoders
8948 which will automatically decode an ANY member given the direct or
8953 <sect1 id="odr.debugging">
8954 <title>Debugging</title>
8956 The protocol modules are suffering somewhat from a lack of diagnostic
8957 tools at the moment. Specifically ways to pretty-print PDUs that
8958 aren't recognized by the system. We'll include something to this end
8959 in a not-too-distant release. In the meantime, what we do when we get
8960 packages we don't understand is to compile the ODR module with
8961 <literal>ODR_DEBUG</literal> defined. This causes the module to dump tracing
8962 information as it processes data units. With this output and the
8963 protocol specification (Z39.50), it is generally fairly easy to see
8968 <chapter id="comstack">
8969 <title>The COMSTACK Module</title>
8970 <sect1 id="comstack.synopsis">
8971 <title>Synopsis (blocking mode)</title>
8972 <programlisting><![CDATA[
8975 int size = 0, length_incoming;
8976 char server_address_str[] = "localhost:9999";
8977 void *server_address_ip;
8980 char *protocol_package = "GET / HTTP/1.0\r\n\r\n";
8981 int protocol_package_length = strlen(protocol_package);
8983 stack = cs_create(tcpip_type, 1, PROTO_HTTP);
8985 perror("cs_create"); /* use perror() here since we have no stack yet */
8989 server_address_ip = cs_straddr(stack, server_address_str);
8990 if (!server_address_ip) {
8991 fprintf(stderr, "cs_straddr: address could not be resolved\n");
8995 status = cs_connect(stack, server_address_ip);
8997 fprintf(stderr, "cs_connect: %s\n", cs_strerror(stack));
9001 status = cs_rcvconnect(stack);
9003 fprintf(stderr, "cs_rcvconnect: %s\n", cs_strerror(stack));
9007 status = cs_put(stack, protocol_package, protocol_package_length);
9009 fprintf(stderr, "cs_put: %s\n", cs_strerror(stack));
9013 /* Now get a response */
9014 length_incoming = cs_get(stack, &buf, &size);
9015 if (!length_incoming) {
9016 fprintf(stderr, "Connection closed\n");
9018 } else if (length_incoming < 0) {
9019 fprintf(stderr, "cs_get: %s\n", cs_strerror(stack));
9024 fwrite(buf, length_incoming, 1, stdout);
9035 <sect1 id="comstack.introduction">
9036 <title>Introduction</title>
9039 subsystem provides a transparent interface to different types of transport
9040 stacks for the exchange of BER-encoded data and HTTP packets.
9041 At present, the RFC1729 method (BER over TCP/IP), local UNIX socket and an
9042 experimental SSL stack are supported, but others may be added in time.
9043 The philosophy of the
9044 module is to provide a simple interface by hiding unused options and
9045 facilities of the underlying libraries. This is always done at the risk
9046 of losing generality, and it may prove that the interface will need
9051 There hasn't been interest in the XTImOSI stack for some years.
9052 Therefore, it is no longer supported.
9056 The interface is implemented in such a fashion that only the
9057 sub-layers constructed to the transport methods that you wish to
9058 use in your application are linked in.
9061 You will note that even though simplicity was a goal in the design,
9062 the interface is still orders of magnitudes more complex than the
9063 transport systems found in many other packages. One reason is that
9064 the interface needs to support the somewhat different requirements of
9065 the different lower-layer communications stacks; another important
9066 reason is that the interface seeks to provide a more or less
9067 industrial-strength approach to asynchronous event-handling.
9068 When no function is allowed to block, things get more complex -
9069 particularly on the server side.
9070 We urge you to have a look at the demonstration client and server
9071 provided with the package. They are meant to be easily readable and
9072 instructive, while still being at least moderately useful.
9075 <sect1 id="comstack.common">
9076 <title>Common Functions</title>
9077 <sect2 id="comstack.managing.endpoints">
9078 <title>Managing Endpoints</title>
9080 COMSTACK cs_create(CS_TYPE type, int blocking, int protocol);
9083 Creates an instance of the protocol stack - a communications endpoint.
9084 The <literal>type</literal> parameter determines the mode
9085 of communication. At present the following values are supported:
9089 <term><literal>tcpip_type</literal></term>
9090 <listitem><para>TCP/IP (BER over TCP/IP or HTTP over TCP/IP)
9094 <term><literal>ssl_type</literal></term>
9095 <listitem><para>Secure Socket Layer (SSL). This COMSTACK
9096 is experimental and is not fully implemented. If
9097 HTTP is used, this effectively is HTTPS.
9101 <term><literal>unix_type</literal></term>
9102 <listitem><para>Unix socket (unix only). Local Transfer via
9103 file socket. See <citerefentry><refentrytitle>unix</refentrytitle>
9104 <manvolnum>7</manvolnum></citerefentry>.
9109 The <function>cs_create</function> function returns a null-pointer
9110 if a system error occurs.
9111 The <literal>blocking</literal> parameter should be one if
9112 you wish the association to operate in blocking mode, zero otherwise.
9113 The <literal>protocol</literal> field should be
9114 <literal>PROTO_Z3950</literal> or <literal>PROTO_HTTP</literal>.
9115 Protocol <literal>PROTO_SR</literal> is no longer supported.
9118 void cs_close(COMSTACK handle);
9121 Closes the connection (as elegantly as the lower layers will permit),
9122 and releases the resources pointed to by the
9123 <literal>handle</literal>
9125 <literal>handle</literal>
9126 should not be referenced again after this call.
9130 We really need a soft disconnect, don't we?
9134 <sect2 id="comstack.data.exchange">
9135 <title>Data Exchange</title>
9137 int cs_put(COMSTACK handle, char *buf, int len);
9140 Sends <literal>buf</literal> down the wire.
9141 In blocking mode, this function will return only when a full buffer has
9142 been written, or an error has occurred. In nonblocking mode, it's
9143 possible that the function will be unable to send the full buffer
9144 at once, which will be indicated by a return value of 1.
9145 The function will keep track of the number of octets already written; you
9146 should call it repeatedly with the same values of <literal>buf</literal>
9147 and <literal>len</literal>, until the buffer has been transmitted.
9148 When a full buffer has been sent, the function will return 0 for
9149 success. -1 indicates an error condition (see below).
9152 int cs_get(COMSTACK handle, char **buf, int *size);
9155 Receives a PDU or HTTP Response from the peer. Returns the number of
9157 In nonblocking mode, it is possible that not all of the packet can be
9158 read at once. In this case, the function returns 1. To simplify the
9159 interface, the function is
9160 responsible for managing the size of the buffer. It will be reallocated
9161 if necessary to contain large packages, and will sometimes be moved
9162 around internally by the subsystem when partial packages are read. Before
9164 <function>cs_get</function>
9165 for the fist time, the buffer can be initialized to the null pointer,
9166 and the length should also be set to 0 - cs_get will perform a
9167 <function>malloc(2)</function>
9168 on the buffer for you. When a full buffer has been read, the size of
9169 the package is returned (which will always be greater than 1). -1
9170 indicates an error condition.
9173 See also the <function>cs_more()</function> function below.
9176 int cs_more(COMSTACK handle);
9179 The <function>cs_more()</function> function should be used in conjunction
9180 with <function>cs_get</function> and
9181 <function>select(2)</function>.
9182 The <function>cs_get()</function> function will sometimes
9183 (notably in the TCP/IP mode) read more than a single protocol package
9184 off the network. When this happens, the extra package is stored
9185 by the subsystem. After calling <function>cs_get()</function>, and before
9186 waiting for more input, You should always call
9187 <function>cs_more()</function>
9188 to check if there's a full protocol package already read. If
9189 <function>cs_more()</function>
9191 <function>cs_get()</function>
9192 can be used to immediately fetch the new package. For the
9194 subsystem, the function should always return 0, but if you want your
9195 stuff to be protocol independent, you should use it.
9199 The <function>cs_more()</function>
9200 function is required because the RFC1729-method
9201 does not provide a way of separating individual PDUs, short of
9202 partially decoding the BER. Some other implementations will carefully
9203 nibble at the packet by calling
9204 <function>read(2)</function>
9205 several times. This was felt to be too inefficient (or at least
9206 clumsy) - hence the call for this extra function.
9210 int cs_look(COMSTACK handle);
9213 This function is useful when you're operating in nonblocking
9215 <function>select(2)</function>
9216 tells you there's something happening on the line. It returns one of
9217 the following values:
9221 <term>CS_NONE</term>
9223 No event is pending. The data found on the line was not a
9228 <term>CS_CONNECT</term>
9230 A response to your connect request has been received. Call
9231 <function>cs_rcvconnect</function>
9232 to process the event and to finalize the connection establishment.
9236 <term>CS_DISCON</term>
9238 The other side has closed the connection (or maybe sent a disconnect
9239 request - but do we care? Maybe later). Call
9240 <function>cs_close</function> to close your end of the association
9245 <term>CS_LISTEN</term>
9247 A connect request has been received.
9248 Call <function>cs_listen</function> to process the event.
9252 <term>CS_DATA</term>
9254 There's data to be found on the line.
9255 Call <function>cs_get</function> to get it.
9261 You should be aware that even if
9262 <function>cs_look()</function>
9263 tells you that there's an event event pending, the corresponding
9264 function may still return and tell you there was nothing to be found.
9265 This means that only part of a package was available for reading. The
9266 same event will show up again, when more data has arrived.
9270 int cs_fileno(COMSTACK h);
9273 Returns the file descriptor of the association. Use this when
9274 file-level operations on the endpoint are required
9275 (<function>select(2)</function> operations, specifically).
9279 <sect1 id="comstack.client">
9280 <title>Client Side</title>
9282 int cs_connect(COMSTACK handle, void *address);
9285 Initiate a connection with the target at <literal>address</literal>
9286 (more on addresses below). The function will return 0 on success, and 1 if
9287 the operation does not complete immediately (this will only
9288 happen on a nonblocking endpoint). In this case, use
9289 <function>cs_rcvconnect</function> to complete the operation,
9290 when <function>select(2)</function> or <function>poll(2)</function>
9291 reports input pending on the association.
9294 int cs_rcvconnect(COMSTACK handle);
9297 Complete a connect operation initiated by <function>cs_connect()</function>.
9298 It will return 0 on success; 1 if the operation has not yet completed (in
9299 this case, call the function again later); -1 if an error has occurred.
9302 <sect1 id="comstack.server">
9303 <title>Server Side</title>
9305 To establish a server under the <application>inetd</application>
9309 COMSTACK cs_createbysocket(int socket, CS_TYPE type, int blocking,
9313 The <literal>socket</literal> parameter is an established socket (when
9314 your application is invoked from <application>inetd</application>, the
9315 socket will typically be 0.
9316 The following parameters are identical to the ones for
9317 <function>cs_create</function>.
9320 int cs_bind(COMSTACK handle, void *address, int mode)
9323 Binds a local address to the endpoint. Read about addresses below. The
9324 <literal>mode</literal> parameter should be either
9325 <literal>CS_CLIENT</literal> or <literal>CS_SERVER</literal>.
9328 int cs_listen(COMSTACK handle, char *addr, int *addrlen);
9331 Call this to process incoming events on an endpoint that has been
9332 bound in listening mode. It will return 0 to indicate that the connect
9333 request has been received, 1 to signal a partial reception, and -1 to
9334 indicate an error condition.
9337 COMSTACK cs_accept(COMSTACK handle);
9340 This finalizes the server-side association establishment, after
9341 cs_listen has completed successfully. It returns a new connection
9342 endpoint, which represents the new association. The application will
9343 typically wish to fork off a process to handle the association at this
9344 point, and continue listen for new connections on the old
9345 <literal>handle</literal>.
9348 You can use the call
9351 const char *cs_addrstr(COMSTACK);
9354 on an established connection to retrieve the host-name of the remote host.
9358 You may need to use this function with some care if your
9359 name server service is slow or unreliable
9363 <sect1 id="comstack.addresses">
9364 <title>Addresses</title>
9366 The low-level format of the addresses are different depending on the
9367 mode of communication you have chosen. A function is provided by each
9368 of the lower layers to map a user-friendly string-form address to the
9369 binary form required by the lower layers.
9372 void *cs_straddr(COMSTACK handle, const char *str);
9375 The format for TCP/IP and SSL addresses is:
9378 <host> [ ':' <portnum> ]
9381 The <literal>hostname</literal> can be either a domain name or an
9382 IP address. The port number, if omitted, defaults to 210.
9385 For TCP/IP and SSL, the special hostnames <literal>@</literal>,
9386 maps to <literal>IN6ADDR_ANY_INIT</literal> with
9387 IPV4 binding as well (bindv6only=0),
9388 The special hostname <literal>@4</literal> binds to
9389 <literal>INADDR_ANY</literal> (IPV4 only listener).
9390 The special hostname <literal>@6</literal> binds to
9391 <literal>IN6ADDR_ANY_INIT</literal> with bindv6only=1 (IPV6 only listener).
9394 For UNIX sockets, the format of an address is the socket filename.
9397 When a connection has been established, you can use
9400 const char *cs_addrstr(COMSTACK h);
9403 to retrieve the host name of the peer system. The function returns
9404 a pointer to a static area, which is overwritten on the next call
9408 A fairly recent addition to the &comstack; module is the utility
9412 COMSTACK cs_create_host (const char *str, int blocking, void **vp);
9415 which is just a wrapper for <function>cs_create</function> and
9416 <function>cs_straddr</function>. The <parameter>str</parameter>
9417 is similar to that described for <function>cs_straddr</function>
9418 but with a prefix denoting the &comstack; type. Prefixes supported
9419 are <literal>tcp:</literal>, <literal>unix:</literal> and
9420 <literal>ssl:</literal> for TCP/IP, UNIX and SSL respectively.
9421 If no prefix is given, then TCP/IP is used.
9422 The <parameter>blocking</parameter> is passed to
9423 function <function>cs_create</function>. The third parameter
9424 <parameter>vp</parameter> is a pointer to &comstack; stack type
9426 Parameter <parameter>vp</parameter> is reserved for future use.
9427 Set it to <literal>NULL</literal>.
9430 <sect1 id="comstack.ssl">
9434 void *cs_get_ssl(COMSTACK cs);
9436 Returns the SSL handle, <literal>SSL *</literal> for comstack. If comstack
9437 is not of type SSL, NULL is returned.
9441 int cs_set_ssl_ctx(COMSTACK cs, void *ctx);
9443 Sets SSL context for comstack. The parameter is expected to be of type
9444 <literal>SSL_CTX *</literal>. This function should be called just
9445 after comstack has been created (before connect, bind, etc).
9446 This function returns 1 for success; 0 for failure.
9450 int cs_set_ssl_certificate_file(COMSTACK cs, const char *fname);
9452 Sets SSL certificate for comstack as a PEM file. This function
9453 returns 1 for success; 0 for failure.
9457 int cs_get_ssl_peer_certificate_x509(COMSTACK cs, char **buf, int *len);
9459 This function returns the peer certificate. If successful,
9460 <literal>*buf</literal> and <literal>*len</literal> holds
9461 X509 buffer and length respectively. Buffer should be freed
9462 with <literal>xfree</literal>. This function returns 1 for success;
9466 <sect1 id="comstack.diagnostics">
9467 <title>Diagnostics</title>
9469 All functions return -1 if an error occurs. Typically, the functions
9470 will return 0 on success, but the data exchange functions
9471 (<function>cs_get</function>, <function>cs_put</function>,
9472 <function>cs_more</function>) follow special rules. Consult their
9476 The error code for the COMSTACK can be retrieved using C macro
9477 <function>cs_errno</function> which will return one
9478 of the error codes <literal>CSYSERR</literal>,
9479 <literal>CSOUTSTATE</literal>,
9480 <literal>CSNODATA</literal>, ...
9483 int cs_errno(COMSTACK handle);
9486 You can the textual representation of the error code
9487 by using <function>cs_errmsg</function> - which
9488 works like <function>strerror(3)</function>
9491 const char *cs_errmsg(int n);
9494 It is also possible to get straight to the textual represenataion
9495 without the error code by using
9496 <function>cs_strerror</function>.
9499 const char *cs_strerror(COMSTACK h);
9502 <sect1 id="comstack.summary">
9503 <title>Summary and Synopsis</title>
9505 #include <yaz/comstack.h>
9507 #include <yaz/tcpip.h> /* this is for TCP/IP and SSL support */
9508 #include <yaz/unix.h> /* this is for UNIX socket support */
9510 COMSTACK cs_create(CS_TYPE type, int blocking, int protocol);
9512 COMSTACK cs_createbysocket(int s, CS_TYPE type, int blocking,
9514 COMSTACK cs_create_host(const char *str, int blocking,
9517 int cs_bind(COMSTACK handle, int mode);
9519 int cs_connect(COMSTACK handle, void *address);
9521 int cs_rcvconnect(COMSTACK handle);
9523 int cs_listen(COMSTACK handle);
9525 COMSTACK cs_accept(COMSTACK handle);
9527 int cs_put(COMSTACK handle, char *buf, int len);
9529 int cs_get(COMSTACK handle, char **buf, int *size);
9531 int cs_more(COMSTACK handle);
9533 void cs_close(COMSTACK handle);
9535 int cs_look(COMSTACK handle);
9537 void *cs_straddr(COMSTACK handle, const char *str);
9539 const char *cs_addrstr(COMSTACK h);
9544 <chapter id="future">
9545 <title>Future Directions</title>
9547 We have a new and better version of the front-end server on the drawing
9548 board. Resources and external commitments will govern when we'll be
9549 able to do something real with it. Features should include greater
9550 flexibility, greater support for access/resource control, and easy
9551 support for Explain (possibly with Zebra as an extra database engine).
9554 &yaz; is a BER toolkit and as such should support all protocols
9555 out there based on that. We'd like to see running ILL applications.
9556 It shouldn't be that hard. Another thing that would be interesting is
9557 LDAP. Maybe a generic framework for doing IR using both LDAP and
9558 Z39.50 transparently.
9561 The SOAP implementation is incomplete. In the future we hope
9562 to add more features to it. Perhaps make a WSDL/XML Schema compiler.
9563 The authors of libxml2 are already working on XML Schema / RelaxNG
9564 compilers so this may not be too hard.
9567 It would be neat to have a proper module mechanism for the Generic
9568 Frontend Server so that backend would be dynamically
9569 loaded (as shared objects / DLLs).
9572 Other than that, &yaz; generally moves in the directions which appear to
9573 make the most people happy (including ourselves, as prime users of the
9574 software). If there's something you'd like to see in here, then drop
9575 us a note and let's see what we can come up with.
9578 <reference id="reference">
9579 <title>Reference</title>
9580 <partintro id="reference-introduction">
9582 The material in this chapter is drawn directly from the individual
9588 <appendix id="list-oids">
9589 <title>List of Object Identifiers</title>
9591 These is a list of object identifiers that are built into YAZ.
9595 <appendix id="bib1-diagnostics">
9596 <title>Bib-1 diagnostics</title>
9598 List of Bib-1 diagnostics that are known to YAZ.
9602 <appendix id="sru-diagnostics">
9603 <title>SRU diagnostics</title>
9605 List of SRU diagnostics that are known to YAZ.
9609 <appendix id="license">
9610 <title>License</title>
9611 <sect1 id="license.indexdata">
9612 <title>Index Data Copyright</title>
9614 Copyright © ©right-year; Index Data.
9617 All rights reserved.
9620 Redistribution and use in source and binary forms, with or without
9621 modification, are permitted provided that the following conditions are met:
9626 Redistributions of source code must retain the above copyright
9627 notice, this list of conditions and the following disclaimer.
9632 Redistributions in binary form must reproduce the above copyright
9633 notice, this list of conditions and the following disclaimer in the
9634 documentation and/or other materials provided with the distribution.
9639 Neither the name of Index Data nor the names of its contributors
9640 may be used to endorse or promote products derived from this
9641 software without specific prior written permission.
9646 THIS SOFTWARE IS PROVIDED BY INDEX DATA ``AS IS'' AND ANY
9647 EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
9648 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
9649 DISCLAIMED. IN NO EVENT SHALL INDEX DATA BE LIABLE FOR
9650 ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
9651 DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
9652 SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
9653 CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
9654 LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
9655 OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
9660 <appendix id="indexdata">
9661 <title>About Index Data</title>
9663 Index Data is a consulting and software-development enterprise that
9664 specializes in library and information management systems. Our
9665 interests and expertise span a broad range of related fields, and one
9666 of our primary, long-term objectives is the development of a powerful
9667 information management
9668 system with open network interfaces and hyper-media capabilities.
9670 We make this software available free of charge, on a fairly unrestrictive
9671 license; as a service to the networking community, and to further the
9672 development of quality software for open network communication.
9674 We'll be happy to answer questions about the software, and about ourselves
9680 <street>Amagerfælledvej 56</street>
9681 <postcode>2300 Copenhagen S</postcode>
9682 <country>Denmark</country>
9683 Email <email>info@indexdata.dk</email>
9687 The Hacker's Jargon File has the following to say about the
9689 prefix "YA" in the name of a software product.
9693 Yet Another. adj. 1. Of your own work: A
9694 humorous allusion often used in titles to acknowledge that the
9695 topic is not original, though the content is. As in "Yet Another
9696 AI Group" or "Yet Another Simulated Annealing Algorithm".
9698 others' work: Describes something of which there are already far
9703 <appendix id="credits">
9704 <title>Credits</title>
9706 This appendix lists individuals that have contributed in the development
9707 of &yaz;. Some have contributed with code, while others have provided bug
9708 fixes or suggestions. If we're missing somebody, of if you, for
9709 whatever reason, don't like to be listed here, let us know.
9719 Morten Bøgeskov
9740 Mads Bondo Dydensborg
9749 Morten Garkier Hendriksen
9806 Tom André Øverland
9812 <!-- Keep this comment at the end of the file
9815 nxml-child-indent: 1