doc/z3950_client.xml

   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">
   5      %idcommon;
   6 ]>
   7 <refentry id="ref-z3950_client">
   8  <refentryinfo>
   9   <productname>Metaproxy</productname>
  10   <info><orgname>Index Data</orgname></info>
  11  </refentryinfo>
  12
  13  <refmeta>
  14   <refentrytitle>z3950_client</refentrytitle>
  15   <manvolnum>3mp</manvolnum>
  16   <refmiscinfo class="manual">Metaproxy Module</refmiscinfo>
  17  </refmeta>
  18
  19  <refnamediv>
  20   <refname>z3950_client</refname>
  21   <refpurpose>Metaproxy Z39.50 Backend Client Module</refpurpose>
  22  </refnamediv>
  23
  24  <refsect1><title>DESCRIPTION</title>
  25   <para>
  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
  30    in the configuration.
  31   </para>
  32   <para>
  33    <variablelist>
  34     <varlistentry><term>connect-timeout</term>
  35      <listitem>
  36       <para>
  37        Specifies how long the client will wait for TCP connect to
  38        complete before giving up. Default value is 30 seconds.
  39       </para>
  40      </listitem>
  41     </varlistentry>
  42     <varlistentry><term>init-timeout</term>
  43      <listitem>
  44       <para>
  45        Specifies how long the client will wait for Z39.50 Init response
  46        before giving up. Default value is 10 seconds.
  47       </para>
  48      </listitem>
  49     </varlistentry>
  50     <varlistentry><term>timeout</term>
  51      <listitem>
  52       <para>
  53        Specifies how long the client will wait for any request other
  54        than Init before giving up. Default value is 30 seconds.
  55       </para>
  56      </listitem>
  57     </varlistentry>
  58     <varlistentry><term>default_target</term>
  59      <listitem>
  60       <para>
  61        Specifies the target (host) for the Z39.50 server to be used
  62        if the Init Request does not indicate otherwise.
  63       </para>
  64      </listitem>
  65     </varlistentry>
  66     <varlistentry><term>force_target</term>
  67      <listitem>
  68       <para>
  69        Specifies the target (host) for the Z39.50 server to be used
  70        always (regardless of Init Request vhost).
  71       </para>
  72      </listitem>
  73     </varlistentry>
  74     <varlistentry><term>force_close</term>
  75      <listitem>
  76       <para>
  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.
  81       </para>
  82      </listitem>
  83     </varlistentry>
  84     <varlistentry><term>client_ip</term>
  85      <listitem>
  86       <para>
  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).
  91       </para>
  92      </listitem>
  93     </varlistentry>
  94     <varlistentry><term>charset</term>
  95      <listitem>
  96       <para>
  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.
 100       </para>
 101      </listitem>
 102     </varlistentry>
 103     <varlistentry><term>bind_host</term>
 104      <listitem>
 105       <para>
 106        Is a boolean value (false, true). If true, the out going
 107        TCP connection will be bound to the same as listening IP.
 108       </para>
 109      </listitem>
 110     </varlistentry>
 111    </variablelist>
 112   </para>
 113  </refsect1>
 114
 115  <refsect1><title>SCHEMA</title>
 116    <literallayout><xi:include
 117                      xi:href="../xml/schema/filter_z3950_client.rnc"
 118                      xi:parse="text"
 119                      xmlns:xi="http://www.w3.org/2001/XInclude" />
 120    </literallayout>
 121  </refsect1>
 122
 123  <refsect1><title>EXAMPLES</title>
 124   <para>
 125    A typical configuration looks like this:
 126    <screen><![CDATA[
 127     <filter type="z3950_client">
 128      <timeout>30</timeout>
 129      <default_target>z3950.indexdata.dk</default_target>
 130     </filter>
 131 ]]>
 132    </screen>
 133   </para>
 134  </refsect1>
 135
 136  <refsect1><title>SEE ALSO</title>
 137   <para>
 138    <citerefentry>
 139     <refentrytitle>metaproxy</refentrytitle>
 140     <manvolnum>1</manvolnum>
 141    </citerefentry>
 142   </para>
 143   <para>
 144    <citerefentry>
 145     <refentrytitle>backend_test</refentrytitle>
 146     <manvolnum>3mp</manvolnum>
 147    </citerefentry>
 148   </para>
 149  </refsect1>
 150
 151  &copyright;
 152 </refentry>
 153
 154 <!-- Keep this comment at the end of the file
 155 Local variables:
 156 mode: nxml
 157 nxml-child-indent: 1
 158 End:
 159 -->