X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=doc%2Fz3950_client.xml;h=ff59c11f9eae8080d93607a31ccb54babe3ae66a;hb=259a989d5f7d9c966caa44f2bffc08ee3798e3a5;hp=a33e5fcd38b56e7cdbb1e1168c5876b0d365a5de;hpb=dac0c39ac77d0ed84af695020fa49dde6dd2940b;p=metaproxy-moved-to-github.git diff --git a/doc/z3950_client.xml b/doc/z3950_client.xml index a33e5fc..ff59c11 100644 --- a/doc/z3950_client.xml +++ b/doc/z3950_client.xml @@ -1,38 +1,138 @@ - + + %idcommon; ]> - - + + + Metaproxy + Index Data + + z3950_client 3mp - Metaproxy Module - - + Metaproxy Module + + z3950_client - backend module Z39.50 client + Metaproxy Z39.50 Backend Client Module - + DESCRIPTION - This backend filter is a Z39.50 client. + This backend filter is a Z39.50 client. This modules + proxies all Z39.50 packages to a target. HTTP packages are ignored. + The address of the backend target (host) can be given as part of the + Initialize Request (Virtual host) or the default target may be specified + in the configuration. + + + + connect-timeout + + + Specifies how long the client will wait for TCP connect to + complete before giving up. Default value is 30 seconds. + + + + init-timeout + + + Specifies how long the client will wait for Z39.50 Init response + before giving up. Default value is 10 seconds. + + + + timeout + + + Specifies how long the client will wait for any request other + than Init before giving up. Default value is 30 seconds. + + + + default_target + + + Specifies the target (host) for the Z39.50 server to be used + if the Init Request does not indicate otherwise. + + + + force_target + + + Specifies the target (host) for the Z39.50 server to be used + always (regardless of Init Request vhost). + + + + force_close + + + Is a boolean value (false, true). If true, the Z39.50 client will + terminate Z39.50 sessions with a close APDU followed by a socket close. + If false (default), the Z39.50 client will be transparent and only + send a close if the peer client does it too. + + + + client_ip + + + Is a boolean value (false, true). If true, the Z39.50 client will + as part of the Init Request include Client-IP information (the + Z39.50 equivalent of HTTP X-Forwarded-To information). By default + this is false (not included). + + + + charset + + + If set, holds Z39.50 negotiation charset (encoding) that is + sent via the Initialize Request. If Initalize Request already + contains negotaition information it will be left un-modified. + + + + bind_host + + + Is a boolean value (false, true). If true, the out going + TCP connection will be bound to the same as listening IP. + + + + - + + SCHEMA + + + + EXAMPLES A typical configuration looks like this: 30 + z3950.indexdata.com ]]> - - + + SEE ALSO @@ -47,21 +147,13 @@ - + ©right;