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-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>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 Inheritance diagram for Module:<p><center><img src="classModule__inherit__graph.gif" border="0" usemap="#Module__inherit__map" alt="Inheritance graph"></center>
  15 <map name="Module__inherit__map">
  16 <area href="classclassbase.html" shape="rect" coords="7,16,73,37" alt="">
  17 </map>
  18 <center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center>Collaboration diagram for Module:<p><center><img src="classModule__coll__graph.gif" border="0" usemap="#Module__coll__map" alt="Collaboration graph"></center>
  19 <map name="Module__coll__map">
  20 <area href="classclassbase.html" shape="rect" coords="7,106,73,128" alt="">
  21 </map>
  22 <center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center><a href="classModule-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
  23 <tr><td></td></tr>
  24 <tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
  25 <tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="classModule.html#a0">Module</a> ()</td></tr>
  26 <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>
  27 <tr><td nowrap align=right valign=top>virtual&nbsp;</td><td valign=bottom><a class="el" href="classModule.html#a1">~Module</a> ()</td></tr>
  28 <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>
  29 <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>
  30 <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>
  31 <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>
  32 <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>
  33 <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>
  34 <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>
  35 <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>
  36 <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>
  37 <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>
  38 <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>
  39 <tr><td nowrap align=right valign=top>virtual void&nbsp;</td><td valign=bottom><a class="el" href="classModule.html#a7">Module::OnPacketTransmit</a> (char *p)</td></tr>
  40 <tr><td>&nbsp;</td><td><font size=-1><em>Called before a packet is transmitted across the irc network between two irc servers.</em> <a href="#a7"></a><em></em></font><br><br></td></tr>
  41 <tr><td nowrap align=right valign=top>virtual void&nbsp;</td><td valign=bottom><a class="el" href="classModule.html#a8">Module::OnPacketReceive</a> (char *p)</td></tr>
  42 <tr><td>&nbsp;</td><td><font size=-1><em>Called after a packet is received from another irc server.</em> <a href="#a8"></a><em></em></font><br><br></td></tr>
  43 <tr><td nowrap align=right valign=top>virtual void&nbsp;</td><td valign=bottom><a class="el" href="classModule.html#a9">OnRehash</a> ()</td></tr>
  44 <tr><td>&nbsp;</td><td><font size=-1><em>Called on rehash.</em> <a href="#a9"></a><em></em></font><br><br></td></tr>
  45 <tr><td nowrap align=right valign=top>virtual void&nbsp;</td><td valign=bottom><a class="el" href="classModule.html#a10">OnServerRaw</a> (std::string &amp;raw, bool inbound)</td></tr>
  46 <tr><td>&nbsp;</td><td><font size=-1><em>Called when a raw command is transmitted or received.</em> <a href="#a10"></a><em></em></font><br><br></td></tr>
  47 <tr><td nowrap align=right valign=top>virtual bool&nbsp;</td><td valign=bottom><a class="el" href="classModule.html#a11">OnExtendedMode</a> (<a class="el" href="classuserrec.html">userrec</a> *user, <a class="el" href="classchanrec.html">chanrec</a> *chan, char modechar, int type, bool mode_on, <a class="el" href="modules_8h.html#a10">string_list</a> &amp;params)</td></tr>
  48 <tr><td>&nbsp;</td><td><font size=-1><em>Called whenever an extended mode is to be processed.</em> <a href="#a11"></a><em></em></font><br><br></td></tr>
  49 </table>
  50 <hr><a name="_details"></a><h2>Detailed Description</h2>
  51 Base class for all InspIRCd modules This class is the base class for InspIRCd modules.
  52 <p>
  53 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.
  54 <p>
  55
  56 <p>
  57 Definition at line <a class="el" href="modules_8h-source.html#l00071">71</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
  58 <a name="a0" doxytag="Module::Module"></a><p>
  59 <table width="100%" cellpadding="2" cellspacing="0" border="0">
  60   <tr>
  61     <td class="md">
  62       <table cellpadding="0" cellspacing="0" border="0">
  63         <tr>
  64           <td class="md" nowrap valign="top"> Module::Module </td>
  65           <td class="md" valign="top">(&nbsp;</td>
  66           <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
  67           <td class="md" valign="top">)&nbsp;</td>
  68           <td class="md" nowrap></td>
  69         </tr>
  70
  71       </table>
  72     </td>
  73   </tr>
  74 </table>
  75 <table cellspacing=5 cellpadding=0 border=0>
  76   <tr>
  77     <td>
  78       &nbsp;
  79     </td>
  80     <td>
  81
  82 <p>
  83 Default constructor creates a module class.
  84 <p>
  85
  86 <p>
  87 Definition at line <a class="el" href="modules_8cpp-source.html#l00088">88</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
  88 <p>
  89 <div class="fragment"><pre>00088 { }
  90 </pre></div>    </td>
  91   </tr>
  92 </table>
  93 <a name="a1" doxytag="Module::~Module"></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"> Module::~Module </td>
 100           <td class="md" valign="top">(&nbsp;</td>
 101           <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
 102           <td class="md" valign="top">)&nbsp;</td>
 103           <td class="md" nowrap><code> [virtual]</code></td>
 104         </tr>
 105
 106       </table>
 107     </td>
 108   </tr>
 109 </table>
 110 <table cellspacing=5 cellpadding=0 border=0>
 111   <tr>
 112     <td>
 113       &nbsp;
 114     </td>
 115     <td>
 116
 117 <p>
 118 Default destructor destroys a module class.
 119 <p>
 120
 121 <p>
 122 Definition at line <a class="el" href="modules_8cpp-source.html#l00089">89</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 123 <p>
 124 <div class="fragment"><pre>00089 { }
 125 </pre></div>    </td>
 126   </tr>
 127 </table>
 128 <hr><h2>Member Function Documentation</h2>
 129 <a name="a2" doxytag="Module::GetVersion"></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"> <a class="el" href="classVersion.html">Version</a> Module::GetVersion </td>
 136           <td class="md" valign="top">(&nbsp;</td>
 137           <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
 138           <td class="md" valign="top">)&nbsp;</td>
 139           <td class="md" nowrap><code> [virtual]</code></td>
 140         </tr>
 141
 142       </table>
 143     </td>
 144   </tr>
 145 </table>
 146 <table cellspacing=5 cellpadding=0 border=0>
 147   <tr>
 148     <td>
 149       &nbsp;
 150     </td>
 151     <td>
 152
 153 <p>
 154 Returns the version number of a Module.
 155 <p>
 156 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>
 157 <p>
 158 Definition at line <a class="el" href="modules_8cpp-source.html#l00099">99</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 159 <p>
 160 <div class="fragment"><pre>00099 { <span class="keywordflow">return</span> <a class="code" href="classVersion.html">Version</a>(1,0,0,0); }
 161 </pre></div>    </td>
 162   </tr>
 163 </table>
 164 <a name="a8" doxytag="Module::Module::OnPacketReceive"></a><p>
 165 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 166   <tr>
 167     <td class="md">
 168       <table cellpadding="0" cellspacing="0" border="0">
 169         <tr>
 170           <td class="md" nowrap valign="top"> virtual void Module::Module::OnPacketReceive </td>
 171           <td class="md" valign="top">(&nbsp;</td>
 172           <td class="md" nowrap valign="top">char *&nbsp;</td>
 173           <td class="mdname1" valign="top" nowrap>&nbsp; <em>p</em>          </td>
 174           <td class="md" valign="top">)&nbsp;</td>
 175           <td class="md" nowrap><code> [virtual]</code></td>
 176         </tr>
 177
 178       </table>
 179     </td>
 180   </tr>
 181 </table>
 182 <table cellspacing=5 cellpadding=0 border=0>
 183   <tr>
 184     <td>
 185       &nbsp;
 186     </td>
 187     <td>
 188
 189 <p>
 190 Called after a packet is received from another irc server.
 191 <p>
 192 The packet is represented as a char*, as it should be regarded as a buffer, and not a string. This allows you to easily represent it in the correct ways to implement encryption, compression, digital signatures and anything else you may want to add. This should be regarded as a pre-processor and will be called immediately after the packet is received but before any other operations with the core of the ircd.    </td>
 193   </tr>
 194 </table>
 195 <a name="a7" doxytag="Module::Module::OnPacketTransmit"></a><p>
 196 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 197   <tr>
 198     <td class="md">
 199       <table cellpadding="0" cellspacing="0" border="0">
 200         <tr>
 201           <td class="md" nowrap valign="top"> virtual void Module::Module::OnPacketTransmit </td>
 202           <td class="md" valign="top">(&nbsp;</td>
 203           <td class="md" nowrap valign="top">char *&nbsp;</td>
 204           <td class="mdname1" valign="top" nowrap>&nbsp; <em>p</em>          </td>
 205           <td class="md" valign="top">)&nbsp;</td>
 206           <td class="md" nowrap><code> [virtual]</code></td>
 207         </tr>
 208
 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 Called before a packet is transmitted across the irc network between two irc servers.
 222 <p>
 223 The packet is represented as a char*, as it should be regarded as a buffer, and not a string. This allows you to easily represent it in the correct ways to implement encryption, compression, digital signatures and anything else you may want to add. This should be regarded as a pre-processor and will be called before ANY other operations within the ircd core program.    </td>
 224   </tr>
 225 </table>
 226 <a name="a11" doxytag="Module::OnExtendedMode"></a><p>
 227 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 228   <tr>
 229     <td class="md">
 230       <table cellpadding="0" cellspacing="0" border="0">
 231         <tr>
 232           <td class="md" nowrap valign="top"> bool Module::OnExtendedMode </td>
 233           <td class="md" valign="top">(&nbsp;</td>
 234           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 235           <td class="mdname" nowrap>&nbsp; <em>user</em>, </td>
 236         </tr>
 237         <tr>
 238           <td></td>
 239           <td></td>
 240           <td class="md" nowrap><a class="el" href="classchanrec.html">chanrec</a> *&nbsp;</td>
 241           <td class="mdname" nowrap>&nbsp; <em>chan</em>, </td>
 242         </tr>
 243         <tr>
 244           <td></td>
 245           <td></td>
 246           <td class="md" nowrap>char&nbsp;</td>
 247           <td class="mdname" nowrap>&nbsp; <em>modechar</em>, </td>
 248         </tr>
 249         <tr>
 250           <td></td>
 251           <td></td>
 252           <td class="md" nowrap>int&nbsp;</td>
 253           <td class="mdname" nowrap>&nbsp; <em>type</em>, </td>
 254         </tr>
 255         <tr>
 256           <td></td>
 257           <td></td>
 258           <td class="md" nowrap>bool&nbsp;</td>
 259           <td class="mdname" nowrap>&nbsp; <em>mode_on</em>, </td>
 260         </tr>
 261         <tr>
 262           <td></td>
 263           <td></td>
 264           <td class="md" nowrap><a class="el" href="modules_8h.html#a10">string_list</a> &amp;&nbsp;</td>
 265           <td class="mdname" nowrap>&nbsp; <em>params</em></td>
 266         </tr>
 267         <tr>
 268           <td></td>
 269           <td class="md">)&nbsp;</td>
 270           <td class="md" colspan="2"><code> [virtual]</code></td>
 271         </tr>
 272
 273       </table>
 274     </td>
 275   </tr>
 276 </table>
 277 <table cellspacing=5 cellpadding=0 border=0>
 278   <tr>
 279     <td>
 280       &nbsp;
 281     </td>
 282     <td>
 283
 284 <p>
 285 Called whenever an extended mode is to be processed.
 286 <p>
 287 The type parameter is MT_SERVER, MT_CLIENT or MT_CHANNEL, dependent on where the mode is being changed. mode_on is set when the mode is being set, in which case params contains a list of parameters for the mode as strings. If mode_on is false, the mode is being removed, and parameters may contain the parameters for the mode, dependent on wether they were defined when a mode handler was set up with <a class="el" href="classServer.html#a19">Server::AddExtendedMode</a> If the mode is not a channel mode, chanrec* chan is null, and should not be read from or written to.
 288 <p>
 289 Definition at line <a class="el" href="modules_8cpp-source.html#l00098">98</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 290 <p>
 291 <div class="fragment"><pre>00098 { }
 292 </pre></div>    </td>
 293   </tr>
 294 </table>
 295 <a name="a9" doxytag="Module::OnRehash"></a><p>
 296 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 297   <tr>
 298     <td class="md">
 299       <table cellpadding="0" cellspacing="0" border="0">
 300         <tr>
 301           <td class="md" nowrap valign="top"> void Module::OnRehash </td>
 302           <td class="md" valign="top">(&nbsp;</td>
 303           <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
 304           <td class="md" valign="top">)&nbsp;</td>
 305           <td class="md" nowrap><code> [virtual]</code></td>
 306         </tr>
 307
 308       </table>
 309     </td>
 310   </tr>
 311 </table>
 312 <table cellspacing=5 cellpadding=0 border=0>
 313   <tr>
 314     <td>
 315       &nbsp;
 316     </td>
 317     <td>
 318
 319 <p>
 320 Called on rehash.
 321 <p>
 322 This method is called prior to a /REHASH or when a SIGHUP is received from the operating system. You should use it to reload any files so that your module keeps in step with the rest of the application.
 323 <p>
 324 Definition at line <a class="el" href="modules_8cpp-source.html#l00096">96</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 325 <p>
 326 <div class="fragment"><pre>00096 { }
 327 </pre></div>    </td>
 328   </tr>
 329 </table>
 330 <a name="a10" doxytag="Module::OnServerRaw"></a><p>
 331 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 332   <tr>
 333     <td class="md">
 334       <table cellpadding="0" cellspacing="0" border="0">
 335         <tr>
 336           <td class="md" nowrap valign="top"> void Module::OnServerRaw </td>
 337           <td class="md" valign="top">(&nbsp;</td>
 338           <td class="md" nowrap valign="top">std::string &amp;&nbsp;</td>
 339           <td class="mdname" nowrap>&nbsp; <em>raw</em>, </td>
 340         </tr>
 341         <tr>
 342           <td></td>
 343           <td></td>
 344           <td class="md" nowrap>bool&nbsp;</td>
 345           <td class="mdname" nowrap>&nbsp; <em>inbound</em></td>
 346         </tr>
 347         <tr>
 348           <td></td>
 349           <td class="md">)&nbsp;</td>
 350           <td class="md" colspan="2"><code> [virtual]</code></td>
 351         </tr>
 352
 353       </table>
 354     </td>
 355   </tr>
 356 </table>
 357 <table cellspacing=5 cellpadding=0 border=0>
 358   <tr>
 359     <td>
 360       &nbsp;
 361     </td>
 362     <td>
 363
 364 <p>
 365 Called when a raw command is transmitted or received.
 366 <p>
 367 This method is the lowest level of handler available to a module. It will be called with raw data which is passing through a connected socket. If you wish, you may munge this data by changing the string parameter "raw". If you do this, after your function exits it will immediately be cut down to 510 characters plus a carriage return and linefeed.
 368 <p>
 369 Definition at line <a class="el" href="modules_8cpp-source.html#l00097">97</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 370 <p>
 371 <div class="fragment"><pre>00097 { }
 372 </pre></div>    </td>
 373   </tr>
 374 </table>
 375 <a name="a3" doxytag="Module::OnUserConnect"></a><p>
 376 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 377   <tr>
 378     <td class="md">
 379       <table cellpadding="0" cellspacing="0" border="0">
 380         <tr>
 381           <td class="md" nowrap valign="top"> void Module::OnUserConnect </td>
 382           <td class="md" valign="top">(&nbsp;</td>
 383           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 384           <td class="mdname1" valign="top" nowrap>&nbsp; <em>user</em>          </td>
 385           <td class="md" valign="top">)&nbsp;</td>
 386           <td class="md" nowrap><code> [virtual]</code></td>
 387         </tr>
 388
 389       </table>
 390     </td>
 391   </tr>
 392 </table>
 393 <table cellspacing=5 cellpadding=0 border=0>
 394   <tr>
 395     <td>
 396       &nbsp;
 397     </td>
 398     <td>
 399
 400 <p>
 401 Called when a user connects.
 402 <p>
 403 The details of the connecting user are available to you in the parameter userrec *user
 404 <p>
 405 Definition at line <a class="el" href="modules_8cpp-source.html#l00090">90</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 406 <p>
 407 <div class="fragment"><pre>00090 { }
 408 </pre></div>    </td>
 409   </tr>
 410 </table>
 411 <a name="a5" doxytag="Module::OnUserJoin"></a><p>
 412 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 413   <tr>
 414     <td class="md">
 415       <table cellpadding="0" cellspacing="0" border="0">
 416         <tr>
 417           <td class="md" nowrap valign="top"> void Module::OnUserJoin </td>
 418           <td class="md" valign="top">(&nbsp;</td>
 419           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 420           <td class="mdname" nowrap>&nbsp; <em>user</em>, </td>
 421         </tr>
 422         <tr>
 423           <td></td>
 424           <td></td>
 425           <td class="md" nowrap><a class="el" href="classchanrec.html">chanrec</a> *&nbsp;</td>
 426           <td class="mdname" nowrap>&nbsp; <em>channel</em></td>
 427         </tr>
 428         <tr>
 429           <td></td>
 430           <td class="md">)&nbsp;</td>
 431           <td class="md" colspan="2"><code> [virtual]</code></td>
 432         </tr>
 433
 434       </table>
 435     </td>
 436   </tr>
 437 </table>
 438 <table cellspacing=5 cellpadding=0 border=0>
 439   <tr>
 440     <td>
 441       &nbsp;
 442     </td>
 443     <td>
 444
 445 <p>
 446 Called when a user joins a channel.
 447 <p>
 448 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
 449 <p>
 450 Definition at line <a class="el" href="modules_8cpp-source.html#l00092">92</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 451 <p>
 452 <div class="fragment"><pre>00092 { }
 453 </pre></div>    </td>
 454   </tr>
 455 </table>
 456 <a name="a6" doxytag="Module::OnUserPart"></a><p>
 457 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 458   <tr>
 459     <td class="md">
 460       <table cellpadding="0" cellspacing="0" border="0">
 461         <tr>
 462           <td class="md" nowrap valign="top"> void Module::OnUserPart </td>
 463           <td class="md" valign="top">(&nbsp;</td>
 464           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 465           <td class="mdname" nowrap>&nbsp; <em>user</em>, </td>
 466         </tr>
 467         <tr>
 468           <td></td>
 469           <td></td>
 470           <td class="md" nowrap><a class="el" href="classchanrec.html">chanrec</a> *&nbsp;</td>
 471           <td class="mdname" nowrap>&nbsp; <em>channel</em></td>
 472         </tr>
 473         <tr>
 474           <td></td>
 475           <td class="md">)&nbsp;</td>
 476           <td class="md" colspan="2"><code> [virtual]</code></td>
 477         </tr>
 478
 479       </table>
 480     </td>
 481   </tr>
 482 </table>
 483 <table cellspacing=5 cellpadding=0 border=0>
 484   <tr>
 485     <td>
 486       &nbsp;
 487     </td>
 488     <td>
 489
 490 <p>
 491 Called when a user parts a channel.
 492 <p>
 493 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
 494 <p>
 495 Definition at line <a class="el" href="modules_8cpp-source.html#l00093">93</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 496 <p>
 497 <div class="fragment"><pre>00093 { }
 498 </pre></div>    </td>
 499   </tr>
 500 </table>
 501 <a name="a4" doxytag="Module::OnUserQuit"></a><p>
 502 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 503   <tr>
 504     <td class="md">
 505       <table cellpadding="0" cellspacing="0" border="0">
 506         <tr>
 507           <td class="md" nowrap valign="top"> void Module::OnUserQuit </td>
 508           <td class="md" valign="top">(&nbsp;</td>
 509           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 510           <td class="mdname1" valign="top" nowrap>&nbsp; <em>user</em>          </td>
 511           <td class="md" valign="top">)&nbsp;</td>
 512           <td class="md" nowrap><code> [virtual]</code></td>
 513         </tr>
 514
 515       </table>
 516     </td>
 517   </tr>
 518 </table>
 519 <table cellspacing=5 cellpadding=0 border=0>
 520   <tr>
 521     <td>
 522       &nbsp;
 523     </td>
 524     <td>
 525
 526 <p>
 527 Called when a user quits.
 528 <p>
 529 The details of the exiting user are available to you in the parameter userrec *user
 530 <p>
 531 Definition at line <a class="el" href="modules_8cpp-source.html#l00091">91</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 532 <p>
 533 <div class="fragment"><pre>00091 { }
 534 </pre></div>    </td>
 535   </tr>
 536 </table>
 537 <hr>The documentation for this class was generated from the following files:<ul>
 538 <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>
 539 <hr><address style="align: right;"><small>Generated on Fri Apr 2 13:37:42 2004 for InspIRCd by
 540 <a href="http://www.doxygen.org/index.html">
 541 <img src="doxygen.png" alt="doxygen" align="middle" border=0
 542 width=110 height=53></a>1.3-rc3 </small></address>
 543 </body>
 544 </html>