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-frontend_net">
9 <productname>Metaproxy</productname>
10 <info><orgname>Index Data</orgname></info>
14 <refentrytitle>frontend_net</refentrytitle>
15 <manvolnum>3mp</manvolnum>
16 <refmiscinfo class="manual">Metaproxy Module</refmiscinfo>
20 <refname>frontend_net</refname>
21 <refpurpose>Metaproxy Network Server module that accepts Z39.50 and
22 HTTP requests</refpurpose>
25 <refsect1><title>DESCRIPTION</title>
27 This is a frontend module. Listens on one or more ports and
28 sends HTTP/Z39.50 messages to other filters.
32 <refsect1><title>CONFIGURATION</title>
34 Element <literal>port</literal> is a repeating element (1 or more). The
35 text content specifies a listening port.
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).
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).
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.
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).
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>.
68 <refsect1><title>SCHEMA</title>
69 <literallayout><xi:include
70 xi:href="../xml/schema/filter_frontend_net.rnc"
72 xmlns:xi="http://www.w3.org/2001/XInclude" />
76 <refsect1><title>EXAMPLES</title>
78 A typical configuration looks like this:
80 <filter type="frontend_net">
84 <stat-req>/fn_stat</stat-req>
91 <refsect1><title>SEE ALSO</title>
94 <refentrytitle>metaproxy</refentrytitle>
95 <manvolnum>1</manvolnum>
103 <!-- Keep this comment at the end of the file