]> git.netwichtig.de Git - user/henk/code/inspircd.git/blob - docs/module-doc/modules_8h.html
Added documentation of new ConfigReader methods suggested by Azhrarn for sanity
[user/henk/code/inspircd.git] / docs / module-doc / modules_8h.html
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>modules.h File Reference</title>
4 <link href="inspircd.css" rel="stylesheet" type="text/css">
5 </head><body>
6 <!-- Generated by Doxygen 1.3-rc3 -->
7 <center>
8 <a class="qindex" href="main.html">Main Page</a> &nbsp; <a class="qindex" href="namespaces.html">Namespace List</a> &nbsp; <a class="qindex" href="hierarchy.html">Class Hierarchy</a> &nbsp; <a class="qindex" href="classes.html">Alphabetical List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
9 <hr><h1>modules.h File Reference</h1><code>#include "dynamic.h"</code><br>
10 <code>#include "<a class="el" href="base_8h-source.html">base.h</a>"</code><br>
11 <code>#include "<a class="el" href="ctables_8h-source.html">ctables.h</a>"</code><br>
12 <code>#include &lt;string&gt;</code><br>
13 <code>#include &lt;deque&gt;</code><br>
14 <code>#include &lt;sstream&gt;</code><br>
15
16 <p>
17 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>
18 <map name="modules.h_map">
19 <area href="base_8h.html" shape="rect" coords="88,86,136,107" alt="">
20 <area href="ctables_8h.html" shape="rect" coords="213,155,275,176" alt="">
21 </map>
22
23 <p>
24 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>
25 <map name="modules.hdep_map">
26 <area href="channels_8cpp.html" shape="rect" coords="7,16,95,37" alt="">
27 <area href="modules_8cpp.html" shape="rect" coords="119,16,201,37" alt="">
28 </map>
29
30 <p>
31 <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></td></tr>
33 <tr><td colspan=2><br><h2>Compounds</h2></td></tr>
34 <tr><td nowrap align=right valign=top>class &nbsp;</td><td valign=bottom><a class="el" href="classAdmin.html">Admin</a></td></tr>
35 <tr><td>&nbsp;</td><td><font size=-1><em>Holds /ADMIN data This class contains the admin details of the local server.</em> <a href="classAdmin.html#_details">More...</a><em></em></font><br><br></td></tr>
36 <tr><td nowrap align=right valign=top>class &nbsp;</td><td valign=bottom><a class="el" href="classConfigReader.html">ConfigReader</a></td></tr>
37 <tr><td>&nbsp;</td><td><font size=-1><em>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></em></font><br><br></td></tr>
38 <tr><td nowrap align=right valign=top>class &nbsp;</td><td valign=bottom><a class="el" href="classFileReader.html">FileReader</a></td></tr>
39 <tr><td>&nbsp;</td><td><font size=-1><em>Caches a text file into memory and can be used to retrieve lines from it.</em> <a href="classFileReader.html#_details">More...</a><em></em></font><br><br></td></tr>
40 <tr><td nowrap align=right valign=top>class &nbsp;</td><td valign=bottom><a class="el" href="classModule.html">Module</a></td></tr>
41 <tr><td>&nbsp;</td><td><font size=-1><em>Base class for all InspIRCd modules This class is the base class for InspIRCd modules.</em> <a href="classModule.html#_details">More...</a><em></em></font><br><br></td></tr>
42 <tr><td nowrap align=right valign=top>class &nbsp;</td><td valign=bottom><a class="el" href="classModuleFactory.html">ModuleFactory</a></td></tr>
43 <tr><td>&nbsp;</td><td><font size=-1><em>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></em></font><br><br></td></tr>
44 <tr><td nowrap align=right valign=top>class &nbsp;</td><td valign=bottom><a class="el" href="classServer.html">Server</a></td></tr>
45 <tr><td>&nbsp;</td><td><font size=-1><em>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></em></font><br><br></td></tr>
46 <tr><td nowrap align=right valign=top>class &nbsp;</td><td valign=bottom><a class="el" href="classVersion.html">Version</a></td></tr>
47 <tr><td>&nbsp;</td><td><font size=-1><em>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></em></font><br><br></td></tr>
48 <tr><td colspan=2><br><h2>Defines</h2></td></tr>
49 <tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="modules_8h.html#a0">DEBUG</a>&nbsp;&nbsp;&nbsp;10</td></tr>
50 <tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="modules_8h.html#a1">VERBOSE</a>&nbsp;&nbsp;&nbsp;20</td></tr>
51 <tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="modules_8h.html#a2">DEFAULT</a>&nbsp;&nbsp;&nbsp;30</td></tr>
52 <tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="modules_8h.html#a3">SPARSE</a>&nbsp;&nbsp;&nbsp;40</td></tr>
53 <tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="modules_8h.html#a4">NONE</a>&nbsp;&nbsp;&nbsp;50</td></tr>
54 <tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="modules_8h.html#a5">MT_CHANNEL</a>&nbsp;&nbsp;&nbsp;1</td></tr>
55 <tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="modules_8h.html#a6">MT_CLIENT</a>&nbsp;&nbsp;&nbsp;2</td></tr>
56 <tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="modules_8h.html#a7">MT_SERVER</a>&nbsp;&nbsp;&nbsp;3</td></tr>
57 <tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="modules_8h.html#a8">ACR_DEFAULT</a>&nbsp;&nbsp;&nbsp;0</td></tr>
58 <tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="modules_8h.html#a9">ACR_DENY</a>&nbsp;&nbsp;&nbsp;1</td></tr>
59 <tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="modules_8h.html#a10">ACR_ALLOW</a>&nbsp;&nbsp;&nbsp;2</td></tr>
60 <tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="modules_8h.html#a11">AC_KICK</a>&nbsp;&nbsp;&nbsp;0</td></tr>
61 <tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="modules_8h.html#a12">AC_DEOP</a>&nbsp;&nbsp;&nbsp;1</td></tr>
62 <tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="modules_8h.html#a13">AC_OP</a>&nbsp;&nbsp;&nbsp;2</td></tr>
63 <tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="modules_8h.html#a14">AC_VOICE</a>&nbsp;&nbsp;&nbsp;3</td></tr>
64 <tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="modules_8h.html#a15">AC_DEVOICE</a>&nbsp;&nbsp;&nbsp;4</td></tr>
65 <tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="modules_8h.html#a16">AC_HALFOP</a>&nbsp;&nbsp;&nbsp;5</td></tr>
66 <tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="modules_8h.html#a17">AC_DEHALFOP</a>&nbsp;&nbsp;&nbsp;6</td></tr>
67 <tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="modules_8h.html#a18">AC_INVITE</a>&nbsp;&nbsp;&nbsp;7</td></tr>
68 <tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="modules_8h.html#a19">AC_GENERAL_MODE</a>&nbsp;&nbsp;&nbsp;8</td></tr>
69 <tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="modules_8h.html#a20">FOREACH_MOD</a>&nbsp;&nbsp;&nbsp;for (int i = 0; i &lt;= <a class="el" href="modules_8cpp.html#a1">MODCOUNT</a>; i++) modules[i]-&gt;</td></tr>
70 <tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="modules_8h.html#a21">FOREACH_RESULT</a>(x)</td></tr>
71 <tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="modules_8h.html#a22">CONF_NOT_A_NUMBER</a>&nbsp;&nbsp;&nbsp;0x000010</td></tr>
72 <tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="modules_8h.html#a23">CONF_NOT_UNSIGNED</a>&nbsp;&nbsp;&nbsp;0x000080</td></tr>
73 <tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="modules_8h.html#a24">CONF_VALUE_NOT_FOUND</a>&nbsp;&nbsp;&nbsp;0x000100</td></tr>
74 <tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="modules_8h.html#a25">CONF_FILE_NOT_FOUND</a>&nbsp;&nbsp;&nbsp;0x000200</td></tr>
75 <tr><td colspan=2><br><h2>Typedefs</h2></td></tr>
76 <tr><td nowrap align=right valign=top>typedef std::deque&lt; std::string &gt;&nbsp;</td><td valign=bottom><a class="el" href="modules_8h.html#a26">file_cache</a></td></tr>
77 <tr><td>&nbsp;</td><td><font size=-1><em>Low level definition of a <a class="el" href="classFileReader.html">FileReader</a> classes file cache area.</em> <a href="#a26"></a><em></em></font><br><br></td></tr>
78 <tr><td nowrap align=right valign=top>typedef <a class="el" href="modules_8h.html#a26">file_cache</a>&nbsp;</td><td valign=bottom><a class="el" href="modules_8h.html#a27">string_list</a></td></tr>
79 <tr><td nowrap align=right valign=top>typedef std::deque&lt; <a class="el" href="classuserrec.html">userrec</a> * &gt;&nbsp;</td><td valign=bottom><a class="el" href="modules_8h.html#a28">chanuserlist</a></td></tr>
80 <tr><td>&nbsp;</td><td><font size=-1><em>Holds a list of users in a channel.</em> <a href="#a28"></a><em></em></font><br><br></td></tr>
81 <tr><td nowrap align=right valign=top>typedef DLLFactory&lt; <a class="el" href="classModuleFactory.html">ModuleFactory</a> &gt;&nbsp;</td><td valign=bottom><a class="el" href="modules_8h.html#a29">ircd_module</a></td></tr>
82 <tr><td colspan=2><br><h2>Functions</h2></td></tr>
83 <tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="modules_8h.html#a30">createcommand</a> (char *cmd, handlerfunc f, char flags, int minparams)</td></tr>
84 <tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="modules_8h.html#a31">server_mode</a> (char **parameters, int pcnt, <a class="el" href="classuserrec.html">userrec</a> *user)</td></tr>
85 </table>
86 <hr><h2>Define Documentation</h2>
87 <a name="a17" doxytag="modules.h::AC_DEHALFOP"></a><p>
88 <table width="100%" cellpadding="2" cellspacing="0" border="0">
89   <tr>
90     <td class="md">
91       <table cellpadding="0" cellspacing="0" border="0">
92         <tr>
93           <td class="md" nowrap valign="top"> #define AC_DEHALFOP&nbsp;&nbsp;&nbsp;6
94       </table>
95     </td>
96   </tr>
97 </table>
98 <table cellspacing=5 cellpadding=0 border=0>
99   <tr>
100     <td>
101       &nbsp;
102     </td>
103     <td>
104
105 <p>
106
107 <p>
108 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>.    </td>
109   </tr>
110 </table>
111 <a name="a12" doxytag="modules.h::AC_DEOP"></a><p>
112 <table width="100%" cellpadding="2" cellspacing="0" border="0">
113   <tr>
114     <td class="md">
115       <table cellpadding="0" cellspacing="0" border="0">
116         <tr>
117           <td class="md" nowrap valign="top"> #define AC_DEOP&nbsp;&nbsp;&nbsp;1
118       </table>
119     </td>
120   </tr>
121 </table>
122 <table cellspacing=5 cellpadding=0 border=0>
123   <tr>
124     <td>
125       &nbsp;
126     </td>
127     <td>
128
129 <p>
130
131 <p>
132 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>.    </td>
133   </tr>
134 </table>
135 <a name="a15" doxytag="modules.h::AC_DEVOICE"></a><p>
136 <table width="100%" cellpadding="2" cellspacing="0" border="0">
137   <tr>
138     <td class="md">
139       <table cellpadding="0" cellspacing="0" border="0">
140         <tr>
141           <td class="md" nowrap valign="top"> #define AC_DEVOICE&nbsp;&nbsp;&nbsp;4
142       </table>
143     </td>
144   </tr>
145 </table>
146 <table cellspacing=5 cellpadding=0 border=0>
147   <tr>
148     <td>
149       &nbsp;
150     </td>
151     <td>
152
153 <p>
154
155 <p>
156 Definition at line <a class="el" href="modules_8h-source.html#l00035">35</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.    </td>
157   </tr>
158 </table>
159 <a name="a19" doxytag="modules.h::AC_GENERAL_MODE"></a><p>
160 <table width="100%" cellpadding="2" cellspacing="0" border="0">
161   <tr>
162     <td class="md">
163       <table cellpadding="0" cellspacing="0" border="0">
164         <tr>
165           <td class="md" nowrap valign="top"> #define AC_GENERAL_MODE&nbsp;&nbsp;&nbsp;8
166       </table>
167     </td>
168   </tr>
169 </table>
170 <table cellspacing=5 cellpadding=0 border=0>
171   <tr>
172     <td>
173       &nbsp;
174     </td>
175     <td>
176
177 <p>
178
179 <p>
180 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>
181   </tr>
182 </table>
183 <a name="a16" doxytag="modules.h::AC_HALFOP"></a><p>
184 <table width="100%" cellpadding="2" cellspacing="0" border="0">
185   <tr>
186     <td class="md">
187       <table cellpadding="0" cellspacing="0" border="0">
188         <tr>
189           <td class="md" nowrap valign="top"> #define AC_HALFOP&nbsp;&nbsp;&nbsp;5
190       </table>
191     </td>
192   </tr>
193 </table>
194 <table cellspacing=5 cellpadding=0 border=0>
195   <tr>
196     <td>
197       &nbsp;
198     </td>
199     <td>
200
201 <p>
202
203 <p>
204 Definition at line <a class="el" href="modules_8h-source.html#l00036">36</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.    </td>
205   </tr>
206 </table>
207 <a name="a18" doxytag="modules.h::AC_INVITE"></a><p>
208 <table width="100%" cellpadding="2" cellspacing="0" border="0">
209   <tr>
210     <td class="md">
211       <table cellpadding="0" cellspacing="0" border="0">
212         <tr>
213           <td class="md" nowrap valign="top"> #define AC_INVITE&nbsp;&nbsp;&nbsp;7
214       </table>
215     </td>
216   </tr>
217 </table>
218 <table cellspacing=5 cellpadding=0 border=0>
219   <tr>
220     <td>
221       &nbsp;
222     </td>
223     <td>
224
225 <p>
226
227 <p>
228 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>
229   </tr>
230 </table>
231 <a name="a11" doxytag="modules.h::AC_KICK"></a><p>
232 <table width="100%" cellpadding="2" cellspacing="0" border="0">
233   <tr>
234     <td class="md">
235       <table cellpadding="0" cellspacing="0" border="0">
236         <tr>
237           <td class="md" nowrap valign="top"> #define AC_KICK&nbsp;&nbsp;&nbsp;0
238       </table>
239     </td>
240   </tr>
241 </table>
242 <table cellspacing=5 cellpadding=0 border=0>
243   <tr>
244     <td>
245       &nbsp;
246     </td>
247     <td>
248
249 <p>
250
251 <p>
252 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>.    </td>
253   </tr>
254 </table>
255 <a name="a13" doxytag="modules.h::AC_OP"></a><p>
256 <table width="100%" cellpadding="2" cellspacing="0" border="0">
257   <tr>
258     <td class="md">
259       <table cellpadding="0" cellspacing="0" border="0">
260         <tr>
261           <td class="md" nowrap valign="top"> #define AC_OP&nbsp;&nbsp;&nbsp;2
262       </table>
263     </td>
264   </tr>
265 </table>
266 <table cellspacing=5 cellpadding=0 border=0>
267   <tr>
268     <td>
269       &nbsp;
270     </td>
271     <td>
272
273 <p>
274
275 <p>
276 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>.    </td>
277   </tr>
278 </table>
279 <a name="a14" doxytag="modules.h::AC_VOICE"></a><p>
280 <table width="100%" cellpadding="2" cellspacing="0" border="0">
281   <tr>
282     <td class="md">
283       <table cellpadding="0" cellspacing="0" border="0">
284         <tr>
285           <td class="md" nowrap valign="top"> #define AC_VOICE&nbsp;&nbsp;&nbsp;3
286       </table>
287     </td>
288   </tr>
289 </table>
290 <table cellspacing=5 cellpadding=0 border=0>
291   <tr>
292     <td>
293       &nbsp;
294     </td>
295     <td>
296
297 <p>
298
299 <p>
300 Definition at line <a class="el" href="modules_8h-source.html#l00034">34</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.    </td>
301   </tr>
302 </table>
303 <a name="a10" doxytag="modules.h::ACR_ALLOW"></a><p>
304 <table width="100%" cellpadding="2" cellspacing="0" border="0">
305   <tr>
306     <td class="md">
307       <table cellpadding="0" cellspacing="0" border="0">
308         <tr>
309           <td class="md" nowrap valign="top"> #define ACR_ALLOW&nbsp;&nbsp;&nbsp;2
310       </table>
311     </td>
312   </tr>
313 </table>
314 <table cellspacing=5 cellpadding=0 border=0>
315   <tr>
316     <td>
317       &nbsp;
318     </td>
319     <td>
320
321 <p>
322
323 <p>
324 Definition at line <a class="el" href="modules_8h-source.html#l00029">29</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.    </td>
325   </tr>
326 </table>
327 <a name="a8" doxytag="modules.h::ACR_DEFAULT"></a><p>
328 <table width="100%" cellpadding="2" cellspacing="0" border="0">
329   <tr>
330     <td class="md">
331       <table cellpadding="0" cellspacing="0" border="0">
332         <tr>
333           <td class="md" nowrap valign="top"> #define ACR_DEFAULT&nbsp;&nbsp;&nbsp;0
334       </table>
335     </td>
336   </tr>
337 </table>
338 <table cellspacing=5 cellpadding=0 border=0>
339   <tr>
340     <td>
341       &nbsp;
342     </td>
343     <td>
344
345 <p>
346
347 <p>
348 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>.
349 <p>
350 Referenced by <a class="el" href="modules_8cpp-source.html#l00304">Module::OnAccessCheck()</a>.    </td>
351   </tr>
352 </table>
353 <a name="a9" doxytag="modules.h::ACR_DENY"></a><p>
354 <table width="100%" cellpadding="2" cellspacing="0" border="0">
355   <tr>
356     <td class="md">
357       <table cellpadding="0" cellspacing="0" border="0">
358         <tr>
359           <td class="md" nowrap valign="top"> #define ACR_DENY&nbsp;&nbsp;&nbsp;1
360       </table>
361     </td>
362   </tr>
363 </table>
364 <table cellspacing=5 cellpadding=0 border=0>
365   <tr>
366     <td>
367       &nbsp;
368     </td>
369     <td>
370
371 <p>
372
373 <p>
374 Definition at line <a class="el" href="modules_8h-source.html#l00028">28</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.    </td>
375   </tr>
376 </table>
377 <a name="a25" doxytag="modules.h::CONF_FILE_NOT_FOUND"></a><p>
378 <table width="100%" cellpadding="2" cellspacing="0" border="0">
379   <tr>
380     <td class="md">
381       <table cellpadding="0" cellspacing="0" border="0">
382         <tr>
383           <td class="md" nowrap valign="top"> #define CONF_FILE_NOT_FOUND&nbsp;&nbsp;&nbsp;0x000200
384       </table>
385     </td>
386   </tr>
387 </table>
388 <table cellspacing=5 cellpadding=0 border=0>
389   <tr>
390     <td>
391       &nbsp;
392     </td>
393     <td>
394
395 <p>
396
397 <p>
398 Definition at line <a class="el" href="modules_8h-source.html#l00609">609</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.
399 <p>
400 Referenced by <a class="el" href="modules_8cpp-source.html#l00553">ConfigReader::ConfigReader()</a>.    </td>
401   </tr>
402 </table>
403 <a name="a22" doxytag="modules.h::CONF_NOT_A_NUMBER"></a><p>
404 <table width="100%" cellpadding="2" cellspacing="0" border="0">
405   <tr>
406     <td class="md">
407       <table cellpadding="0" cellspacing="0" border="0">
408         <tr>
409           <td class="md" nowrap valign="top"> #define CONF_NOT_A_NUMBER&nbsp;&nbsp;&nbsp;0x000010
410       </table>
411     </td>
412   </tr>
413 </table>
414 <table cellspacing=5 cellpadding=0 border=0>
415   <tr>
416     <td>
417       &nbsp;
418     </td>
419     <td>
420
421 <p>
422
423 <p>
424 Definition at line <a class="el" href="modules_8h-source.html#l00606">606</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.
425 <p>
426 Referenced by <a class="el" href="modules_8cpp-source.html#l00610">ConfigReader::ReadInteger()</a>.    </td>
427   </tr>
428 </table>
429 <a name="a23" doxytag="modules.h::CONF_NOT_UNSIGNED"></a><p>
430 <table width="100%" cellpadding="2" cellspacing="0" border="0">
431   <tr>
432     <td class="md">
433       <table cellpadding="0" cellspacing="0" border="0">
434         <tr>
435           <td class="md" nowrap valign="top"> #define CONF_NOT_UNSIGNED&nbsp;&nbsp;&nbsp;0x000080
436       </table>
437     </td>
438   </tr>
439 </table>
440 <table cellspacing=5 cellpadding=0 border=0>
441   <tr>
442     <td>
443       &nbsp;
444     </td>
445     <td>
446
447 <p>
448
449 <p>
450 Definition at line <a class="el" href="modules_8h-source.html#l00607">607</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.
451 <p>
452 Referenced by <a class="el" href="modules_8cpp-source.html#l00610">ConfigReader::ReadInteger()</a>.    </td>
453   </tr>
454 </table>
455 <a name="a24" doxytag="modules.h::CONF_VALUE_NOT_FOUND"></a><p>
456 <table width="100%" cellpadding="2" cellspacing="0" border="0">
457   <tr>
458     <td class="md">
459       <table cellpadding="0" cellspacing="0" border="0">
460         <tr>
461           <td class="md" nowrap valign="top"> #define CONF_VALUE_NOT_FOUND&nbsp;&nbsp;&nbsp;0x000100
462       </table>
463     </td>
464   </tr>
465 </table>
466 <table cellspacing=5 cellpadding=0 border=0>
467   <tr>
468     <td>
469       &nbsp;
470     </td>
471     <td>
472
473 <p>
474
475 <p>
476 Definition at line <a class="el" href="modules_8h-source.html#l00608">608</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.
477 <p>
478 Referenced by <a class="el" href="modules_8cpp-source.html#l00593">ConfigReader::ReadFlag()</a>, <a class="el" href="modules_8cpp-source.html#l00610">ConfigReader::ReadInteger()</a>, and <a class="el" href="modules_8cpp-source.html#l00577">ConfigReader::ReadValue()</a>.    </td>
479   </tr>
480 </table>
481 <a name="a0" doxytag="modules.h::DEBUG"></a><p>
482 <table width="100%" cellpadding="2" cellspacing="0" border="0">
483   <tr>
484     <td class="md">
485       <table cellpadding="0" cellspacing="0" border="0">
486         <tr>
487           <td class="md" nowrap valign="top"> #define DEBUG&nbsp;&nbsp;&nbsp;10
488       </table>
489     </td>
490   </tr>
491 </table>
492 <table cellspacing=5 cellpadding=0 border=0>
493   <tr>
494     <td>
495       &nbsp;
496     </td>
497     <td>
498
499 <p>
500
501 <p>
502 Definition at line <a class="el" href="modules_8h-source.html#l00013">13</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.    </td>
503   </tr>
504 </table>
505 <a name="a2" doxytag="modules.h::DEFAULT"></a><p>
506 <table width="100%" cellpadding="2" cellspacing="0" border="0">
507   <tr>
508     <td class="md">
509       <table cellpadding="0" cellspacing="0" border="0">
510         <tr>
511           <td class="md" nowrap valign="top"> #define DEFAULT&nbsp;&nbsp;&nbsp;30
512       </table>
513     </td>
514   </tr>
515 </table>
516 <table cellspacing=5 cellpadding=0 border=0>
517   <tr>
518     <td>
519       &nbsp;
520     </td>
521     <td>
522
523 <p>
524
525 <p>
526 Definition at line <a class="el" href="modules_8h-source.html#l00015">15</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.    </td>
527   </tr>
528 </table>
529 <a name="a20" doxytag="modules.h::FOREACH_MOD"></a><p>
530 <table width="100%" cellpadding="2" cellspacing="0" border="0">
531   <tr>
532     <td class="md">
533       <table cellpadding="0" cellspacing="0" border="0">
534         <tr>
535           <td class="md" nowrap valign="top"> #define FOREACH_MOD&nbsp;&nbsp;&nbsp;for (int i = 0; i &lt;= <a class="el" href="modules_8cpp.html#a1">MODCOUNT</a>; i++) modules[i]-&gt;
536       </table>
537     </td>
538   </tr>
539 </table>
540 <table cellspacing=5 cellpadding=0 border=0>
541   <tr>
542     <td>
543       &nbsp;
544     </td>
545     <td>
546
547 <p>
548
549 <p>
550 Definition at line <a class="el" href="modules_8h-source.html#l00062">62</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.    </td>
551   </tr>
552 </table>
553 <a name="a21" doxytag="modules.h::FOREACH_RESULT"></a><p>
554 <table width="100%" cellpadding="2" cellspacing="0" border="0">
555   <tr>
556     <td class="md">
557       <table cellpadding="0" cellspacing="0" border="0">
558         <tr>
559           <td class="md" nowrap valign="top"> #define FOREACH_RESULT</td>
560           <td class="md" valign="top">(&nbsp;</td>
561           <td class="md" nowrap valign="top">x&nbsp;</td>
562           <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
563           <td class="md" valign="top">)&nbsp;</td>
564           <td class="md" nowrap>
565       </table>
566     </td>
567   </tr>
568 </table>
569 <table cellspacing=5 cellpadding=0 border=0>
570   <tr>
571     <td>
572       &nbsp;
573     </td>
574     <td>
575
576 <p>
577 <b>Value:</b><div class="fragment"><pre>{ MOD_RESULT = 0; \
578                         <span class="keywordflow">for</span> (<span class="keywordtype">int</span> i = 0; i &lt;= <a class="code" href="modules_8cpp.html#a1">MODCOUNT</a>; i++) { \
579                         <span class="keywordtype">int</span> res = <a class="code" href="channels_8cpp.html#a2">modules</a>[i]-&gt;x ; \
580                         <span class="keywordflow">if</span> (res) { \
581                                 MOD_RESULT = res; \
582                                 <span class="keywordflow">break</span>; \
583                         } \
584                 } \
585    }
586 </pre></div>
587 <p>
588 Definition at line <a class="el" href="modules_8h-source.html#l00070">70</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.    </td>
589   </tr>
590 </table>
591 <a name="a5" doxytag="modules.h::MT_CHANNEL"></a><p>
592 <table width="100%" cellpadding="2" cellspacing="0" border="0">
593   <tr>
594     <td class="md">
595       <table cellpadding="0" cellspacing="0" border="0">
596         <tr>
597           <td class="md" nowrap valign="top"> #define MT_CHANNEL&nbsp;&nbsp;&nbsp;1
598       </table>
599     </td>
600   </tr>
601 </table>
602 <table cellspacing=5 cellpadding=0 border=0>
603   <tr>
604     <td>
605       &nbsp;
606     </td>
607     <td>
608
609 <p>
610
611 <p>
612 Definition at line <a class="el" href="modules_8h-source.html#l00021">21</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.
613 <p>
614 Referenced by <a class="el" href="modules_8cpp-source.html#l00264">ModeMakeList()</a>.    </td>
615   </tr>
616 </table>
617 <a name="a6" doxytag="modules.h::MT_CLIENT"></a><p>
618 <table width="100%" cellpadding="2" cellspacing="0" border="0">
619   <tr>
620     <td class="md">
621       <table cellpadding="0" cellspacing="0" border="0">
622         <tr>
623           <td class="md" nowrap valign="top"> #define MT_CLIENT&nbsp;&nbsp;&nbsp;2
624       </table>
625     </td>
626   </tr>
627 </table>
628 <table cellspacing=5 cellpadding=0 border=0>
629   <tr>
630     <td>
631       &nbsp;
632     </td>
633     <td>
634
635 <p>
636
637 <p>
638 Definition at line <a class="el" href="modules_8h-source.html#l00022">22</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.
639 <p>
640 Referenced by <a class="el" href="modules_8cpp-source.html#l00519">Server::AddExtendedMode()</a>.    </td>
641   </tr>
642 </table>
643 <a name="a7" doxytag="modules.h::MT_SERVER"></a><p>
644 <table width="100%" cellpadding="2" cellspacing="0" border="0">
645   <tr>
646     <td class="md">
647       <table cellpadding="0" cellspacing="0" border="0">
648         <tr>
649           <td class="md" nowrap valign="top"> #define MT_SERVER&nbsp;&nbsp;&nbsp;3
650       </table>
651     </td>
652   </tr>
653 </table>
654 <table cellspacing=5 cellpadding=0 border=0>
655   <tr>
656     <td>
657       &nbsp;
658     </td>
659     <td>
660
661 <p>
662
663 <p>
664 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>.
665 <p>
666 Referenced by <a class="el" href="modules_8cpp-source.html#l00519">Server::AddExtendedMode()</a>.    </td>
667   </tr>
668 </table>
669 <a name="a4" doxytag="modules.h::NONE"></a><p>
670 <table width="100%" cellpadding="2" cellspacing="0" border="0">
671   <tr>
672     <td class="md">
673       <table cellpadding="0" cellspacing="0" border="0">
674         <tr>
675           <td class="md" nowrap valign="top"> #define NONE&nbsp;&nbsp;&nbsp;50
676       </table>
677     </td>
678   </tr>
679 </table>
680 <table cellspacing=5 cellpadding=0 border=0>
681   <tr>
682     <td>
683       &nbsp;
684     </td>
685     <td>
686
687 <p>
688
689 <p>
690 Definition at line <a class="el" href="modules_8h-source.html#l00017">17</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.    </td>
691   </tr>
692 </table>
693 <a name="a3" doxytag="modules.h::SPARSE"></a><p>
694 <table width="100%" cellpadding="2" cellspacing="0" border="0">
695   <tr>
696     <td class="md">
697       <table cellpadding="0" cellspacing="0" border="0">
698         <tr>
699           <td class="md" nowrap valign="top"> #define SPARSE&nbsp;&nbsp;&nbsp;40
700       </table>
701     </td>
702   </tr>
703 </table>
704 <table cellspacing=5 cellpadding=0 border=0>
705   <tr>
706     <td>
707       &nbsp;
708     </td>
709     <td>
710
711 <p>
712
713 <p>
714 Definition at line <a class="el" href="modules_8h-source.html#l00016">16</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.    </td>
715   </tr>
716 </table>
717 <a name="a1" doxytag="modules.h::VERBOSE"></a><p>
718 <table width="100%" cellpadding="2" cellspacing="0" border="0">
719   <tr>
720     <td class="md">
721       <table cellpadding="0" cellspacing="0" border="0">
722         <tr>
723           <td class="md" nowrap valign="top"> #define VERBOSE&nbsp;&nbsp;&nbsp;20
724       </table>
725     </td>
726   </tr>
727 </table>
728 <table cellspacing=5 cellpadding=0 border=0>
729   <tr>
730     <td>
731       &nbsp;
732     </td>
733     <td>
734
735 <p>
736
737 <p>
738 Definition at line <a class="el" href="modules_8h-source.html#l00014">14</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.    </td>
739   </tr>
740 </table>
741 <hr><h2>Typedef Documentation</h2>
742 <a name="a28" doxytag="modules.h::chanuserlist"></a><p>
743 <table width="100%" cellpadding="2" cellspacing="0" border="0">
744   <tr>
745     <td class="md">
746       <table cellpadding="0" cellspacing="0" border="0">
747         <tr>
748           <td class="md" nowrap valign="top"> typedef std::deque&lt;<a class="el" href="classuserrec.html">userrec</a>*&gt; chanuserlist
749       </table>
750     </td>
751   </tr>
752 </table>
753 <table cellspacing=5 cellpadding=0 border=0>
754   <tr>
755     <td>
756       &nbsp;
757     </td>
758     <td>
759
760 <p>
761 Holds a list of users in a channel.
762 <p>
763
764 <p>
765 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>.
766 <p>
767 Referenced by <a class="el" href="modules_8cpp-source.html#l00349">Server::GetUsers()</a>.    </td>
768   </tr>
769 </table>
770 <a name="a26" doxytag="modules.h::file_cache"></a><p>
771 <table width="100%" cellpadding="2" cellspacing="0" border="0">
772   <tr>
773     <td class="md">
774       <table cellpadding="0" cellspacing="0" border="0">
775         <tr>
776           <td class="md" nowrap valign="top"> typedef std::deque&lt;std::string&gt; file_cache
777       </table>
778     </td>
779   </tr>
780 </table>
781 <table cellspacing=5 cellpadding=0 border=0>
782   <tr>
783     <td>
784       &nbsp;
785     </td>
786     <td>
787
788 <p>
789 Low level definition of a <a class="el" href="classFileReader.html">FileReader</a> classes file cache area.
790 <p>
791
792 <p>
793 Definition at line <a class="el" href="modules_8h-source.html#l00050">50</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.
794 <p>
795 Referenced by <a class="el" href="modules_8cpp-source.html#l00663">FileReader::FileReader()</a>, and <a class="el" href="modules_8cpp-source.html#l00674">FileReader::LoadFile()</a>.    </td>
796   </tr>
797 </table>
798 <a name="a29" doxytag="modules.h::ircd_module"></a><p>
799 <table width="100%" cellpadding="2" cellspacing="0" border="0">
800   <tr>
801     <td class="md">
802       <table cellpadding="0" cellspacing="0" border="0">
803         <tr>
804           <td class="md" nowrap valign="top"> typedef DLLFactory&lt;<a class="el" href="classModuleFactory.html">ModuleFactory</a>&gt; ircd_module
805       </table>
806     </td>
807   </tr>
808 </table>
809 <table cellspacing=5 cellpadding=0 border=0>
810   <tr>
811     <td>
812       &nbsp;
813     </td>
814     <td>
815
816 <p>
817
818 <p>
819 Definition at line <a class="el" href="modules_8h-source.html#l00766">766</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.    </td>
820   </tr>
821 </table>
822 <a name="a27" doxytag="modules.h::string_list"></a><p>
823 <table width="100%" cellpadding="2" cellspacing="0" border="0">
824   <tr>
825     <td class="md">
826       <table cellpadding="0" cellspacing="0" border="0">
827         <tr>
828           <td class="md" nowrap valign="top"> typedef <a class="el" href="modules_8h.html#a26">file_cache</a> string_list
829       </table>
830     </td>
831   </tr>
832 </table>
833 <table cellspacing=5 cellpadding=0 border=0>
834   <tr>
835     <td>
836       &nbsp;
837     </td>
838     <td>
839
840 <p>
841
842 <p>
843 Definition at line <a class="el" href="modules_8h-source.html#l00051">51</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.
844 <p>
845 Referenced by <a class="el" href="modules_8cpp-source.html#l00306">Module::OnChannelSync()</a>, and <a class="el" href="modules_8cpp-source.html#l00305">Module::OnUserSync()</a>.    </td>
846   </tr>
847 </table>
848 <hr><h2>Function Documentation</h2>
849 <a name="a30" doxytag="modules.h::createcommand"></a><p>
850 <table width="100%" cellpadding="2" cellspacing="0" border="0">
851   <tr>
852     <td class="md">
853       <table cellpadding="0" cellspacing="0" border="0">
854         <tr>
855           <td class="md" nowrap valign="top"> void createcommand </td>
856           <td class="md" valign="top">(&nbsp;</td>
857           <td class="md" nowrap valign="top">char *&nbsp;</td>
858           <td class="mdname" nowrap>&nbsp; <em>cmd</em>, </td>
859         </tr>
860         <tr>
861           <td></td>
862           <td></td>
863           <td class="md" nowrap>handlerfunc&nbsp;</td>
864           <td class="mdname" nowrap>&nbsp; <em>f</em>, </td>
865         </tr>
866         <tr>
867           <td></td>
868           <td></td>
869           <td class="md" nowrap>char&nbsp;</td>
870           <td class="mdname" nowrap>&nbsp; <em>flags</em>, </td>
871         </tr>
872         <tr>
873           <td></td>
874           <td></td>
875           <td class="md" nowrap>int&nbsp;</td>
876           <td class="mdname" nowrap>&nbsp; <em>minparams</em></td>
877         </tr>
878         <tr>
879           <td></td>
880           <td class="md">)&nbsp;</td>
881           <td class="md" colspan="2"></td>
882         </tr>
883
884       </table>
885     </td>
886   </tr>
887 </table>
888 <table cellspacing=5 cellpadding=0 border=0>
889   <tr>
890     <td>
891       &nbsp;
892     </td>
893     <td>
894
895 <p>
896
897 <p>
898 Referenced by <a class="el" href="modules_8cpp-source.html#l00394">Server::AddCommand()</a>.    </td>
899   </tr>
900 </table>
901 <a name="a31" doxytag="modules.h::server_mode"></a><p>
902 <table width="100%" cellpadding="2" cellspacing="0" border="0">
903   <tr>
904     <td class="md">
905       <table cellpadding="0" cellspacing="0" border="0">
906         <tr>
907           <td class="md" nowrap valign="top"> void server_mode </td>
908           <td class="md" valign="top">(&nbsp;</td>
909           <td class="md" nowrap valign="top">char **&nbsp;</td>
910           <td class="mdname" nowrap>&nbsp; <em>parameters</em>, </td>
911         </tr>
912         <tr>
913           <td></td>
914           <td></td>
915           <td class="md" nowrap>int&nbsp;</td>
916           <td class="mdname" nowrap>&nbsp; <em>pcnt</em>, </td>
917         </tr>
918         <tr>
919           <td></td>
920           <td></td>
921           <td class="md" nowrap><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
922           <td class="mdname" nowrap>&nbsp; <em>user</em></td>
923         </tr>
924         <tr>
925           <td></td>
926           <td class="md">)&nbsp;</td>
927           <td class="md" colspan="2"></td>
928         </tr>
929
930       </table>
931     </td>
932   </tr>
933 </table>
934 <table cellspacing=5 cellpadding=0 border=0>
935   <tr>
936     <td>
937       &nbsp;
938     </td>
939     <td>
940
941 <p>
942
943 <p>
944 Referenced by <a class="el" href="modules_8cpp-source.html#l00399">Server::SendMode()</a>.    </td>
945   </tr>
946 </table>
947 <hr><address style="align: right;"><small>Generated on Sat May 1 20:57:55 2004 for InspIRCd by
948 <a href="http://www.doxygen.org/index.html">
949 <img src="doxygen.png" alt="doxygen" align="middle" border=0 
950 width=110 height=53></a>1.3-rc3 </small></address>
951 </body>
952 </html>