yaoweibin/nginx_limit_speed_module

= Synopsis =
This module makes it possible to limit the total speed of simultaneous 
connections for the assigned session or as a special case, from one address.

Example configuration
<geshi lang="nginx">
http {
    limit_speed_zone   one  $binary_remote_addr  10m;

    server {
        location /download/ {
            limit_speed   one  100k;
        }
    }
}
</geshi>

= Directives =
== limit_speed_zone ==
'''syntax:''' ''limit_speed_zone zone_name $variable memory_max_size''

'''default:''' ''no''

'''context:''' ''http''

Directive describes the zone, in which the session states are stored.<BR>
The numbers of sessions is determined by the assigned variable, it depends on
the size of the used Variable and '''memory_max_size''' value.

Example of the use:

<geshi lang="nginx">
limit_speed_zone one $binary_remote_addr 10m;
</geshi>

The address of client is used as the session.
Notice that the variable <code>$binary_remote_addr</code> is used instead of 
<code>$remote_addr</code>.

The length of the values of the variable of <code>$remote_addr</code> can be 
from 7 to 15 bytes; therefore size state is equal to 32 or 64 bytes.

Length of all values of the variable of <code>$binary_remote_addr</code> is 
always 4 bytes and the size of the state is always 32 bytes.

When the zone size is 1M then it is possible to handle 32000 sessions with 
32 bytes/session.

== limit_speed ==

'''syntax:''' ''limit_speed zone_name max_speed''

'''default:''' ''no''

'''context:''' ''http, server, location''

Directive assigns the sum of maximum speed from the same IP address. For 
example, if you limit the total speed to 100KB per IP address and there
are 10 concurrent connections from the same IP, each connection speed 
is 10KB(100KB/10).

= License =

This code is published under the BSD license.

Copyright (C) 2011 by Weibin Yao <[email protected]>.

This README template is from nginx_limit_zone_module
(http://wiki.nginx.org/HttpLimitZoneModule).

I borrowed a lot of codes from limit_zone module of Nginx. This part of
code is copyrighted by Igor Sysoev. Thanks for his hard work.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:

*   Redistributions of source code must retain the above copyright
    notice, this list of conditions and the following disclaimer.

*   Redistributions in binary form must reproduce the above copyright
    notice, this list of conditions and the following disclaimer in the
    documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.