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