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>timeout</term>
37 Specifies how long the client will wait for any request
38 before giving up. Default value is 30 seconds.
42 <varlistentry><term>default_target</term>
45 Specifies the target (host) for the Z39.50 server to be used
46 if the Init Request does not indicate otherwise.
50 <varlistentry><term>force_target</term>
53 Specifies the target (host) for the Z39.50 server to be used
54 always (regardless of Init Request vhost).
58 <varlistentry><term>force_close</term>
61 Is a boolean value (false, true). If true, the Z39.50 client will
62 terminate Z39.50 sessions with a close APDU followed by a socket close.
63 If false (default), the Z39.50 client will be transparent and only
64 send a close if the peer client does it too.
68 <varlistentry><term>client_ip</term>
71 Is a boolean value (false, true). If true, the Z39.50 client will
72 as part of the Init Request include Client-IP information (the
73 Z39.50 equivalent of HTTP X-Forwarded-To information). By default
74 this is false (not included).
78 <varlistentry><term>charset</term>
81 If set, holds Z39.50 negotiation charset (encoding) that is
82 sent via the Initialize Request. If Initalize Request already
83 contains negotaition information it will be left un-modified.
87 <varlistentry><term>bind_host</term>
90 Is a boolean value (false, true). If true, the out going
91 TCP connection will be bound to the same as listening IP.
99 <refsect1><title>SCHEMA</title>
100 <literallayout><xi:include
101 xi:href="../xml/schema/filter_z3950_client.rnc"
103 xmlns:xi="http://www.w3.org/2001/XInclude" />
107 <refsect1><title>EXAMPLES</title>
109 A typical configuration looks like this:
111 <filter type="z3950_client">
112 <timeout>30</timeout>
113 <default_target>z3950.indexdata.dk</default_target>
120 <refsect1><title>SEE ALSO</title>
123 <refentrytitle>metaproxy</refentrytitle>
124 <manvolnum>1</manvolnum>
129 <refentrytitle>backend_test</refentrytitle>
130 <manvolnum>3mp</manvolnum>
138 <!-- Keep this comment at the end of the file