doc/frontend_net.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-frontend_net">
   8  <refmeta>
   9   <refentrytitle>frontend_net</refentrytitle>
  10   <manvolnum>3mp</manvolnum>
  11    <refmiscinfo>Metaproxy Module</refmiscinfo>
  12 </refmeta>
  13
  14  <refnamediv>
  15   <refname>frontend_net</refname>
  16   <refpurpose>Metaproxy Network Server module that accepts Z39.50 and
  17   HTTP requests</refpurpose>
  18  </refnamediv>
  19
  20  <refsect1><title>DESCRIPTION</title>
  21   <para>
  22    This is a frontend module. Listens on one or more ports and
  23    sends HTTP/Z39.50 messages to other filters.
  24   </para>
  25  </refsect1>
  26
  27  <refsect1><title>CONFIGURATION</title>
  28   <para>
  29    Element <literal>port</literal> is a repeating element (1 or more). The
  30    text content specifies a listening port.
  31   </para>
  32   <para>
  33    Element <literal>threads</literal> is an optional element. The
  34    text content specifies number of worker threads for the following
  35    filters to use. The default value is 5 (5 worker threads).
  36   </para>
  37   <para>
  38    Element <literal>timeout</literal> is an optional element. The
  39    text content is treated as an integer that specifies the session timeout
  40    in seconds for a client session (using the frontend net filter). The
  41    default value is 300 (5 minutes).
  42   </para>
  43   <para>
  44    Element <literal>connect-max</literal> is an optional element. The
  45    text content is treated as an integer that specifies maximum number
  46    of TCP sessions from the same original IP. The special value 0 means
  47    : no connection limit. This is also the default if this element is omitted.
  48   </para>
  49  </refsect1>
  50
  51  <refsect1><title>EXAMPLES</title>
  52   <para>
  53    A typical configuration looks like this:
  54    <screen><![CDATA[
  55     <filter type="frontend_net">
  56      <port>@:9000</port>
  57      <threads>10</threads>
  58     </filter>
  59 ]]>
  60    </screen>
  61   </para>
  62  </refsect1>
  63
  64  <refsect1><title>SEE ALSO</title>
  65   <para>
  66    <citerefentry>
  67     <refentrytitle>metaproxy</refentrytitle>
  68     <manvolnum>1</manvolnum>
  69    </citerefentry>
  70   </para>
  71  </refsect1>
  72
  73  &copyright;
  74 </refentry>
  75
  76 <!-- Keep this comment at the end of the file
  77 Local variables:
  78 mode: sgml
  79 sgml-omittag:t
  80 sgml-shorttag:t
  81 sgml-minimize-attributes:nil
  82 sgml-always-quote-attributes:t
  83 sgml-indent-step:1
  84 sgml-indent-data:t
  85 sgml-parent-document:nil
  86 sgml-local-catalogs: nil
  87 sgml-namecase-general:t
  88 End:
  89 -->