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 </table>
  64 <hr><h2>Define Documentation</h2>
  65 <a name="a0" doxytag="modules.h::DEBUG"></a><p>
  66 <table width="100%" cellpadding="2" cellspacing="0" border="0">
  67   <tr>
  68     <td class="md">
  69       <table cellpadding="0" cellspacing="0" border="0">
  70         <tr>
  71           <td class="md" nowrap valign="top"> #define DEBUG&nbsp;&nbsp;&nbsp;10
  72       </table>
  73     </td>
  74   </tr>
  75 </table>
  76 <table cellspacing=5 cellpadding=0 border=0>
  77   <tr>
  78     <td>
  79       &nbsp;
  80     </td>
  81     <td>
  82
  83 <p>
  84
  85 <p>
  86 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>
  87   </tr>
  88 </table>
  89 <a name="a2" doxytag="modules.h::DEFAULT"></a><p>
  90 <table width="100%" cellpadding="2" cellspacing="0" border="0">
  91   <tr>
  92     <td class="md">
  93       <table cellpadding="0" cellspacing="0" border="0">
  94         <tr>
  95           <td class="md" nowrap valign="top"> #define DEFAULT&nbsp;&nbsp;&nbsp;30
  96       </table>
  97     </td>
  98   </tr>
  99 </table>
 100 <table cellspacing=5 cellpadding=0 border=0>
 101   <tr>
 102     <td>
 103       &nbsp;
 104     </td>
 105     <td>
 106
 107 <p>
 108
 109 <p>
 110 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>
 111   </tr>
 112 </table>
 113 <a name="a8" doxytag="modules.h::FOREACH_MOD"></a><p>
 114 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 115   <tr>
 116     <td class="md">
 117       <table cellpadding="0" cellspacing="0" border="0">
 118         <tr>
 119           <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;
 120       </table>
 121     </td>
 122   </tr>
 123 </table>
 124 <table cellspacing=5 cellpadding=0 border=0>
 125   <tr>
 126     <td>
 127       &nbsp;
 128     </td>
 129     <td>
 130
 131 <p>
 132
 133 <p>
 134 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>
 135   </tr>
 136 </table>
 137 <a name="a5" doxytag="modules.h::MT_CHANNEL"></a><p>
 138 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 139   <tr>
 140     <td class="md">
 141       <table cellpadding="0" cellspacing="0" border="0">
 142         <tr>
 143           <td class="md" nowrap valign="top"> #define MT_CHANNEL&nbsp;&nbsp;&nbsp;1
 144       </table>
 145     </td>
 146   </tr>
 147 </table>
 148 <table cellspacing=5 cellpadding=0 border=0>
 149   <tr>
 150     <td>
 151       &nbsp;
 152     </td>
 153     <td>
 154
 155 <p>
 156
 157 <p>
 158 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>
 159   </tr>
 160 </table>
 161 <a name="a6" doxytag="modules.h::MT_CLIENT"></a><p>
 162 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 163   <tr>
 164     <td class="md">
 165       <table cellpadding="0" cellspacing="0" border="0">
 166         <tr>
 167           <td class="md" nowrap valign="top"> #define MT_CLIENT&nbsp;&nbsp;&nbsp;2
 168       </table>
 169     </td>
 170   </tr>
 171 </table>
 172 <table cellspacing=5 cellpadding=0 border=0>
 173   <tr>
 174     <td>
 175       &nbsp;
 176     </td>
 177     <td>
 178
 179 <p>
 180
 181 <p>
 182 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>
 183   </tr>
 184 </table>
 185 <a name="a7" doxytag="modules.h::MT_SERVER"></a><p>
 186 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 187   <tr>
 188     <td class="md">
 189       <table cellpadding="0" cellspacing="0" border="0">
 190         <tr>
 191           <td class="md" nowrap valign="top"> #define MT_SERVER&nbsp;&nbsp;&nbsp;3
 192       </table>
 193     </td>
 194   </tr>
 195 </table>
 196 <table cellspacing=5 cellpadding=0 border=0>
 197   <tr>
 198     <td>
 199       &nbsp;
 200     </td>
 201     <td>
 202
 203 <p>
 204
 205 <p>
 206 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>
 207   </tr>
 208 </table>
 209 <a name="a4" doxytag="modules.h::NONE"></a><p>
 210 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 211   <tr>
 212     <td class="md">
 213       <table cellpadding="0" cellspacing="0" border="0">
 214         <tr>
 215           <td class="md" nowrap valign="top"> #define NONE&nbsp;&nbsp;&nbsp;50
 216       </table>
 217     </td>
 218   </tr>
 219 </table>
 220 <table cellspacing=5 cellpadding=0 border=0>
 221   <tr>
 222     <td>
 223       &nbsp;
 224     </td>
 225     <td>
 226
 227 <p>
 228
 229 <p>
 230 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>
 231   </tr>
 232 </table>
 233 <a name="a3" doxytag="modules.h::SPARSE"></a><p>
 234 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 235   <tr>
 236     <td class="md">
 237       <table cellpadding="0" cellspacing="0" border="0">
 238         <tr>
 239           <td class="md" nowrap valign="top"> #define SPARSE&nbsp;&nbsp;&nbsp;40
 240       </table>
 241     </td>
 242   </tr>
 243 </table>
 244 <table cellspacing=5 cellpadding=0 border=0>
 245   <tr>
 246     <td>
 247       &nbsp;
 248     </td>
 249     <td>
 250
 251 <p>
 252
 253 <p>
 254 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>
 255   </tr>
 256 </table>
 257 <a name="a1" doxytag="modules.h::VERBOSE"></a><p>
 258 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 259   <tr>
 260     <td class="md">
 261       <table cellpadding="0" cellspacing="0" border="0">
 262         <tr>
 263           <td class="md" nowrap valign="top"> #define VERBOSE&nbsp;&nbsp;&nbsp;20
 264       </table>
 265     </td>
 266   </tr>
 267 </table>
 268 <table cellspacing=5 cellpadding=0 border=0>
 269   <tr>
 270     <td>
 271       &nbsp;
 272     </td>
 273     <td>
 274
 275 <p>
 276
 277 <p>
 278 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>
 279   </tr>
 280 </table>
 281 <hr><h2>Typedef Documentation</h2>
 282 <a name="a9" doxytag="modules.h::file_cache"></a><p>
 283 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 284   <tr>
 285     <td class="md">
 286       <table cellpadding="0" cellspacing="0" border="0">
 287         <tr>
 288           <td class="md" nowrap valign="top"> typedef std::deque&lt;std::string&gt; file_cache
 289       </table>
 290     </td>
 291   </tr>
 292 </table>
 293 <table cellspacing=5 cellpadding=0 border=0>
 294   <tr>
 295     <td>
 296       &nbsp;
 297     </td>
 298     <td>
 299
 300 <p>
 301 Low level definition of a <a class="el" href="classFileReader.html">FileReader</a> classes file cache area.
 302 <p>
 303
 304 <p>
 305 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>.
 306 <p>
 307 Referenced by <a class="el" href="modules_8cpp-source.html#l00258">FileReader::FileReader()</a>, and <a class="el" href="modules_8cpp-source.html#l00269">FileReader::LoadFile()</a>.    </td>
 308   </tr>
 309 </table>
 310 <a name="a11" doxytag="modules.h::ircd_module"></a><p>
 311 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 312   <tr>
 313     <td class="md">
 314       <table cellpadding="0" cellspacing="0" border="0">
 315         <tr>
 316           <td class="md" nowrap valign="top"> typedef DLLFactory&lt;<a class="el" href="classModuleFactory.html">ModuleFactory</a>&gt; ircd_module
 317       </table>
 318     </td>
 319   </tr>
 320 </table>
 321 <table cellspacing=5 cellpadding=0 border=0>
 322   <tr>
 323     <td>
 324       &nbsp;
 325     </td>
 326     <td>
 327
 328 <p>
 329
 330 <p>
 331 Definition at line <a class="el" href="modules_8h-source.html#l00406">406</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.    </td>
 332   </tr>
 333 </table>
 334 <a name="a10" doxytag="modules.h::string_list"></a><p>
 335 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 336   <tr>
 337     <td class="md">
 338       <table cellpadding="0" cellspacing="0" border="0">
 339         <tr>
 340           <td class="md" nowrap valign="top"> typedef <a class="el" href="modules_8h.html#a9">file_cache</a> string_list
 341       </table>
 342     </td>
 343   </tr>
 344 </table>
 345 <table cellspacing=5 cellpadding=0 border=0>
 346   <tr>
 347     <td>
 348       &nbsp;
 349     </td>
 350     <td>
 351
 352 <p>
 353
 354 <p>
 355 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>
 356   </tr>
 357 </table>
 358 <hr><h2>Function Documentation</h2>
 359 <a name="a12" doxytag="modules.h::createcommand"></a><p>
 360 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 361   <tr>
 362     <td class="md">
 363       <table cellpadding="0" cellspacing="0" border="0">
 364         <tr>
 365           <td class="md" nowrap valign="top"> void createcommand </td>
 366           <td class="md" valign="top">(&nbsp;</td>
 367           <td class="md" nowrap valign="top">char *&nbsp;</td>
 368           <td class="mdname" nowrap>&nbsp; <em>cmd</em>, </td>
 369         </tr>
 370         <tr>
 371           <td></td>
 372           <td></td>
 373           <td class="md" nowrap><a class="el" href="ctables_8h.html#a0">handlerfunc</a>&nbsp;</td>
 374           <td class="mdname" nowrap>&nbsp; <em>f</em>, </td>
 375         </tr>
 376         <tr>
 377           <td></td>
 378           <td></td>
 379           <td class="md" nowrap>char&nbsp;</td>
 380           <td class="mdname" nowrap>&nbsp; <em>flags</em>, </td>
 381         </tr>
 382         <tr>
 383           <td></td>
 384           <td></td>
 385           <td class="md" nowrap>int&nbsp;</td>
 386           <td class="mdname" nowrap>&nbsp; <em>minparams</em></td>
 387         </tr>
 388         <tr>
 389           <td></td>
 390           <td class="md">)&nbsp;</td>
 391           <td class="md" colspan="2"></td>
 392         </tr>
 393
 394       </table>
 395     </td>
 396   </tr>
 397 </table>
 398 <table cellspacing=5 cellpadding=0 border=0>
 399   <tr>
 400     <td>
 401       &nbsp;
 402     </td>
 403     <td>
 404
 405 <p>
 406
 407 <p>
 408 Referenced by <a class="el" href="modules_8cpp-source.html#l00123">Server::AddCommand()</a>.    </td>
 409   </tr>
 410 </table>
 411 <hr><address style="align: right;"><small>Generated on Fri Apr 2 13:37:31 2004 for InspIRCd by
 412 <a href="http://www.doxygen.org/index.html">
 413 <img src="doxygen.png" alt="doxygen" align="middle" border=0
 414 width=110 height=53></a>1.3-rc3 </small></address>
 415 </body>
 416 </html>