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 <a href="modules_8h-source.html">Go to the source code of this file.</a><table border=0 cellpadding=0 cellspacing=0>
18 <tr><td colspan=2><br><h2>Compounds</h2></td></tr>
19 <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>
21 <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>
22 <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>
24 <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>
25 <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>
27 <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>
28 <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>
30 <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>
31 <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>
33 <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>
34 <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>
36 <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>
37 <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>
39 <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>
40 <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>
42 <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>
43 <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>
45 <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>
46 <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>
48 <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>
49 <tr><td colspan=2><br><h2>Defines</h2></td></tr>
50 <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>
52 <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>
54 <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>
56 <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>
58 <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>
60 <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>
62 <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>
64 <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>
66 <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>
68 <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>
70 <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>
72 <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>
74 <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>
76 <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>
78 <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>
80 <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>
82 <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>
84 <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>
86 <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>
88 <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>
90 <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>
92 <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>
94 <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>
96 <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>
98 <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>
100 <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>
102 <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>
104 <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>
106 <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>
108 <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>
110 <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>
112 <tr><td colspan=2><br><h2>Typedefs</h2></td></tr>
113 <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>
115 <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>
116 <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>
118 <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>
120 <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>
121 <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>
123 <tr><td colspan=2><br><h2>Functions</h2></td></tr>
124 <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>
126 <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>
129 <hr><h2>Define Documentation</h2>
130 <a name="a17" doxytag="modules.h::AC_DEHALFOP"></a><p>
131 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
134 <table cellpadding="0" cellspacing="0" border="0">
136 <td class="md" nowrap valign="top"> #define AC_DEHALFOP 6
141 <table cellspacing=5 cellpadding=0 border=0>
151 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>
154 <a name="a12" doxytag="modules.h::AC_DEOP"></a><p>
155 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
158 <table cellpadding="0" cellspacing="0" border="0">
160 <td class="md" nowrap valign="top"> #define AC_DEOP 1
165 <table cellspacing=5 cellpadding=0 border=0>
175 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>
178 <a name="a15" doxytag="modules.h::AC_DEVOICE"></a><p>
179 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
182 <table cellpadding="0" cellspacing="0" border="0">
184 <td class="md" nowrap valign="top"> #define AC_DEVOICE 4
189 <table cellspacing=5 cellpadding=0 border=0>
199 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>
202 <a name="a19" doxytag="modules.h::AC_GENERAL_MODE"></a><p>
203 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
206 <table cellpadding="0" cellspacing="0" border="0">
208 <td class="md" nowrap valign="top"> #define AC_GENERAL_MODE 8
213 <table cellspacing=5 cellpadding=0 border=0>
223 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>
226 <a name="a16" doxytag="modules.h::AC_HALFOP"></a><p>
227 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
230 <table cellpadding="0" cellspacing="0" border="0">
232 <td class="md" nowrap valign="top"> #define AC_HALFOP 5
237 <table cellspacing=5 cellpadding=0 border=0>
247 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>
250 <a name="a18" doxytag="modules.h::AC_INVITE"></a><p>
251 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
254 <table cellpadding="0" cellspacing="0" border="0">
256 <td class="md" nowrap valign="top"> #define AC_INVITE 7
261 <table cellspacing=5 cellpadding=0 border=0>
271 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>
274 <a name="a11" doxytag="modules.h::AC_KICK"></a><p>
275 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
278 <table cellpadding="0" cellspacing="0" border="0">
280 <td class="md" nowrap valign="top"> #define AC_KICK 0
285 <table cellspacing=5 cellpadding=0 border=0>
295 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>
298 <a name="a13" doxytag="modules.h::AC_OP"></a><p>
299 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
302 <table cellpadding="0" cellspacing="0" border="0">
304 <td class="md" nowrap valign="top"> #define AC_OP 2
309 <table cellspacing=5 cellpadding=0 border=0>
319 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>
322 <a name="a14" doxytag="modules.h::AC_VOICE"></a><p>
323 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
326 <table cellpadding="0" cellspacing="0" border="0">
328 <td class="md" nowrap valign="top"> #define AC_VOICE 3
333 <table cellspacing=5 cellpadding=0 border=0>
343 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>
346 <a name="a10" doxytag="modules.h::ACR_ALLOW"></a><p>
347 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
350 <table cellpadding="0" cellspacing="0" border="0">
352 <td class="md" nowrap valign="top"> #define ACR_ALLOW 2
357 <table cellspacing=5 cellpadding=0 border=0>
367 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>
370 <a name="a8" doxytag="modules.h::ACR_DEFAULT"></a><p>
371 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
374 <table cellpadding="0" cellspacing="0" border="0">
376 <td class="md" nowrap valign="top"> #define ACR_DEFAULT 0
381 <table cellspacing=5 cellpadding=0 border=0>
391 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>.
393 Referenced by <a class="el" href="modules_8cpp-source.html#l00391">Module::OnAccessCheck()</a>. </td>
396 <a name="a9" doxytag="modules.h::ACR_DENY"></a><p>
397 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
400 <table cellpadding="0" cellspacing="0" border="0">
402 <td class="md" nowrap valign="top"> #define ACR_DENY 1
407 <table cellspacing=5 cellpadding=0 border=0>
417 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>
420 <a name="a30" doxytag="modules.h::CONF_FILE_NOT_FOUND"></a><p>
421 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
424 <table cellpadding="0" cellspacing="0" border="0">
426 <td class="md" nowrap valign="top"> #define CONF_FILE_NOT_FOUND 0x000200
431 <table cellspacing=5 cellpadding=0 border=0>
441 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>.
443 Referenced by <a class="el" href="modules_8cpp-source.html#l00869">ConfigReader::ConfigReader()</a>. </td>
446 <a name="a27" doxytag="modules.h::CONF_NOT_A_NUMBER"></a><p>
447 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
450 <table cellpadding="0" cellspacing="0" border="0">
452 <td class="md" nowrap valign="top"> #define CONF_NOT_A_NUMBER 0x000010
457 <table cellspacing=5 cellpadding=0 border=0>
467 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>.
469 Referenced by <a class="el" href="modules_8cpp-source.html#l00930">ConfigReader::ReadInteger()</a>. </td>
472 <a name="a28" doxytag="modules.h::CONF_NOT_UNSIGNED"></a><p>
473 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
476 <table cellpadding="0" cellspacing="0" border="0">
478 <td class="md" nowrap valign="top"> #define CONF_NOT_UNSIGNED 0x000080
483 <table cellspacing=5 cellpadding=0 border=0>
493 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>.
495 Referenced by <a class="el" href="modules_8cpp-source.html#l00930">ConfigReader::ReadInteger()</a>. </td>
498 <a name="a29" doxytag="modules.h::CONF_VALUE_NOT_FOUND"></a><p>
499 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
502 <table cellpadding="0" cellspacing="0" border="0">
504 <td class="md" nowrap valign="top"> #define CONF_VALUE_NOT_FOUND 0x000100
509 <table cellspacing=5 cellpadding=0 border=0>
519 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>.
521 Referenced by <a class="el" href="modules_8cpp-source.html#l00913">ConfigReader::ReadFlag()</a>, <a class="el" href="modules_8cpp-source.html#l00930">ConfigReader::ReadInteger()</a>, and <a class="el" href="modules_8cpp-source.html#l00897">ConfigReader::ReadValue()</a>. </td>
524 <a name="a0" doxytag="modules.h::DEBUG"></a><p>
525 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
528 <table cellpadding="0" cellspacing="0" border="0">
530 <td class="md" nowrap valign="top"> #define DEBUG 10
535 <table cellspacing=5 cellpadding=0 border=0>
545 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>.
547 Referenced by <a class="el" href="modules_8cpp-source.html#l00638">Server::AddExtendedMode()</a>, <a class="el" href="channels_8cpp-source.html#l00215">chanrec::AddUser()</a>, <a class="el" href="channels_8cpp-source.html#l00221">chanrec::DelUser()</a>, <a class="el" href="users_8cpp-source.html#l00118">userrec::HasPermission()</a>, <a class="el" href="channels_8cpp-source.html#l00181">chanrec::IsCustomModeSet()</a>, <a class="el" href="users_8cpp-source.html#l00096">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#l00264">userrec::SetWriteError()</a>, and <a class="el" href="modules_8cpp-source.html#l00680">Server::UserToPseudo()</a>. </td>
550 <a name="a2" doxytag="modules.h::DEFAULT"></a><p>
551 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
554 <table cellpadding="0" cellspacing="0" border="0">
556 <td class="md" nowrap valign="top"> #define DEFAULT 30
561 <table cellspacing=5 cellpadding=0 border=0>
571 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>
574 <a name="a26" doxytag="modules.h::FD_MAGIC_NUMBER"></a><p>
575 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
578 <table cellpadding="0" cellspacing="0" border="0">
580 <td class="md" nowrap valign="top"> #define FD_MAGIC_NUMBER -42
585 <table cellspacing=5 cellpadding=0 border=0>
595 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>.
597 Referenced by <a class="el" href="modules_8cpp-source.html#l00699">Server::PseudoToUser()</a>, and <a class="el" href="modules_8cpp-source.html#l00680">Server::UserToPseudo()</a>. </td>
600 <a name="a24" doxytag="modules.h::FOREACH_MOD"></a><p>
601 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
604 <table cellpadding="0" cellspacing="0" border="0">
606 <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]->
611 <table cellspacing=5 cellpadding=0 border=0>
621 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>.
623 Referenced by <a class="el" href="modules_8cpp-source.html#l00356">Event::Send()</a>. </td>
626 <a name="a25" doxytag="modules.h::FOREACH_RESULT"></a><p>
627 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
630 <table cellpadding="0" cellspacing="0" border="0">
632 <td class="md" nowrap valign="top"> #define FOREACH_RESULT</td>
633 <td class="md" valign="top">( </td>
634 <td class="md" nowrap valign="top">x </td>
635 <td class="mdname1" valign="top" nowrap> </td>
636 <td class="md" valign="top"> ) </td>
637 <td class="md" nowrap>
642 <table cellspacing=5 cellpadding=0 border=0>
650 <b>Value:</b><div class="fragment"><pre>{ MOD_RESULT = 0; \
651 <span class="keywordflow">for</span> (<span class="keywordtype">int</span> _i = 0; _i <= <a class="code" href="modules_8cpp.html#a1">MODCOUNT</a>; _i++) { \
652 <span class="keywordtype">int</span> res = <a class="code" href="channels_8cpp.html#a2">modules</a>[_i]->x ; \
653 <span class="keywordflow">if</span> (res != 0) { \
655 <span class="keywordflow">break</span>; \
661 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>
664 <a name="a5" doxytag="modules.h::MT_CHANNEL"></a><p>
665 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
668 <table cellpadding="0" cellspacing="0" border="0">
670 <td class="md" nowrap valign="top"> #define MT_CHANNEL 1
675 <table cellspacing=5 cellpadding=0 border=0>
685 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>.
687 Referenced by <a class="el" href="modules_8cpp-source.html#l00666">Server::AddExtendedListMode()</a>, and <a class="el" href="modules_8cpp-source.html#l00294">ModeMakeList()</a>. </td>
690 <a name="a6" doxytag="modules.h::MT_CLIENT"></a><p>
691 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
694 <table cellpadding="0" cellspacing="0" border="0">
696 <td class="md" nowrap valign="top"> #define MT_CLIENT 2
701 <table cellspacing=5 cellpadding=0 border=0>
711 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>.
713 Referenced by <a class="el" href="modules_8cpp-source.html#l00638">Server::AddExtendedMode()</a>. </td>
716 <a name="a7" doxytag="modules.h::MT_SERVER"></a><p>
717 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
720 <table cellpadding="0" cellspacing="0" border="0">
722 <td class="md" nowrap valign="top"> #define MT_SERVER 3
727 <table cellspacing=5 cellpadding=0 border=0>
737 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>.
739 Referenced by <a class="el" href="modules_8cpp-source.html#l00638">Server::AddExtendedMode()</a>. </td>
742 <a name="a4" doxytag="modules.h::NONE"></a><p>
743 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
746 <table cellpadding="0" cellspacing="0" border="0">
748 <td class="md" nowrap valign="top"> #define NONE 50
753 <table cellspacing=5 cellpadding=0 border=0>
763 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>
766 <a name="a3" doxytag="modules.h::SPARSE"></a><p>
767 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
770 <table cellpadding="0" cellspacing="0" border="0">
772 <td class="md" nowrap valign="top"> #define SPARSE 40
777 <table cellspacing=5 cellpadding=0 border=0>
787 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>
790 <a name="a1" doxytag="modules.h::VERBOSE"></a><p>
791 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
794 <table cellpadding="0" cellspacing="0" border="0">
796 <td class="md" nowrap valign="top"> #define VERBOSE 20
801 <table cellspacing=5 cellpadding=0 border=0>
811 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>
814 <a name="a23" doxytag="modules.h::VF_COMMON"></a><p>
815 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
818 <table cellpadding="0" cellspacing="0" border="0">
820 <td class="md" nowrap valign="top"> #define VF_COMMON 8
825 <table cellspacing=5 cellpadding=0 border=0>
835 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>
838 <a name="a22" doxytag="modules.h::VF_SERVICEPROVIDER"></a><p>
839 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
842 <table cellpadding="0" cellspacing="0" border="0">
844 <td class="md" nowrap valign="top"> #define VF_SERVICEPROVIDER 4
849 <table cellspacing=5 cellpadding=0 border=0>
859 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>
862 <a name="a20" doxytag="modules.h::VF_STATIC"></a><p>
863 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
866 <table cellpadding="0" cellspacing="0" border="0">
868 <td class="md" nowrap valign="top"> #define VF_STATIC 1
873 <table cellspacing=5 cellpadding=0 border=0>
883 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>
886 <a name="a21" doxytag="modules.h::VF_VENDOR"></a><p>
887 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
890 <table cellpadding="0" cellspacing="0" border="0">
892 <td class="md" nowrap valign="top"> #define VF_VENDOR 2
897 <table cellspacing=5 cellpadding=0 border=0>
907 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>.
909 Referenced by <a class="el" href="modules_8cpp-source.html#l00382">Module::GetVersion()</a>. </td>
912 <hr><h2>Typedef Documentation</h2>
913 <a name="a33" doxytag="modules.h::chanuserlist"></a><p>
914 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
917 <table cellpadding="0" cellspacing="0" border="0">
919 <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>
924 <table cellspacing=5 cellpadding=0 border=0>
932 Holds a list of users in a channel.
936 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>.
938 Referenced by <a class="el" href="modules_8cpp-source.html#l00466">Server::GetUsers()</a>. </td>
941 <a name="a31" doxytag="modules.h::file_cache"></a><p>
942 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
945 <table cellpadding="0" cellspacing="0" border="0">
947 <td class="md" nowrap valign="top"> typedef std::deque<std::string> <a class="el" href="modules_8h.html#a31">file_cache</a>
952 <table cellspacing=5 cellpadding=0 border=0>
960 Low level definition of a <a class="el" href="classFileReader.html">FileReader</a> classes file cache area.
964 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>.
966 Referenced by <a class="el" href="modules_8cpp-source.html#l01015">FileReader::FileReader()</a>, and <a class="el" href="modules_8cpp-source.html#l01026">FileReader::LoadFile()</a>. </td>
969 <a name="a34" doxytag="modules.h::ircd_module"></a><p>
970 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
973 <table cellpadding="0" cellspacing="0" border="0">
975 <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>
980 <table cellspacing=5 cellpadding=0 border=0>
990 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>
993 <a name="a32" doxytag="modules.h::string_list"></a><p>
994 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
997 <table cellpadding="0" cellspacing="0" border="0">
999 <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>
1004 <table cellspacing=5 cellpadding=0 border=0>
1014 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>.
1016 Referenced by <a class="el" href="modules_8cpp-source.html#l00393">Module::OnChannelSync()</a>, and <a class="el" href="modules_8cpp-source.html#l00392">Module::OnUserSync()</a>. </td>
1019 <hr><h2>Function Documentation</h2>
1020 <a name="a35" doxytag="modules.h::createcommand"></a><p>
1021 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1024 <table cellpadding="0" cellspacing="0" border="0">
1026 <td class="md" nowrap valign="top"> void createcommand </td>
1027 <td class="md" valign="top">( </td>
1028 <td class="md" nowrap valign="top">char * </td>
1029 <td class="mdname" nowrap> <em>cmd</em>, </td>
1034 <td class="md" nowrap>handlerfunc </td>
1035 <td class="mdname" nowrap> <em>f</em>, </td>
1040 <td class="md" nowrap>char </td>
1041 <td class="mdname" nowrap> <em>flags</em>, </td>
1046 <td class="md" nowrap>int </td>
1047 <td class="mdname" nowrap> <em>minparams</em>, </td>
1052 <td class="md" nowrap>char * </td>
1053 <td class="mdname" nowrap> <em>source</em></td>
1057 <td class="md">) </td>
1058 <td class="md" colspan="2"></td>
1065 <table cellspacing=5 cellpadding=0 border=0>
1075 Referenced by <a class="el" href="modules_8cpp-source.html#l00503">Server::AddCommand()</a>. </td>
1078 <a name="a36" doxytag="modules.h::server_mode"></a><p>
1079 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1082 <table cellpadding="0" cellspacing="0" border="0">
1084 <td class="md" nowrap valign="top"> void server_mode </td>
1085 <td class="md" valign="top">( </td>
1086 <td class="md" nowrap valign="top">char ** </td>
1087 <td class="mdname" nowrap> <em>parameters</em>, </td>
1092 <td class="md" nowrap>int </td>
1093 <td class="mdname" nowrap> <em>pcnt</em>, </td>
1098 <td class="md" nowrap><a class="el" href="classuserrec.html">userrec</a> * </td>
1099 <td class="mdname" nowrap> <em>user</em></td>
1103 <td class="md">) </td>
1104 <td class="md" colspan="2"></td>
1111 <table cellspacing=5 cellpadding=0 border=0>
1121 Referenced by <a class="el" href="modules_8cpp-source.html#l00508">Server::SendMode()</a>. </td>
1124 <hr size="1"><address style="align: right;"><small>Generated on Thu May 12 02:25:16 2005 for InspIRCd by
1125 <a href="http://www.doxygen.org/index.html">
1126 <img src="doxygen.png" alt="doxygen" align="middle" border=0 >
1127 </a>1.3.3 </small></address>