doc/zoom.xml

   1 <!-- $Id: zoom.xml,v 1.11 2001-11-16 09:52:39 adam Exp $ -->
   2  <chapter id="zoom"><title>Building clients with ZOOM</title>
   3
   4   <para>
   5     &zoom; is an acronym for 'Z39.50 Object-Orientation Model' and is
   6    an initiative started by Mike Taylor (Mike is from the UK, which
   7    explains the peculiar name of the model). The goal of &zoom; is to
   8    provide a common Z39.50 client API not bound to a particular
   9    programming language or toolkit.
  10   </para>
  11   <para>
  12    The lack of a simple Z39.50 client API for &yaz; has become more
  13    and more apparent over time. So when the first &zoom; specification
  14    became available,
  15    an implementation for &yaz; was quickly developed. For the first time, it is
  16    now as easy (or easier!) to develop clients than servers with &yaz;. This
  17    chapter describes the &zoom; C binding. Before going futher, please
  18    reconsider whether C is the right programming language for the job.
  19    There are other language bindings available for &yaz;, and still
  20    more
  21    are in active development. See the
  22    <ulink url="http://zoom.z3950.org/">ZOOM website</ulink> for
  23    more information.
  24   </para>
  25
  26   <para>
  27    In order to fully understand this chapter you should read and
  28    try the example programs <literal>zoomtst1.c</literal>,
  29    <literal>zoomtst2.c</literal>, .. in the <literal>zoom</literal>
  30    directory.
  31   </para>
  32
  33   <para>
  34    The C language misses many features found in object oriented languages
  35    such as C++, Java, etc. For example, you'll have to manually,
  36    destroy all objects you create, even though you may think of them as
  37    temporary. Most objects has a <literal>_create</literal> - and a
  38    <literal>_destroy</literal> variant.
  39    All objects are in fact pointers to internal stuff, but you don't see
  40    that because of typedefs. All destroy methods should gracefully ignore a
  41    <literal>NULL</literal> pointer.
  42   </para>
  43   <para>
  44    In each of the sections below you'll find a sub section called
  45    protocol behavior, that descries how the API maps to the Z39.50
  46    protocol.
  47   </para>
  48   <sect1 id="zoom.connections"><title>Connections</title>
  49
  50    <para>The Connection object is a session with a target.
  51    </para>
  52    <synopsis>
  53    #include &lt;yaz/zoom.h>
  54
  55    Z3950_connection Z3950_connection_new (const char *host, int portnum);
  56
  57    Z3950_connection Z3950_connection_create (Z3950_options options);
  58
  59    void Z3950_connection_connect(Z3950_connection c, const char *host,
  60                                  int portnum);
  61    void Z3950_connection_destroy (Z3950_connection c);
  62    </synopsis>
  63    <para>
  64     Connection objects are created with either function
  65     <function>Z3950_connection_new</function> or
  66     <function>Z3950_connection_create</function>.
  67     The former creates and automatically attempts to establish a network
  68     connection with the target. The latter doesn't establish
  69     a connection immediately, thus allowing you to specify options
  70     before establishing network connection using the function
  71     <function>Z3950_connection_connect</function>.
  72     If the portnumber, <literal>portnum</literal>, is zero, the
  73     <literal>host</literal> is consulted for a port specification.
  74     If no port is given, 210 is used. A colon denotes the beginning of
  75     a port number in the host string. If the host string includes a
  76     slash, the following part specifies a database for the connection.
  77    </para>
  78    <para>
  79     Connection objects should be destroyed using the function
  80     <function>Z3950_connection_destroy</function>.
  81    </para>
  82    <synopsis>
  83     void Z3950_connection_option_set (Z3950_connection c,
  84                                       const char *key,
  85                                       const char *val);
  86
  87     const char *Z3950_connection_option_get (Z3950_connection c,
  88                                              const char *key);
  89    </synopsis>
  90    <para>
  91     The <function>Z3950_connection_option_set</function> allows you to
  92     set an option given by <parameter>key</parameter> to the value
  93     <parameter>value</parameter> for the connection.
  94      Function <function>Z3950_connection_option_get</function> returns
  95     the value for an option given by <parameter>key</parameter>.
  96    </para>
  97    <table frame="top"><title>ZOOM Connection Options</title>
  98     <tgroup cols="3">
  99      <colspec colwidth="4*" colname="name"></colspec>
 100      <colspec colwidth="7*" colname="description"></colspec>
 101      <colspec colwidth="3*" colname="default"></colspec>
 102      <thead>
 103       <row>
 104        <entry>Option</entry>
 105        <entry>Description</entry>
 106        <entry>Default</entry>
 107       </row>
 108      </thead>
 109      <tbody>
 110       <row><entry>
 111         implementationName</entry><entry>Name of Your client
 112        </entry><entry>none</entry></row>
 113       <row><entry>
 114         user</entry><entry>Authentication user name
 115        </entry><entry>none</entry></row>
 116       <row><entry>
 117         group</entry><entry>Authentication group name
 118        </entry><entry>none</entry></row>
 119       <row><entry>
 120         pass</entry><entry>Authentication password
 121       </entry><entry>none</entry></row>
 122       <row><entry>
 123         host</entry><entry>Target host. This setting is "read-only".
 124         It's automatically set internally when connecting to a target.
 125        </entry><entry>none</entry></row>
 126       <row><entry>
 127         proxy</entry><entry>Proxy host
 128        </entry><entry>none</entry></row>
 129       <row><entry>
 130         async</entry><entry>If true (1) the connection operates in
 131         asynchronous operation which means that all calls are non-blocking
 132         except
 133         <link linkend="zoom.events"><function>Z3950_event</function></link>.
 134        </entry><entry>0</entry></row>
 135       <row><entry>
 136         maximumRecordSize</entry><entry> Maximum size of single record.
 137        </entry><entry>1 MB</entry></row>
 138       <row><entry>
 139         preferredMessageSize</entry><entry> Maximum size of multiple records.
 140        </entry><entry>1 MB</entry></row>
 141      </tbody>
 142     </tgroup>
 143    </table>
 144    <synopsis>
 145      int Z3950_connection_error (Z3950_connection c, const char **cp,
 146                                  const char **addinfo);
 147    </synopsis>
 148    <para>
 149     Use <function>Z3950_connection_error</function> to check for
 150     errors for the last operation(s) performed. The function returns
 151     zero if no errors occurred; non-zero otherwise indicating the error.
 152     Pointers <parameter>cp</parameter> and <parameter>addinfo</parameter>
 153     holds messages for the error and additional-info if passed as
 154     non-<literal>NULL</literal>.
 155    </para>
 156    <sect2><title>Protocol behavior</title>
 157     <para>
 158      The calls <function>Z3950_connection_new</function> and
 159      <function>Z3950_connection_connect</function> establises a TCP/IP
 160       connection and sends an Initialize Request to the target if
 161       possible. In addition, the calls waits for an Initialize Response
 162       from the target and the result is inspected (OK or rejected).
 163     </para>
 164     <para>
 165      If <literal>proxy</literal> is set then the client will establish
 166      a TCP/IP connection with the peer as specified by the
 167      <literal>proxy</literal> host and the hostname as part of the
 168      connect calls will be set as part of the Initialize Request.
 169      The proxy server will then "forward" the PDU's transparently
 170      to the target behind the proxy.
 171     </para>
 172     <para>
 173      For the authentication parameters, if option <literal>user</literal>
 174      is set and both options <literal>group</literal> and
 175      <literal>pass</literal> are unset, then Open style
 176      authentication is used (Version 2/3) in which case the username
 177      is usually followed by a slash, then by a password.
 178      If either <literal>group</literal>
 179      or <literal>pass</literal> is set then idPass authentication
 180      (Version 3 only) is used. If none of the options are set, no
 181      authentication parameters are set as part of the Initialize Request
 182      (obviously).
 183     </para>
 184     <para>
 185      When option <literal>async</literal> is 1, it really means that
 186      all network operations are postponed (and queued) until the
 187      function <literal>Z3950_event</literal> is invoked. When doing so
 188      it doesn't make sense to check for errors after
 189      <literal>Z3950_connection_new</literal> is called since that
 190      operation "connecting - and init" is still incomplete and the
 191      API cannot tell the outcome (yet).
 192     </para>
 193     </sect2>
 194   </sect1>
 195   <sect1 id="zoom.query"><title>Queries</title>
 196    <para>
 197     Query objects represents queries.
 198    </para>
 199    <synopsis>
 200      Z3950_query Z3950_query_create(void);
 201
 202      void Z3950_query_destroy(Z3950_query q);
 203
 204      int Z3950_query_prefix(Z3950_query q, const char *str);
 205
 206      int Z3950_query_sortby(Z3950_query q, const char *criteria);
 207    </synopsis>
 208    <para>
 209     Create query objects using <function>Z3950_query_create</function>
 210     and destroy them by calling <function>Z3950_query_destroy</function>.
 211     RPN-queries can be specified in <link linkend="PQF">PQF</link>
 212     notation by using the
 213     function <function>Z3950_query_prefix</function>. More
 214     query types will be added later, such as
 215     <link linkend="CCL">CCL</link> to RPN-mapping, native CCL query,
 216     etc. In addition to a search, a sort criteria may be set. Function
 217     <function>Z3950_query_sortby</function> specifies a
 218     sort criteria using the same string notation for sort as offered by
 219     the <link linkend="sortspec">YAZ client</link>.
 220    </para>
 221    <sect2><title>Protocol behavior</title>
 222     <para>
 223      The query object is just an interface for the member Query
 224      in the SearchRequest. The sortby-function is an interface to the
 225      sortSequence member of the SortRequest.
 226     </para>
 227    </sect2>
 228   </sect1>
 229   <sect1 id="zoom.resultsets"><title>Result sets</title>
 230    <para>
 231     The result set object is a container for records returned from
 232     a target.
 233    </para>
 234    <synopsis>
 235      Z3950_resultset Z3950_connection_search(Z3950_connection,
 236                                              Z3950_query q);
 237
 238      Z3950_resultset Z3950_connection_search_pqf(Z3950_connection c,
 239                                                  const char *q);
 240
 241      void Z3950_resultset_destroy(Z3950_resultset r);
 242    </synopsis>
 243    <para>
 244     Function <function>Z3950_connection_search</function> creates
 245      a result set given a connection and query.
 246     Destroy a result set by calling
 247     <function>Z3950_resultset_destroy</function>.
 248     Simple clients may using PQF only may use function
 249     <function>Z3950_connection_search_pqf</function> in which case
 250     creating query objects is not necessary.
 251    </para>
 252    <synopsis>
 253      void Z3950_resultset_option_set (Z3950_resultset r,
 254                                       const char *key,
 255                                       const char *val);
 256
 257      const char *Z3950_resultset_option_get (Z3950_resultset r,
 258                                              const char *key);
 259
 260      size_t Z3950_resultset_size (Z3950_resultset r);
 261    </synopsis>
 262    <para>
 263     Functions <function>Z3950_resultset_options_set</function> and
 264     <function>Z3950_resultset_get</function> sets and gets an option
 265     for a result set similar to <function>Z3950_connection_option_get</function>
 266     and <function>Z3950_connection_option_set</function>.
 267    </para>
 268    <para>
 269     The number of hits also called result-count is returned by
 270     function <function>Z3950_resultset_size</function>.
 271    </para>
 272    <table frame="top"><title>ZOOM Result set Options</title>
 273     <tgroup cols="3">
 274      <colspec colwidth="4*" colname="name"></colspec>
 275      <colspec colwidth="7*" colname="description"></colspec>
 276      <colspec colwidth="2*" colname="default"></colspec>
 277      <thead>
 278       <row>
 279        <entry>Option</entry>
 280        <entry>Description</entry>
 281        <entry>Default</entry>
 282       </row>
 283      </thead>
 284      <tbody>
 285       <row><entry>
 286         piggyback</entry><entry>True (1) if piggyback should be
 287         used in searches; false (0) if not.
 288        </entry><entry>1</entry></row>
 289       <row><entry>
 290         start</entry><entry>Offset of first record to be
 291         retrieved from target. First record has offset 0 unlike the
 292         protocol specifications where first record has position 1.
 293        </entry><entry>0</entry></row>
 294       <row><entry>
 295         count</entry><entry>Number of records to be retrieved.
 296        </entry><entry>0</entry></row>
 297       <row><entry>
 298         elementSetName</entry><entry>Element-Set name of records.
 299         Most targets should honor element set name <literal>B</literal>
 300         and <literal>F</literal> for brief and full respectively.
 301        </entry><entry>none</entry></row>
 302       <row><entry>
 303         preferredRecordSyntax</entry><entry>Preferred Syntax, such as
 304         <literal>USMARC</literal>, <literal>SUTRS</literal>, etc.
 305        </entry><entry>none</entry></row>
 306       <row><entry>
 307         smallSetUpperBound</entry><entry>If hits is less than or equal to this
 308         value, then target will return all records using small element set name
 309        </entry><entry>0</entry></row>
 310       <row><entry>
 311         largeSetLowerBound</entry><entry>If hits is greator than this
 312         value, the target will return no records.
 313        </entry><entry>1</entry></row>
 314       <row><entry>
 315         mediumSetPresentNumber</entry><entry>This value represents
 316         the number of records to be returned as part of a search when when
 317         hits is less than or equal to large set lower bound and if hits
 318         is greator than small set upper bound.
 319        </entry><entry>0</entry></row>
 320       <row><entry>
 321         smallSetElementSetName</entry><entry>
 322         The element set name to be used for small result sets.
 323        </entry><entry>none</entry></row>
 324       <row><entry>
 325         mediumSetElementSetName</entry><entry>
 326         The element set name to be for medium-sized result sets.
 327        </entry><entry>none</entry></row>
 328       <row><entry>
 329         databaseName</entry><entry>One or more database names
 330         separated by character plus (<literal>+</literal>).
 331        </entry><entry>Default</entry></row>
 332      </tbody>
 333     </tgroup>
 334    </table>
 335    <sect2>
 336     <title>Protocol behavior</title>
 337     <para>
 338      The creation of a result set involves at least a SearchRequest
 339      - SearchResponse protocol handshake. Following that, if a sort
 340      critieria was specified as part of the query, a sortRequest -
 341      SortResponse handshake takes place. Note that it is necessary to
 342      perform sorting before any retrieval takes place, so no records will
 343      be returned from the target as part of the SearchResponse because these
 344      would be unsorted. Hence, piggyback is disabled when sort critieria
 345      is set. Following Search - and a Possible sort, Retrieval takes
 346      place - as one or more Present Requests - Present Response being
 347      transferred.
 348      </para>
 349     <para>
 350      The API allows for two different modes for retrieval. A high level
 351      mode which is somewhat more powerful and a low level one.
 352      The low level is "enabled" when the settings
 353      <literal>smallSetUpperBound</literal>,
 354      <literal>mediumSetPresentNumber</literal> and
 355      <literal>largeSetLowerBound</literal> are set. The low level mode
 356      thus allows you to precisely set how records are returned as part
 357      of a search response as offered by the Z39.50 protocol.
 358      Since the client may be retrieving records as part of the
 359      search response, this mode doesn't work well if sorting is used.
 360      </para>
 361     <para>
 362      The high-level mode allows you to fetch a range of records from
 363      the result set with a given start offset. When you use this mode
 364      the client will automatically use piggyback if that is possible
 365      with the target and perform one or more present requests as needed.
 366      Even if the target returns fewer records as part of a present response
 367      because of a record size limit, etc. the client will repeat sending
 368      present requests. As an example, if option <literal>start</literal>
 369      is 0 (default) and <literal>count</literal> is 4, and
 370      <literal>piggyback</literal> is 1 (default) and no sorting critieria
 371      is specified, then the client will attempt to retrieve the 4
 372      records as part the search response (using piggyback). On the other
 373      hand, if either <literal>start</literal> is positive or if
 374      a sorting criteria is set, or if <literal>piggyback</literal>
 375      is 0, then the client will not perform piggyback but send Present
 376      Requests instead.
 377     </para>
 378     <para>
 379      If either of the options <literal>mediumSetElementSetName</literal> and
 380      <literal>smallSetElementSetName</literal> are unset, the value
 381      of option <literal>elementSetName</literal> is used for piggyback
 382      searches. This means that for the high-level mode you only have
 383      to specify one elementSetName option rather than three.
 384      </para>
 385    </sect2>
 386   </sect1>
 387   <sect1 id="zoom.records"><title>Records</title>
 388    <para>
 389     A record object is a retrival record on the client side -
 390     created from result sets.
 391    </para>
 392    <synopsis>
 393      void Z3950_resultset_records (Z3950_resultset r,
 394                                    Z3950_record *recs,
 395                                    size_t start, size_t count);
 396      Z3950_record Z3950_resultset_record (Z3950_resultset s, size_t pos);
 397
 398      void *Z3950_record_get (Z3950_record rec, const char *type,
 399                              size_t *len);
 400
 401      Z3950_record Z3950_record_dup (Z3950_record rec);
 402
 403      void Z3950_record_destroy (Z3950_record rec);
 404    </synopsis>
 405    <para>
 406     References to temporary records are returned by functions
 407     <function>Z3950_resultset_records</function> or
 408     <function>Z3950_resultset_record</function>.
 409     </para>
 410    <para>
 411     If a persistent reference to a record is desired
 412     <function>Z3950_record_dup</function> should be used.
 413     It returns a record reference that at any
 414     later stage should be destroyed by
 415     <function>Z3950_record_destroy</function>.
 416    </para>
 417    <para>
 418     A single record is returned by function
 419     <function>Z3950_resultset_record</function> that takes a
 420     position as argument. First record has position zero.
 421     If no record could be obtained <literal>NULL</literal> is returned.
 422    </para>
 423    <para>
 424     Function <function>Z3950_resultset_records</function> retrieves
 425     a number of records from a result set. Parameter <literal>start</literal>
 426     and <literal>count</literal> specifies the range of records to
 427     be returned. Upon completion array
 428     <literal>recs[0], ..recs[count-1]</literal>
 429     holds record objects for the records. The array of records
 430      <literal>recs</literal> should be allocate prior to calling
 431     <function>Z3950_resultset_records</function>. Note that for those
 432     records that couldn't be retrieved from the target
 433     <literal>recs[ ..]</literal> is set to <literal>NULL</literal>.
 434    </para>
 435    <para id="zoom.record.get">
 436     In order to extract information about a single record,
 437     <function>Z3950_record_get</function> is provided. The
 438     function returns a pointer to certain record information. The
 439     nature (type) of the pointer depends on the <function>type</function>
 440     given. In addition for certain types, the length
 441     <literal>len</literal> passed will be set to the size in bytes of
 442     the returned information.
 443     <variablelist>
 444      <varlistentry><term><literal>database</literal></term>
 445       <listitem><para>Database of record is returned
 446         as a C null-terminated string. Return type <literal>char *</literal>.
 447        </para></listitem>
 448       </varlistentry>
 449      <varlistentry><term><literal>syntax</literal></term>
 450       <listitem><para>The transfer syntax (OID) of the record is returned
 451         as a C null-terminated string. Return type <literal>char *</literal>.
 452        </para></listitem>
 453       </varlistentry>
 454      <varlistentry><term><literal>render</literal></term>
 455       <listitem><para>The record is returned in a display friendly
 456         format. Upon completion buffer is returned
 457         (type <literal>char *</literal>) and length is stored in
 458         <literal>*len</literal>.
 459        </para></listitem>
 460       </varlistentry>
 461      <varlistentry><term><literal>raw</literal></term>
 462       <listitem><para>The record is returned in the internal
 463         YAZ specific format. The raw data is returned as type
 464         <literal>Z_External *</literal> which is just the type for
 465         the member <literal>retrievalRecord</literal> in
 466         type <literal>NamePlusRecord</literal>.
 467        </para></listitem>
 468       </varlistentry>
 469     </variablelist>
 470    </para>
 471    <sect2><title>Protocol behavior</title>
 472     <para>
 473      The functions <function>Z3950_resultset_record</function> and
 474      <function>Z3950_resultset_records</function> inspects the client-side
 475      record cache. Records not found in cache are fetched using
 476      Present.
 477      The functions may block (and perform network I/O)  - even though option
 478      <literal>async</literal> is 1, because they return records objects.
 479      (and there's no way to return records objects without retrieving them!).
 480      </para>
 481     <para>
 482      There is a trick, however, in the usage of function
 483      <function>Z3950_resultset_records</function> that allows for
 484      delayed retrieval (and makes it non-blocking). By passing
 485      a null pointer for <parameter>recs</parameter> you're indicating
 486      you're not interested in getting records objects
 487      <emphasis>now</emphasis>.
 488     </para>
 489    </sect2>
 490   </sect1>
 491   <sect1 id="zoom.options"><title>Options</title>
 492    <para>
 493     Most &zoom; objects provide a way to specify options to change behavior.
 494     From an implementation point of view a set of options is just like
 495     an associative array / hash array, etc.
 496    </para>
 497    <synopsis>
 498      Z3950_options Z3950_options_create (void);
 499
 500      Z3950_options Z3950_options_create_with_parent (Z3950_options parent);
 501
 502      void Z3950_options_destroy (Z3950_options opt);
 503    </synopsis>
 504    <synopsis>
 505      const char *Z3950_options_get (Z3950_options opt, const char *name);
 506
 507      void Z3950_options_set (Z3950_options opt, const char *name,
 508                              const char *v);
 509    </synopsis>
 510    <synopsis>
 511      typedef const char *(*Z3950_options_callback)
 512                                      (void *handle, const char *name);
 513
 514      Z3950_options_callback
 515              Z3950_options_set_callback (Z3950_options opt,
 516                                          Z3950_options_callback c,
 517                                          void *handle);
 518    </synopsis>
 519   </sect1>
 520   <sect1 id="zoom.events"><title>Events</title>
 521    <para>
 522     If you're developing non-blocking applications, you have to deal
 523     with events.
 524    </para>
 525    <synopsis>
 526     int Z3950_event (int no, Z3950_connection *cs);
 527    </synopsis>
 528    <para>
 529     The <function>Z3950_event</function> executes pending events for
 530     a number of connections. Supply the number of connections in
 531     <literal>no</literal> and an array of connections in
 532     <literal>cs</literal> (<literal>cs[0] ... cs[no-1]</literal>).
 533     A pending event could be a sending a search, receiving a response,
 534     etc.
 535     When an event has a occured for one of the connections, this function
 536     returns a positive integer <literal>n</literal> denoting that an event
 537     occurred for connection <literal>cs[n-1]</literal>.
 538     When no events are pending for the connections, a value of zero is
 539     returned.
 540     To ensure that all outstanding requests are performed call this function
 541     repeatedly until zero is returned.
 542    </para>
 543   </sect1>
 544  </chapter>
 545
 546  <!-- Keep this comment at the end of the file
 547  Local variables:
 548  mode: sgml
 549  sgml-omittag:t
 550  sgml-shorttag:t
 551  sgml-minimize-attributes:nil
 552  sgml-always-quote-attributes:t
 553  sgml-indent-step:1
 554  sgml-indent-data:t
 555  sgml-parent-document: "yaz.xml"
 556  sgml-local-catalogs: nil
 557  sgml-namecase-general:t
 558  End:
 559  -->
 560