1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
3 <title>InspIRCd: modules.h File Reference</title>
4 <link href="inspircd.css" rel="stylesheet" type="text/css">
6 <!-- Generated by Doxygen 1.3.3 -->
7 <div class="qindex"><a class="qindex" href="main.html">Main Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical List</a> | <a class="qindex" href="annotated.html">Compound List</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Compound Members</a> | <a class="qindex" href="globals.html">File Members</a></div>
8 <h1>modules.h File Reference</h1><code>#include "dynamic.h"</code><br>
9 <code>#include "<a class="el" href="base_8h-source.html">base.h</a>"</code><br>
10 <code>#include "<a class="el" href="ctables_8h-source.html">ctables.h</a>"</code><br>
11 <code>#include <string></code><br>
12 <code>#include <deque></code><br>
13 <code>#include <sstream></code><br>
16 Include dependency graph for modules.h:<p><center><img src="modules_8h__incl.gif" border="0" usemap="#modules.h_map" alt="Include dependency graph"></center>
17 <map name="modules.h_map">
18 <area href="base_8h.html" shape="rect" coords="104,82,165,109" alt="">
19 <area href="ctables_8h.html" shape="rect" coords="242,157,317,184" alt="">
23 This graph shows which files directly or indirectly include this file:<p><center><img src="modules_8h__dep__incl.gif" border="0" usemap="#modules.hdep_map" alt="Included by dependency graph"></center>
24 <map name="modules.hdep_map">
25 <area href="channels_8cpp.html" shape="rect" coords="7,7,106,34" alt="">
26 <area href="modules_8cpp.html" shape="rect" coords="130,7,229,34" alt="">
30 <a href="modules_8h-source.html">Go to the source code of this file.</a><table border=0 cellpadding=0 cellspacing=0>
32 <tr><td colspan=2><br><h2>Compounds</h2></td></tr>
33 <tr><td class="memItemLeft" nowrap align=right valign=top>class </td><td class="memItemRight" valign=bottom><a class="el" href="classAdmin.html">Admin</a></td></tr>
35 <tr><td class="mdescLeft"> </td><td class="mdescRight">Holds /ADMIN data This class contains the admin details of the local server. </em> <a href="classAdmin.html#_details">More...</a><em><br><br></td></tr>
36 <tr><td class="memItemLeft" nowrap align=right valign=top>class </td><td class="memItemRight" valign=bottom><a class="el" href="classConfigReader.html">ConfigReader</a></td></tr>
38 <tr><td class="mdescLeft"> </td><td class="mdescRight">Allows reading of values from configuration files This class allows a module to read from either the main configuration file (inspircd.conf) or from a module-specified configuration file. </em> <a href="classConfigReader.html#_details">More...</a><em><br><br></td></tr>
39 <tr><td class="memItemLeft" nowrap align=right valign=top>class </td><td class="memItemRight" valign=bottom><a class="el" href="classEvent.html">Event</a></td></tr>
41 <tr><td class="mdescLeft"> </td><td class="mdescRight">The Event class is a unicast message directed at all modules. </em> <a href="classEvent.html#_details">More...</a><em><br><br></td></tr>
42 <tr><td class="memItemLeft" nowrap align=right valign=top>class </td><td class="memItemRight" valign=bottom><a class="el" href="classFileReader.html">FileReader</a></td></tr>
44 <tr><td class="mdescLeft"> </td><td class="mdescRight">Caches a text file into memory and can be used to retrieve lines from it. </em> <a href="classFileReader.html#_details">More...</a><em><br><br></td></tr>
45 <tr><td class="memItemLeft" nowrap align=right valign=top>class </td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html">Module</a></td></tr>
47 <tr><td class="mdescLeft"> </td><td class="mdescRight">Base class for all InspIRCd modules This class is the base class for InspIRCd modules. </em> <a href="classModule.html#_details">More...</a><em><br><br></td></tr>
48 <tr><td class="memItemLeft" nowrap align=right valign=top>class </td><td class="memItemRight" valign=bottom><a class="el" href="classModuleFactory.html">ModuleFactory</a></td></tr>
50 <tr><td class="mdescLeft"> </td><td class="mdescRight">Instantiates classes inherited from <a class="el" href="classModule.html">Module</a> This class creates a class inherited from type <a class="el" href="classModule.html">Module</a>, using new. </em> <a href="classModuleFactory.html#_details">More...</a><em><br><br></td></tr>
51 <tr><td class="memItemLeft" nowrap align=right valign=top>class </td><td class="memItemRight" valign=bottom><a class="el" href="classModuleMessage.html">ModuleMessage</a></td></tr>
53 <tr><td class="mdescLeft"> </td><td class="mdescRight">The ModuleMessage class is the base class of <a class="el" href="classRequest.html">Request</a> and <a class="el" href="classEvent.html">Event</a> This class is used to represent a basic data structure which is passed between modules for safe inter-module communications. </em> <a href="classModuleMessage.html#_details">More...</a><em><br><br></td></tr>
54 <tr><td class="memItemLeft" nowrap align=right valign=top>class </td><td class="memItemRight" valign=bottom><a class="el" href="classRequest.html">Request</a></td></tr>
56 <tr><td class="mdescLeft"> </td><td class="mdescRight">The Request class is a unicast message directed at a given module. </em> <a href="classRequest.html#_details">More...</a><em><br><br></td></tr>
57 <tr><td class="memItemLeft" nowrap align=right valign=top>class </td><td class="memItemRight" valign=bottom><a class="el" href="classServer.html">Server</a></td></tr>
59 <tr><td class="mdescLeft"> </td><td class="mdescRight">Allows server output and query functions This class contains methods which allow a module to query the state of the irc server, and produce output to users and other servers. </em> <a href="classServer.html#_details">More...</a><em><br><br></td></tr>
60 <tr><td class="memItemLeft" nowrap align=right valign=top>class </td><td class="memItemRight" valign=bottom><a class="el" href="classVersion.html">Version</a></td></tr>
62 <tr><td class="mdescLeft"> </td><td class="mdescRight">Holds a module's Version information The four members (set by the constructor only) indicate details as to the version number of a module. </em> <a href="classVersion.html#_details">More...</a><em><br><br></td></tr>
63 <tr><td colspan=2><br><h2>Defines</h2></td></tr>
64 <tr><td class="memItemLeft" nowrap align=right valign=top>#define </td><td class="memItemRight" valign=bottom><a class="el" href="modules_8h.html#a0">DEBUG</a> 10</td></tr>
66 <tr><td class="memItemLeft" nowrap align=right valign=top>#define </td><td class="memItemRight" valign=bottom><a class="el" href="modules_8h.html#a1">VERBOSE</a> 20</td></tr>
68 <tr><td class="memItemLeft" nowrap align=right valign=top>#define </td><td class="memItemRight" valign=bottom><a class="el" href="modules_8h.html#a2">DEFAULT</a> 30</td></tr>
70 <tr><td class="memItemLeft" nowrap align=right valign=top>#define </td><td class="memItemRight" valign=bottom><a class="el" href="modules_8h.html#a3">SPARSE</a> 40</td></tr>
72 <tr><td class="memItemLeft" nowrap align=right valign=top>#define </td><td class="memItemRight" valign=bottom><a class="el" href="modules_8h.html#a4">NONE</a> 50</td></tr>
74 <tr><td class="memItemLeft" nowrap align=right valign=top>#define </td><td class="memItemRight" valign=bottom><a class="el" href="modules_8h.html#a5">MT_CHANNEL</a> 1</td></tr>
76 <tr><td class="memItemLeft" nowrap align=right valign=top>#define </td><td class="memItemRight" valign=bottom><a class="el" href="modules_8h.html#a6">MT_CLIENT</a> 2</td></tr>
78 <tr><td class="memItemLeft" nowrap align=right valign=top>#define </td><td class="memItemRight" valign=bottom><a class="el" href="modules_8h.html#a7">MT_SERVER</a> 3</td></tr>
80 <tr><td class="memItemLeft" nowrap align=right valign=top>#define </td><td class="memItemRight" valign=bottom><a class="el" href="modules_8h.html#a8">ACR_DEFAULT</a> 0</td></tr>
82 <tr><td class="memItemLeft" nowrap align=right valign=top>#define </td><td class="memItemRight" valign=bottom><a class="el" href="modules_8h.html#a9">ACR_DENY</a> 1</td></tr>
84 <tr><td class="memItemLeft" nowrap align=right valign=top>#define </td><td class="memItemRight" valign=bottom><a class="el" href="modules_8h.html#a10">ACR_ALLOW</a> 2</td></tr>
86 <tr><td class="memItemLeft" nowrap align=right valign=top>#define </td><td class="memItemRight" valign=bottom><a class="el" href="modules_8h.html#a11">AC_KICK</a> 0</td></tr>
88 <tr><td class="memItemLeft" nowrap align=right valign=top>#define </td><td class="memItemRight" valign=bottom><a class="el" href="modules_8h.html#a12">AC_DEOP</a> 1</td></tr>
90 <tr><td class="memItemLeft" nowrap align=right valign=top>#define </td><td class="memItemRight" valign=bottom><a class="el" href="modules_8h.html#a13">AC_OP</a> 2</td></tr>
92 <tr><td class="memItemLeft" nowrap align=right valign=top>#define </td><td class="memItemRight" valign=bottom><a class="el" href="modules_8h.html#a14">AC_VOICE</a> 3</td></tr>
94 <tr><td class="memItemLeft" nowrap align=right valign=top>#define </td><td class="memItemRight" valign=bottom><a class="el" href="modules_8h.html#a15">AC_DEVOICE</a> 4</td></tr>
96 <tr><td class="memItemLeft" nowrap align=right valign=top>#define </td><td class="memItemRight" valign=bottom><a class="el" href="modules_8h.html#a16">AC_HALFOP</a> 5</td></tr>
98 <tr><td class="memItemLeft" nowrap align=right valign=top>#define </td><td class="memItemRight" valign=bottom><a class="el" href="modules_8h.html#a17">AC_DEHALFOP</a> 6</td></tr>
100 <tr><td class="memItemLeft" nowrap align=right valign=top>#define </td><td class="memItemRight" valign=bottom><a class="el" href="modules_8h.html#a18">AC_INVITE</a> 7</td></tr>
102 <tr><td class="memItemLeft" nowrap align=right valign=top>#define </td><td class="memItemRight" valign=bottom><a class="el" href="modules_8h.html#a19">AC_GENERAL_MODE</a> 8</td></tr>
104 <tr><td class="memItemLeft" nowrap align=right valign=top>#define </td><td class="memItemRight" valign=bottom><a class="el" href="modules_8h.html#a20">VF_STATIC</a> 1</td></tr>
106 <tr><td class="memItemLeft" nowrap align=right valign=top>#define </td><td class="memItemRight" valign=bottom><a class="el" href="modules_8h.html#a21">VF_VENDOR</a> 2</td></tr>
108 <tr><td class="memItemLeft" nowrap align=right valign=top>#define </td><td class="memItemRight" valign=bottom><a class="el" href="modules_8h.html#a22">VF_SERVICEPROVIDER</a> 4</td></tr>
110 <tr><td class="memItemLeft" nowrap align=right valign=top>#define </td><td class="memItemRight" valign=bottom><a class="el" href="modules_8h.html#a23">VF_COMMON</a> 8</td></tr>
112 <tr><td class="memItemLeft" nowrap align=right valign=top>#define </td><td class="memItemRight" valign=bottom><a class="el" href="modules_8h.html#a24">FOREACH_MOD</a> for (int _i = 0; _i <= <a class="el" href="modules_8cpp.html#a1">MODCOUNT</a>; _i++) modules[_i]-></td></tr>
114 <tr><td class="memItemLeft" nowrap align=right valign=top>#define </td><td class="memItemRight" valign=bottom><a class="el" href="modules_8h.html#a25">FOREACH_RESULT</a>(x)</td></tr>
116 <tr><td class="memItemLeft" nowrap align=right valign=top>#define </td><td class="memItemRight" valign=bottom><a class="el" href="modules_8h.html#a26">FD_MAGIC_NUMBER</a> -42</td></tr>
118 <tr><td class="memItemLeft" nowrap align=right valign=top>#define </td><td class="memItemRight" valign=bottom><a class="el" href="modules_8h.html#a27">CONF_NOT_A_NUMBER</a> 0x000010</td></tr>
120 <tr><td class="memItemLeft" nowrap align=right valign=top>#define </td><td class="memItemRight" valign=bottom><a class="el" href="modules_8h.html#a28">CONF_NOT_UNSIGNED</a> 0x000080</td></tr>
122 <tr><td class="memItemLeft" nowrap align=right valign=top>#define </td><td class="memItemRight" valign=bottom><a class="el" href="modules_8h.html#a29">CONF_VALUE_NOT_FOUND</a> 0x000100</td></tr>
124 <tr><td class="memItemLeft" nowrap align=right valign=top>#define </td><td class="memItemRight" valign=bottom><a class="el" href="modules_8h.html#a30">CONF_FILE_NOT_FOUND</a> 0x000200</td></tr>
126 <tr><td colspan=2><br><h2>Typedefs</h2></td></tr>
127 <tr><td class="memItemLeft" nowrap align=right valign=top>typedef std::deque< std::string > </td><td class="memItemRight" valign=bottom><a class="el" href="modules_8h.html#a31">file_cache</a></td></tr>
129 <tr><td class="mdescLeft"> </td><td class="mdescRight">Low level definition of a <a class="el" href="classFileReader.html">FileReader</a> classes file cache area. </em> <a href="#a31"></a><em><br><br></td></tr>
130 <tr><td class="memItemLeft" nowrap align=right valign=top>typedef <a class="el" href="modules_8h.html#a31">file_cache</a> </td><td class="memItemRight" valign=bottom><a class="el" href="modules_8h.html#a32">string_list</a></td></tr>
132 <tr><td class="memItemLeft" nowrap align=right valign=top>typedef std::deque< <a class="el" href="classuserrec.html">userrec</a> * > </td><td class="memItemRight" valign=bottom><a class="el" href="modules_8h.html#a33">chanuserlist</a></td></tr>
134 <tr><td class="mdescLeft"> </td><td class="mdescRight">Holds a list of users in a channel. </em> <a href="#a33"></a><em><br><br></td></tr>
135 <tr><td class="memItemLeft" nowrap align=right valign=top>typedef DLLFactory< <a class="el" href="classModuleFactory.html">ModuleFactory</a> > </td><td class="memItemRight" valign=bottom><a class="el" href="modules_8h.html#a34">ircd_module</a></td></tr>
137 <tr><td colspan=2><br><h2>Functions</h2></td></tr>
138 <tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="modules_8h.html#a35">createcommand</a> (char *cmd, handlerfunc f, char flags, int minparams, char *source)</td></tr>
140 <tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="modules_8h.html#a36">server_mode</a> (char **parameters, int pcnt, <a class="el" href="classuserrec.html">userrec</a> *user)</td></tr>
143 <hr><h2>Define Documentation</h2>
144 <a name="a17" doxytag="modules.h::AC_DEHALFOP"></a><p>
145 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
148 <table cellpadding="0" cellspacing="0" border="0">
150 <td class="md" nowrap valign="top"> #define AC_DEHALFOP 6
155 <table cellspacing=5 cellpadding=0 border=0>
165 Definition at line <a class="el" href="modules_8h-source.html#l00047">47</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>. </td>
168 <a name="a12" doxytag="modules.h::AC_DEOP"></a><p>
169 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
172 <table cellpadding="0" cellspacing="0" border="0">
174 <td class="md" nowrap valign="top"> #define AC_DEOP 1
179 <table cellspacing=5 cellpadding=0 border=0>
189 Definition at line <a class="el" href="modules_8h-source.html#l00042">42</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>. </td>
192 <a name="a15" doxytag="modules.h::AC_DEVOICE"></a><p>
193 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
196 <table cellpadding="0" cellspacing="0" border="0">
198 <td class="md" nowrap valign="top"> #define AC_DEVOICE 4
203 <table cellspacing=5 cellpadding=0 border=0>
213 Definition at line <a class="el" href="modules_8h-source.html#l00045">45</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>. </td>
216 <a name="a19" doxytag="modules.h::AC_GENERAL_MODE"></a><p>
217 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
220 <table cellpadding="0" cellspacing="0" border="0">
222 <td class="md" nowrap valign="top"> #define AC_GENERAL_MODE 8
227 <table cellspacing=5 cellpadding=0 border=0>
237 Definition at line <a class="el" href="modules_8h-source.html#l00049">49</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>. </td>
240 <a name="a16" doxytag="modules.h::AC_HALFOP"></a><p>
241 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
244 <table cellpadding="0" cellspacing="0" border="0">
246 <td class="md" nowrap valign="top"> #define AC_HALFOP 5
251 <table cellspacing=5 cellpadding=0 border=0>
261 Definition at line <a class="el" href="modules_8h-source.html#l00046">46</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>. </td>
264 <a name="a18" doxytag="modules.h::AC_INVITE"></a><p>
265 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
268 <table cellpadding="0" cellspacing="0" border="0">
270 <td class="md" nowrap valign="top"> #define AC_INVITE 7
275 <table cellspacing=5 cellpadding=0 border=0>
285 Definition at line <a class="el" href="modules_8h-source.html#l00048">48</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>. </td>
288 <a name="a11" doxytag="modules.h::AC_KICK"></a><p>
289 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
292 <table cellpadding="0" cellspacing="0" border="0">
294 <td class="md" nowrap valign="top"> #define AC_KICK 0
299 <table cellspacing=5 cellpadding=0 border=0>
309 Definition at line <a class="el" href="modules_8h-source.html#l00041">41</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>. </td>
312 <a name="a13" doxytag="modules.h::AC_OP"></a><p>
313 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
316 <table cellpadding="0" cellspacing="0" border="0">
318 <td class="md" nowrap valign="top"> #define AC_OP 2
323 <table cellspacing=5 cellpadding=0 border=0>
333 Definition at line <a class="el" href="modules_8h-source.html#l00043">43</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>. </td>
336 <a name="a14" doxytag="modules.h::AC_VOICE"></a><p>
337 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
340 <table cellpadding="0" cellspacing="0" border="0">
342 <td class="md" nowrap valign="top"> #define AC_VOICE 3
347 <table cellspacing=5 cellpadding=0 border=0>
357 Definition at line <a class="el" href="modules_8h-source.html#l00044">44</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>. </td>
360 <a name="a10" doxytag="modules.h::ACR_ALLOW"></a><p>
361 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
364 <table cellpadding="0" cellspacing="0" border="0">
366 <td class="md" nowrap valign="top"> #define ACR_ALLOW 2
371 <table cellspacing=5 cellpadding=0 border=0>
381 Definition at line <a class="el" href="modules_8h-source.html#l00039">39</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>. </td>
384 <a name="a8" doxytag="modules.h::ACR_DEFAULT"></a><p>
385 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
388 <table cellpadding="0" cellspacing="0" border="0">
390 <td class="md" nowrap valign="top"> #define ACR_DEFAULT 0
395 <table cellspacing=5 cellpadding=0 border=0>
405 Definition at line <a class="el" href="modules_8h-source.html#l00037">37</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.
407 Referenced by <a class="el" href="modules_8cpp-source.html#l00392">Module::OnAccessCheck()</a>. </td>
410 <a name="a9" doxytag="modules.h::ACR_DENY"></a><p>
411 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
414 <table cellpadding="0" cellspacing="0" border="0">
416 <td class="md" nowrap valign="top"> #define ACR_DENY 1
421 <table cellspacing=5 cellpadding=0 border=0>
431 Definition at line <a class="el" href="modules_8h-source.html#l00038">38</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>. </td>
434 <a name="a30" doxytag="modules.h::CONF_FILE_NOT_FOUND"></a><p>
435 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
438 <table cellpadding="0" cellspacing="0" border="0">
440 <td class="md" nowrap valign="top"> #define CONF_FILE_NOT_FOUND 0x000200
445 <table cellspacing=5 cellpadding=0 border=0>
455 Definition at line <a class="el" href="modules_8h-source.html#l01138">1138</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.
457 Referenced by <a class="el" href="modules_8cpp-source.html#l00870">ConfigReader::ConfigReader()</a>. </td>
460 <a name="a27" doxytag="modules.h::CONF_NOT_A_NUMBER"></a><p>
461 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
464 <table cellpadding="0" cellspacing="0" border="0">
466 <td class="md" nowrap valign="top"> #define CONF_NOT_A_NUMBER 0x000010
471 <table cellspacing=5 cellpadding=0 border=0>
481 Definition at line <a class="el" href="modules_8h-source.html#l01135">1135</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.
483 Referenced by <a class="el" href="modules_8cpp-source.html#l00931">ConfigReader::ReadInteger()</a>. </td>
486 <a name="a28" doxytag="modules.h::CONF_NOT_UNSIGNED"></a><p>
487 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
490 <table cellpadding="0" cellspacing="0" border="0">
492 <td class="md" nowrap valign="top"> #define CONF_NOT_UNSIGNED 0x000080
497 <table cellspacing=5 cellpadding=0 border=0>
507 Definition at line <a class="el" href="modules_8h-source.html#l01136">1136</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.
509 Referenced by <a class="el" href="modules_8cpp-source.html#l00931">ConfigReader::ReadInteger()</a>. </td>
512 <a name="a29" doxytag="modules.h::CONF_VALUE_NOT_FOUND"></a><p>
513 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
516 <table cellpadding="0" cellspacing="0" border="0">
518 <td class="md" nowrap valign="top"> #define CONF_VALUE_NOT_FOUND 0x000100
523 <table cellspacing=5 cellpadding=0 border=0>
533 Definition at line <a class="el" href="modules_8h-source.html#l01137">1137</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.
535 Referenced by <a class="el" href="modules_8cpp-source.html#l00914">ConfigReader::ReadFlag()</a>, <a class="el" href="modules_8cpp-source.html#l00931">ConfigReader::ReadInteger()</a>, and <a class="el" href="modules_8cpp-source.html#l00898">ConfigReader::ReadValue()</a>. </td>
538 <a name="a0" doxytag="modules.h::DEBUG"></a><p>
539 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
542 <table cellpadding="0" cellspacing="0" border="0">
544 <td class="md" nowrap valign="top"> #define DEBUG 10
549 <table cellspacing=5 cellpadding=0 border=0>
559 Definition at line <a class="el" href="modules_8h-source.html#l00023">23</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.
561 Referenced by <a class="el" href="modules_8cpp-source.html#l00639">Server::AddExtendedMode()</a>, <a class="el" href="channels_8cpp-source.html#l00207">chanrec::AddUser()</a>, <a class="el" href="channels_8cpp-source.html#l00213">chanrec::DelUser()</a>, <a class="el" href="users_8cpp-source.html#l00117">userrec::HasPermission()</a>, <a class="el" href="channels_8cpp-source.html#l00181">chanrec::IsCustomModeSet()</a>, <a class="el" href="users_8cpp-source.html#l00095">userrec::RemoveInvite()</a>, <a class="el" href="channels_8cpp-source.html#l00125">chanrec::SetCustomMode()</a>, <a class="el" href="channels_8cpp-source.html#l00150">chanrec::SetCustomModeParam()</a>, <a class="el" href="users_8cpp-source.html#l00263">userrec::SetWriteError()</a>, and <a class="el" href="modules_8cpp-source.html#l00681">Server::UserToPseudo()</a>. </td>
564 <a name="a2" doxytag="modules.h::DEFAULT"></a><p>
565 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
568 <table cellpadding="0" cellspacing="0" border="0">
570 <td class="md" nowrap valign="top"> #define DEFAULT 30
575 <table cellspacing=5 cellpadding=0 border=0>
585 Definition at line <a class="el" href="modules_8h-source.html#l00025">25</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>. </td>
588 <a name="a26" doxytag="modules.h::FD_MAGIC_NUMBER"></a><p>
589 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
592 <table cellpadding="0" cellspacing="0" border="0">
594 <td class="md" nowrap valign="top"> #define FD_MAGIC_NUMBER -42
599 <table cellspacing=5 cellpadding=0 border=0>
609 Definition at line <a class="el" href="modules_8h-source.html#l00099">99</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.
611 Referenced by <a class="el" href="modules_8cpp-source.html#l00700">Server::PseudoToUser()</a>, and <a class="el" href="modules_8cpp-source.html#l00681">Server::UserToPseudo()</a>. </td>
614 <a name="a24" doxytag="modules.h::FOREACH_MOD"></a><p>
615 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
618 <table cellpadding="0" cellspacing="0" border="0">
620 <td class="md" nowrap valign="top"> #define FOREACH_MOD for (int _i = 0; _i <= <a class="el" href="modules_8cpp.html#a1">MODCOUNT</a>; _i++) modules[_i]->
625 <table cellspacing=5 cellpadding=0 border=0>
635 Definition at line <a class="el" href="modules_8h-source.html#l00079">79</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.
637 Referenced by <a class="el" href="modules_8cpp-source.html#l00357">Event::Send()</a>. </td>
640 <a name="a25" doxytag="modules.h::FOREACH_RESULT"></a><p>
641 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
644 <table cellpadding="0" cellspacing="0" border="0">
646 <td class="md" nowrap valign="top"> #define FOREACH_RESULT</td>
647 <td class="md" valign="top">( </td>
648 <td class="md" nowrap valign="top">x </td>
649 <td class="mdname1" valign="top" nowrap> </td>
650 <td class="md" valign="top"> ) </td>
651 <td class="md" nowrap>
656 <table cellspacing=5 cellpadding=0 border=0>
664 <b>Value:</b><div class="fragment"><pre>{ MOD_RESULT = 0; \
665 <span class="keywordflow">for</span> (<span class="keywordtype">int</span> _i = 0; _i <= <a class="code" href="modules_8cpp.html#a1">MODCOUNT</a>; _i++) { \
666 <span class="keywordtype">int</span> res = <a class="code" href="channels_8cpp.html#a2">modules</a>[_i]->x ; \
667 <span class="keywordflow">if</span> (res != 0) { \
669 <span class="keywordflow">break</span>; \
675 Definition at line <a class="el" href="modules_8h-source.html#l00087">87</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>. </td>
678 <a name="a5" doxytag="modules.h::MT_CHANNEL"></a><p>
679 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
682 <table cellpadding="0" cellspacing="0" border="0">
684 <td class="md" nowrap valign="top"> #define MT_CHANNEL 1
689 <table cellspacing=5 cellpadding=0 border=0>
699 Definition at line <a class="el" href="modules_8h-source.html#l00031">31</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.
701 Referenced by <a class="el" href="modules_8cpp-source.html#l00667">Server::AddExtendedListMode()</a>, and <a class="el" href="modules_8cpp-source.html#l00295">ModeMakeList()</a>. </td>
704 <a name="a6" doxytag="modules.h::MT_CLIENT"></a><p>
705 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
708 <table cellpadding="0" cellspacing="0" border="0">
710 <td class="md" nowrap valign="top"> #define MT_CLIENT 2
715 <table cellspacing=5 cellpadding=0 border=0>
725 Definition at line <a class="el" href="modules_8h-source.html#l00032">32</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.
727 Referenced by <a class="el" href="modules_8cpp-source.html#l00639">Server::AddExtendedMode()</a>. </td>
730 <a name="a7" doxytag="modules.h::MT_SERVER"></a><p>
731 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
734 <table cellpadding="0" cellspacing="0" border="0">
736 <td class="md" nowrap valign="top"> #define MT_SERVER 3
741 <table cellspacing=5 cellpadding=0 border=0>
751 Definition at line <a class="el" href="modules_8h-source.html#l00033">33</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.
753 Referenced by <a class="el" href="modules_8cpp-source.html#l00639">Server::AddExtendedMode()</a>. </td>
756 <a name="a4" doxytag="modules.h::NONE"></a><p>
757 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
760 <table cellpadding="0" cellspacing="0" border="0">
762 <td class="md" nowrap valign="top"> #define NONE 50
767 <table cellspacing=5 cellpadding=0 border=0>
777 Definition at line <a class="el" href="modules_8h-source.html#l00027">27</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>. </td>
780 <a name="a3" doxytag="modules.h::SPARSE"></a><p>
781 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
784 <table cellpadding="0" cellspacing="0" border="0">
786 <td class="md" nowrap valign="top"> #define SPARSE 40
791 <table cellspacing=5 cellpadding=0 border=0>
801 Definition at line <a class="el" href="modules_8h-source.html#l00026">26</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>. </td>
804 <a name="a1" doxytag="modules.h::VERBOSE"></a><p>
805 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
808 <table cellpadding="0" cellspacing="0" border="0">
810 <td class="md" nowrap valign="top"> #define VERBOSE 20
815 <table cellspacing=5 cellpadding=0 border=0>
825 Definition at line <a class="el" href="modules_8h-source.html#l00024">24</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>. </td>
828 <a name="a23" doxytag="modules.h::VF_COMMON"></a><p>
829 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
832 <table cellpadding="0" cellspacing="0" border="0">
834 <td class="md" nowrap valign="top"> #define VF_COMMON 8
839 <table cellspacing=5 cellpadding=0 border=0>
849 Definition at line <a class="el" href="modules_8h-source.html#l00056">56</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>. </td>
852 <a name="a22" doxytag="modules.h::VF_SERVICEPROVIDER"></a><p>
853 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
856 <table cellpadding="0" cellspacing="0" border="0">
858 <td class="md" nowrap valign="top"> #define VF_SERVICEPROVIDER 4
863 <table cellspacing=5 cellpadding=0 border=0>
873 Definition at line <a class="el" href="modules_8h-source.html#l00055">55</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>. </td>
876 <a name="a20" doxytag="modules.h::VF_STATIC"></a><p>
877 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
880 <table cellpadding="0" cellspacing="0" border="0">
882 <td class="md" nowrap valign="top"> #define VF_STATIC 1
887 <table cellspacing=5 cellpadding=0 border=0>
897 Definition at line <a class="el" href="modules_8h-source.html#l00053">53</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>. </td>
900 <a name="a21" doxytag="modules.h::VF_VENDOR"></a><p>
901 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
904 <table cellpadding="0" cellspacing="0" border="0">
906 <td class="md" nowrap valign="top"> #define VF_VENDOR 2
911 <table cellspacing=5 cellpadding=0 border=0>
921 Definition at line <a class="el" href="modules_8h-source.html#l00054">54</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.
923 Referenced by <a class="el" href="modules_8cpp-source.html#l00383">Module::GetVersion()</a>. </td>
926 <hr><h2>Typedef Documentation</h2>
927 <a name="a33" doxytag="modules.h::chanuserlist"></a><p>
928 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
931 <table cellpadding="0" cellspacing="0" border="0">
933 <td class="md" nowrap valign="top"> typedef std::deque<<a class="el" href="classuserrec.html">userrec</a>*> <a class="el" href="modules_8h.html#a33">chanuserlist</a>
938 <table cellspacing=5 cellpadding=0 border=0>
946 Holds a list of users in a channel.
950 Definition at line <a class="el" href="modules_8h-source.html#l00072">72</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.
952 Referenced by <a class="el" href="modules_8cpp-source.html#l00467">Server::GetUsers()</a>. </td>
955 <a name="a31" doxytag="modules.h::file_cache"></a><p>
956 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
959 <table cellpadding="0" cellspacing="0" border="0">
961 <td class="md" nowrap valign="top"> typedef std::deque<std::string> <a class="el" href="modules_8h.html#a31">file_cache</a>
966 <table cellspacing=5 cellpadding=0 border=0>
974 Low level definition of a <a class="el" href="classFileReader.html">FileReader</a> classes file cache area.
978 Definition at line <a class="el" href="modules_8h-source.html#l00067">67</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.
980 Referenced by <a class="el" href="modules_8cpp-source.html#l01016">FileReader::FileReader()</a>, and <a class="el" href="modules_8cpp-source.html#l01027">FileReader::LoadFile()</a>. </td>
983 <a name="a34" doxytag="modules.h::ircd_module"></a><p>
984 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
987 <table cellpadding="0" cellspacing="0" border="0">
989 <td class="md" nowrap valign="top"> typedef DLLFactory<<a class="el" href="classModuleFactory.html">ModuleFactory</a>> <a class="el" href="modules_8h.html#a34">ircd_module</a>
994 <table cellspacing=5 cellpadding=0 border=0>
1004 Definition at line <a class="el" href="modules_8h-source.html#l01304">1304</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>. </td>
1007 <a name="a32" doxytag="modules.h::string_list"></a><p>
1008 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1011 <table cellpadding="0" cellspacing="0" border="0">
1013 <td class="md" nowrap valign="top"> typedef <a class="el" href="modules_8h.html#a31">file_cache</a> <a class="el" href="modules_8h.html#a32">string_list</a>
1018 <table cellspacing=5 cellpadding=0 border=0>
1028 Definition at line <a class="el" href="modules_8h-source.html#l00068">68</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.
1030 Referenced by <a class="el" href="modules_8cpp-source.html#l00394">Module::OnChannelSync()</a>, and <a class="el" href="modules_8cpp-source.html#l00393">Module::OnUserSync()</a>. </td>
1033 <hr><h2>Function Documentation</h2>
1034 <a name="a35" doxytag="modules.h::createcommand"></a><p>
1035 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1038 <table cellpadding="0" cellspacing="0" border="0">
1040 <td class="md" nowrap valign="top"> void createcommand </td>
1041 <td class="md" valign="top">( </td>
1042 <td class="md" nowrap valign="top">char * </td>
1043 <td class="mdname" nowrap> <em>cmd</em>, </td>
1048 <td class="md" nowrap>handlerfunc </td>
1049 <td class="mdname" nowrap> <em>f</em>, </td>
1054 <td class="md" nowrap>char </td>
1055 <td class="mdname" nowrap> <em>flags</em>, </td>
1060 <td class="md" nowrap>int </td>
1061 <td class="mdname" nowrap> <em>minparams</em>, </td>
1066 <td class="md" nowrap>char * </td>
1067 <td class="mdname" nowrap> <em>source</em></td>
1071 <td class="md">) </td>
1072 <td class="md" colspan="2"></td>
1079 <table cellspacing=5 cellpadding=0 border=0>
1089 Referenced by <a class="el" href="modules_8cpp-source.html#l00504">Server::AddCommand()</a>. </td>
1092 <a name="a36" doxytag="modules.h::server_mode"></a><p>
1093 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1096 <table cellpadding="0" cellspacing="0" border="0">
1098 <td class="md" nowrap valign="top"> void server_mode </td>
1099 <td class="md" valign="top">( </td>
1100 <td class="md" nowrap valign="top">char ** </td>
1101 <td class="mdname" nowrap> <em>parameters</em>, </td>
1106 <td class="md" nowrap>int </td>
1107 <td class="mdname" nowrap> <em>pcnt</em>, </td>
1112 <td class="md" nowrap><a class="el" href="classuserrec.html">userrec</a> * </td>
1113 <td class="mdname" nowrap> <em>user</em></td>
1117 <td class="md">) </td>
1118 <td class="md" colspan="2"></td>
1125 <table cellspacing=5 cellpadding=0 border=0>
1135 Referenced by <a class="el" href="modules_8cpp-source.html#l00509">Server::SendMode()</a>. </td>
1138 <hr size="1"><address style="align: right;"><small>Generated on Fri May 13 01:59:15 2005 for InspIRCd by
1139 <a href="http://www.doxygen.org/index.html">
1140 <img src="doxygen.png" alt="doxygen" align="middle" border=0 >
1141 </a>1.3.3 </small></address>