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="doxygen.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="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
  15 <p>
  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="91,86,139,107" alt="">
  19 <area href="ctables_8h.html" shape="rect" coords="151,155,212,176" alt="">
  20 </map>
  21
  22 <p>
  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="modules_8cpp.html" shape="rect" coords="7,16,89,37" alt="">
  26 </map>
  27
  28 <p>
  29 <a href="modules_8h-source.html">Go to the source code of this file.</a><table border=0 cellpadding=0 cellspacing=0>
  30 <tr><td></td></tr>
  31 <tr><td colspan=2><br><h2>Compounds</h2></td></tr>
  32 <tr><td nowrap align=right valign=top>class &nbsp;</td><td valign=bottom><a class="el" href="classAdmin.html">Admin</a></td></tr>
  33 <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>
  34 <tr><td nowrap align=right valign=top>class &nbsp;</td><td valign=bottom><a class="el" href="classConfigReader.html">ConfigReader</a></td></tr>
  35 <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>
  36 <tr><td nowrap align=right valign=top>class &nbsp;</td><td valign=bottom><a class="el" href="classFileReader.html">FileReader</a></td></tr>
  37 <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>
  38 <tr><td nowrap align=right valign=top>class &nbsp;</td><td valign=bottom><a class="el" href="classModule.html">Module</a></td></tr>
  39 <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>
  40 <tr><td nowrap align=right valign=top>class &nbsp;</td><td valign=bottom><a class="el" href="classModuleFactory.html">ModuleFactory</a></td></tr>
  41 <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>
  42 <tr><td nowrap align=right valign=top>class &nbsp;</td><td valign=bottom><a class="el" href="classServer.html">Server</a></td></tr>
  43 <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>
  44 <tr><td nowrap align=right valign=top>class &nbsp;</td><td valign=bottom><a class="el" href="classVersion.html">Version</a></td></tr>
  45 <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>
  46 <tr><td colspan=2><br><h2>Defines</h2></td></tr>
  47 <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>
  48 <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>
  49 <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>
  50 <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>
  51 <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>
  52 <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>
  53 <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>
  54 <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>
  55 <tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="modules_8h.html#a8">FOREACH_MOD</a>&nbsp;&nbsp;&nbsp;for (int i = 0; i &lt;= <a class="el" href="modules_8cpp.html#a3">MODCOUNT</a>; i++) modules[i]-&gt;</td></tr>
  56 <tr><td colspan=2><br><h2>Typedefs</h2></td></tr>
  57 <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#a9">file_cache</a></td></tr>
  58 <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="#a9"></a><em></em></font><br><br></td></tr>
  59 <tr><td nowrap align=right valign=top>typedef <a class="el" href="modules_8h.html#a9">file_cache</a>&nbsp;</td><td valign=bottom><a class="el" href="modules_8h.html#a10">string_list</a></td></tr>
  60 <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#a11">ircd_module</a></td></tr>
  61 <tr><td colspan=2><br><h2>Functions</h2></td></tr>
  62 <tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="modules_8h.html#a12">createcommand</a> (char *cmd, <a class="el" href="ctables_8h.html#a0">handlerfunc</a> f, char flags, int minparams)</td></tr>
  63 <tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="modules_8h.html#a13">server_mode</a> (char **parameters, int pcnt, <a class="el" href="classuserrec.html">userrec</a> *user)</td></tr>
  64 </table>
  65 <hr><h2>Define Documentation</h2>
  66 <a name="a0" doxytag="modules.h::DEBUG"></a><p>
  67 <table width="100%" cellpadding="2" cellspacing="0" border="0">
  68   <tr>
  69     <td class="md">
  70       <table cellpadding="0" cellspacing="0" border="0">
  71         <tr>
  72           <td class="md" nowrap valign="top"> #define DEBUG&nbsp;&nbsp;&nbsp;10
  73       </table>
  74     </td>
  75   </tr>
  76 </table>
  77 <table cellspacing=5 cellpadding=0 border=0>
  78   <tr>
  79     <td>
  80       &nbsp;
  81     </td>
  82     <td>
  83
  84 <p>
  85
  86 <p>
  87 Definition at line <a class="el" href="modules_8h-source.html#l00011">11</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.    </td>
  88   </tr>
  89 </table>
  90 <a name="a2" doxytag="modules.h::DEFAULT"></a><p>
  91 <table width="100%" cellpadding="2" cellspacing="0" border="0">
  92   <tr>
  93     <td class="md">
  94       <table cellpadding="0" cellspacing="0" border="0">
  95         <tr>
  96           <td class="md" nowrap valign="top"> #define DEFAULT&nbsp;&nbsp;&nbsp;30
  97       </table>
  98     </td>
  99   </tr>
 100 </table>
 101 <table cellspacing=5 cellpadding=0 border=0>
 102   <tr>
 103     <td>
 104       &nbsp;
 105     </td>
 106     <td>
 107
 108 <p>
 109
 110 <p>
 111 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>
 112   </tr>
 113 </table>
 114 <a name="a8" doxytag="modules.h::FOREACH_MOD"></a><p>
 115 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 116   <tr>
 117     <td class="md">
 118       <table cellpadding="0" cellspacing="0" border="0">
 119         <tr>
 120           <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#a3">MODCOUNT</a>; i++) modules[i]-&gt;
 121       </table>
 122     </td>
 123   </tr>
 124 </table>
 125 <table cellspacing=5 cellpadding=0 border=0>
 126   <tr>
 127     <td>
 128       &nbsp;
 129     </td>
 130     <td>
 131
 132 <p>
 133
 134 <p>
 135 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>
 136   </tr>
 137 </table>
 138 <a name="a5" doxytag="modules.h::MT_CHANNEL"></a><p>
 139 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 140   <tr>
 141     <td class="md">
 142       <table cellpadding="0" cellspacing="0" border="0">
 143         <tr>
 144           <td class="md" nowrap valign="top"> #define MT_CHANNEL&nbsp;&nbsp;&nbsp;1
 145       </table>
 146     </td>
 147   </tr>
 148 </table>
 149 <table cellspacing=5 cellpadding=0 border=0>
 150   <tr>
 151     <td>
 152       &nbsp;
 153     </td>
 154     <td>
 155
 156 <p>
 157
 158 <p>
 159 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>
 160   </tr>
 161 </table>
 162 <a name="a6" doxytag="modules.h::MT_CLIENT"></a><p>
 163 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 164   <tr>
 165     <td class="md">
 166       <table cellpadding="0" cellspacing="0" border="0">
 167         <tr>
 168           <td class="md" nowrap valign="top"> #define MT_CLIENT&nbsp;&nbsp;&nbsp;2
 169       </table>
 170     </td>
 171   </tr>
 172 </table>
 173 <table cellspacing=5 cellpadding=0 border=0>
 174   <tr>
 175     <td>
 176       &nbsp;
 177     </td>
 178     <td>
 179
 180 <p>
 181
 182 <p>
 183 Definition at line <a class="el" href="modules_8h-source.html#l00018">18</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.    </td>
 184   </tr>
 185 </table>
 186 <a name="a7" doxytag="modules.h::MT_SERVER"></a><p>
 187 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 188   <tr>
 189     <td class="md">
 190       <table cellpadding="0" cellspacing="0" border="0">
 191         <tr>
 192           <td class="md" nowrap valign="top"> #define MT_SERVER&nbsp;&nbsp;&nbsp;3
 193       </table>
 194     </td>
 195   </tr>
 196 </table>
 197 <table cellspacing=5 cellpadding=0 border=0>
 198   <tr>
 199     <td>
 200       &nbsp;
 201     </td>
 202     <td>
 203
 204 <p>
 205
 206 <p>
 207 Definition at line <a class="el" href="modules_8h-source.html#l00019">19</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.    </td>
 208   </tr>
 209 </table>
 210 <a name="a4" doxytag="modules.h::NONE"></a><p>
 211 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 212   <tr>
 213     <td class="md">
 214       <table cellpadding="0" cellspacing="0" border="0">
 215         <tr>
 216           <td class="md" nowrap valign="top"> #define NONE&nbsp;&nbsp;&nbsp;50
 217       </table>
 218     </td>
 219   </tr>
 220 </table>
 221 <table cellspacing=5 cellpadding=0 border=0>
 222   <tr>
 223     <td>
 224       &nbsp;
 225     </td>
 226     <td>
 227
 228 <p>
 229
 230 <p>
 231 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>
 232   </tr>
 233 </table>
 234 <a name="a3" doxytag="modules.h::SPARSE"></a><p>
 235 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 236   <tr>
 237     <td class="md">
 238       <table cellpadding="0" cellspacing="0" border="0">
 239         <tr>
 240           <td class="md" nowrap valign="top"> #define SPARSE&nbsp;&nbsp;&nbsp;40
 241       </table>
 242     </td>
 243   </tr>
 244 </table>
 245 <table cellspacing=5 cellpadding=0 border=0>
 246   <tr>
 247     <td>
 248       &nbsp;
 249     </td>
 250     <td>
 251
 252 <p>
 253
 254 <p>
 255 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>
 256   </tr>
 257 </table>
 258 <a name="a1" doxytag="modules.h::VERBOSE"></a><p>
 259 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 260   <tr>
 261     <td class="md">
 262       <table cellpadding="0" cellspacing="0" border="0">
 263         <tr>
 264           <td class="md" nowrap valign="top"> #define VERBOSE&nbsp;&nbsp;&nbsp;20
 265       </table>
 266     </td>
 267   </tr>
 268 </table>
 269 <table cellspacing=5 cellpadding=0 border=0>
 270   <tr>
 271     <td>
 272       &nbsp;
 273     </td>
 274     <td>
 275
 276 <p>
 277
 278 <p>
 279 Definition at line <a class="el" href="modules_8h-source.html#l00012">12</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.    </td>
 280   </tr>
 281 </table>
 282 <hr><h2>Typedef Documentation</h2>
 283 <a name="a9" doxytag="modules.h::file_cache"></a><p>
 284 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 285   <tr>
 286     <td class="md">
 287       <table cellpadding="0" cellspacing="0" border="0">
 288         <tr>
 289           <td class="md" nowrap valign="top"> typedef std::deque&lt;std::string&gt; file_cache
 290       </table>
 291     </td>
 292   </tr>
 293 </table>
 294 <table cellspacing=5 cellpadding=0 border=0>
 295   <tr>
 296     <td>
 297       &nbsp;
 298     </td>
 299     <td>
 300
 301 <p>
 302 Low level definition of a <a class="el" href="classFileReader.html">FileReader</a> classes file cache area.
 303 <p>
 304
 305 <p>
 306 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>.
 307 <p>
 308 Referenced by <a class="el" href="modules_8cpp-source.html#l00262">FileReader::FileReader()</a>, and <a class="el" href="modules_8cpp-source.html#l00273">FileReader::LoadFile()</a>.    </td>
 309   </tr>
 310 </table>
 311 <a name="a11" doxytag="modules.h::ircd_module"></a><p>
 312 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 313   <tr>
 314     <td class="md">
 315       <table cellpadding="0" cellspacing="0" border="0">
 316         <tr>
 317           <td class="md" nowrap valign="top"> typedef DLLFactory&lt;<a class="el" href="classModuleFactory.html">ModuleFactory</a>&gt; ircd_module
 318       </table>
 319     </td>
 320   </tr>
 321 </table>
 322 <table cellspacing=5 cellpadding=0 border=0>
 323   <tr>
 324     <td>
 325       &nbsp;
 326     </td>
 327     <td>
 328
 329 <p>
 330
 331 <p>
 332 Definition at line <a class="el" href="modules_8h-source.html#l00426">426</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.    </td>
 333   </tr>
 334 </table>
 335 <a name="a10" doxytag="modules.h::string_list"></a><p>
 336 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 337   <tr>
 338     <td class="md">
 339       <table cellpadding="0" cellspacing="0" border="0">
 340         <tr>
 341           <td class="md" nowrap valign="top"> typedef <a class="el" href="modules_8h.html#a9">file_cache</a> string_list
 342       </table>
 343     </td>
 344   </tr>
 345 </table>
 346 <table cellspacing=5 cellpadding=0 border=0>
 347   <tr>
 348     <td>
 349       &nbsp;
 350     </td>
 351     <td>
 352
 353 <p>
 354
 355 <p>
 356 Definition at line <a class="el" href="modules_8h-source.html#l00030">30</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.    </td>
 357   </tr>
 358 </table>
 359 <hr><h2>Function Documentation</h2>
 360 <a name="a12" doxytag="modules.h::createcommand"></a><p>
 361 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 362   <tr>
 363     <td class="md">
 364       <table cellpadding="0" cellspacing="0" border="0">
 365         <tr>
 366           <td class="md" nowrap valign="top"> void createcommand </td>
 367           <td class="md" valign="top">(&nbsp;</td>
 368           <td class="md" nowrap valign="top">char *&nbsp;</td>
 369           <td class="mdname" nowrap>&nbsp; <em>cmd</em>, </td>
 370         </tr>
 371         <tr>
 372           <td></td>
 373           <td></td>
 374           <td class="md" nowrap><a class="el" href="ctables_8h.html#a0">handlerfunc</a>&nbsp;</td>
 375           <td class="mdname" nowrap>&nbsp; <em>f</em>, </td>
 376         </tr>
 377         <tr>
 378           <td></td>
 379           <td></td>
 380           <td class="md" nowrap>char&nbsp;</td>
 381           <td class="mdname" nowrap>&nbsp; <em>flags</em>, </td>
 382         </tr>
 383         <tr>
 384           <td></td>
 385           <td></td>
 386           <td class="md" nowrap>int&nbsp;</td>
 387           <td class="mdname" nowrap>&nbsp; <em>minparams</em></td>
 388         </tr>
 389         <tr>
 390           <td></td>
 391           <td class="md">)&nbsp;</td>
 392           <td class="md" colspan="2"></td>
 393         </tr>
 394
 395       </table>
 396     </td>
 397   </tr>
 398 </table>
 399 <table cellspacing=5 cellpadding=0 border=0>
 400   <tr>
 401     <td>
 402       &nbsp;
 403     </td>
 404     <td>
 405
 406 <p>
 407
 408 <p>
 409 Referenced by <a class="el" href="modules_8cpp-source.html#l00123">Server::AddCommand()</a>.    </td>
 410   </tr>
 411 </table>
 412 <a name="a13" doxytag="modules.h::server_mode"></a><p>
 413 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 414   <tr>
 415     <td class="md">
 416       <table cellpadding="0" cellspacing="0" border="0">
 417         <tr>
 418           <td class="md" nowrap valign="top"> void server_mode </td>
 419           <td class="md" valign="top">(&nbsp;</td>
 420           <td class="md" nowrap valign="top">char **&nbsp;</td>
 421           <td class="mdname" nowrap>&nbsp; <em>parameters</em>, </td>
 422         </tr>
 423         <tr>
 424           <td></td>
 425           <td></td>
 426           <td class="md" nowrap>int&nbsp;</td>
 427           <td class="mdname" nowrap>&nbsp; <em>pcnt</em>, </td>
 428         </tr>
 429         <tr>
 430           <td></td>
 431           <td></td>
 432           <td class="md" nowrap><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 433           <td class="mdname" nowrap>&nbsp; <em>user</em></td>
 434         </tr>
 435         <tr>
 436           <td></td>
 437           <td class="md">)&nbsp;</td>
 438           <td class="md" colspan="2"></td>
 439         </tr>
 440
 441       </table>
 442     </td>
 443   </tr>
 444 </table>
 445 <table cellspacing=5 cellpadding=0 border=0>
 446   <tr>
 447     <td>
 448       &nbsp;
 449     </td>
 450     <td>
 451
 452 <p>
 453
 454 <p>
 455 Referenced by <a class="el" href="modules_8cpp-source.html#l00128">Server::SendMode()</a>.    </td>
 456   </tr>
 457 </table>
 458 <hr><address style="align: right;"><small>Generated on Fri Apr 2 14:46:08 2004 for InspIRCd by
 459 <a href="http://www.doxygen.org/index.html">
 460 <img src="doxygen.png" alt="doxygen" align="middle" border=0
 461 width=110 height=53></a>1.3-rc3 </small></address>
 462 </body>
 463 </html>