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 &lt;string&gt;</code><br>
  12 <code>#include &lt;deque&gt;</code><br>
  13
  14 <p>
  15 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>
  16 <map name="modules.h_map">
  17 <area href="base_8h.html" shape="rect" coords="100,85,148,106" alt="">
  18 </map>
  19
  20 <p>
  21 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>
  22 <map name="modules.hdep_map">
  23 <area href="modules_8cpp.html" shape="rect" coords="7,16,89,37" alt="">
  24 </map>
  25
  26 <p>
  27 <a href="modules_8h-source.html">Go to the source code of this file.</a><table border=0 cellpadding=0 cellspacing=0>
  28 <tr><td></td></tr>
  29 <tr><td colspan=2><br><h2>Compounds</h2></td></tr>
  30 <tr><td nowrap align=right valign=top>class &nbsp;</td><td valign=bottom><a class="el" href="classAdmin.html">Admin</a></td></tr>
  31 <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>
  32 <tr><td nowrap align=right valign=top>class &nbsp;</td><td valign=bottom><a class="el" href="classConfigReader.html">ConfigReader</a></td></tr>
  33 <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>
  34 <tr><td nowrap align=right valign=top>class &nbsp;</td><td valign=bottom><a class="el" href="classFileReader.html">FileReader</a></td></tr>
  35 <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>
  36 <tr><td nowrap align=right valign=top>class &nbsp;</td><td valign=bottom><a class="el" href="classModule.html">Module</a></td></tr>
  37 <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>
  38 <tr><td nowrap align=right valign=top>class &nbsp;</td><td valign=bottom><a class="el" href="classModuleFactory.html">ModuleFactory</a></td></tr>
  39 <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>
  40 <tr><td nowrap align=right valign=top>class &nbsp;</td><td valign=bottom><a class="el" href="classServer.html">Server</a></td></tr>
  41 <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>
  42 <tr><td nowrap align=right valign=top>class &nbsp;</td><td valign=bottom><a class="el" href="classVersion.html">Version</a></td></tr>
  43 <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>
  44 <tr><td colspan=2><br><h2>Defines</h2></td></tr>
  45 <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>
  46 <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>
  47 <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>
  48 <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>
  49 <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>
  50 <tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="modules_8h.html#a5">FOREACH_MOD</a>&nbsp;&nbsp;&nbsp;for (int i = 0; i &lt;= <a class="el" href="modules_8cpp.html#a0">MODCOUNT</a>; i++) modules[i]-&gt;</td></tr>
  51 <tr><td colspan=2><br><h2>Typedefs</h2></td></tr>
  52 <tr><td nowrap align=right valign=top>typedef deque&lt; string &gt;&nbsp;</td><td valign=bottom><a class="el" href="modules_8h.html#a6">file_cache</a></td></tr>
  53 <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="#a6"></a><em></em></font><br><br></td></tr>
  54 <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#a7">ircd_module</a></td></tr>
  55 </table>
  56 <hr><h2>Define Documentation</h2>
  57 <a name="a0" doxytag="modules.h::DEBUG"></a><p>
  58 <table width="100%" cellpadding="2" cellspacing="0" border="0">
  59   <tr>
  60     <td class="md">
  61       <table cellpadding="0" cellspacing="0" border="0">
  62         <tr>
  63           <td class="md" nowrap valign="top"> #define DEBUG&nbsp;&nbsp;&nbsp;10
  64       </table>
  65     </td>
  66   </tr>
  67 </table>
  68 <table cellspacing=5 cellpadding=0 border=0>
  69   <tr>
  70     <td>
  71       &nbsp;
  72     </td>
  73     <td>
  74
  75 <p>
  76
  77 <p>
  78 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>
  79   </tr>
  80 </table>
  81 <a name="a2" doxytag="modules.h::DEFAULT"></a><p>
  82 <table width="100%" cellpadding="2" cellspacing="0" border="0">
  83   <tr>
  84     <td class="md">
  85       <table cellpadding="0" cellspacing="0" border="0">
  86         <tr>
  87           <td class="md" nowrap valign="top"> #define DEFAULT&nbsp;&nbsp;&nbsp;30
  88       </table>
  89     </td>
  90   </tr>
  91 </table>
  92 <table cellspacing=5 cellpadding=0 border=0>
  93   <tr>
  94     <td>
  95       &nbsp;
  96     </td>
  97     <td>
  98
  99 <p>
 100
 101 <p>
 102 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>
 103   </tr>
 104 </table>
 105 <a name="a5" doxytag="modules.h::FOREACH_MOD"></a><p>
 106 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 107   <tr>
 108     <td class="md">
 109       <table cellpadding="0" cellspacing="0" border="0">
 110         <tr>
 111           <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#a0">MODCOUNT</a>; i++) modules[i]-&gt;
 112       </table>
 113     </td>
 114   </tr>
 115 </table>
 116 <table cellspacing=5 cellpadding=0 border=0>
 117   <tr>
 118     <td>
 119       &nbsp;
 120     </td>
 121     <td>
 122
 123 <p>
 124
 125 <p>
 126 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>
 127   </tr>
 128 </table>
 129 <a name="a4" doxytag="modules.h::NONE"></a><p>
 130 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 131   <tr>
 132     <td class="md">
 133       <table cellpadding="0" cellspacing="0" border="0">
 134         <tr>
 135           <td class="md" nowrap valign="top"> #define NONE&nbsp;&nbsp;&nbsp;50
 136       </table>
 137     </td>
 138   </tr>
 139 </table>
 140 <table cellspacing=5 cellpadding=0 border=0>
 141   <tr>
 142     <td>
 143       &nbsp;
 144     </td>
 145     <td>
 146
 147 <p>
 148
 149 <p>
 150 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>
 151   </tr>
 152 </table>
 153 <a name="a3" doxytag="modules.h::SPARSE"></a><p>
 154 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 155   <tr>
 156     <td class="md">
 157       <table cellpadding="0" cellspacing="0" border="0">
 158         <tr>
 159           <td class="md" nowrap valign="top"> #define SPARSE&nbsp;&nbsp;&nbsp;40
 160       </table>
 161     </td>
 162   </tr>
 163 </table>
 164 <table cellspacing=5 cellpadding=0 border=0>
 165   <tr>
 166     <td>
 167       &nbsp;
 168     </td>
 169     <td>
 170
 171 <p>
 172
 173 <p>
 174 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>
 175   </tr>
 176 </table>
 177 <a name="a1" doxytag="modules.h::VERBOSE"></a><p>
 178 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 179   <tr>
 180     <td class="md">
 181       <table cellpadding="0" cellspacing="0" border="0">
 182         <tr>
 183           <td class="md" nowrap valign="top"> #define VERBOSE&nbsp;&nbsp;&nbsp;20
 184       </table>
 185     </td>
 186   </tr>
 187 </table>
 188 <table cellspacing=5 cellpadding=0 border=0>
 189   <tr>
 190     <td>
 191       &nbsp;
 192     </td>
 193     <td>
 194
 195 <p>
 196
 197 <p>
 198 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>
 199   </tr>
 200 </table>
 201 <hr><h2>Typedef Documentation</h2>
 202 <a name="a6" doxytag="modules.h::file_cache"></a><p>
 203 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 204   <tr>
 205     <td class="md">
 206       <table cellpadding="0" cellspacing="0" border="0">
 207         <tr>
 208           <td class="md" nowrap valign="top"> typedef deque&lt;string&gt; file_cache
 209       </table>
 210     </td>
 211   </tr>
 212 </table>
 213 <table cellspacing=5 cellpadding=0 border=0>
 214   <tr>
 215     <td>
 216       &nbsp;
 217     </td>
 218     <td>
 219
 220 <p>
 221 Low level definition of a <a class="el" href="classFileReader.html">FileReader</a> classes file cache area.
 222 <p>
 223
 224 <p>
 225 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>.
 226 <p>
 227 Referenced by <a class="el" href="modules_8cpp-source.html#l00186">FileReader::FileReader()</a>, and <a class="el" href="modules_8cpp-source.html#l00197">FileReader::LoadFile()</a>.    </td>
 228   </tr>
 229 </table>
 230 <a name="a7" doxytag="modules.h::ircd_module"></a><p>
 231 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 232   <tr>
 233     <td class="md">
 234       <table cellpadding="0" cellspacing="0" border="0">
 235         <tr>
 236           <td class="md" nowrap valign="top"> typedef DLLFactory&lt;<a class="el" href="classModuleFactory.html">ModuleFactory</a>&gt; ircd_module
 237       </table>
 238     </td>
 239   </tr>
 240 </table>
 241 <table cellspacing=5 cellpadding=0 border=0>
 242   <tr>
 243     <td>
 244       &nbsp;
 245     </td>
 246     <td>
 247
 248 <p>
 249
 250 <p>
 251 Definition at line <a class="el" href="modules_8h-source.html#l00322">322</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.    </td>
 252   </tr>
 253 </table>
 254 <hr><address style="align: right;"><small>Generated on Sun Mar 30 13:28:16 2003 for InspIRCd by
 255 <a href="http://www.doxygen.org/index.html">
 256 <img src="doxygen.png" alt="doxygen" align="middle" border=0
 257 width=110 height=53></a>1.3-rc3 </small></address>
 258 </body>
 259 </html>