mod_ratelimit.xml revision 5d01f40ffd657dd2ac567aacd93cabd162ddfa79
860b4efe27e7c1c9a2bf5c872b29c90f76849b51jim<?xml version="1.0"?>
baa1100889dada3e56561fd30e1ca8c21743b5bbrbowen<!DOCTYPE modulesynopsis SYSTEM "/style/modulesynopsis.dtd">
860b4efe27e7c1c9a2bf5c872b29c90f76849b51jim<?xml-stylesheet type="text/xsl" href="/style/manual.en.xsl"?>
baa1100889dada3e56561fd30e1ca8c21743b5bbrbowen<!-- $LastChangedRevision$ -->
baa1100889dada3e56561fd30e1ca8c21743b5bbrbowen
860b4efe27e7c1c9a2bf5c872b29c90f76849b51jim<!--
860b4efe27e7c1c9a2bf5c872b29c90f76849b51jim Licensed to the Apache Software Foundation (ASF) under one or more
860b4efe27e7c1c9a2bf5c872b29c90f76849b51jim contributor license agreements. See the NOTICE file distributed with
baa1100889dada3e56561fd30e1ca8c21743b5bbrbowen this work for additional information regarding copyright ownership.
860b4efe27e7c1c9a2bf5c872b29c90f76849b51jim 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
860b4efe27e7c1c9a2bf5c872b29c90f76849b51jim<modulesynopsis metafile="mod_ratelimit.xml.meta">
baa1100889dada3e56561fd30e1ca8c21743b5bbrbowen<name>mod_ratelimit</name>
baa1100889dada3e56561fd30e1ca8c21743b5bbrbowen<description>Bandwidth Rate Limiting for Clients</description>
b75b4bfd9e8ec9fbf28a95174dc0e4d420f744a8sf<status>Extension</status>
baa1100889dada3e56561fd30e1ca8c21743b5bbrbowen<sourcefile>mod_ratelimit.c</sourcefile>
baa1100889dada3e56561fd30e1ca8c21743b5bbrbowen<identifier>ratelimit_module</identifier>
baa1100889dada3e56561fd30e1ca8c21743b5bbrbowen
baa1100889dada3e56561fd30e1ca8c21743b5bbrbowen<summary>
baa1100889dada3e56561fd30e1ca8c21743b5bbrbowen
f5946a9962f503d98811ab14163a5b472e42bf75covener<p>Provides a filter named <code>RATE_LIMIT</code> to limit client bandwidth.
f5946a9962f503d98811ab14163a5b472e42bf75covenerThe connection speed to be simulated is specified, in KiB/s, using the environment
f5378009c22a4813ef3ec1dba4bd52e1b07a47c7rbowenvariable <code>rate-limit</code>.</p>
baa1100889dada3e56561fd30e1ca8c21743b5bbrbowen
414bdbeedd80a7db9f35858d58888d92a50212c9rbowen<example><title>Example Configuration</title>
3a257106808eabaefbb483bdc6273e7af062ead8humbedooh<highlight language="config">
1f1b6bf13313fdd14a45e52e553d3ff28689b717coar&lt;Location "/downloads"&gt;
3a257106808eabaefbb483bdc6273e7af062ead8humbedooh SetOutputFilter RATE_LIMIT
5d01f40ffd657dd2ac567aacd93cabd162ddfa79coar SetEnv rate-limit 400
baa1100889dada3e56561fd30e1ca8c21743b5bbrbowen&lt;/Location&gt;
3a257106808eabaefbb483bdc6273e7af062ead8humbedooh</highlight>
baa1100889dada3e56561fd30e1ca8c21743b5bbrbowen</example>
baa1100889dada3e56561fd30e1ca8c21743b5bbrbowen
baa1100889dada3e56561fd30e1ca8c21743b5bbrbowen</summary>
baa1100889dada3e56561fd30e1ca8c21743b5bbrbowen
baa1100889dada3e56561fd30e1ca8c21743b5bbrbowen</modulesynopsis>