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