X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=doc%2Fcomstack.xml;h=335eb0d6d045d6ba1f617cfd6bc84d3348a2abc7;hb=8d92137c228ec24df2d62a8039635bb8ad19558d;hp=4c2c6ba5811ac728fadc6c262dcf62755ff51134;hpb=d82eeac05d2899fa30704e2c40e9dd603ff2c581;p=yaz-moved-to-github.git diff --git a/doc/comstack.xml b/doc/comstack.xml index 4c2c6ba..335eb0d 100644 --- a/doc/comstack.xml +++ b/doc/comstack.xml @@ -1,4 +1,4 @@ - + The COMSTACK Module Synopsis (blocking mode) @@ -60,8 +60,8 @@ if (buf) The &comstack; subsystem provides a transparent interface to different types of transport - stacks for the exchange of BER-encoded data. At present, the - RFC1729 method (BER over TCP/IP), local UNIX socket and an + stacks for the exchange of BER-encoded data and HTTP packets. + At present, the RFC1729 method (BER over TCP/IP), local UNIX socket and an experimental SSL stack are supported, but others may be added in time. The philosophy of the module is to provide a simple interface by hiding unused options and @@ -115,16 +115,17 @@ if (buf) tcpip_type - TCP/IP (BER over TCP/IP) + TCP/IP (BER over TCP/IP or HTTP over TCP/IP) ssl_type Secure Socket Layer (SSL). This COMSTACK - is experimental and is not fully implemented. + is experimental and is not fully implemented. If + HTTP is used, this effectively is HTTPS. unix_type - Unix socket (unix only). Fast local transfer via + Unix socket (unix only). Local Transfer via file socket. See unix 7. @@ -137,7 +138,7 @@ if (buf) The blocking parameter should be one if you wish the association to operate in blocking mode, zero otherwise. The protocol field should be - PROTO_Z3950. + PROTO_Z3950 or PROTO_HTTP. Protocol PROTO_SR is no longer supported. @@ -186,7 +187,8 @@ if (buf) - Receives a PDU from the peer. Returns the number of bytes read. + Receives a PDU or HTTP Response from the peer. Returns the number of + bytes read. In nonblocking mode, it is possible that not all of the packet can be read at once. In this case, the function returns 1. To simplify the interface, the function is