doc/zoom.xml

   1 <!--
   2 ### Still to document:
   3 ZOOM_connection_errcode(c)
   4 ZOOM_connection_errmsg(c)
   5 ZOOM_connection_addinfo(c)
   6 ZOOM_connection_addinfo(c)
   7 ZOOM_connection_diagset(c);
   8 ZOOM_diag_str(error)
   9 ZOOM_resultset_record_immediate(s, pos)
  10 ZOOM_resultset_cache_reset(r)
  11 ZOOM_resultset_sort(r, sort_type, sort_spec)
  12 ZOOM_resultset_sort1(r, sort_type, sort_spec)
  13 ZOOM_options_set_callback(opt, function, handle)
  14 ZOOM_options_create_with_parent2(parent1, parent2)
  15 ZOOM_options_getl(opt, name, len)
  16 ZOOM_options_setl(opt, name, value, len)
  17 ZOOM_options_get_bool(opt, name, defa)
  18 ZOOM_options_get_int(opt, name, defa)
  19 ZOOM_options_set_int(opt, name, value)
  20 ZOOM_connection_scan1 (ZOOM_connection c, ZOOM_query startterm)
  21 ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn)
  22 -->
  23  <chapter id="zoom"><title>ZOOM</title>
  24   <para>
  25     &zoom; is an acronym for 'Z39.50 Object-Orientation Model' and is
  26    an initiative started by Mike Taylor (Mike is from the UK, which
  27    explains the peculiar name of the model). The goal of &zoom; is to
  28    provide a common Z39.50 client API not bound to a particular
  29    programming language or toolkit.
  30   </para>
  31
  32   <note>
  33    <para>
  34     A recent addition to &yaz; is SRU support. You can now make
  35     SRU ZOOM connections by specifying scheme <literal>http://</literal>
  36     for the hostname for a connection.  The dialect of SRU used is
  37     specified by the value of the connection's <literal>sru</literal>
  38     option, which may be SRU over HTTP GET (<literal>get</literal>),
  39     SRU over HTTP POST (<literal>post</literal>) or SRW (SRU over
  40     SOAP) (<literal>soap</literal>).  Using the facility for embedding
  41     options in target strings, a connection can be forced to use SRU
  42     rather the SRW (the default) by prefixing the target string with
  43     <literal>sru=get,</literal>, like this:
  44     <literal>sru=get,http://sru.miketaylor.org.uk:80/sru.pl</literal>
  45    </para>
  46   </note>
  47
  48   <para>
  49    The lack of a simple Z39.50 client API for &yaz; has become more
  50    and more apparent over time. So when the first &zoom; specification
  51    became available,
  52    an implementation for &yaz; was quickly developed. For the first time, it is
  53    now as easy (or easier!) to develop clients than servers with &yaz;. This
  54    chapter describes the &zoom; C binding. Before going further, please
  55    reconsider whether C is the right programming language for the job.
  56    There are other language bindings available for &yaz;, and still
  57    more
  58    are in active development. See the
  59    <ulink url="&url.zoom;">ZOOM web-site</ulink> for
  60    more information.
  61   </para>
  62
  63   <para>
  64    In order to fully understand this chapter you should read and
  65    try the example programs <literal>zoomtst1.c</literal>,
  66    <literal>zoomtst2.c</literal>, .. in the <literal>zoom</literal>
  67    directory.
  68   </para>
  69
  70   <para>
  71    The C language misses features found in object oriented languages
  72    such as C++, Java, etc. For example, you'll have to manually,
  73    destroy all objects you create, even though you may think of them as
  74    temporary. Most objects has a <literal>_create</literal> - and a
  75    <literal>_destroy</literal> variant.
  76    All objects are in fact pointers to internal stuff, but you don't see
  77    that because of typedefs. All destroy methods should gracefully ignore a
  78    <literal>NULL</literal> pointer.
  79   </para>
  80   <para>
  81    In each of the sections below you'll find a sub section called
  82    protocol behavior, that describes how the API maps to the Z39.50
  83    protocol.
  84   </para>
  85   <sect1 id="zoom-connections"><title>Connections</title>
  86
  87    <para>The Connection object is a session with a target.
  88    </para>
  89    <synopsis>
  90     #include &lt;yaz/zoom.h>
  91
  92     ZOOM_connection ZOOM_connection_new (const char *host, int portnum);
  93
  94     ZOOM_connection ZOOM_connection_create (ZOOM_options options);
  95
  96     void ZOOM_connection_connect(ZOOM_connection c, const char *host,
  97                                  int portnum);
  98     void ZOOM_connection_destroy (ZOOM_connection c);
  99    </synopsis>
 100    <para>
 101     Connection objects are created with either function
 102     <function>ZOOM_connection_new</function> or
 103     <function>ZOOM_connection_create</function>.
 104     The former creates and automatically attempts to establish a network
 105     connection with the target. The latter doesn't establish
 106     a connection immediately, thus allowing you to specify options
 107     before establishing network connection using the function
 108     <function>ZOOM_connection_connect</function>.
 109     If the port number, <literal>portnum</literal>, is zero, the
 110     <literal>host</literal> is consulted for a port specification.
 111     If no port is given, 210 is used. A colon denotes the beginning of
 112     a port number in the host string. If the host string includes a
 113     slash, the following part specifies a database for the connection.
 114    </para>
 115    <para>
 116     You can prefix the host with a scheme followed by colon. The
 117     default scheme is <literal>tcp</literal> (Z39.50 protocol).
 118     The scheme <literal>http</literal> selects SRU over HTTP.
 119    </para>
 120    <para>
 121     You can prefix the scheme-qualified host-string with one or more
 122     comma-separated
 123     <literal><parameter>key</parameter>=<parameter>value</parameter></literal>
 124     sequences, each of which represents an option to be set into the
 125     connection structure <emphasis>before</emphasis> the
 126     protocol-level connection is forged and the initialization
 127     handshake takes place.  This facility can be used to provide
 128     authentication credentials, as in host-strings such as:
 129     <literal>user=admin,password=halfAm4n,tcp:localhost:8017/db</literal>
 130    </para>
 131    <para>
 132     Connection objects should be destroyed using the function
 133     <function>ZOOM_connection_destroy</function>.
 134    </para>
 135    <synopsis>
 136     void ZOOM_connection_option_set(ZOOM_connection c,
 137                                     const char *key, const char *val);
 138
 139     void ZOOM_connection_option_setl(ZOOM_connection c,
 140                                      const char *key,
 141                                      const char *val, int len);
 142
 143     const char *ZOOM_connection_option_get(ZOOM_connection c,
 144                                            const char *key);
 145     const char *ZOOM_connection_option_getl(ZOOM_connection c,
 146                                             const char *key,
 147                                             int *lenp);
 148    </synopsis>
 149    <para>
 150     The functions <function>ZOOM_connection_option_set</function> and
 151     <function>ZOOM_connection_option_setl</function> allows you to
 152     set an option given by <parameter>key</parameter> to the value
 153     <parameter>value</parameter> for the connection.
 154     For <function>ZOOM_connection_option_set</function>, the
 155     value is assumed to be a 0-terminated string. Function
 156     <function>ZOOM_connection_option_setl</function> specifies a
 157     value of a certain size (len).
 158    </para>
 159    <para>
 160     Functions <function>ZOOM_connection_option_get</function> and
 161     <function>ZOOM_connection_option_getl</function> returns
 162     the value for an option given by <parameter>key</parameter>.
 163    </para>
 164    <table id="zoom-connection-options" frame="top">
 165     <title>ZOOM Connection Options</title>
 166     <tgroup cols="3">
 167      <colspec colwidth="4*" colname="name"></colspec>
 168      <colspec colwidth="7*" colname="description"></colspec>
 169      <colspec colwidth="3*" colname="default"></colspec>
 170      <thead>
 171       <row>
 172        <entry>Option</entry>
 173        <entry>Description</entry>
 174        <entry>Default</entry>
 175       </row>
 176      </thead>
 177      <tbody>
 178       <row><entry>
 179         implementationName</entry><entry>Name of Your client
 180        </entry><entry>none</entry></row>
 181       <row><entry>
 182         user</entry><entry>Authentication user name
 183        </entry><entry>none</entry></row>
 184       <row><entry>
 185         group</entry><entry>Authentication group name
 186        </entry><entry>none</entry></row>
 187       <row><entry>
 188         password</entry><entry>Authentication password.
 189        </entry><entry>none</entry></row>
 190       <row><entry>
 191         host</entry><entry>Target host. This setting is "read-only".
 192         It's automatically set internally when connecting to a target.
 193        </entry><entry>none</entry></row>
 194       <row><entry>
 195         proxy</entry><entry>Proxy host
 196        </entry><entry>none</entry></row>
 197       <row><entry>
 198         async</entry><entry>If true (1) the connection operates in
 199         asynchronous operation which means that all calls are non-blocking
 200         except
 201         <link linkend="zoom.events"><function>ZOOM_event</function></link>.
 202        </entry><entry>0</entry></row>
 203       <row><entry>
 204         maximumRecordSize</entry><entry> Maximum size of single record.
 205        </entry><entry>1 MB</entry></row>
 206       <row><entry>
 207         preferredMessageSize</entry><entry> Maximum size of multiple records.
 208        </entry><entry>1 MB</entry></row>
 209       <row><entry>
 210         lang</entry><entry> Language for negotiation.
 211        </entry><entry>none</entry></row>
 212       <row><entry>
 213         charset</entry><entry> Character set for negotiation.
 214        </entry><entry>none</entry></row>
 215       <row><entry>
 216         serverImplementationId</entry><entry>
 217         Implementation ID of server.  (The old targetImplementationId
 218         option is also supported for the benefit of old applications.)
 219        </entry><entry>none</entry></row>
 220       <row><entry>
 221         targetImplementationName</entry><entry>
 222         Implementation Name of server.  (The old
 223         targetImplementationName option is also supported for the
 224         benefit of old applications.)
 225        </entry><entry>none</entry></row>
 226       <row><entry>
 227         serverImplementationVersion</entry><entry>
 228         Implementation Version of server.  (the old
 229         targetImplementationVersion option is also supported for the
 230         benefit of old applications.)
 231        </entry><entry>none</entry></row>
 232       <row><entry>
 233         databaseName</entry><entry>One or more database names
 234         separated by character plus (<literal>+</literal>), which to
 235         be used by subsequent search requests on this Connection.
 236        </entry><entry>Default</entry></row>
 237       <row><entry>
 238         piggyback</entry><entry>True (1) if piggyback should be
 239         used in searches; false (0) if not.
 240        </entry><entry>1</entry></row>
 241       <row><entry>
 242         smallSetUpperBound</entry><entry>If hits is less than or equal to this
 243         value, then target will return all records using small element set name
 244        </entry><entry>0</entry></row>
 245       <row><entry>
 246         largeSetLowerBound</entry><entry>If hits is greater than this
 247         value, the target will return no records.
 248        </entry><entry>1</entry></row>
 249       <row><entry>
 250         mediumSetPresentNumber</entry><entry>This value represents
 251         the number of records to be returned as part of a search when when
 252         hits is less than or equal to large set lower bound and if hits
 253         is greater than small set upper bound.
 254        </entry><entry>0</entry></row>
 255       <row><entry>
 256         smallSetElementSetName</entry><entry>
 257         The element set name to be used for small result sets.
 258        </entry><entry>none</entry></row>
 259       <row><entry>
 260         mediumSetElementSetName</entry><entry>
 261         The element set name to be for medium-sized result sets.
 262        </entry><entry>none</entry></row>
 263       <row><entry>
 264         init_opt_search, init_opt_present, init_opt_delSet, etc.</entry><entry>
 265         After a successful Init, these options may be interrogated to
 266         discover whether the server claims to support the specified
 267         operations.
 268        </entry><entry>none</entry></row>
 269       <row><entry>
 270         sru</entry><entry>
 271         SRU transport type. Must be either <literal>soap</literal>,
 272         <literal>get</literal> or <literal>post</literal>.
 273        </entry><entry>soap</entry></row>
 274       <row><entry>
 275         sru_version</entry><entry>
 276         SRU/SRW version. Should be <literal>1.1</literal>, or
 277         <literal>1.2</literal>. This is , prior to connect, the version
 278         to offer (highest version). And following connect (in fact
 279         first operation), holds the negotiated version with the server
 280         (same or lower version).
 281        </entry><entry>1.2</entry></row>
 282      </tbody>
 283     </tgroup>
 284    </table>
 285    <para>
 286     If either option <literal>lang</literal> or <literal>charset</literal>
 287     is set, then
 288     <ulink url="&url.z39.50.charneg;">
 289      Character Set and Language Negotiation</ulink> is in effect.
 290    </para>
 291    <synopsis>
 292      int ZOOM_connection_error (ZOOM_connection c, const char **cp,
 293                                 const char **addinfo);
 294      int ZOOM_connection_error_x (ZOOM_connection c, const char **cp,
 295                                   const char **addinfo, const char **dset);
 296    </synopsis>
 297    <para>
 298     Function <function>ZOOM_connection_error</function> checks for
 299     errors for the last operation(s) performed. The function returns
 300     zero if no errors occurred; non-zero otherwise indicating the error.
 301     Pointers <parameter>cp</parameter> and <parameter>addinfo</parameter>
 302     holds messages for the error and additional-info if passed as
 303     non-<literal>NULL</literal>. Function
 304     <function>ZOOM_connection_error_x</function> is an extended version
 305     of <function>ZOOM_connection_error</function> that is capable of
 306     returning name of diagnostic set in <parameter>dset</parameter>.
 307    </para>
 308    <sect2 id="zoom-connection-z39.50">
 309     <title>Z39.50 Protocol behavior</title>
 310     <para>
 311      The calls <function>ZOOM_connection_new</function> and
 312      <function>ZOOM_connection_connect</function> establishes a TCP/IP
 313       connection and sends an Initialize Request to the target if
 314       possible. In addition, the calls waits for an Initialize Response
 315       from the target and the result is inspected (OK or rejected).
 316     </para>
 317     <para>
 318      If <literal>proxy</literal> is set then the client will establish
 319      a TCP/IP connection with the peer as specified by the
 320      <literal>proxy</literal> host and the hostname as part of the
 321      connect calls will be set as part of the Initialize Request.
 322      The proxy server will then "forward" the PDU's transparently
 323      to the target behind the proxy.
 324     </para>
 325     <para>
 326      For the authentication parameters, if option <literal>user</literal>
 327      is set and both options <literal>group</literal> and
 328      <literal>pass</literal> are unset, then Open style
 329      authentication is used (Version 2/3) in which case the username
 330      is usually followed by a slash, then by a password.
 331      If either <literal>group</literal>
 332      or <literal>pass</literal> is set then idPass authentication
 333      (Version 3 only) is used. If none of the options are set, no
 334      authentication parameters are set as part of the Initialize Request
 335      (obviously).
 336     </para>
 337     <para>
 338      When option <literal>async</literal> is 1, it really means that
 339      all network operations are postponed (and queued) until the
 340      function <literal>ZOOM_event</literal> is invoked. When doing so
 341      it doesn't make sense to check for errors after
 342      <literal>ZOOM_connection_new</literal> is called since that
 343      operation "connecting - and init" is still incomplete and the
 344      API cannot tell the outcome (yet).
 345     </para>
 346     </sect2>
 347    <sect2 id="zoom.sru.init.behavior">
 348     <title>SRU Protocol behavior</title>
 349     <para>
 350      The SRU protocol doesn't feature an Inititialize Request, so
 351      the connection phase merely establishes a TCP/IP connection
 352      with the SOAP service.
 353     </para>
 354     <para>Most of the ZOOM connection options do not
 355      affect SRU and they are ignored. However, future versions
 356      of &yaz; might honor <literal>implementationName</literal> and
 357      put that as part of User-Agent header for HTTP requests.
 358      </para>
 359     <para>
 360      The <literal>charset</literal> is used in the Content-Type header
 361      of HTTP requests.
 362     </para>
 363    </sect2>
 364   </sect1>
 365   <sect1 id="zoom.query"><title>Queries</title>
 366    <para>
 367     Query objects represents queries.
 368    </para>
 369    <synopsis>
 370      ZOOM_query ZOOM_query_create(void);
 371
 372      void ZOOM_query_destroy(ZOOM_query q);
 373
 374      int ZOOM_query_prefix(ZOOM_query q, const char *str);
 375
 376      int ZOOM_query_cql(ZOOM_query s, const char *str);
 377
 378      int ZOOM_query_sortby(ZOOM_query q, const char *criteria);
 379    </synopsis>
 380    <para>
 381     Create query objects using <function>ZOOM_query_create</function>
 382     and destroy them by calling <function>ZOOM_query_destroy</function>.
 383     RPN-queries can be specified in <link linkend="PQF">PQF</link>
 384     notation by using the
 385     function <function>ZOOM_query_prefix</function>.
 386     The <function>ZOOM_query_cql</function> specifies a CQL
 387     query to be sent to the server/target.
 388     More query types will be added in future versions of &yaz;, such as
 389     <link linkend="CCL">CCL</link> to RPN-mapping, native CCL query,
 390     etc. In addition to a search, a sort criteria may be set. Function
 391     <function>ZOOM_query_sortby</function> specifies a
 392     sort criteria using the same string notation for sort as offered by
 393     the <link linkend="sortspec">YAZ client</link>.
 394    </para>
 395    <sect2 id="zoom.sort.behavior"><title>Protocol behavior</title>
 396     <para>
 397      The query object is just an interface for the member Query
 398      in the SearchRequest. The sortby-function is an interface to the
 399      sortSequence member of the SortRequest.
 400     </para>
 401    </sect2>
 402   </sect1>
 403   <sect1 id="zoom.resultsets"><title>Result sets</title>
 404    <para>
 405     The result set object is a container for records returned from
 406     a target.
 407    </para>
 408    <synopsis>
 409      ZOOM_resultset ZOOM_connection_search(ZOOM_connection,
 410                                            ZOOM_query q);
 411
 412      ZOOM_resultset ZOOM_connection_search_pqf(ZOOM_connection c,
 413                                                const char *q);
 414
 415      void ZOOM_resultset_destroy(ZOOM_resultset r);
 416    </synopsis>
 417    <para>
 418     Function <function>ZOOM_connection_search</function> creates
 419      a result set given a connection and query.
 420     Destroy a result set by calling
 421     <function>ZOOM_resultset_destroy</function>.
 422     Simple clients may using PQF only may use function
 423     <function>ZOOM_connection_search_pqf</function> in which case
 424     creating query objects is not necessary.
 425    </para>
 426    <synopsis>
 427      void ZOOM_resultset_option_set (ZOOM_resultset r,
 428                                       const char *key,
 429                                       const char *val);
 430
 431      const char *ZOOM_resultset_option_get (ZOOM_resultset r,
 432                                              const char *key);
 433
 434      size_t ZOOM_resultset_size (ZOOM_resultset r);
 435    </synopsis>
 436    <para>
 437     Functions <function>ZOOM_resultset_options_set</function> and
 438     <function>ZOOM_resultset_get</function> sets and gets an option
 439     for a result set similar to <function>ZOOM_connection_option_get</function>
 440     and <function>ZOOM_connection_option_set</function>.
 441    </para>
 442    <para>
 443     The number of hits also called result-count is returned by
 444     function <function>ZOOM_resultset_size</function>.
 445    </para>
 446    <table id="zoom.resultset.options"
 447     frame="top"><title>ZOOM Result set Options</title>
 448     <tgroup cols="3">
 449      <colspec colwidth="4*" colname="name"></colspec>
 450      <colspec colwidth="7*" colname="description"></colspec>
 451      <colspec colwidth="2*" colname="default"></colspec>
 452      <thead>
 453       <row>
 454        <entry>Option</entry>
 455        <entry>Description</entry>
 456        <entry>Default</entry>
 457       </row>
 458      </thead>
 459      <tbody>
 460       <row><entry>
 461         start</entry><entry>Offset of first record to be
 462         retrieved from target. First record has offset 0 unlike the
 463         protocol specifications where first record has position 1.
 464        </entry><entry>0</entry></row>
 465       <row><entry>
 466         count</entry><entry>Number of records to be retrieved.
 467        </entry><entry>0</entry></row>
 468       <row><entry>
 469         presentChunk</entry><entry>The number of records to be
 470         requested from the server in each chunk (present requst).  The
 471         value 0 means to request all the records in a single chunk.
 472         (The old <literal>step</literal>
 473         option is also supported for the benefit of old applications.)
 474        </entry><entry>0</entry></row>
 475       <row><entry>
 476         elementSetName</entry><entry>Element-Set name of records.
 477         Most targets should honor element set name <literal>B</literal>
 478         and <literal>F</literal> for brief and full respectively.
 479        </entry><entry>none</entry></row>
 480       <row><entry>
 481         preferredRecordSyntax</entry><entry>Preferred Syntax, such as
 482         <literal>USMARC</literal>, <literal>SUTRS</literal>, etc.
 483        </entry><entry>none</entry></row>
 484       <row><entry>
 485         schema</entry><entry>Schema for retrieval, such as
 486         <literal>Gils-schema</literal>, <literal>Geo-schema</literal>, etc.
 487        </entry><entry>none</entry></row>
 488       <row><entry>
 489         setname</entry><entry>Name of Result Set (Result Set ID).
 490         If this option isn't set, the ZOOM module will automatically
 491         allocate a result set name.
 492        </entry><entry>default</entry></row>
 493       <row><entry>
 494         rpnCharset</entry><entry>Character set for RPN terms.
 495         If this is set, ZOOM C will assume that the ZOOM application is
 496         running UTF-8. Terms in RPN queries are then converted to the
 497         rpnCharset. If this is unset, ZOOM C will not assume any encoding
 498         of RPN terms and no conversion is performed.
 499        </entry><entry>none</entry></row>
 500      </tbody>
 501     </tgroup>
 502    </table>
 503    <para>
 504     For servers that support Search Info report, the following
 505     options may be read using <function>ZOOM_resultset_get</function>.
 506     This detailed information is read after a successful search has
 507     completed.
 508    </para>
 509    <para>
 510     This information is a list of of items, where each item is
 511     information about a term or subquery. All items in the list
 512     are prefixed by
 513     <literal>SearchResult.</literal><replaceable>no</replaceable>
 514     where no presents the item number (0=first, 1=second).
 515     Read <literal>searchresult.size</literal> to determine the
 516     number of items.
 517    </para>
 518    <table id="zoom.search.info.report.options"
 519     frame="top"><title>Search Info Report Options</title>
 520     <tgroup cols="2">
 521      <colspec colwidth="4*" colname="name"></colspec>
 522      <colspec colwidth="7*" colname="description"></colspec>
 523      <thead>
 524       <row>
 525        <entry>Option</entry>
 526        <entry>Description</entry>
 527       </row>
 528      </thead>
 529      <tbody>
 530       <row>
 531        <entry>searchresult.size</entry>
 532        <entry>
 533         number of search result entries. This option is-nonexistant
 534         if no entries are returned by the server.
 535        </entry>
 536       </row>
 537       <row>
 538        <entry>searchresult.<replaceable>no</replaceable>.id</entry>
 539        <entry>sub query ID</entry>
 540       </row>
 541       <row>
 542        <entry>searchresult.<replaceable>no</replaceable>.count</entry>
 543        <entry>result count for item (number of hits)</entry>
 544       </row>
 545       <row>
 546        <entry>searchresult.<replaceable>no</replaceable>.subquery.term</entry>
 547        <entry>subquery term</entry>
 548       </row>
 549       <row>
 550        <entry>
 551         searchresult.<replaceable>no</replaceable>.interpretation.term
 552        </entry>
 553        <entry>interpretation term</entry>
 554       </row>
 555       <row>
 556        <entry>
 557         searchresult.<replaceable>no</replaceable>.recommendation.term
 558        </entry>
 559        <entry>recommendation term</entry>
 560       </row>
 561      </tbody>
 562     </tgroup>
 563    </table>
 564    <sect2 id="zoom.z3950.resultset.behavior">
 565     <title>Z39.50 Protocol behavior</title>
 566     <para>
 567      The creation of a result set involves at least a SearchRequest
 568      - SearchResponse protocol handshake. Following that, if a sort
 569      criteria was specified as part of the query, a SortRequest -
 570      SortResponse handshake takes place. Note that it is necessary to
 571      perform sorting before any retrieval takes place, so no records will
 572      be returned from the target as part of the SearchResponse because these
 573      would be unsorted. Hence, piggyback is disabled when sort criteria
 574      are set. Following Search - and a possible sort - Retrieval takes
 575      place - as one or more Present Requests/Response pairs being
 576      transferred.
 577      </para>
 578     <para>
 579      The API allows for two different modes for retrieval. A high level
 580      mode which is somewhat more powerful and a low level one.
 581      The low level is enabled when searching on a Connection object
 582      for which the settings
 583      <literal>smallSetUpperBound</literal>,
 584      <literal>mediumSetPresentNumber</literal> and
 585      <literal>largeSetLowerBound</literal> are set. The low level mode
 586      thus allows you to precisely set how records are returned as part
 587      of a search response as offered by the Z39.50 protocol.
 588      Since the client may be retrieving records as part of the
 589      search response, this mode doesn't work well if sorting is used.
 590      </para>
 591     <para>
 592      The high-level mode allows you to fetch a range of records from
 593      the result set with a given start offset. When you use this mode
 594      the client will automatically use piggyback if that is possible
 595      with the target and perform one or more present requests as needed.
 596      Even if the target returns fewer records as part of a present response
 597      because of a record size limit, etc. the client will repeat sending
 598      present requests. As an example, if option <literal>start</literal>
 599      is 0 (default) and <literal>count</literal> is 4, and
 600      <literal>piggyback</literal> is 1 (default) and no sorting criteria
 601      is specified, then the client will attempt to retrieve the 4
 602      records as part the search response (using piggyback). On the other
 603      hand, if either <literal>start</literal> is positive or if
 604      a sorting criteria is set, or if <literal>piggyback</literal>
 605      is 0, then the client will not perform piggyback but send Present
 606      Requests instead.
 607     </para>
 608     <para>
 609      If either of the options <literal>mediumSetElementSetName</literal> and
 610      <literal>smallSetElementSetName</literal> are unset, the value
 611      of option <literal>elementSetName</literal> is used for piggyback
 612      searches. This means that for the high-level mode you only have
 613      to specify one elementSetName option rather than three.
 614      </para>
 615    </sect2>
 616    <sect2 id="zoom.sru.resultset.behavior">
 617     <title>SRU Protocol behavior</title>
 618     <para>
 619      Current version of &yaz; does not take advantage of a result set id
 620      returned by the SRU server. Future versions might do, however.
 621      Since, the ZOOM driver does not save result set IDs any
 622      present (retrieval) is transformed to a SRU SearchRetrieveRequest
 623      with same query but, possibly, different offsets.
 624     </para>
 625     <para>
 626      Option <literal>schema</literal> specifies SRU schema
 627      for retrieval. However, options <literal>elementSetName</literal> and
 628      <literal>preferredRecordSyntax</literal> are ignored.
 629     </para>
 630     <para>
 631      Options <literal>start</literal> and <literal>count</literal>
 632      are supported by SRU.
 633      The remaining options
 634      <literal>piggyback</literal>,
 635      <literal>smallSetUpperBound</literal>,
 636      <literal>largeSetLowerBound</literal>,
 637      <literal>mediumSetPresentNumber</literal>,
 638      <literal>mediumSetElementSetName</literal>,
 639       <literal>smallSetElementSetName</literal> are
 640      unsupported.
 641     </para>
 642     <para>
 643      SRU supports CQL queries, <emphasis>not</emphasis> PQF.
 644      If PQF is used, however, the PQF query is transferred anyway
 645      using non-standard element <literal>pQuery</literal> in
 646      SRU SearchRetrieveRequest.
 647     </para>
 648     <para>
 649      Unfortunately, SRU does not define a database setting. Hence,
 650      <literal>databaseName</literal> is unsupported and ignored.
 651      However, the path part in host parameter for functions
 652      <function>ZOOM_connecton_new</function> and
 653      <function>ZOOM_connection_connect</function> acts as a
 654      database (at least for the &yaz; SRU server).
 655     </para>
 656    </sect2>
 657   </sect1>
 658   <sect1 id="zoom.records"><title>Records</title>
 659    <para>
 660     A record object is a retrieval record on the client side -
 661     created from result sets.
 662    </para>
 663    <synopsis>
 664      void ZOOM_resultset_records(ZOOM_resultset r,
 665                                  ZOOM_record *recs,
 666                                  size_t start, size_t count);
 667      ZOOM_record ZOOM_resultset_record(ZOOM_resultset s, size_t pos);
 668
 669      const char *ZOOM_record_get(ZOOM_record rec, const char *type,
 670                                  size_t *len);
 671
 672      int ZOOM_record_error(ZOOM_record rec, const char **msg,
 673                            const char **addinfo, const char **diagset);
 674
 675      ZOOM_record ZOOM_record_clone (ZOOM_record rec);
 676
 677      void ZOOM_record_destroy (ZOOM_record rec);
 678    </synopsis>
 679    <para>
 680     References to temporary records are returned by functions
 681     <function>ZOOM_resultset_records</function> or
 682     <function>ZOOM_resultset_record</function>.
 683     </para>
 684    <para>
 685     If a persistent reference to a record is desired
 686     <function>ZOOM_record_clone</function> should be used.
 687     It returns a record reference that should be destroyed
 688     by a call to <function>ZOOM_record_destroy</function>.
 689    </para>
 690    <para>
 691     A single record is returned by function
 692     <function>ZOOM_resultset_record</function> that takes a
 693     position as argument. First record has position zero.
 694     If no record could be obtained <literal>NULL</literal> is returned.
 695    </para>
 696    <para>
 697     Error information for a record can be checked with
 698     <function>ZOOM_record_error</function> which returns non-zero
 699     (error code) if record is in error, called <emphasis>Surrogate
 700      Diagnostics</emphasis> in Z39.50.
 701    </para>
 702    <para>
 703     Function <function>ZOOM_resultset_records</function> retrieves
 704     a number of records from a result set. Parameter <literal>start</literal>
 705     and <literal>count</literal> specifies the range of records to
 706     be returned. Upon completion array
 707     <literal>recs[0], ..recs[count-1]</literal>
 708     holds record objects for the records. The array of records
 709      <literal>recs</literal> should be allocated prior the call
 710     <function>ZOOM_resultset_records</function>. Note that for those
 711     records that couldn't be retrieved from the target
 712     <literal>recs[ ..]</literal> is set to <literal>NULL</literal>.
 713    </para>
 714    <para id="zoom.record.get">
 715     In order to extract information about a single record,
 716     <function>ZOOM_record_get</function> is provided. The
 717     function returns a pointer to certain record information. The
 718     nature (type) of the pointer depends on the parameter,
 719     <parameter>type</parameter>.
 720    </para>
 721    <para>
 722     The <parameter>type</parameter> is a string of the format:
 723    </para>
 724    <para>
 725     <replaceable>form</replaceable>[; charset=<replaceable>from</replaceable>[,<replaceable>to</replaceable>]]
 726    </para>
 727    <para>
 728     where <replaceable>form</replaceable> specifies the format of the
 729     returned record, <replaceable>from</replaceable>
 730     specifies the character set of the record in its original form
 731     (as returned by the server), <replaceable>to</replaceable> specifies
 732     the output (returned)
 733     character set encoding.
 734     If charset is not given, then no character set conversion takes place.
 735     If <replaceable>to</replaceable> is omitted UTF-8 is assumed.
 736    </para>
 737    <para>
 738     In addition, for certain types, the length
 739     <literal>len</literal> passed will be set to the size in bytes of
 740     the returned information.
 741     </para>
 742    <para>
 743     The following are the supported values for <replaceable>form</replaceable>.
 744     <variablelist>
 745      <varlistentry><term><literal>database</literal></term>
 746       <listitem><para>Database of record is returned
 747         as a C null-terminated string. Return type
 748         <literal>const char *</literal>.
 749        </para></listitem>
 750      </varlistentry>
 751      <varlistentry><term><literal>syntax</literal></term>
 752       <listitem><para>The transfer syntax of the record is returned
 753         as a C null-terminated string containing the symbolic name of
 754         the record syntax, e.g. <literal>Usmarc</literal>. Return type
 755         is
 756         <literal>const char *</literal>.
 757        </para></listitem>
 758      </varlistentry>
 759      <varlistentry><term><literal>schema</literal></term>
 760       <listitem><para>The schema of the record is returned
 761         as a C null-terminated string. Return type is
 762         <literal>const char *</literal>.
 763        </para></listitem>
 764      </varlistentry>
 765      <varlistentry><term><literal>render</literal></term>
 766       <listitem><para>The record is returned in a display friendly
 767         format. Upon completion buffer is returned
 768         (type <literal>const char *</literal>) and length is stored in
 769         <literal>*len</literal>.
 770        </para></listitem>
 771      </varlistentry>
 772      <varlistentry><term><literal>raw</literal></term>
 773       <listitem><para>The record is returned in the internal
 774         YAZ specific format. For GRS-1, Explain, and others, the
 775         raw data is returned as type
 776         <literal>Z_External *</literal> which is just the type for
 777         the member <literal>retrievalRecord</literal> in
 778         type <literal>NamePlusRecord</literal>.
 779         For SUTRS and octet aligned record (including all MARCs) the
 780         octet buffer is returned and the length of the buffer.
 781        </para></listitem>
 782      </varlistentry>
 783      <varlistentry><term><literal>xml</literal></term>
 784       <listitem><para>The record is returned in XML if possible.
 785         SRU and Z39.50 records with transfer syntax XML are
 786         returned verbatim. MARC records are returned in
 787         <ulink url="&url.marcxml;">
 788          MARCXML
 789          </ulink>
 790         (converted from ISO2709 to MARCXML by YAZ).
 791         GRS-1 and OPAC records are not supported for this form.
 792         Upon completion, the XML buffer is returned
 793         (type <literal>const char *</literal>) and length is stored in
 794         <literal>*len</literal>.
 795        </para></listitem>
 796      </varlistentry>
 797      <varlistentry><term><literal>opac</literal></term>
 798       <listitem><para>OPAC for record is returned in XML.
 799        </para></listitem>
 800      </varlistentry>
 801     </variablelist>
 802    </para>
 803    <para>
 804     Most
 805     <ulink url="&url.marc21;">MARC21</ulink>
 806     records uses the
 807     <ulink url="&url.marc8;">MARC-8</ulink>
 808     character set encoding.
 809     An application that wishes to display in Latin-1 would use
 810     <screen>
 811      render; charset=marc8,iso-8859-1
 812     </screen>
 813    </para>
 814    <sect2 id="zoom.z3950.record.behavior">
 815     <title>Z39.50 Protocol behavior</title>
 816     <para>
 817      The functions <function>ZOOM_resultset_record</function> and
 818      <function>ZOOM_resultset_records</function> inspects the client-side
 819      record cache. Records not found in cache are fetched using
 820      Present.
 821      The functions may block (and perform network I/O)  - even though option
 822      <literal>async</literal> is 1, because they return records objects.
 823      (and there's no way to return records objects without retrieving them!).
 824      </para>
 825     <para>
 826      There is a trick, however, in the usage of function
 827      <function>ZOOM_resultset_records</function> that allows for
 828      delayed retrieval (and makes it non-blocking). By using
 829      a null pointer for <parameter>recs</parameter> you're indicating
 830      you're not interested in getting records objects
 831      <emphasis>now</emphasis>.
 832     </para>
 833    </sect2>
 834    <sect2 id="zoom.sru.record.behavior">
 835     <title>SRU Protocol behavior</title>
 836     <para>
 837      The ZOOM driver for SRU treats records returned by a SRU server
 838      as if they where Z39.50 records with transfer syntax XML and
 839      no element set name or database name.
 840     </para>
 841    </sect2>
 842   </sect1>
 843   <sect1 id="zoom.scan"><title>Scan</title>
 844    <para>
 845     This section describes an interface for Scan. Scan is not an
 846     official part of the ZOOM model yet. The result of a scan operation
 847     is the <literal>ZOOM_scanset</literal> which is a set of terms
 848     returned by a target.
 849    </para>
 850
 851    <para>
 852     The Scan interface is supported for both Z39.50 and SRU.
 853    </para>
 854
 855    <synopsis>
 856     ZOOM_scanset ZOOM_connection_scan(ZOOM_connection c,
 857                                       const char *startpqf);
 858
 859     ZOOM_scanset ZOOM_connection_scan1(ZOOM_connection c,
 860                                        ZOOM_query q);
 861
 862     size_t ZOOM_scanset_size(ZOOM_scanset scan);
 863
 864     const char * ZOOM_scanset_term(ZOOM_scanset scan, size_t pos,
 865                                    int *occ, size_t *len);
 866
 867     const char * ZOOM_scanset_display_term(ZOOM_scanset scan, size_t pos,
 868                                            int *occ, size_t *len);
 869
 870     void ZOOM_scanset_destroy (ZOOM_scanset scan);
 871
 872     const char *ZOOM_scanset_option_get(ZOOM_scanset scan,
 873                                          const char *key);
 874
 875     void ZOOM_scanset_option_set(ZOOM_scanset scan, const char *key,
 876                                  const char *val);
 877     </synopsis>
 878    <para>
 879     The scan set is created by function
 880     <function>ZOOM_connection_scan</function> which performs a scan
 881     operation on the connection using the specified
 882     <parameter>startpqf</parameter>.
 883     If the operation was successful, the size of the scan set can be
 884     retrieved by a call to <function>ZOOM_scanset_size</function>.
 885     Like result sets, the items are numbered 0,..size-1.
 886     To obtain information about a particular scan term, call function
 887     <function>ZOOM_scanset_term</function>. This function takes
 888     a scan set offset <literal>pos</literal> and returns a pointer
 889     to a <emphasis>raw term</emphasis> or <literal>NULL</literal> if
 890     non-present.
 891     If present, the <literal>occ</literal> and <literal>len</literal>
 892     are set to the number of occurrences and the length
 893     of the actual term respectively.
 894     <function>ZOOM_scanset_display_term</function> is similar to
 895     <function>ZOOM_scanset_term</function> except that it returns
 896     the <emphasis>display term</emphasis> rather than the raw term.
 897     In a few cases, the term is different from display term. Always
 898     use the display term for display and the raw term for subsequent
 899     scan operations (to get more terms, next scan result, etc).
 900    </para>
 901    <para>
 902     A scan set may be freed by a call to function
 903     <function>ZOOM_scanset_destroy</function>.
 904     Functions <function>ZOOM_scanset_option_get</function> and
 905     <function>ZOOM_scanset_option_set</function> retrieves and sets
 906     an option respectively.
 907    </para>
 908
 909    <para>
 910     The <parameter>startpqf</parameter> is a subset of PQF, namely
 911     the Attributes+Term part. Multiple <literal>@attr</literal> can
 912     be used. For example to scan in title (complete) phrases:
 913     <literallayout>
 914      @attr 1=4 @attr 6=2 "science o"
 915     </literallayout>
 916    </para>
 917
 918    <para>
 919     The <function>ZOOM_connecton_scan1</function> is a newer and
 920     more generic alternative to <function>ZOOM_connection_scan</function>
 921     which allows to use both CQL and PQF for Scan.
 922    </para>
 923
 924    <table frame="top" id="zoom.scanset.options">
 925     <title>ZOOM Scan Set Options</title>
 926     <tgroup cols="3">
 927      <colspec colwidth="4*" colname="name"></colspec>
 928      <colspec colwidth="7*" colname="description"></colspec>
 929      <colspec colwidth="2*" colname="default"></colspec>
 930      <thead>
 931       <row>
 932        <entry>Option</entry>
 933        <entry>Description</entry>
 934        <entry>Default</entry>
 935       </row>
 936      </thead>
 937      <tbody>
 938       <row><entry>
 939         number</entry><entry>Number of Scan Terms requested in next scan.
 940         After scan it holds the actual number of terms returned.
 941        </entry><entry>10</entry></row>
 942       <row><entry>
 943         position</entry><entry>Preferred Position of term in response
 944         in next scan; actual position after completion of scan.
 945        </entry><entry>1</entry></row>
 946       <row><entry>
 947         stepSize</entry><entry>Step Size
 948        </entry><entry>0</entry></row>
 949       <row><entry>
 950         scanStatus</entry><entry>An integer indicating the Scan Status
 951         of last scan.
 952        </entry><entry>0</entry></row>
 953       <row><entry>
 954         rpnCharset</entry><entry>Character set for RPN terms.
 955         If this is set, ZOOM C will assume that the ZOOM application is
 956         running UTF-8. Terms in RPN queries are then converted to the
 957         rpnCharset. If this is unset, ZOOM C will not assume any encoding
 958         of RPN terms and no conversion is performed.
 959        </entry><entry>none</entry></row>
 960      </tbody>
 961     </tgroup>
 962    </table>
 963   </sect1>
 964
 965   <sect1 id="zoom.extendedservices"><title>Extended Services</title>
 966    <para>
 967     ZOOM offers an interface to a subset of the Z39.50 extended services
 968     as well as a few privately defined ones:
 969    </para>
 970    <itemizedlist>
 971     <listitem>
 972      <para>
 973       Z39.50 Item Order (ILL).
 974       See <xref linkend="zoom.item.order"/>.
 975      </para>
 976     </listitem>
 977     <listitem>
 978      <para>
 979       Record Update. This allows a client to insert, modify or delete
 980       records.
 981       See <xref linkend="zoom.record.update"/>.
 982      </para>
 983     </listitem>
 984     <listitem>
 985      <para>
 986       Database Create. This a non-standard feature. Allows a client
 987       to create a database.
 988       See <xref linkend="zoom.database.create"/>.
 989      </para>
 990     </listitem>
 991     <listitem>
 992      <para>
 993       Database Drop. This a non-standard feature. Allows a client
 994       to delete/drop a database.
 995       See <xref linkend="zoom.database.drop"/>.
 996      </para>
 997      </listitem>
 998     <listitem>
 999      <para>
1000       Commit operation. This a non-standard feature. Allows a client
1001       to commit operations.
1002       See <xref linkend="zoom.commit"/>.
1003      </para>
1004     </listitem>
1005     <!-- all the ILL PDU options should go here too -->
1006    </itemizedlist>
1007    <para>
1008     To create an extended service operation a <literal>ZOOM_package</literal>
1009     must be created. The operation is a five step operation. The
1010     package is created, package is configured by means of options,
1011     the package is send, result is inspected (by means of options),
1012     the package is destroyed.
1013    </para>
1014    <synopsis>
1015     ZOOM_package ZOOM_connection_package(ZOOM_connection c,
1016                                          ZOOM_options options);
1017
1018     const char *ZOOM_package_option_get(ZOOM_package p,
1019                                         const char *key);
1020     void ZOOM_package_option_set(ZOOM_package p, const char *key,
1021                                  const char *val);
1022     void ZOOM_package_send(ZOOM_package p, const char *type);
1023
1024     void ZOOM_package_destroy(ZOOM_package p);
1025    </synopsis>
1026    <para>
1027     The <function>ZOOM_connection_package</function> creates a
1028     package for the connection given using the options specified.
1029    </para>
1030    <para>
1031     Functions <function>ZOOM_package_option_get</function> and
1032     <function>ZOOM_package_option_set</function> gets and sets
1033     options.
1034    </para>
1035    <para>
1036     <function>ZOOM_package_send</function> sends
1037     the package the via connection specified in
1038     <function>ZOOM_connection_package</function>.
1039     The <parameter>type</parameter> specifies the actual extended service
1040     package type to be sent.
1041    </para>
1042
1043    <table frame="top" id="zoom.extendedservices.options">
1044     <title>Extended Service Common Options</title>
1045     <tgroup cols="3">
1046      <colspec colwidth="4*" colname="name"></colspec>
1047      <colspec colwidth="7*" colname="description"></colspec>
1048      <colspec colwidth="3*" colname="default"></colspec>
1049      <thead>
1050       <row>
1051        <entry>Option</entry>
1052        <entry>Description</entry>
1053        <entry>Default</entry>
1054       </row>
1055      </thead>
1056      <tbody>
1057       <row>
1058        <entry>package-name</entry>
1059        <entry>Extended Service Request package name. Must be specified
1060        as part of a request</entry>
1061        <entry>none</entry>
1062       </row>
1063       <row>
1064        <entry>user-id</entry>
1065        <entry>User ID of Extended Service Package. Is a request option</entry>
1066        <entry>none</entry>
1067       </row>
1068       <row>
1069        <entry>function</entry>
1070        <entry>
1071         Function of package - one of <literal>create</literal>,
1072         <literal>delete</literal>, <literal>modify</literal>. Is
1073         a request option.
1074        </entry>
1075        <entry><literal>create</literal></entry>
1076       </row>
1077       <row>
1078        <entry>waitAction</entry>
1079        <entry>
1080         Wait action for package. Possible values:
1081         <literal>wait</literal>, <literal>waitIfPossible</literal>,
1082         <literal>dontWait</literal> or <literal>dontReturnPackage</literal>.
1083        </entry>
1084        <entry><literal>waitIfPossible</literal></entry>
1085       </row>
1086       <row>
1087        <entry>targetReference</entry>
1088        <entry>
1089         Target Reference. This is part of the response as returned
1090         by the server. Read it after a successful operation.
1091        </entry>
1092        <entry><literal>none</literal></entry>
1093       </row>
1094      </tbody>
1095     </tgroup>
1096    </table>
1097
1098    <sect2 id="zoom.item.order"><title>Item Order</title>
1099     <para>
1100      For Item Order, type must be set to <literal>itemorder</literal> in
1101      <function>ZOOM_package_send</function>.
1102     </para>
1103
1104     <table frame="top" id="zoom.item.order.options">
1105      <title>Item Order Options</title>
1106      <tgroup cols="3">
1107       <colspec colwidth="4*" colname="name"></colspec>
1108       <colspec colwidth="7*" colname="description"></colspec>
1109       <colspec colwidth="3*" colname="default"></colspec>
1110       <thead>
1111        <row>
1112         <entry>Option</entry>
1113         <entry>Description</entry>
1114         <entry>Default</entry>
1115        </row>
1116       </thead>
1117       <tbody>
1118        <row>
1119         <entry>contact-name</entry>
1120         <entry>ILL contact name</entry>
1121         <entry>none</entry>
1122        </row>
1123        <row>
1124         <entry>contact-phone</entry>
1125         <entry>ILL contact phone</entry>
1126         <entry>none</entry>
1127        </row>
1128        <row>
1129         <entry>contact-email</entry>
1130         <entry>ILL contact email</entry>
1131         <entry>none</entry>
1132        </row>
1133        <row>
1134         <entry>itemorder-item</entry>
1135         <entry>Position for item (record) requested. An integer</entry>
1136         <entry>1</entry>
1137        </row>
1138       </tbody>
1139      </tgroup>
1140     </table>
1141
1142    </sect2>
1143
1144    <sect2 id="zoom.record.update"><title>Record Update</title>
1145     <para>
1146      For Record Update, type must be set to <literal>update</literal> in
1147      <function>ZOOM_package_send</function>.
1148     </para>
1149
1150     <table frame="top" id="zoom.record.update.options">
1151      <title>Record Update Options</title>
1152      <tgroup cols="3">
1153       <colspec colwidth="4*" colname="name"></colspec>
1154       <colspec colwidth="7*" colname="description"></colspec>
1155       <colspec colwidth="3*" colname="default"></colspec>
1156       <thead>
1157        <row>
1158         <entry>Option</entry>
1159         <entry>Description</entry>
1160         <entry>Default</entry>
1161        </row>
1162       </thead>
1163       <tbody>
1164        <row>
1165         <entry>action</entry>
1166         <entry>
1167          The update action. One of
1168          <literal>specialUpdate</literal>,
1169          <literal>recordInsert</literal>,
1170          <literal>recordReplace</literal>,
1171          <literal>recordDelete</literal>,
1172          <literal>elementUpdate</literal>.
1173         </entry>
1174         <entry><literal>specialUpdate (recordInsert for updateVersion=1 which does not support specialUpdate)</literal></entry>
1175        </row>
1176        <row>
1177         <entry>recordIdOpaque</entry>
1178         <entry>Opaque Record ID</entry>
1179         <entry>none</entry>
1180        </row>
1181        <row>
1182         <entry>recordIdNumber</entry>
1183         <entry>Record ID number</entry>
1184         <entry>none</entry>
1185        </row>
1186        <row>
1187         <entry>record</entry>
1188         <entry>The record itself</entry>
1189         <entry>none</entry>
1190        </row>
1191        <row>
1192         <entry>recordOpaque</entry>
1193         <entry>Specifies an opaque record which is
1194           encoded as an ASN.1 ANY type with the OID as tiven by option
1195           <literal>syntax</literal> (see below).
1196           Option <literal>recordOpaque</literal> is an alternative
1197           to record - and <literal>record</literal> option (above) is
1198           ignored if recordOpaque is set. This option is only available in
1199           YAZ 3.0.35 and later and is meant to facilitate Updates with
1200           servers from OCLC.
1201         </entry>
1202         <entry>none</entry>
1203        </row>
1204        <row>
1205         <entry>syntax</entry>
1206         <entry>The record syntax (transfer syntax). Is a string that
1207          is a known record syntax.
1208         </entry>
1209         <entry>no syntax</entry>
1210        </row>
1211        <row>
1212         <entry>databaseName</entry>
1213         <entry>Database from connection object</entry>
1214         <entry>Default</entry>
1215        </row>
1216        <row>
1217         <entry>correlationInfo.note</entry>
1218         <entry>Correlation Info Note (string)</entry>
1219         <entry>none</entry>
1220        </row>
1221        <row>
1222         <entry>correlationInfo.id</entry>
1223         <entry>Correlation Info ID (integer)</entry>
1224         <entry>none</entry>
1225        </row>
1226        <row>
1227         <entry>elementSetName</entry>
1228         <entry>Element Set for Record</entry>
1229         <entry>none</entry>
1230        </row>
1231        <row>
1232         <entry>updateVersion</entry>
1233         <entry>Record Update version which holds one of the values
1234          1, 2 or 3. Each version has a distinct OID:
1235          1.2.840.10003.9.5
1236          (<ulink url="&url.z39.50.extupdate1;">first version</ulink>) ,
1237          1.2.840.10003.9.5.1
1238          (second version) and
1239          1.2.840.10003.9.5.1.1
1240          (<ulink url="&url.z39.50.extupdate3;">third and
1241           newest version</ulink>).
1242         </entry>
1243         <entry>3</entry>
1244        </row>
1245       </tbody>
1246      </tgroup>
1247     </table>
1248
1249    </sect2>
1250
1251    <sect2 id="zoom.database.create"><title>Database Create</title>
1252     <para>
1253      For Database Create, type must be set to <literal>create</literal> in
1254      <function>ZOOM_package_send</function>.
1255     </para>
1256
1257     <table frame="top" id="zoom.database.create.options">
1258      <title>Database Create Options</title>
1259      <tgroup cols="3">
1260       <colspec colwidth="4*" colname="name"></colspec>
1261       <colspec colwidth="7*" colname="description"></colspec>
1262       <colspec colwidth="3*" colname="default"></colspec>
1263       <thead>
1264        <row>
1265         <entry>Option</entry>
1266         <entry>Description</entry>
1267         <entry>Default</entry>
1268        </row>
1269       </thead>
1270       <tbody>
1271        <row>
1272         <entry>databaseName</entry>
1273         <entry>Database from connection object</entry>
1274         <entry>Default</entry>
1275        </row>
1276       </tbody>
1277      </tgroup>
1278     </table>
1279    </sect2>
1280
1281    <sect2 id="zoom.database.drop"><title>Database Drop</title>
1282     <para>
1283      For Database Drop, type must be set to <literal>drop</literal> in
1284      <function>ZOOM_package_send</function>.
1285     </para>
1286
1287     <table frame="top" id="zoom.database.drop.options">
1288      <title>Database Drop Options</title>
1289      <tgroup cols="3">
1290       <colspec colwidth="4*" colname="name"></colspec>
1291       <colspec colwidth="7*" colname="description"></colspec>
1292       <colspec colwidth="3*" colname="default"></colspec>
1293       <thead>
1294        <row>
1295         <entry>Option</entry>
1296         <entry>Description</entry>
1297         <entry>Default</entry>
1298        </row>
1299       </thead>
1300       <tbody>
1301        <row>
1302         <entry>databaseName</entry>
1303         <entry>Database from connection object</entry>
1304         <entry>Default</entry>
1305        </row>
1306       </tbody>
1307      </tgroup>
1308     </table>
1309    </sect2>
1310
1311    <sect2 id="zoom.commit"><title>Commit Operation</title>
1312     <para>
1313      For Commit, type must be set to <literal>commit</literal> in
1314      <function>ZOOM_package_send</function>.
1315     </para>
1316    </sect2>
1317
1318    <sect2 id="zoom.extended.services.behavior">
1319     <title>Protocol behavior</title>
1320     <para>
1321      All the extended services are Z39.50-only.
1322     </para>
1323     <note>
1324      <para>
1325       The database create, drop and commit services are privately defined
1326       operations.
1327       Refer to <filename>esadmin.asn</filename> in YAZ for the ASN.1
1328       definitions.
1329      </para>
1330     </note>
1331    </sect2>
1332   </sect1>
1333
1334   <sect1 id="zoom.options"><title>Options</title>
1335    <para>
1336     Most &zoom; objects provide a way to specify options to change behavior.
1337     From an implementation point of view a set of options is just like
1338     an associative array / hash.
1339    </para>
1340    <synopsis>
1341      ZOOM_options ZOOM_options_create (void);
1342
1343      ZOOM_options ZOOM_options_create_with_parent (ZOOM_options parent);
1344
1345      void ZOOM_options_destroy (ZOOM_options opt);
1346    </synopsis>
1347    <synopsis>
1348      const char *ZOOM_options_get (ZOOM_options opt, const char *name);
1349
1350      void ZOOM_options_set (ZOOM_options opt, const char *name,
1351                             const char *v);
1352    </synopsis>
1353    <synopsis>
1354      typedef const char *(*ZOOM_options_callback)
1355                                      (void *handle, const char *name);
1356
1357      ZOOM_options_callback
1358              ZOOM_options_set_callback (ZOOM_options opt,
1359                                         ZOOM_options_callback c,
1360                                         void *handle);
1361    </synopsis>
1362   </sect1>
1363   <sect1 id="zoom.events"><title>Events</title>
1364    <para>
1365     If you're developing non-blocking applications, you have to deal
1366     with events.
1367    </para>
1368    <synopsis>
1369     int ZOOM_event (int no, ZOOM_connection *cs);
1370    </synopsis>
1371    <para>
1372     The <function>ZOOM_event</function> executes pending events for
1373     a number of connections. Supply the number of connections in
1374     <literal>no</literal> and an array of connections in
1375     <literal>cs</literal> (<literal>cs[0] ... cs[no-1]</literal>).
1376     A pending event could be a sending a search, receiving a response,
1377     etc.
1378     When an event has occurred for one of the connections, this function
1379     returns a positive integer <literal>n</literal> denoting that an event
1380     occurred for connection <literal>cs[n-1]</literal>.
1381     When no events are pending for the connections, a value of zero is
1382     returned.
1383     To ensure that all outstanding requests are performed call this function
1384     repeatedly until zero is returned.
1385    </para>
1386    <para>
1387     If <function>ZOOM_event</function> returns and returns non-zero, the
1388     last event that occurred can be expected.
1389    </para>
1390    <synopsis>
1391     int ZOOM_connection_last_event(ZOOM_connection cs);
1392    </synopsis>
1393    <para>
1394     <function>ZOOM_connection_last_event</function> returns an event type
1395     (integer) for the last event.
1396    </para>
1397
1398    <table frame="top" id="zoom.event.ids">
1399     <title>ZOOM Event IDs</title>
1400     <tgroup cols="2">
1401      <colspec colwidth="4*" colname="name"></colspec>
1402      <colspec colwidth="7*" colname="description"></colspec>
1403      <thead>
1404       <row>
1405        <entry>Event</entry>
1406        <entry>Description</entry>
1407       </row>
1408      </thead>
1409      <tbody>
1410       <row>
1411        <entry>ZOOM_EVENT_NONE</entry>
1412        <entry>No event has occurred</entry>
1413       </row>
1414       <row>
1415        <entry>ZOOM_EVENT_CONNECT</entry>
1416        <entry>TCP/IP connect has initiated</entry>
1417       </row>
1418       <row>
1419        <entry>ZOOM_EVENT_SEND_DATA</entry>
1420        <entry>Data has been transmitted (sending)</entry>
1421       </row>
1422       <row>
1423        <entry>ZOOM_EVENT_RECV_DATA</entry>
1424        <entry>Data has been received)</entry>
1425       </row>
1426       <row>
1427        <entry>ZOOM_EVENT_TIMEOUT</entry>
1428        <entry>Timeout</entry>
1429       </row>
1430       <row>
1431        <entry>ZOOM_EVENT_UNKNOWN</entry>
1432        <entry>Unknown event</entry>
1433       </row>
1434       <row>
1435        <entry>ZOOM_EVENT_SEND_APDU</entry>
1436        <entry>An APDU has been transmitted (sending)</entry>
1437       </row>
1438       <row>
1439        <entry>ZOOM_EVENT_RECV_APDU</entry>
1440        <entry>An APDU has been received</entry>
1441       </row>
1442       <row>
1443        <entry>ZOOM_EVENT_RECV_RECORD</entry>
1444        <entry>A result-set record has been received</entry>
1445       </row>
1446       <row>
1447        <entry>ZOOM_EVENT_RECV_SEARCH</entry>
1448        <entry>A search result been received</entry>
1449       </row>
1450      </tbody>
1451     </tgroup>
1452    </table>
1453   </sect1>
1454  </chapter>
1455
1456  <!-- Keep this comment at the end of the file
1457  Local variables:
1458  mode: sgml
1459  sgml-omittag:t
1460  sgml-shorttag:t
1461  sgml-minimize-attributes:nil
1462  sgml-always-quote-attributes:t
1463  sgml-indent-step:1
1464  sgml-indent-data:t
1465  sgml-parent-document: "yaz.xml"
1466  sgml-local-catalogs: nil
1467  sgml-namecase-general:t
1468  End:
1469  -->
1470