X-Git-Url: http://jsfdemo.indexdata.com/?a=blobdiff_plain;f=doc%2Fproxy.xml;h=efb9a1bbec18008490aaac5dfda72515c22925aa;hb=da58ec3f2b9c0e5d15e4a022e7072f573784f9eb;hp=d64d6cfe9ad23e136e43bfee7cf9f2b6742bad00;hpb=c2f14867d5abde02ffe548fb0e269aa37756915f;p=yazpp-moved-to-github.git diff --git a/doc/proxy.xml b/doc/proxy.xml index d64d6cf..efb9a1b 100644 --- a/doc/proxy.xml +++ b/doc/proxy.xml @@ -1,31 +1,31 @@ - + YAZ Proxy The YAZ proxy is a transparent Z39.50 to Z39.50 gateway. It is useful for debugging Z39.50 software, redirect - Z39.50 packages through firewalls, etc. + Z39.50 packages through fire walls, etc. - Furthermore, the proxy offers facilities that often - boost performance for "connection-less" Z39.50 clients such - as web gateways. + Furthermore, the proxy offers facilities that often boost + performance for stateless Z39.50 clients such as web gateways. Unlike most other "server" software the proxy runs single-threaded, single-process. Every I/O operation is non-blocking so it is light-weight and very fast. - It does not store "state" information on the hard drive + It does not store state information on the hard drive except the log files you want. -
Specifying the backend target +
+ Specifying the backend target When a Z39.50 client session is accepted by the proxy, the proxy determines the backend target by the following rules: If the Initialize Request PDU from the client - includes OtherInformation, with OID, + includes Other-Information, with OID 1.2.840.10003.10.1000.81.1, that specifies the target. @@ -43,7 +43,8 @@
-
Keep-alive facility for Stateless clients +
+ Keep-alive facility for Stateless clients Stateless clients may generate a cookie for a Z39.50 session which is sent to the proxy as part of PDUs. @@ -58,13 +59,14 @@ point of view should be considered stateless. - As for the target specification, the OtherInformation + As for the target specification, the Other-Information area is used to hold the cookie with OID 1.2.840.10003.10.1000.81.2.
-
Query Caching +
+ Query Caching Simple stateless clients often sends identical Z39.50 searches in a relatively short period of time (full-list, next-page, @@ -84,13 +86,16 @@
-
Other optimizations +
+ Other optimizations We've had some plans to support caching of result set records, but this had not yet been implemented.
-
Proxy usage + +
+ Proxy usage @@ -117,7 +122,7 @@ DESCRIPTION - The proxy is a daemon on its own and runs standalone (no + The proxy is a daemon on its own and runs stand-alone (no inetd support). The host:port specifies host address and listening port respectively. Use @ for ANY address. @@ -157,7 +162,7 @@ Sets level for optimization. Use zero to disable; non-zero to enable. Handling for this is not fully implemented; - we will probably use a bitmask to enable/disable specific + we will probably use a bit mask to enable/disable specific features. @@ -167,11 +172,11 @@ EXAMPLES The following starts the proxy so that it listens on port - 9000. The default backend target is LOC. + 9000. The default backend target is the LOC target. $ yaz-proxy -t z3950.loc.gov:7090 @:9000 - The LOC target is sometimes very slow. You can connect to + This target is sometimes very slow. You can connect to it using yaz-client as follows: $ yaz-client localhost:9000/voyager @@ -204,7 +209,8 @@ Elapsed: 0.001417 The YAZ client allows you to set the backend target in the Initialize Request using option -p. To connect to - Index Data's target you could use: + Index Data's target through a proxy on localhost, port 9000, + you could use: yaz-client -p indexdata.dk localhost:9000/gils