X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=doc%2Fintroduction.xml;h=3ef6a0bf10baf07aa467aad10e979f7df61d797e;hb=10e81e043068151fd32d623ace21222ab6c91ea3;hp=f531c749cab6f4dbce4a087b8602d4254f52b3fa;hpb=bd7e251dac1b07c54884d26295f66b90cfb23131;p=yaz-moved-to-github.git diff --git a/doc/introduction.xml b/doc/introduction.xml index f531c74..3ef6a0b 100644 --- a/doc/introduction.xml +++ b/doc/introduction.xml @@ -1,4 +1,4 @@ - + Introduction @@ -56,16 +56,21 @@ specification of the protocol (generally Z39.50-1995). In the case of base types (those originating in the ASN.1 standard itself), the prefix Odr_ is sometimes seen. Either way, look for - the actual definition in either proto.h (for the types + the actual definition in either z-core.h (for the types from the protocol), odr.h (for the primitive ASN.1 - types, or odr_use.h (for the ASN.1 - useful types). The &asn; library also - provides functions (which are, in turn, defined using &odr; - primitives) for encoding and decoding data values. Their general form is + types). + The &asn; library also provides functions (which are, in turn, + defined using &odr; primitives) for encoding and decoding data values. + Their general form is - - int z_xxx(ODR o, Z_xxx **p, int optional, const char *name); - + + int z_xxx + ODR o + Z_xxx **p + int optional + const char *name + + (note the lower-case "z" in the function name) @@ -85,7 +90,7 @@ (passively or actively, depending on the role of your application), and for exchanging BER-encoded PDUs over that connection. When you create a connection endpoint, you need to specify what transport to - use (TCP/IP or SSL). + use (TCP/IP, SSL or UNIX sockets). For the remainder of the connection's lifetime, you don't have to worry about the underlying transport protocol at all - the &comstack; will ensure that the correct mechanism is used. @@ -104,8 +109,8 @@ can use SNACC or BERUtils instead, and still have the benefits of the transparent transport approach of the &comstack; module. Secondly, we realize that you may have to fit the toolkit into an existing - event-processing structure, in a way that - is incompatible with the &comstack; interface or some other part of &yaz;. + event-processing structure, in a way that is incompatible with + the &comstack; interface or some other part of &yaz;.