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