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  <refmeta>
   9   <refentrytitle>bounce</refentrytitle>
  10   <manvolnum>3mp</manvolnum>
  11   <refmiscinfo>Metaproxy Module</refmiscinfo>
  12  </refmeta>
  13
  14  <refnamediv>
  15   <refname>bounce</refname>
  16   <refpurpose>Metaproxy Bouncing Package Sink Module for all kind of metaproxy packages</refpurpose>
  17  </refnamediv>
  18
  19  <refsect1><title>DESCRIPTION</title>
  20   <para>
  21    A sink that swallows all packages, and returns them almost
  22    unprocessed. It never sends any package of any type further down
  23    the row, but sets Z39.50 packages to Z_Close, and HTTP_Request
  24    packages to HTTP_Response err code 400 packages, and adds a
  25    suitable bounce message. The bounce filter is added at the end of
  26    filter routes to prevent infinite hanging of yet unprocessed
  27    packages. When a package is bounced, the client connection is
  28    closed as well.
  29   </para>
  30  </refsect1>
  31
  32  <refsect1><title>EXAMPLES</title>
  33   <para>
  34    A typical configuration looks like this:
  35    <screen><![CDATA[
  36     <filter type="bounce"/>
  37 ]]>
  38    </screen>
  39   </para>
  40  </refsect1>
  41
  42  <refsect1><title>SEE ALSO</title>
  43   <para>
  44    <citerefentry>
  45     <refentrytitle>metaproxy</refentrytitle>
  46     <manvolnum>1</manvolnum>
  47    </citerefentry>
  48   </para>
  49  </refsect1>
  50
  51  &copyright;
  52 </refentry>
  53
  54 <!-- Keep this comment at the end of the file
  55 Local variables:
  56 mode: sgml
  57 sgml-omittag:t
  58 sgml-shorttag:t
  59 sgml-minimize-attributes:nil
  60 sgml-always-quote-attributes:t
  61 sgml-indent-step:1
  62 sgml-indent-data:t
  63 sgml-parent-document:nil
  64 sgml-local-catalogs: nil
  65 sgml-namecase-general:t
  66 End:
  67 -->