mod_ratelimit.xml revision f5378009c22a4813ef3ec1dba4bd52e1b07a47c7
baa1100889dada3e56561fd30e1ca8c21743b5bbrbowen<?xml version="1.0"?>
baa1100889dada3e56561fd30e1ca8c21743b5bbrbowen<!DOCTYPE modulesynopsis SYSTEM "/style/modulesynopsis.dtd">
baa1100889dada3e56561fd30e1ca8c21743b5bbrbowen<?xml-stylesheet type="text/xsl" href="/style/manual.en.xsl"?>
baa1100889dada3e56561fd30e1ca8c21743b5bbrbowen<!-- $LastChangedRevision$ -->
baa1100889dada3e56561fd30e1ca8c21743b5bbrbowen
baa1100889dada3e56561fd30e1ca8c21743b5bbrbowen<!--
baa1100889dada3e56561fd30e1ca8c21743b5bbrbowen Licensed to the Apache Software Foundation (ASF) under one or more
baa1100889dada3e56561fd30e1ca8c21743b5bbrbowen contributor license agreements. See the NOTICE file distributed with
baa1100889dada3e56561fd30e1ca8c21743b5bbrbowen this work for additional information regarding copyright ownership.
baa1100889dada3e56561fd30e1ca8c21743b5bbrbowen The ASF licenses this file to You under the Apache License, Version 2.0
baa1100889dada3e56561fd30e1ca8c21743b5bbrbowen (the "License"); you may not use this file except in compliance with
baa1100889dada3e56561fd30e1ca8c21743b5bbrbowen the License. You may obtain a copy of the License at
baa1100889dada3e56561fd30e1ca8c21743b5bbrbowen
baa1100889dada3e56561fd30e1ca8c21743b5bbrbowen http://www.apache.org/licenses/LICENSE-2.0
baa1100889dada3e56561fd30e1ca8c21743b5bbrbowen
baa1100889dada3e56561fd30e1ca8c21743b5bbrbowen Unless required by applicable law or agreed to in writing, software
baa1100889dada3e56561fd30e1ca8c21743b5bbrbowen distributed under the License is distributed on an "AS IS" BASIS,
baa1100889dada3e56561fd30e1ca8c21743b5bbrbowen WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
baa1100889dada3e56561fd30e1ca8c21743b5bbrbowen See the License for the specific language governing permissions and
baa1100889dada3e56561fd30e1ca8c21743b5bbrbowen limitations under the License.
baa1100889dada3e56561fd30e1ca8c21743b5bbrbowen-->
baa1100889dada3e56561fd30e1ca8c21743b5bbrbowen
baa1100889dada3e56561fd30e1ca8c21743b5bbrbowen<!--<modulesynopsis> is the root tag and must surround all other tags.
baa1100889dada3e56561fd30e1ca8c21743b5bbrbowenThe sequence of tags is important and must be followed in order for
baa1100889dada3e56561fd30e1ca8c21743b5bbrbowenthe document to validate. -->
baa1100889dada3e56561fd30e1ca8c21743b5bbrbowen
baa1100889dada3e56561fd30e1ca8c21743b5bbrbowen<modulesynopsis metafile="mod_ratelimit.xml.meta">
baa1100889dada3e56561fd30e1ca8c21743b5bbrbowen<name>mod_ratelimit</name>
baa1100889dada3e56561fd30e1ca8c21743b5bbrbowen<description>Bandwidth Rate Limiting for Clients</description>
baa1100889dada3e56561fd30e1ca8c21743b5bbrbowen<status>extension</status>
baa1100889dada3e56561fd30e1ca8c21743b5bbrbowen<sourcefile>mod_ratelimit.c</sourcefile>
baa1100889dada3e56561fd30e1ca8c21743b5bbrbowen<identifier>ratelimit_module</identifier>
baa1100889dada3e56561fd30e1ca8c21743b5bbrbowen
baa1100889dada3e56561fd30e1ca8c21743b5bbrbowen<summary>
baa1100889dada3e56561fd30e1ca8c21743b5bbrbowen
f5378009c22a4813ef3ec1dba4bd52e1b07a47c7rbowen<p>Provides a <code>rate_limit</code> filter to limit client bandwidth.
f5378009c22a4813ef3ec1dba4bd52e1b07a47c7rbowenThe connection speed to be simulated is specified, in kb/s, using the environment
f5378009c22a4813ef3ec1dba4bd52e1b07a47c7rbowenvariable <code>rate-limit</code>.</p>
baa1100889dada3e56561fd30e1ca8c21743b5bbrbowen
f5378009c22a4813ef3ec1dba4bd52e1b07a47c7rbowen<example><title>Example Configufation</title>
baa1100889dada3e56561fd30e1ca8c21743b5bbrbowen&lt;Location /downloads&gt;<br />
f5378009c22a4813ef3ec1dba4bd52e1b07a47c7rbowenSetHandler RATE_LIMIT<br />
f5378009c22a4813ef3ec1dba4bd52e1b07a47c7rbowenSetEnv rate-limit 400
baa1100889dada3e56561fd30e1ca8c21743b5bbrbowen&lt;/Location&gt;
baa1100889dada3e56561fd30e1ca8c21743b5bbrbowen</example>
baa1100889dada3e56561fd30e1ca8c21743b5bbrbowen
baa1100889dada3e56561fd30e1ca8c21743b5bbrbowen</summary>
baa1100889dada3e56561fd30e1ca8c21743b5bbrbowen
baa1100889dada3e56561fd30e1ca8c21743b5bbrbowen</modulesynopsis>
baa1100889dada3e56561fd30e1ca8c21743b5bbrbowen