dependencies/yaz_3.0.14/doc/odr.html

   1 <html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>Chapter 10. The ODR Module</title><meta name="generator" content="DocBook XSL Stylesheets V1.73.2"><link rel="start" href="index.html" title="YAZ User's Guide and Reference"><link rel="up" href="index.html" title="YAZ User's Guide and Reference"><link rel="prev" href="tools.retrieval.html" title="6. Retrieval Facility"><link rel="next" href="odr.use.html" title="2. Using ODR"></head><body><link rel="stylesheet" type="text/css" href="common/style1.css"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Chapter 10. The ODR Module</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="tools.retrieval.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="odr.use.html">Next</a></td></tr></table><hr></div><div class="chapter" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="odr"></a>Chapter 10. The ODR Module</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="sect1"><a href="odr.html#odr.introduction">1. Introduction</a></span></dt><dt><span class="sect1"><a href="odr.use.html">2. Using ODR</a></span></dt><dd><dl><dt><span class="sect2"><a href="odr.use.html#odr.streams">2.1. ODR Streams</a></span></dt><dt><span class="sect2"><a href="odr.use.html#odr.memory.management">2.2. Memory Management</a></span></dt><dt><span class="sect2"><a href="odr.use.html#odr.encoding.and.decoding">2.3. Encoding and Decoding Data</a></span></dt><dt><span class="sect2"><a href="odr.use.html#odr.printing">2.4. Printing</a></span></dt><dt><span class="sect2"><a href="odr.use.html#odr.diagnostics">2.5. Diagnostics</a></span></dt><dt><span class="sect2"><a href="odr.use.html#odr.summary.and.synopsis">2.6. Summary and Synopsis</a></span></dt></dl></dd><dt><span class="sect1"><a href="odr.programming.html">3. Programming with ODR</a></span></dt><dd><dl><dt><span class="sect2"><a href="odr.programming.html#odr.primitive.asn1.types">3.1. The Primitive ASN.1 Types</a></span></dt><dd><dl><dt><span class="sect3"><a href="odr.programming.html#odr.integer">3.1.1. INTEGER</a></span></dt><dt><span class="sect3"><a href="odr.programming.html#odr.boolean">3.1.2. BOOLEAN</a></span></dt><dt><span class="sect3"><a href="odr.programming.html#odr.real">3.1.3. REAL</a></span></dt><dt><span class="sect3"><a href="odr.programming.html#odr.null">3.1.4. NULL</a></span></dt><dt><span class="sect3"><a href="odr.programming.html#odr.octet.string">3.1.5. OCTET STRING</a></span></dt><dt><span class="sect3"><a href="odr.programming.html#odr.bit.string">3.1.6. BIT STRING</a></span></dt><dt><span class="sect3"><a href="odr.programming.html#odr.object.identifier">3.1.7. OBJECT IDENTIFIER</a></span></dt></dl></dd><dt><span class="sect2"><a href="odr.programming.html#odr.tagging.primitive.types">3.2. Tagging Primitive Types</a></span></dt><dt><span class="sect2"><a href="odr.programming.html#odr.constructed.types">3.3. Constructed Types</a></span></dt><dt><span class="sect2"><a href="odr.programming.html#odr.tagging.constructed.types">3.4. Tagging Constructed Types</a></span></dt><dd><dl><dt><span class="sect3"><a href="odr.programming.html#odr.implicit.tagging">3.4.1. Implicit Tagging</a></span></dt><dt><span class="sect3"><a href="odr.programming.html#odr.explicit.tagging">3.4.2. Explicit Tagging</a></span></dt></dl></dd><dt><span class="sect2"><a href="odr.programming.html#odr.sequence.of">3.5. SEQUENCE OF</a></span></dt><dt><span class="sect2"><a href="odr.programming.html#odr.choice.types">3.6. CHOICE Types</a></span></dt></dl></dd><dt><span class="sect1"><a href="odr.debugging.html">4. Debugging</a></span></dt></dl></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="odr.introduction"></a>1. Introduction</h2></div></div></div><p>
   2      <acronym class="acronym">ODR</acronym> is the BER-encoding/decoding subsystem of YAZ. Care as been taken
   3     to isolate <acronym class="acronym">ODR</acronym> from the rest of the package - specifically from the
   4     transport interface. <acronym class="acronym">ODR</acronym> may be used in any context where basic
   5     ASN.1/BER representations are used.
   6    </p><p>
   7     If you are only interested in writing a Z39.50 implementation based on
   8     the PDUs that are already provided with YAZ, you only need to concern
   9     yourself with the section on managing ODR streams
  10     (<a class="xref" href="odr.use.html" title="2. Using ODR">Section 2, &#8220;Using ODR&#8221;</a>). Only if you need to
  11     implement ASN.1 beyond that which has been provided, should you
  12     worry about the second half of the documentation
  13     (<a class="xref" href="odr.programming.html" title="3. Programming with ODR">Section 3, &#8220;Programming with ODR&#8221;</a>).
  14     If you use one of the higher-level interfaces, you can skip this
  15     section entirely.
  16    </p><p>
  17     This is important, so we'll repeat it for emphasis: <span class="emphasis"><em>You do
  18      not need to read <a class="xref" href="odr.programming.html" title="3. Programming with ODR">Section 3, &#8220;Programming with ODR&#8221;</a>
  19      to implement Z39.50 with YAZ.</em></span>
  20    </p><p>
  21     If you need a part of the protocol that isn't already in YAZ, you
  22     should contact the authors before going to work on it yourself: We
  23     might already be working on it. Conversely, if you implement a useful
  24     part of the protocol before us, we'd be happy to include it in a
  25     future release.
  26    </p></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="tools.retrieval.html">Prev</a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="odr.use.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">6. Retrieval Facility </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> 2. Using ODR</td></tr></table></div></body></html>