X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=doc%2Fasn.xml;h=9ef1576dce11a8faaf916049551784b88a1316ea;hb=df6700d5c88cff54c491ad2a1ae7d8426f92f044;hp=3f378c42a83694c0acc381ccea01bf0200b26cde;hpb=33c05384cfbca55da4ff97e5b2047b16596c72f7;p=yaz-moved-to-github.git diff --git a/doc/asn.xml b/doc/asn.xml index 3f378c4..9ef1576 100644 --- a/doc/asn.xml +++ b/doc/asn.xml @@ -1,9 +1,9 @@ - - The ASN Module + + The Z39.50 ASN.1 Module Introduction The &asn; module provides you with a set of C struct definitions for the - various PDUs of the protocol, as well as for the complex types + various PDUs of the Z39.50 protocol, as well as for the complex types appearing within the PDUs. For the primitive data types, the C representation often takes the form of an ordinary C language type, such as int. For ASN.1 constructs that have no direct @@ -11,6 +11,13 @@ the &odr; module (see section The ODR Module) provides auxiliary definitions. + + The &asn; module is located in sub directory z39.50. + There you'll find C files that implements encoders and decoders for the + Z39.50 types. You'll also find the protocol definitions: + z3950v3.asn, esupdate.asn, + and others. + Preparing PDUs @@ -47,8 +54,8 @@ structure before freeing the structure itself. - You can use the odr_malloc() function (see section - Using ODR for details). When you use + You can use the odr_malloc() function (see + for details). When you use odr_malloc(), you can release all of the allocated data in a single operation, independent of any pointers and relations between the data. odr_malloc() is based on a @@ -125,7 +132,7 @@ - Object Identifiers + Object Identifiers 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 @@ -301,8 +308,8 @@ typedef struct Z_ext_typeent z_ext_gettypebyref to look for the provided direct-reference. If the return value is different from NULL, you can use the provided - function to decode the BER string (see section - Using ODR). + function to decode the BER string (see + ). @@ -372,10 +379,10 @@ typedef struct Z_ext_typeent idAuthenticationZ_IdAuthenticationNULL - implementationIdchar*"YAZ (id=81)" + implementationIdchar*"81" - implementationNamechar*"Index Data/YAZ" + implementationNamechar*"YAZ" implementationVersionchar*YAZ_VERSION @@ -423,10 +430,10 @@ typedef struct Z_ext_typeent resultbool_tTRUE - implementationIdchar*"YAZ (id=81)" + implementationIdchar*"id)" - implementationNamechar*"Index Data/YAZ" + implementationNamechar*"YAZ" implementationVersionchar*YAZ_VERSION @@ -628,7 +635,7 @@ typedef struct Z_ext_typeent nextResultSetPositionint0 - presentStatusintZ_PRES_SUCCESS + presentStatusintZ_PresentStatus_success recordsZ_RecordsNULL @@ -658,7 +665,7 @@ typedef struct Z_ext_typeent Z_ReferenceIdNULL - deleteFunctionintZ_DeleteRequest_list + deleteFunctionintZ_DeleteResultSetRequest_list num_idsint0 @@ -1060,7 +1067,7 @@ typedef struct Z_ext_typeent sgml-indent-step:1 sgml-indent-data:t sgml-parent-document: "yaz.xml" - sgml-local-catalogs: "../../docbook/docbook.cat" + sgml-local-catalogs: nil sgml-namecase-general:t End: -->