1 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.4//EN"
2 "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
3 <!ENTITY copyright SYSTEM "copyright.xml">
4 <!ENTITY % idcommon SYSTEM "common/common.ent">
7 <refentry id="ref-z3950_client">
9 <productname>Metaproxy</productname>
10 <info><orgname>Index Data</orgname></info>
14 <refentrytitle>z3950_client</refentrytitle>
15 <manvolnum>3mp</manvolnum>
16 <refmiscinfo class="manual">Metaproxy Module</refmiscinfo>
20 <refname>z3950_client</refname>
21 <refpurpose>Metaproxy Z39.50 Backend Client Module</refpurpose>
24 <refsect1><title>DESCRIPTION</title>
26 This backend filter is a Z39.50 client. This modules
27 proxies all Z39.50 packages to a target. HTTP packages are ignored.
28 The address of the backend target (host) can be given as part of the
29 Initialize Request (Virtual host) or the default target may be specified
34 <varlistentry><term>connect-timeout</term>
37 Specifies how long the client will wait for TCP connect to
38 complete before giving up. Default value is 30 seconds.
42 <varlistentry><term>init-timeout</term>
45 Specifies how long the client will wait for Z39.50 Init response
46 before giving up. Default value is 10 seconds.
50 <varlistentry><term>timeout</term>
53 Specifies how long the client will wait for any request other
54 than Init before giving up. Default value is 30 seconds.
58 <varlistentry><term>default_target</term>
61 Specifies the target (host) for the Z39.50 server to be used
62 if the Init Request does not indicate otherwise.
66 <varlistentry><term>force_target</term>
69 Specifies the target (host) for the Z39.50 server to be used
70 always (regardless of Init Request vhost).
74 <varlistentry><term>force_close</term>
77 Is a boolean value (false, true). If true, the Z39.50 client will
78 terminate Z39.50 sessions with a close APDU followed by a socket close.
79 If false (default), the Z39.50 client will be transparent and only
80 send a close if the peer client does it too.
84 <varlistentry><term>client_ip</term>
87 Is a boolean value (false, true). If true, the Z39.50 client will
88 as part of the Init Request include Client-IP information (the
89 Z39.50 equivalent of HTTP X-Forwarded-To information). By default
90 this is false (not included).
94 <varlistentry><term>charset</term>
97 If set, holds Z39.50 negotiation charset (encoding) that is
98 sent via the Initialize Request. If Initalize Request already
99 contains negotaition information it will be left un-modified.
103 <varlistentry><term>bind_host</term>
106 Is a boolean value (false, true). If true, the out going
107 TCP connection will be bound to the same as listening IP.
115 <refsect1><title>SCHEMA</title>
116 <literallayout><xi:include
117 xi:href="../xml/schema/filter_z3950_client.rnc"
119 xmlns:xi="http://www.w3.org/2001/XInclude" />
123 <refsect1><title>EXAMPLES</title>
125 A typical configuration looks like this:
127 <filter type="z3950_client">
128 <timeout>30</timeout>
129 <default_target>z3950.indexdata.dk</default_target>
136 <refsect1><title>SEE ALSO</title>
139 <refentrytitle>metaproxy</refentrytitle>
140 <manvolnum>1</manvolnum>
145 <refentrytitle>backend_test</refentrytitle>
146 <manvolnum>3mp</manvolnum>
154 <!-- Keep this comment at the end of the file