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