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 &lt;string&gt;</code><br>
  11 <code>#include &lt;deque&gt;</code><br>
  12
  13 <p>
  14 <a href="modules_8h-source.html">Go to the source code of this file.</a><table border=0 cellpadding=0 cellspacing=0>
  15 <tr><td></td></tr>
  16 <tr><td colspan=2><br><h2>Compounds</h2></td></tr>
  17 <tr><td nowrap align=right valign=top>class &nbsp;</td><td valign=bottom><a class="el" href="classAdmin.html">Admin</a></td></tr>
  18 <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>
  19 <tr><td nowrap align=right valign=top>class &nbsp;</td><td valign=bottom><a class="el" href="classConfigReader.html">ConfigReader</a></td></tr>
  20 <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>
  21 <tr><td nowrap align=right valign=top>class &nbsp;</td><td valign=bottom><a class="el" href="classFileReader.html">FileReader</a></td></tr>
  22 <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>
  23 <tr><td nowrap align=right valign=top>class &nbsp;</td><td valign=bottom><a class="el" href="classModule.html">Module</a></td></tr>
  24 <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>
  25 <tr><td nowrap align=right valign=top>class &nbsp;</td><td valign=bottom><a class="el" href="classModuleFactory.html">ModuleFactory</a></td></tr>
  26 <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>
  27 <tr><td nowrap align=right valign=top>class &nbsp;</td><td valign=bottom><a class="el" href="classServer.html">Server</a></td></tr>
  28 <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>
  29 <tr><td nowrap align=right valign=top>class &nbsp;</td><td valign=bottom><a class="el" href="classVersion.html">Version</a></td></tr>
  30 <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>
  31 <tr><td colspan=2><br><h2>Defines</h2></td></tr>
  32 <tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="modules_8h.html#a0">FOREACH_MOD</a>&nbsp;&nbsp;&nbsp;for (int i = 0; i &lt;= MODCOUNT; i++) modules[i]-&gt;</td></tr>
  33 <tr><td colspan=2><br><h2>Typedefs</h2></td></tr>
  34 <tr><td nowrap align=right valign=top>typedef deque&lt; string &gt;&nbsp;</td><td valign=bottom><a class="el" href="modules_8h.html#a1">file_cache</a></td></tr>
  35 <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="#a1"></a><em></em></font><br><br></td></tr>
  36 </table>
  37 <hr><h2>Define Documentation</h2>
  38 <a name="a0" doxytag="modules.h::FOREACH_MOD"></a><p>
  39 <table width="100%" cellpadding="2" cellspacing="0" border="0">
  40   <tr>
  41     <td class="md">
  42       <table cellpadding="0" cellspacing="0" border="0">
  43         <tr>
  44           <td class="md" nowrap valign="top"> #define FOREACH_MOD&nbsp;&nbsp;&nbsp;for (int i = 0; i &lt;= MODCOUNT; i++) modules[i]-&gt;
  45       </table>
  46     </td>
  47   </tr>
  48 </table>
  49 <table cellspacing=5 cellpadding=0 border=0>
  50   <tr>
  51     <td>
  52       &nbsp;
  53     </td>
  54     <td>
  55
  56 <p>
  57
  58 <p>
  59 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>.    </td>
  60   </tr>
  61 </table>
  62 <hr><h2>Typedef Documentation</h2>
  63 <a name="a1" doxytag="modules.h::file_cache"></a><p>
  64 <table width="100%" cellpadding="2" cellspacing="0" border="0">
  65   <tr>
  66     <td class="md">
  67       <table cellpadding="0" cellspacing="0" border="0">
  68         <tr>
  69           <td class="md" nowrap valign="top"> typedef deque&lt;string&gt; file_cache
  70       </table>
  71     </td>
  72   </tr>
  73 </table>
  74 <table cellspacing=5 cellpadding=0 border=0>
  75   <tr>
  76     <td>
  77       &nbsp;
  78     </td>
  79     <td>
  80
  81 <p>
  82 Low level definition of a <a class="el" href="classFileReader.html">FileReader</a> classes file cache area.
  83 <p>
  84
  85 <p>
  86 Definition at line <a class="el" href="modules_8h-source.html#l00044">44</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.
  87 <p>
  88 Referenced by <a class="el" href="modules_8cpp-source.html#l00198">FileReader::FileReader()</a>, and <a class="el" href="modules_8cpp-source.html#l00209">FileReader::LoadFile()</a>.    </td>
  89   </tr>
  90 </table>
  91 <hr><address style="align: right;"><small>Generated on Thu Jan 23 20:28:58 2003 for InspIRCd by
  92 <a href="http://www.doxygen.org/index.html">
  93 <img src="doxygen.png" alt="doxygen" align="middle" border=0
  94 width=110 height=53></a>1.3-rc2 </small></address>
  95 </body>
  96 </html>