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="inspircd.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="namespaces.html">Namespace List</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">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">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#a11">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 <tr><td nowrap align=right valign=top>virtual int&nbsp;</td><td valign=bottom><a class="el" href="classModule.html#a12">Module::OnUserPreJoin</a> (<a class="el" href="classuserrec.html">userrec</a> *user, <a class="el" href="classchanrec.html">chanrec</a> *chan, char *cname)</td></tr>
  50 <tr><td>&nbsp;</td><td><font size=-1><em>Called whenever a user is about to join a channel, before any processing is done.</em> <a href="#a12"></a><em></em></font><br><br></td></tr>
  51 </table>
  52 <hr><a name="_details"></a><h2>Detailed Description</h2>
  53 Base class for all InspIRCd modules This class is the base class for InspIRCd modules.
  54 <p>
  55 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.
  56 <p>
  57
  58 <p>
  59 Definition at line <a class="el" href="modules_8h-source.html#l00090">90</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
  60 <a name="a0" doxytag="Module::Module"></a><p>
  61 <table width="100%" cellpadding="2" cellspacing="0" border="0">
  62   <tr>
  63     <td class="md">
  64       <table cellpadding="0" cellspacing="0" border="0">
  65         <tr>
  66           <td class="md" nowrap valign="top"> Module::Module </td>
  67           <td class="md" valign="top">(&nbsp;</td>
  68           <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
  69           <td class="md" valign="top">)&nbsp;</td>
  70           <td class="md" nowrap></td>
  71         </tr>
  72
  73       </table>
  74     </td>
  75   </tr>
  76 </table>
  77 <table cellspacing=5 cellpadding=0 border=0>
  78   <tr>
  79     <td>
  80       &nbsp;
  81     </td>
  82     <td>
  83
  84 <p>
  85 Default constructor creates a module class.
  86 <p>
  87
  88 <p>
  89 Definition at line <a class="el" href="modules_8cpp-source.html#l00107">107</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
  90 <p>
  91 <div class="fragment"><pre>00107 { }
  92 </pre></div>    </td>
  93   </tr>
  94 </table>
  95 <a name="a1" doxytag="Module::~Module"></a><p>
  96 <table width="100%" cellpadding="2" cellspacing="0" border="0">
  97   <tr>
  98     <td class="md">
  99       <table cellpadding="0" cellspacing="0" border="0">
 100         <tr>
 101           <td class="md" nowrap valign="top"> Module::~Module </td>
 102           <td class="md" valign="top">(&nbsp;</td>
 103           <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
 104           <td class="md" valign="top">)&nbsp;</td>
 105           <td class="md" nowrap><code> [virtual]</code></td>
 106         </tr>
 107
 108       </table>
 109     </td>
 110   </tr>
 111 </table>
 112 <table cellspacing=5 cellpadding=0 border=0>
 113   <tr>
 114     <td>
 115       &nbsp;
 116     </td>
 117     <td>
 118
 119 <p>
 120 Default destructor destroys a module class.
 121 <p>
 122
 123 <p>
 124 Definition at line <a class="el" href="modules_8cpp-source.html#l00108">108</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 125 <p>
 126 <div class="fragment"><pre>00108 { }
 127 </pre></div>    </td>
 128   </tr>
 129 </table>
 130 <hr><h2>Member Function Documentation</h2>
 131 <a name="a2" doxytag="Module::GetVersion"></a><p>
 132 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 133   <tr>
 134     <td class="md">
 135       <table cellpadding="0" cellspacing="0" border="0">
 136         <tr>
 137           <td class="md" nowrap valign="top"> <a class="el" href="classVersion.html">Version</a> Module::GetVersion </td>
 138           <td class="md" valign="top">(&nbsp;</td>
 139           <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
 140           <td class="md" valign="top">)&nbsp;</td>
 141           <td class="md" nowrap><code> [virtual]</code></td>
 142         </tr>
 143
 144       </table>
 145     </td>
 146   </tr>
 147 </table>
 148 <table cellspacing=5 cellpadding=0 border=0>
 149   <tr>
 150     <td>
 151       &nbsp;
 152     </td>
 153     <td>
 154
 155 <p>
 156 Returns the version number of a Module.
 157 <p>
 158 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>
 159 <p>
 160 Definition at line <a class="el" href="modules_8cpp-source.html#l00119">119</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 161 <p>
 162 <div class="fragment"><pre>00119 { <span class="keywordflow">return</span> <a class="code" href="classVersion.html">Version</a>(1,0,0,0); }
 163 </pre></div>    </td>
 164   </tr>
 165 </table>
 166 <a name="a12" doxytag="Module::Module::OnUserPreJoin"></a><p>
 167 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 168   <tr>
 169     <td class="md">
 170       <table cellpadding="0" cellspacing="0" border="0">
 171         <tr>
 172           <td class="md" nowrap valign="top"> virtual int Module::Module::OnUserPreJoin </td>
 173           <td class="md" valign="top">(&nbsp;</td>
 174           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 175           <td class="mdname" nowrap>&nbsp; <em>user</em>, </td>
 176         </tr>
 177         <tr>
 178           <td></td>
 179           <td></td>
 180           <td class="md" nowrap><a class="el" href="classchanrec.html">chanrec</a> *&nbsp;</td>
 181           <td class="mdname" nowrap>&nbsp; <em>chan</em>, </td>
 182         </tr>
 183         <tr>
 184           <td></td>
 185           <td></td>
 186           <td class="md" nowrap>char *&nbsp;</td>
 187           <td class="mdname" nowrap>&nbsp; <em>cname</em></td>
 188         </tr>
 189         <tr>
 190           <td></td>
 191           <td class="md">)&nbsp;</td>
 192           <td class="md" colspan="2"><code> [virtual]</code></td>
 193         </tr>
 194
 195       </table>
 196     </td>
 197   </tr>
 198 </table>
 199 <table cellspacing=5 cellpadding=0 border=0>
 200   <tr>
 201     <td>
 202       &nbsp;
 203     </td>
 204     <td>
 205
 206 <p>
 207 Called whenever a user is about to join a channel, before any processing is done.
 208 <p>
 209 Returning any nonzero value from this function stops the process immediately, causing no output to be sent to the user by the core. If you do this you must produce your own numerics, notices etc. This is useful for modules which may want to mimic +b, +k, +l etc.<p>
 210 IMPORTANT NOTE!<p>
 211 If the user joins a NEW channel which does not exist yet, OnUserPreJoin will be called BEFORE the channel record is created. This will cause chanrec* chan to be NULL. There is very little you can do in form of processing on the actual channel record at this point, however the channel NAME will still be passed in char* cname, so that you could for example implement a channel blacklist or whitelist, etc.    </td>
 212   </tr>
 213 </table>
 214 <a name="a11" doxytag="Module::OnExtendedMode"></a><p>
 215 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 216   <tr>
 217     <td class="md">
 218       <table cellpadding="0" cellspacing="0" border="0">
 219         <tr>
 220           <td class="md" nowrap valign="top"> bool Module::OnExtendedMode </td>
 221           <td class="md" valign="top">(&nbsp;</td>
 222           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 223           <td class="mdname" nowrap>&nbsp; <em>user</em>, </td>
 224         </tr>
 225         <tr>
 226           <td></td>
 227           <td></td>
 228           <td class="md" nowrap><a class="el" href="classchanrec.html">chanrec</a> *&nbsp;</td>
 229           <td class="mdname" nowrap>&nbsp; <em>chan</em>, </td>
 230         </tr>
 231         <tr>
 232           <td></td>
 233           <td></td>
 234           <td class="md" nowrap>char&nbsp;</td>
 235           <td class="mdname" nowrap>&nbsp; <em>modechar</em>, </td>
 236         </tr>
 237         <tr>
 238           <td></td>
 239           <td></td>
 240           <td class="md" nowrap>int&nbsp;</td>
 241           <td class="mdname" nowrap>&nbsp; <em>type</em>, </td>
 242         </tr>
 243         <tr>
 244           <td></td>
 245           <td></td>
 246           <td class="md" nowrap>bool&nbsp;</td>
 247           <td class="mdname" nowrap>&nbsp; <em>mode_on</em>, </td>
 248         </tr>
 249         <tr>
 250           <td></td>
 251           <td></td>
 252           <td class="md" nowrap><a class="el" href="modules_8h.html#a11">string_list</a> &amp;&nbsp;</td>
 253           <td class="mdname" nowrap>&nbsp; <em>params</em></td>
 254         </tr>
 255         <tr>
 256           <td></td>
 257           <td class="md">)&nbsp;</td>
 258           <td class="md" colspan="2"><code> [virtual]</code></td>
 259         </tr>
 260
 261       </table>
 262     </td>
 263   </tr>
 264 </table>
 265 <table cellspacing=5 cellpadding=0 border=0>
 266   <tr>
 267     <td>
 268       &nbsp;
 269     </td>
 270     <td>
 271
 272 <p>
 273 Called whenever an extended mode is to be processed.
 274 <p>
 275 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.
 276 <p>
 277 Definition at line <a class="el" href="modules_8cpp-source.html#l00118">118</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 278 <p>
 279 <div class="fragment"><pre>00118 { }
 280 </pre></div>    </td>
 281   </tr>
 282 </table>
 283 <a name="a8" doxytag="Module::OnPacketReceive"></a><p>
 284 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 285   <tr>
 286     <td class="md">
 287       <table cellpadding="0" cellspacing="0" border="0">
 288         <tr>
 289           <td class="md" nowrap valign="top"> void Module::OnPacketReceive </td>
 290           <td class="md" valign="top">(&nbsp;</td>
 291           <td class="md" nowrap valign="top">char *&nbsp;</td>
 292           <td class="mdname1" valign="top" nowrap>&nbsp; <em>p</em>          </td>
 293           <td class="md" valign="top">)&nbsp;</td>
 294           <td class="md" nowrap><code> [virtual]</code></td>
 295         </tr>
 296
 297       </table>
 298     </td>
 299   </tr>
 300 </table>
 301 <table cellspacing=5 cellpadding=0 border=0>
 302   <tr>
 303     <td>
 304       &nbsp;
 305     </td>
 306     <td>
 307
 308 <p>
 309 Called after a packet is received from another irc server.
 310 <p>
 311 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.
 312 <p>
 313 Definition at line <a class="el" href="modules_8cpp-source.html#l00114">114</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 314 <p>
 315 <div class="fragment"><pre>00114 { }
 316 </pre></div>    </td>
 317   </tr>
 318 </table>
 319 <a name="a7" doxytag="Module::OnPacketTransmit"></a><p>
 320 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 321   <tr>
 322     <td class="md">
 323       <table cellpadding="0" cellspacing="0" border="0">
 324         <tr>
 325           <td class="md" nowrap valign="top"> void Module::OnPacketTransmit </td>
 326           <td class="md" valign="top">(&nbsp;</td>
 327           <td class="md" nowrap valign="top">char *&nbsp;</td>
 328           <td class="mdname1" valign="top" nowrap>&nbsp; <em>p</em>          </td>
 329           <td class="md" valign="top">)&nbsp;</td>
 330           <td class="md" nowrap><code> [virtual]</code></td>
 331         </tr>
 332
 333       </table>
 334     </td>
 335   </tr>
 336 </table>
 337 <table cellspacing=5 cellpadding=0 border=0>
 338   <tr>
 339     <td>
 340       &nbsp;
 341     </td>
 342     <td>
 343
 344 <p>
 345 Called before a packet is transmitted across the irc network between two irc servers.
 346 <p>
 347 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.
 348 <p>
 349 Definition at line <a class="el" href="modules_8cpp-source.html#l00113">113</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 350 <p>
 351 <div class="fragment"><pre>00113 { }
 352 </pre></div>    </td>
 353   </tr>
 354 </table>
 355 <a name="a9" doxytag="Module::OnRehash"></a><p>
 356 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 357   <tr>
 358     <td class="md">
 359       <table cellpadding="0" cellspacing="0" border="0">
 360         <tr>
 361           <td class="md" nowrap valign="top"> void Module::OnRehash </td>
 362           <td class="md" valign="top">(&nbsp;</td>
 363           <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
 364           <td class="md" valign="top">)&nbsp;</td>
 365           <td class="md" nowrap><code> [virtual]</code></td>
 366         </tr>
 367
 368       </table>
 369     </td>
 370   </tr>
 371 </table>
 372 <table cellspacing=5 cellpadding=0 border=0>
 373   <tr>
 374     <td>
 375       &nbsp;
 376     </td>
 377     <td>
 378
 379 <p>
 380 Called on rehash.
 381 <p>
 382 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.
 383 <p>
 384 Definition at line <a class="el" href="modules_8cpp-source.html#l00115">115</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 385 <p>
 386 <div class="fragment"><pre>00115 { }
 387 </pre></div>    </td>
 388   </tr>
 389 </table>
 390 <a name="a10" doxytag="Module::OnServerRaw"></a><p>
 391 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 392   <tr>
 393     <td class="md">
 394       <table cellpadding="0" cellspacing="0" border="0">
 395         <tr>
 396           <td class="md" nowrap valign="top"> void Module::OnServerRaw </td>
 397           <td class="md" valign="top">(&nbsp;</td>
 398           <td class="md" nowrap valign="top">std::string &amp;&nbsp;</td>
 399           <td class="mdname" nowrap>&nbsp; <em>raw</em>, </td>
 400         </tr>
 401         <tr>
 402           <td></td>
 403           <td></td>
 404           <td class="md" nowrap>bool&nbsp;</td>
 405           <td class="mdname" nowrap>&nbsp; <em>inbound</em></td>
 406         </tr>
 407         <tr>
 408           <td></td>
 409           <td class="md">)&nbsp;</td>
 410           <td class="md" colspan="2"><code> [virtual]</code></td>
 411         </tr>
 412
 413       </table>
 414     </td>
 415   </tr>
 416 </table>
 417 <table cellspacing=5 cellpadding=0 border=0>
 418   <tr>
 419     <td>
 420       &nbsp;
 421     </td>
 422     <td>
 423
 424 <p>
 425 Called when a raw command is transmitted or received.
 426 <p>
 427 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.
 428 <p>
 429 Definition at line <a class="el" href="modules_8cpp-source.html#l00116">116</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 430 <p>
 431 <div class="fragment"><pre>00116 { }
 432 </pre></div>    </td>
 433   </tr>
 434 </table>
 435 <a name="a3" doxytag="Module::OnUserConnect"></a><p>
 436 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 437   <tr>
 438     <td class="md">
 439       <table cellpadding="0" cellspacing="0" border="0">
 440         <tr>
 441           <td class="md" nowrap valign="top"> void Module::OnUserConnect </td>
 442           <td class="md" valign="top">(&nbsp;</td>
 443           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 444           <td class="mdname1" valign="top" nowrap>&nbsp; <em>user</em>          </td>
 445           <td class="md" valign="top">)&nbsp;</td>
 446           <td class="md" nowrap><code> [virtual]</code></td>
 447         </tr>
 448
 449       </table>
 450     </td>
 451   </tr>
 452 </table>
 453 <table cellspacing=5 cellpadding=0 border=0>
 454   <tr>
 455     <td>
 456       &nbsp;
 457     </td>
 458     <td>
 459
 460 <p>
 461 Called when a user connects.
 462 <p>
 463 The details of the connecting user are available to you in the parameter userrec *user
 464 <p>
 465 Definition at line <a class="el" href="modules_8cpp-source.html#l00109">109</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 466 <p>
 467 <div class="fragment"><pre>00109 { }
 468 </pre></div>    </td>
 469   </tr>
 470 </table>
 471 <a name="a5" doxytag="Module::OnUserJoin"></a><p>
 472 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 473   <tr>
 474     <td class="md">
 475       <table cellpadding="0" cellspacing="0" border="0">
 476         <tr>
 477           <td class="md" nowrap valign="top"> void Module::OnUserJoin </td>
 478           <td class="md" valign="top">(&nbsp;</td>
 479           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 480           <td class="mdname" nowrap>&nbsp; <em>user</em>, </td>
 481         </tr>
 482         <tr>
 483           <td></td>
 484           <td></td>
 485           <td class="md" nowrap><a class="el" href="classchanrec.html">chanrec</a> *&nbsp;</td>
 486           <td class="mdname" nowrap>&nbsp; <em>channel</em></td>
 487         </tr>
 488         <tr>
 489           <td></td>
 490           <td class="md">)&nbsp;</td>
 491           <td class="md" colspan="2"><code> [virtual]</code></td>
 492         </tr>
 493
 494       </table>
 495     </td>
 496   </tr>
 497 </table>
 498 <table cellspacing=5 cellpadding=0 border=0>
 499   <tr>
 500     <td>
 501       &nbsp;
 502     </td>
 503     <td>
 504
 505 <p>
 506 Called when a user joins a channel.
 507 <p>
 508 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
 509 <p>
 510 Definition at line <a class="el" href="modules_8cpp-source.html#l00111">111</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 511 <p>
 512 <div class="fragment"><pre>00111 { }
 513 </pre></div>    </td>
 514   </tr>
 515 </table>
 516 <a name="a6" doxytag="Module::OnUserPart"></a><p>
 517 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 518   <tr>
 519     <td class="md">
 520       <table cellpadding="0" cellspacing="0" border="0">
 521         <tr>
 522           <td class="md" nowrap valign="top"> void Module::OnUserPart </td>
 523           <td class="md" valign="top">(&nbsp;</td>
 524           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 525           <td class="mdname" nowrap>&nbsp; <em>user</em>, </td>
 526         </tr>
 527         <tr>
 528           <td></td>
 529           <td></td>
 530           <td class="md" nowrap><a class="el" href="classchanrec.html">chanrec</a> *&nbsp;</td>
 531           <td class="mdname" nowrap>&nbsp; <em>channel</em></td>
 532         </tr>
 533         <tr>
 534           <td></td>
 535           <td class="md">)&nbsp;</td>
 536           <td class="md" colspan="2"><code> [virtual]</code></td>
 537         </tr>
 538
 539       </table>
 540     </td>
 541   </tr>
 542 </table>
 543 <table cellspacing=5 cellpadding=0 border=0>
 544   <tr>
 545     <td>
 546       &nbsp;
 547     </td>
 548     <td>
 549
 550 <p>
 551 Called when a user parts a channel.
 552 <p>
 553 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
 554 <p>
 555 Definition at line <a class="el" href="modules_8cpp-source.html#l00112">112</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 556 <p>
 557 <div class="fragment"><pre>00112 { }
 558 </pre></div>    </td>
 559   </tr>
 560 </table>
 561 <a name="a4" doxytag="Module::OnUserQuit"></a><p>
 562 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 563   <tr>
 564     <td class="md">
 565       <table cellpadding="0" cellspacing="0" border="0">
 566         <tr>
 567           <td class="md" nowrap valign="top"> void Module::OnUserQuit </td>
 568           <td class="md" valign="top">(&nbsp;</td>
 569           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 570           <td class="mdname1" valign="top" nowrap>&nbsp; <em>user</em>          </td>
 571           <td class="md" valign="top">)&nbsp;</td>
 572           <td class="md" nowrap><code> [virtual]</code></td>
 573         </tr>
 574
 575       </table>
 576     </td>
 577   </tr>
 578 </table>
 579 <table cellspacing=5 cellpadding=0 border=0>
 580   <tr>
 581     <td>
 582       &nbsp;
 583     </td>
 584     <td>
 585
 586 <p>
 587 Called when a user quits.
 588 <p>
 589 The details of the exiting user are available to you in the parameter userrec *user
 590 <p>
 591 Definition at line <a class="el" href="modules_8cpp-source.html#l00110">110</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 592 <p>
 593 <div class="fragment"><pre>00110 { }
 594 </pre></div>    </td>
 595   </tr>
 596 </table>
 597 <hr>The documentation for this class was generated from the following files:<ul>
 598 <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>
 599 <hr><address style="align: right;"><small>Generated on Sun Apr 4 23:02:29 2004 for InspIRCd by
 600 <a href="http://www.doxygen.org/index.html">
 601 <img src="doxygen.png" alt="doxygen" align="middle" border=0
 602 width=110 height=53></a>1.3-rc3 </small></address>
 603 </body>
 604 </html>