doc/bounce.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-bounce">
   8  <refentryinfo>
   9   <productname>Metaproxy</productname>
  10   <orgname>Index Data</orgname>
  11  </refentryinfo>
  12
  13  <refmeta>
  14   <refentrytitle>bounce</refentrytitle>
  15   <manvolnum>3mp</manvolnum>
  16   <refmiscinfo class="manual">Metaproxy Module</refmiscinfo>
  17  </refmeta>
  18
  19  <refnamediv>
  20   <refname>bounce</refname>
  21   <refpurpose>Metaproxy Bouncing Package Sink Module for all kind of metaproxy packages</refpurpose>
  22  </refnamediv>
  23
  24  <refsect1><title>DESCRIPTION</title>
  25   <para>
  26    A sink that swallows all packages, and returns them almost
  27    unprocessed. It never sends any package of any type further down
  28    the row, but sets Z39.50 packages to Z_Close, and HTTP_Request
  29    packages to HTTP_Response err code 400 packages, and adds a
  30    suitable bounce message. The bounce filter is added at the end of
  31    filter routes to prevent infinite hanging of yet unprocessed
  32    packages. When a package is bounced, the client connection is
  33    closed as well.
  34   </para>
  35  </refsect1>
  36
  37  <refsect1><title>SCHEMA</title>
  38    <literallayout><xi:include
  39                      xi:href="../xml/schema/filter_bounce.rnc"
  40                      xi:parse="text"
  41                      xmlns:xi="http://www.w3.org/2001/XInclude" />
  42    </literallayout>
  43  </refsect1>
  44
  45  <refsect1><title>EXAMPLES</title>
  46   <para>
  47    A typical configuration looks like this:
  48    <screen><![CDATA[
  49     <filter type="bounce"/>
  50 ]]>
  51    </screen>
  52   </para>
  53  </refsect1>
  54
  55  <refsect1><title>SEE ALSO</title>
  56   <para>
  57    <citerefentry>
  58     <refentrytitle>metaproxy</refentrytitle>
  59     <manvolnum>1</manvolnum>
  60    </citerefentry>
  61   </para>
  62  </refsect1>
  63
  64  &copyright;
  65 </refentry>
  66
  67 <!-- Keep this comment at the end of the file
  68 Local variables:
  69 mode: nxml
  70 nxml-child-indent: 1
  71 End:
  72 -->