~ctrlproxy/ctrlproxy/trunk

« back to all changes in this revision

Viewing changes to doc/antiflood.mod.xml

  • Committer: jelmer
  • Date: 2003-10-18 22:02:02 UTC
  • Revision ID: jelmer@samba.org-20031018220202-6801a76318fb4d13
Update

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<ctrlproxy:module name="antiflood"
 
2
        xmlns:ctrlproxy="http://ctrlproxy.vernstok.nl/common">
 
3
        <modulemeta>
 
4
                <description>Flood protection module</description>
 
5
                <version>0.1</version>
 
6
                <author>Jelmer Vernooij</author>
 
7
                <homepage>http://jelmer.vernstok.nl/ctrlproxy/</homepage>
 
8
        </modulemeta>
 
9
 
 
10
        <description>
 
11
                <para>This module makes sure at most 1 message is sent to the server 
 
12
                        in a certain period of time.</para>
 
13
 
 
14
                <para>A child element of a server element named "queue_speed" contains 
 
15
                        the number of milliseconds the client has to wait before
 
16
                sending a new message.</para>
 
17
 
 
18
        </description>
 
19
 
 
20
        <example>
 
21
                <![CDATA[
 
22
                <ctrlproxy>
 
23
                        <plugins>
 
24
                                <plugin autoload="1" file="antiflood"/>
 
25
                                <plugin autoload="1" file="socket"/>
 
26
                        </plugins>
 
27
 
 
28
                        <networks>
 
29
                                <network name="OFTC">
 
30
                                        <queuespeed>2200</queuespeed>
 
31
                                        <servers><ipv4 host="irc.oftc.net"/></servers>
 
32
                                        <channel name="#flood"/>
 
33
                                </network>
 
34
                        </networks>
 
35
                </ctrlproxy>
 
36
                ]]>
 
37
        </example>
 
38
</ctrlproxy:module>