doc/bounce.xml

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