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  <refentryinfo>
   9   <productname>Metaproxy</productname>
  10   <orgname>Index Data</orgname>
  11  </refentryinfo>
  12
  13  <refmeta>
  14   <refentrytitle>frontend_net</refentrytitle>
  15   <manvolnum>3mp</manvolnum>
  16   <refmiscinfo class="manual">Metaproxy Module</refmiscinfo>
  17  </refmeta>
  18
  19  <refnamediv>
  20   <refname>frontend_net</refname>
  21   <refpurpose>Metaproxy Network Server module that accepts Z39.50 and
  22   HTTP requests</refpurpose>
  23  </refnamediv>
  24
  25  <refsect1><title>DESCRIPTION</title>
  26   <para>
  27    This is a frontend module. Listens on one or more ports and
  28    sends HTTP/Z39.50 messages to other filters.
  29   </para>
  30  </refsect1>
  31
  32  <refsect1><title>CONFIGURATION</title>
  33   <para>
  34    Element <literal>port</literal> is a repeating element (1 or more). The
  35    text content specifies a listening port.
  36   </para>
  37   <para>
  38    Element <literal>threads</literal> is an optional element. The
  39    text content specifies number of worker threads for the following
  40    filters to use. The default value is 5 (5 worker threads).
  41   </para>
  42   <para>
  43    Element <literal>timeout</literal> is an optional element. The
  44    text content is treated as an integer that specifies the session timeout
  45    in seconds for a client session (using the frontend net filter). The
  46    default value is 300 (5 minutes).
  47   </para>
  48   <para>
  49    Element <literal>connect-max</literal> is an optional element. The
  50    text content is treated as an integer that specifies maximum number
  51    of TCP sessions from the same original IP. The special value 0 means
  52    : no connection limit. This is also the default if this element is omitted.
  53   </para>
  54   <para>
  55    Element <literal>message</literal> is an optional element. If
  56    given and non-empty logging is performed by the frontend_net filter
  57    (to the log file as given ny option -l).
  58   </para>
  59   <para>
  60    Element <literal>stat-req</literal> is an optional element. It
  61    specifies a URL path that triggers a report to be generated by
  62    the frontend_net filter. By default this report is disabled (same
  63    as empty value). The value itself is the path and should be prefixed
  64    with a slash. For example <literal>/fn_stat</literal>.
  65   </para>
  66  </refsect1>
  67
  68  <refsect1><title>SCHEMA</title>
  69    <literallayout><xi:include
  70                      xi:href="../xml/schema/filter_frontend_net.rnc"
  71                      xi:parse="text"
  72                      xmlns:xi="http://www.w3.org/2001/XInclude" />
  73    </literallayout>
  74  </refsect1>
  75
  76  <refsect1><title>EXAMPLES</title>
  77   <para>
  78    A typical configuration looks like this:
  79    <screen><![CDATA[
  80     <filter type="frontend_net">
  81      <threads>10</threads>
  82      <port>@:9000</port>
  83      <message>FN</message>
  84      <stat-req>/fn_stat</stat-req>
  85     </filter>
  86 ]]>
  87    </screen>
  88   </para>
  89  </refsect1>
  90
  91  <refsect1><title>SEE ALSO</title>
  92   <para>
  93    <citerefentry>
  94     <refentrytitle>metaproxy</refentrytitle>
  95     <manvolnum>1</manvolnum>
  96    </citerefentry>
  97   </para>
  98  </refsect1>
  99
 100  &copyright;
 101 </refentry>
 102
 103 <!-- Keep this comment at the end of the file
 104 Local variables:
 105 mode: nxml
 106 nxml-child-indent: 1
 107 End:
 108 -->