summaryrefslogtreecommitdiffstats
path: root/docs/manual/mod/mod_dialup.xml
blob: 31e1e8826ae8c44fd65e5577572686c6fab2555a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
<?xml version="1.0"?>
<!DOCTYPE modulesynopsis SYSTEM "../style/modulesynopsis.dtd">
<?xml-stylesheet type="text/xsl" href="../style/manual.en.xsl"?>
<!-- $LastChangedRevision$ -->

<!--
 Licensed to the Apache Software Foundation (ASF) under one or more
 contributor license agreements.  See the NOTICE file distributed with
 this work for additional information regarding copyright ownership.
 The ASF licenses this file to You under the Apache License, Version 2.0
 (the "License"); you may not use this file except in compliance with
 the License.  You may obtain a copy of the License at

     http://www.apache.org/licenses/LICENSE-2.0

 Unless required by applicable law or agreed to in writing, software
 distributed under the License is distributed on an "AS IS" BASIS,
 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
 limitations under the License.
-->

<!--<modulesynopsis> is the root tag and must surround all other tags.
The sequence of tags is important and must be followed in order for
the document to validate. -->

<modulesynopsis metafile="mod_dialup.xml.meta">
<name>mod_dialup</name>
<description>Send static content at a bandwidth rate limit, defined by the various old modem standards</description>
<status>Experimental</status>
<sourcefile>mod_dialup.c</sourcefile>
<identifier>dialup_module</identifier>

<summary>
<p>It is a module that sends static content at a bandwidth rate limit, defined
by the various old modem standards. So, you can browse your site with a 56k
V.92 modem, by adding something like this:</p>

<highlight language="config">
&lt;Location "/mysite"&gt;
    ModemStandard "V.92"
&lt;/Location&gt;
</highlight>

<p>Previously to do bandwidth rate limiting modules would have to block an entire
thread, for each client, and insert sleeps to slow the bandwidth down.
Using the new suspend feature, a handler can get callback N milliseconds in
the future, and it will be invoked by the Event MPM on a different thread,
once the timer hits.  From there the handler can continue to send data to the client.</p>
</summary>

<directivesynopsis>
<name>ModemStandard</name>
<description>Modem standard to simulate</description>
<syntax>ModemStandard V.21|V.26bis|V.32|V.34|V.92</syntax>
<contextlist><context>directory</context></contextlist>

<usage>
<p>Specify what modem standard you wish to simulate.</p>

<highlight language="config">
&lt;Location "/mysite"&gt;
    ModemStandard "V.26bis"
&lt;/Location&gt;
</highlight>

</usage>

</directivesynopsis>

</modulesynopsis>