OID documentation update.

[yaz-moved-to-github.git] / doc / asn.xml

diff --git a/doc/asn.xml b/doc/asn.xml
index 854bc0b..7f6208e 100644 (file)
--- a/doc/asn.xml
+++ b/doc/asn.xml
@@ -1,4 +1,4 @@
-<!-- $Id: asn.xml,v 1.13 2003-11-19 21:17:26 adam Exp $ -->
+<!-- $Id: asn.xml,v 1.19 2007-05-04 12:24:15 adam Exp $ -->
  <chapter id="asn"><title>The Z39.50 ASN.1 Module</title>
   <sect1 id="asn.introduction"><title>Introduction</title>
    <para>
@@ -132,7 +132,16 @@
     
    </para>
   </sect1>
-  <sect1 id="asn.oid"><title id="oid">Object Identifiers</title>
+  <sect1 id="asn.oid"><title>Object Identifiers (YAZ 2)</title>
+
+  <note>
+   <para>
+    This material only applies to version 2 series of YAZ. You need not
+    read this material if you are working with YAZ 3. 
+    See <xref linkend="tools.oid"/> for more information on OIDs.
+   </para>
+  </note>
+
   <para>
     When you refer to object identifiers in your application, you need to
     be aware that SR and Z39.50 use two different set of OIDs to refer to
@@ -271,7 +280,7 @@ typedef struct Z_External
    </para>
    
    <screen>
-   Z_ext_typeent *z_ext_gettypebyref(oid_value ref);
+   Z_ext_typeent *z_ext_gettypebyref(const oid *oid);
    </screen>
 
    <para>
@@ -285,7 +294,7 @@ typedef struct Z_External
    <screen>
 typedef struct Z_ext_typeent
 {
-    oid_value dref;    /* the direct-reference OID value. */
+    int oid[OID_SIZE]; /* the direct-reference OID. */
     int what;          /* discriminator value for the external CHOICE */
     Odr_fun fun;       /* decoder function */
 } Z_ext_typeent;
@@ -347,7 +356,8 @@ typedef struct Z_ext_typeent
     PDU, as well as their default settings.
    </para>
    
-   <table frame="top"><title>Default settings for PDU Initialize Request</title>
+   <table frame="top" id="asn.default.initialize.request">
+    <title>Default settings for PDU Initialize Request</title>
     <tgroup cols="3">
      <colspec colwidth="7*" colname="field"></colspec>
      <colspec colwidth="5*" colname="type"></colspec>
@@ -397,7 +407,8 @@ typedef struct Z_ext_typeent
    </tgroup>
   </table>
 
-  <table frame="top"><title>Default settings for PDU Initialize
+  <table frame="top" id="asn.default.initialize.response">
+    <title>Default settings for PDU Initialize
     Response</title>
    <tgroup cols="3">
      <colspec colwidth="7*" colname="field"></colspec>
@@ -448,7 +459,8 @@ typedef struct Z_ext_typeent
     </tgroup>
    </table>
 
-   <table frame="top"><title>Default settings for PDU Search Request</title>
+   <table frame="top" id="asn.default.search.request">
+    <title>Default settings for PDU Search Request</title>
     <tgroup cols="3">
      <colspec colwidth="7*" colname="field"></colspec>
      <colspec colwidth="5*" colname="type"></colspec>
@@ -510,7 +522,8 @@ typedef struct Z_ext_typeent
     </tgroup>
    </table>
 
-   <table frame="top"><title>Default settings for PDU Search Response</title>
+   <table frame="top" id="asn.default.search.response">
+    <title>Default settings for PDU Search Response</title>
     <tgroup cols="3">
      <colspec colwidth="7*" colname="field"></colspec>
      <colspec colwidth="5*" colname="type"></colspec>
@@ -559,7 +572,8 @@ typedef struct Z_ext_typeent
     </tgroup>
    </table>
 
-   <table frame="top"><title>Default settings for PDU Present Request</title>
+   <table frame="top" id="asn.default.present.request">
+    <title>Default settings for PDU Present Request</title>
     <tgroup cols="3">
      <colspec colwidth="7*" colname="field"></colspec>
      <colspec colwidth="5*" colname="type"></colspec>
@@ -612,7 +626,8 @@ typedef struct Z_ext_typeent
     </tgroup>
    </table>
    
-   <table frame="top"><title>Default settings for PDU Present Response</title>
+   <table frame="top" id="asn.default.present.response">
+    <title>Default settings for PDU Present Response</title>
     <tgroup cols="3">
      <colspec colwidth="7*" colname="field"></colspec>
      <colspec colwidth="5*" colname="type"></colspec>
@@ -635,7 +650,7 @@ typedef struct Z_ext_typeent
        nextResultSetPosition</entry><entry>int</entry><entry>0
        </entry></row>
       <row><entry>
-       presentStatus</entry><entry>int</entry><entry>Z_PRES_SUCCESS
+       presentStatus</entry><entry>int</entry><entry>Z_PresentStatus_success
        </entry></row>
       <row><entry>
        records</entry><entry>Z_Records</entry><entry>NULL
@@ -647,7 +662,8 @@ typedef struct Z_ext_typeent
     </tgroup>
    </table>
    
-   <table frame="top"><title>Default settings for Delete Result Set Request
+   <table frame="top" id="asn.default.delete.result.set.request">
+    <title>Default settings for Delete Result Set Request
     </title>
     <tgroup cols="3">
      <colspec colwidth="7*" colname="field"></colspec>
@@ -665,7 +681,7 @@ typedef struct Z_ext_typeent
        </entry><entry>Z_ReferenceId</entry><entry>NULL
        </entry></row>
       <row><entry>
-       deleteFunction</entry><entry>int</entry><entry>Z_DeleteRequest_list
+       deleteFunction</entry><entry>int</entry><entry>Z_DeleteResultSetRequest_list
        </entry></row>
       <row><entry>
        num_ids</entry><entry>int</entry><entry>0
@@ -680,7 +696,8 @@ typedef struct Z_ext_typeent
     </tgroup>
    </table>
 
-   <table frame="top"><title>Default settings for Delete Result Set Response
+   <table frame="top" id="asn.default.delete.result.set.response">
+    <title>Default settings for Delete Result Set Response
     </title>
     <tgroup cols="3">
      <colspec colwidth="7*" colname="field"></colspec>
@@ -725,7 +742,8 @@ typedef struct Z_ext_typeent
     </tgroup>
    </table>
 
-   <table frame="top"><title>Default settings for Scan Request
+   <table frame="top" id="asn.default.scan.request">
+    <title>Default settings for Scan Request
     </title>
     <tgroup cols="3">
      <colspec colwidth="7*" colname="field"></colspec>
@@ -770,7 +788,8 @@ typedef struct Z_ext_typeent
     </tgroup>
    </table>
 
-   <table frame="top"><title>Default settings for Scan Response
+   <table frame="top" id="asn.default.scan.response">
+    <title>Default settings for Scan Response
     </title>
     <tgroup cols="3">
      <colspec colwidth="7*" colname="field"></colspec>
@@ -813,8 +832,8 @@ typedef struct Z_ext_typeent
     </tgroup>
    </table>
 
-   <table frame="top"><title>Default settings for Trigger Resource
-     Control Request </title>
+   <table frame="top" id="asn.default.trigger.resource.control.request">
+    <title>Default settings for Trigger Resource Control Request </title>
     <tgroup cols="3">
      <colspec colwidth="7*" colname="field"></colspec>
      <colspec colwidth="5*" colname="type"></colspec>
@@ -849,8 +868,8 @@ typedef struct Z_ext_typeent
     </tgroup>
    </table>
 
-   <table frame="top"><title>Default settings for Resource
-     Control Request</title>
+   <table frame="top" id="asn.default.resource.control.request">
+    <title>Default settings for Resource Control Request</title>
     <tgroup cols="3">
      <colspec colwidth="7*" colname="field"></colspec>
      <colspec colwidth="5*" colname="type"></colspec>
@@ -889,8 +908,8 @@ typedef struct Z_ext_typeent
     </tgroup>
    </table>
 
-   <table frame="top"><title>Default settings for Resource
-     Control Response</title>
+   <table frame="top" id="asn.default.resource.control.response">
+    <title>Default settings for Resource Control Response</title>
     <tgroup cols="3">
      <colspec colwidth="7*" colname="field"></colspec>
      <colspec colwidth="5*" colname="type"></colspec>
@@ -920,8 +939,8 @@ typedef struct Z_ext_typeent
     </tgroup>
    </table>
    
-   <table frame="top"><title>Default settings for Access
-     Control Request</title>
+   <table frame="top" id="asn.default.access.control.request">
+    <title>Default settings for Access Control Request</title>
     <tgroup cols="3">
      <colspec colwidth="7*" colname="field"></colspec>
      <colspec colwidth="5*" colname="type"></colspec>
@@ -951,8 +970,8 @@ typedef struct Z_ext_typeent
     </tgroup>
    </table>
 
-   <table frame="top"><title>Default settings for Access
-     Control Response</title>
+   <table frame="top" id="asn.default.access.control.response">
+    <title>Default settings for Access Control Response</title>
     <tgroup cols="3">
      <colspec colwidth="7*" colname="field"></colspec>
      <colspec colwidth="5*" colname="type"></colspec>
@@ -985,7 +1004,8 @@ typedef struct Z_ext_typeent
     </tgroup>
    </table>
 
-   <table frame="top"><title>Default settings for Segment</title>
+   <table frame="top" id="asn.default.segment">
+    <title>Default settings for Segment</title>
     <tgroup cols="3">
      <colspec colwidth="7*" colname="field"></colspec>
      <colspec colwidth="5*" colname="type"></colspec>
@@ -1017,7 +1037,8 @@ typedef struct Z_ext_typeent
     </tgroup>
    </table>
 
-   <table frame="top"><title>Default settings for Close</title>
+   <table frame="top" id="asn.default.close">
+    <title>Default settings for Close</title>
     <tgroup cols="3">
      <colspec colwidth="7*" colname="field"></colspec>
      <colspec colwidth="5*" colname="type"></colspec>