docs/module-doc/classModule.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>Module class 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>Module Class Reference</h1>Base class for all InspIRCd modules This class is the base class for InspIRCd modules.
  10 <a href="#_details">More...</a>
  11 <p>
  12 <code>#include &lt;<a class="el" href="modules_8h-source.html">modules.h</a>&gt;</code>
  13 <p>
  14 <p>Inheritance diagram for Module:
  15 <p><center><img src="classModule.png" usemap="#Module_map" border="0" alt=""></center>
  16 <map name="Module_map">
  17 <area href="classclassbase.html" alt="classbase" shape="rect" coords="0,0,68,24">
  18 </map>
  19 <a href="classModule-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
  20 <tr><td></td></tr>
  21 <tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
  22 <tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="classModule.html#a0">Module</a> ()</td></tr>
  23 <tr><td>&nbsp;</td><td><font size=-1><em>Default constructor creates a module class.</em> <a href="#a0"></a><em></em></font><br><br></td></tr>
  24 <tr><td nowrap align=right valign=top>virtual&nbsp;</td><td valign=bottom><a class="el" href="classModule.html#a1">~Module</a> ()</td></tr>
  25 <tr><td>&nbsp;</td><td><font size=-1><em>Default destructor destroys a module class.</em> <a href="#a1"></a><em></em></font><br><br></td></tr>
  26 <tr><td nowrap align=right valign=top>virtual <a class="el" href="classVersion.html">Version</a>&nbsp;</td><td valign=bottom><a class="el" href="classModule.html#a2">GetVersion</a> ()</td></tr>
  27 <tr><td>&nbsp;</td><td><font size=-1><em>Returns the version number of a Module.</em> <a href="#a2"></a><em></em></font><br><br></td></tr>
  28 <tr><td nowrap align=right valign=top>virtual void&nbsp;</td><td valign=bottom><a class="el" href="classModule.html#a3">OnUserConnect</a> (<a class="el" href="classuserrec.html">userrec</a> *user)</td></tr>
  29 <tr><td>&nbsp;</td><td><font size=-1><em>Called when a user connects.</em> <a href="#a3"></a><em></em></font><br><br></td></tr>
  30 <tr><td nowrap align=right valign=top>virtual void&nbsp;</td><td valign=bottom><a class="el" href="classModule.html#a4">OnUserQuit</a> (<a class="el" href="classuserrec.html">userrec</a> *user)</td></tr>
  31 <tr><td>&nbsp;</td><td><font size=-1><em>Called when a user quits.</em> <a href="#a4"></a><em></em></font><br><br></td></tr>
  32 <tr><td nowrap align=right valign=top>virtual void&nbsp;</td><td valign=bottom><a class="el" href="classModule.html#a5">OnUserJoin</a> (<a class="el" href="classuserrec.html">userrec</a> *user, <a class="el" href="classchanrec.html">chanrec</a> *channel)</td></tr>
  33 <tr><td>&nbsp;</td><td><font size=-1><em>Called when a user joins a channel.</em> <a href="#a5"></a><em></em></font><br><br></td></tr>
  34 <tr><td nowrap align=right valign=top>virtual void&nbsp;</td><td valign=bottom><a class="el" href="classModule.html#a6">OnUserPart</a> (<a class="el" href="classuserrec.html">userrec</a> *user, <a class="el" href="classchanrec.html">chanrec</a> *channel)</td></tr>
  35 <tr><td>&nbsp;</td><td><font size=-1><em>Called when a user parts a channel.</em> <a href="#a6"></a><em></em></font><br><br></td></tr>
  36 </table>
  37 <hr><a name="_details"></a><h2>Detailed Description</h2>
  38 Base class for all InspIRCd modules This class is the base class for InspIRCd modules.
  39 <p>
  40 All modules must inherit from this class, its methods will be called when irc server events occur. class inherited from module must be instantiated by the <a class="el" href="classModuleFactory.html">ModuleFactory</a> class (see relevent section) for the plugin to be initialised.
  41 <p>
  42
  43 <p>
  44 Definition at line <a class="el" href="modules_8h-source.html#l00086">86</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
  45 <a name="a0" doxytag="Module::Module"></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"> Module::Module </td>
  52           <td class="md" valign="top">(&nbsp;</td>
  53           <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
  54           <td class="md" valign="top">)&nbsp;</td>
  55           <td class="md" nowrap></td>
  56         </tr>
  57
  58       </table>
  59     </td>
  60   </tr>
  61 </table>
  62 <table cellspacing=5 cellpadding=0 border=0>
  63   <tr>
  64     <td>
  65       &nbsp;
  66     </td>
  67     <td>
  68
  69 <p>
  70 Default constructor creates a module class.
  71 <p>
  72
  73 <p>
  74 Definition at line <a class="el" href="modules_8cpp-source.html#l00043">43</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
  75 <p>
  76 <div class="fragment"><pre>00043 { }
  77 </pre></div>    </td>
  78   </tr>
  79 </table>
  80 <a name="a1" doxytag="Module::~Module"></a><p>
  81 <table width="100%" cellpadding="2" cellspacing="0" border="0">
  82   <tr>
  83     <td class="md">
  84       <table cellpadding="0" cellspacing="0" border="0">
  85         <tr>
  86           <td class="md" nowrap valign="top"> Module::~Module </td>
  87           <td class="md" valign="top">(&nbsp;</td>
  88           <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
  89           <td class="md" valign="top">)&nbsp;</td>
  90           <td class="md" nowrap><code> [virtual]</code></td>
  91         </tr>
  92
  93       </table>
  94     </td>
  95   </tr>
  96 </table>
  97 <table cellspacing=5 cellpadding=0 border=0>
  98   <tr>
  99     <td>
 100       &nbsp;
 101     </td>
 102     <td>
 103
 104 <p>
 105 Default destructor destroys a module class.
 106 <p>
 107
 108 <p>
 109 Definition at line <a class="el" href="modules_8cpp-source.html#l00044">44</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 110 <p>
 111 <div class="fragment"><pre>00044 { }
 112 </pre></div>    </td>
 113   </tr>
 114 </table>
 115 <hr><h2>Member Function Documentation</h2>
 116 <a name="a2" doxytag="Module::GetVersion"></a><p>
 117 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 118   <tr>
 119     <td class="md">
 120       <table cellpadding="0" cellspacing="0" border="0">
 121         <tr>
 122           <td class="md" nowrap valign="top"> <a class="el" href="classVersion.html">Version</a> Module::GetVersion </td>
 123           <td class="md" valign="top">(&nbsp;</td>
 124           <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
 125           <td class="md" valign="top">)&nbsp;</td>
 126           <td class="md" nowrap><code> [virtual]</code></td>
 127         </tr>
 128
 129       </table>
 130     </td>
 131   </tr>
 132 </table>
 133 <table cellspacing=5 cellpadding=0 border=0>
 134   <tr>
 135     <td>
 136       &nbsp;
 137     </td>
 138     <td>
 139
 140 <p>
 141 Returns the version number of a Module.
 142 <p>
 143 The method should return a <a class="el" href="classVersion.html">Version</a> object with its version information assigned via <a class="el" href="classVersion.html#a0">Version::Version</a>
 144 <p>
 145 Definition at line <a class="el" href="modules_8cpp-source.html#l00049">49</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 146 <p>
 147 <div class="fragment"><pre>00049 { <span class="keywordflow">return</span> <a class="code" href="classVersion.html">Version</a>(1,0,0,0); }
 148 </pre></div>    </td>
 149   </tr>
 150 </table>
 151 <a name="a3" doxytag="Module::OnUserConnect"></a><p>
 152 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 153   <tr>
 154     <td class="md">
 155       <table cellpadding="0" cellspacing="0" border="0">
 156         <tr>
 157           <td class="md" nowrap valign="top"> void Module::OnUserConnect </td>
 158           <td class="md" valign="top">(&nbsp;</td>
 159           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 160           <td class="mdname1" valign="top" nowrap>&nbsp; <em>user</em>          </td>
 161           <td class="md" valign="top">)&nbsp;</td>
 162           <td class="md" nowrap><code> [virtual]</code></td>
 163         </tr>
 164
 165       </table>
 166     </td>
 167   </tr>
 168 </table>
 169 <table cellspacing=5 cellpadding=0 border=0>
 170   <tr>
 171     <td>
 172       &nbsp;
 173     </td>
 174     <td>
 175
 176 <p>
 177 Called when a user connects.
 178 <p>
 179 The details of the connecting user are available to you in the parameter userrec *user
 180 <p>
 181 Definition at line <a class="el" href="modules_8cpp-source.html#l00045">45</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 182 <p>
 183 <div class="fragment"><pre>00045 { }
 184 </pre></div>    </td>
 185   </tr>
 186 </table>
 187 <a name="a5" doxytag="Module::OnUserJoin"></a><p>
 188 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 189   <tr>
 190     <td class="md">
 191       <table cellpadding="0" cellspacing="0" border="0">
 192         <tr>
 193           <td class="md" nowrap valign="top"> void Module::OnUserJoin </td>
 194           <td class="md" valign="top">(&nbsp;</td>
 195           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 196           <td class="mdname" nowrap>&nbsp; <em>user</em>, </td>
 197         </tr>
 198         <tr>
 199           <td></td>
 200           <td></td>
 201           <td class="md" nowrap><a class="el" href="classchanrec.html">chanrec</a> *&nbsp;</td>
 202           <td class="mdname" nowrap>&nbsp; <em>channel</em></td>
 203         </tr>
 204         <tr>
 205           <td></td>
 206           <td class="md">)&nbsp;</td>
 207           <td class="md" colspan="2"><code> [virtual]</code></td>
 208         </tr>
 209
 210       </table>
 211     </td>
 212   </tr>
 213 </table>
 214 <table cellspacing=5 cellpadding=0 border=0>
 215   <tr>
 216     <td>
 217       &nbsp;
 218     </td>
 219     <td>
 220
 221 <p>
 222 Called when a user joins a channel.
 223 <p>
 224 The details of the joining user are available to you in the parameter userrec *user, and the details of the channel they have joined is available in the variable chanrec *channel
 225 <p>
 226 Definition at line <a class="el" href="modules_8cpp-source.html#l00047">47</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 227 <p>
 228 <div class="fragment"><pre>00047 { }
 229 </pre></div>    </td>
 230   </tr>
 231 </table>
 232 <a name="a6" doxytag="Module::OnUserPart"></a><p>
 233 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 234   <tr>
 235     <td class="md">
 236       <table cellpadding="0" cellspacing="0" border="0">
 237         <tr>
 238           <td class="md" nowrap valign="top"> void Module::OnUserPart </td>
 239           <td class="md" valign="top">(&nbsp;</td>
 240           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 241           <td class="mdname" nowrap>&nbsp; <em>user</em>, </td>
 242         </tr>
 243         <tr>
 244           <td></td>
 245           <td></td>
 246           <td class="md" nowrap><a class="el" href="classchanrec.html">chanrec</a> *&nbsp;</td>
 247           <td class="mdname" nowrap>&nbsp; <em>channel</em></td>
 248         </tr>
 249         <tr>
 250           <td></td>
 251           <td class="md">)&nbsp;</td>
 252           <td class="md" colspan="2"><code> [virtual]</code></td>
 253         </tr>
 254
 255       </table>
 256     </td>
 257   </tr>
 258 </table>
 259 <table cellspacing=5 cellpadding=0 border=0>
 260   <tr>
 261     <td>
 262       &nbsp;
 263     </td>
 264     <td>
 265
 266 <p>
 267 Called when a user parts a channel.
 268 <p>
 269 The details of the leaving user are available to you in the parameter userrec *user, and the details of the channel they have left is available in the variable chanrec *channel
 270 <p>
 271 Definition at line <a class="el" href="modules_8cpp-source.html#l00048">48</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 272 <p>
 273 <div class="fragment"><pre>00048 { }
 274 </pre></div>    </td>
 275   </tr>
 276 </table>
 277 <a name="a4" doxytag="Module::OnUserQuit"></a><p>
 278 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 279   <tr>
 280     <td class="md">
 281       <table cellpadding="0" cellspacing="0" border="0">
 282         <tr>
 283           <td class="md" nowrap valign="top"> void Module::OnUserQuit </td>
 284           <td class="md" valign="top">(&nbsp;</td>
 285           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 286           <td class="mdname1" valign="top" nowrap>&nbsp; <em>user</em>          </td>
 287           <td class="md" valign="top">)&nbsp;</td>
 288           <td class="md" nowrap><code> [virtual]</code></td>
 289         </tr>
 290
 291       </table>
 292     </td>
 293   </tr>
 294 </table>
 295 <table cellspacing=5 cellpadding=0 border=0>
 296   <tr>
 297     <td>
 298       &nbsp;
 299     </td>
 300     <td>
 301
 302 <p>
 303 Called when a user quits.
 304 <p>
 305 The details of the exiting user are available to you in the parameter userrec *user
 306 <p>
 307 Definition at line <a class="el" href="modules_8cpp-source.html#l00046">46</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 308 <p>
 309 <div class="fragment"><pre>00046 { }
 310 </pre></div>    </td>
 311   </tr>
 312 </table>
 313 <hr>The documentation for this class was generated from the following files:<ul>
 314 <li><a class="el" href="modules_8h-source.html">modules.h</a><li><a class="el" href="modules_8cpp-source.html">modules.cpp</a></ul>
 315 <hr><address style="align: right;"><small>Generated on Sun Jan 26 23:45:49 2003 for InspIRCd by
 316 <a href="http://www.doxygen.org/index.html">
 317 <img src="doxygen.png" alt="doxygen" align="middle" border=0
 318 width=110 height=53></a>1.3-rc2 </small></address>
 319 </body>
 320 </html>