doc/limit.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-limit">
   8  <refmeta>
   9   <refentrytitle>limit</refentrytitle>
  10   <manvolnum>3mp</manvolnum>
  11   <refmiscinfo>Metaproxy Module</refmiscinfo>
  12  </refmeta>
  13
  14  <refnamediv>
  15   <refname>limit</refname>
  16   <refpurpose> Metaproxy Module for imposing resource limits </refpurpose>
  17  </refnamediv>
  18
  19  <refsect1><title>DESCRIPTION</title>
  20   <para>
  21    This filter offers a way to limit access for a single session to
  22    a resource (target) in order to obtain a fair resource sharing.
  23   </para>
  24   <para>
  25    The limit section specifies bandwidth/pdu requests limits for an active
  26    session. The filter records bandwidth/pdu requests during the last 60
  27    seconds (1 minute). The limit may include the elements bandwidth, pdu,
  28    retrieve and search. The bandwidth measures the number of bytes
  29    transferred within the last minute. The pdu is the number of requests
  30    in the last minute. The retrieve holds the maximum records to which may
  31    be retrieved in one Present Request.
  32    The search is the maximum number of searches within the last minute.
  33   </para>
  34  </refsect1>
  35
  36  <refsect1><title>SCHEMA</title>
  37    <literallayout><xi:include
  38                      xi:href="../xml/schema/filter_limit.rnc"
  39                      xi:parse="text"
  40                      xmlns:xi="http://www.w3.org/2001/XInclude" />
  41    </literallayout>
  42  </refsect1>
  43
  44  <refsect1><title>EXAMPLES</title>
  45   <para>
  46    Configuration:
  47    <screen><![CDATA[
  48     <filter type="limit">
  49      <limit bandwidth="50000" pdu="100" search="5" retrieve="50"/>
  50     </filter>
  51 ]]>
  52    </screen>
  53   </para>
  54  </refsect1>
  55
  56  <refsect1><title>SEE ALSO</title>
  57   <para>
  58    <citerefentry>
  59     <refentrytitle>metaproxy</refentrytitle>
  60     <manvolnum>1</manvolnum>
  61    </citerefentry>
  62   </para>
  63  </refsect1>
  64
  65  &copyright;
  66 </refentry>
  67
  68 <!-- Keep this comment at the end of the file
  69 Local variables:
  70 mode: nxml
  71 nxml-child-indent: 1
  72 End:
  73 -->