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   <info><orgname>Index Data</orgname></info>
  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>EXAMPLES</title>
  38   <para>
  39    A typical configuration looks like this:
  40    <screen><![CDATA[
  41     <filter type="bounce"/>
  42 ]]>
  43    </screen>
  44   </para>
  45  </refsect1>
  46
  47  <refsect1><title>SEE ALSO</title>
  48   <para>
  49    <citerefentry>
  50     <refentrytitle>metaproxy</refentrytitle>
  51     <manvolnum>1</manvolnum>
  52    </citerefentry>
  53   </para>
  54  </refsect1>
  55
  56  &copyright;
  57 </refentry>
  58
  59 <!-- Keep this comment at the end of the file
  60 Local variables:
  61 mode: sgml
  62 sgml-omittag:t
  63 sgml-shorttag:t
  64 sgml-minimize-attributes:nil
  65 sgml-always-quote-attributes:t
  66 sgml-indent-step:1
  67 sgml-indent-data:t
  68 sgml-parent-document:nil
  69 sgml-local-catalogs: nil
  70 sgml-namecase-general:t
  71 End:
  72 -->