~ctrlproxy/ctrlproxy/trunk

« back to all changes in this revision

Viewing changes to doc/antiflood.mod.xml

  • Committer: jelmer
  • Date: 2005-10-30 01:15:57 UTC
  • Revision ID: jelmer@samba.org-20051030011557-7137f871b7495c7c
Re-importĀ docs

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
                <email>jelmer@vernstok.nl</email>
 
8
                <homepage>http://ctrlproxy.vernstok.nl/</homepage>
 
9
        </modulemeta>
 
10
 
 
11
        <description>
 
12
                <para>This module makes sure at most 1 message is sent to the server
 
13
                        in a certain period of time.</para>
 
14
 
 
15
                <para>A child element of a server element named "queue_speed" contains
 
16
                        the number of milliseconds the client has to wait before
 
17
                sending a new message.</para>
 
18
 
 
19
        </description>
 
20
 
 
21
        <configuration>
 
22
                <element name="queuespeed">Milliseconds the client has to wait before sending a new message</element>
 
23
        </configuration>
 
24
 
 
25
        <example>
 
26
                <![CDATA[
 
27
                <ctrlproxy>
 
28
                        <plugins>
 
29
                                <plugin autoload="1" file="antiflood"/>
 
30
                        </plugins>
 
31
 
 
32
                        <networks>
 
33
                                <network name="OFTC">
 
34
                                        <queuespeed>2200</queuespeed>
 
35
                                        <servers><ipv4 host="irc.oftc.net"/></servers>
 
36
                                        <channel name="#flood"/>
 
37
                                </network>
 
38
                        </networks>
 
39
                </ctrlproxy>
 
40
                ]]>
 
41
        </example>
 
42
</ctrlproxy:module>