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, <a class="el" href="classuserrec.html">userrec</a> *user)</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 int&nbsp;</td><td valign=bottom><a class="el" href="classModule.html#a11">OnExtendedMode</a> (<a class="el" href="classuserrec.html">userrec</a> *user, void *target, char modechar, int type, bool mode_on, <a class="el" href="modules_8h.html#a23">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">OnUserPreJoin</a> (<a class="el" href="classuserrec.html">userrec</a> *user, <a class="el" href="classchanrec.html">chanrec</a> *chan, const 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 <tr><td nowrap align=right valign=top>virtual void&nbsp;</td><td valign=bottom><a class="el" href="classModule.html#a13">OnOper</a> (<a class="el" href="classuserrec.html">userrec</a> *user)</td></tr>
  52 <tr><td>&nbsp;</td><td><font size=-1><em>Called whenever a user opers locally.</em> <a href="#a13"></a><em></em></font><br><br></td></tr>
  53 <tr><td nowrap align=right valign=top>virtual void&nbsp;</td><td valign=bottom><a class="el" href="classModule.html#a14">OnInfo</a> (<a class="el" href="classuserrec.html">userrec</a> *user)</td></tr>
  54 <tr><td>&nbsp;</td><td><font size=-1><em>Called whenever a user types /INFO.</em> <a href="#a14"></a><em></em></font><br><br></td></tr>
  55 <tr><td nowrap align=right valign=top>virtual void&nbsp;</td><td valign=bottom><a class="el" href="classModule.html#a15">OnWhois</a> (<a class="el" href="classuserrec.html">userrec</a> *source, <a class="el" href="classuserrec.html">userrec</a> *dest)</td></tr>
  56 <tr><td>&nbsp;</td><td><font size=-1><em>Called whenever a /WHOIS is performed on a local user.</em> <a href="#a15"></a><em></em></font><br><br></td></tr>
  57 <tr><td nowrap align=right valign=top>virtual int&nbsp;</td><td valign=bottom><a class="el" href="classModule.html#a16">OnUserPreMessage</a> (<a class="el" href="classuserrec.html">userrec</a> *user, void *dest, int target_type, std::string text)</td></tr>
  58 <tr><td>&nbsp;</td><td><font size=-1><em>Called whenever a user is about to PRIVMSG A user or a channel, before any processing is done.</em> <a href="#a16"></a><em></em></font><br><br></td></tr>
  59 <tr><td nowrap align=right valign=top>virtual int&nbsp;</td><td valign=bottom><a class="el" href="classModule.html#a17">OnUserPreNotice</a> (<a class="el" href="classuserrec.html">userrec</a> *user, void *dest, int target_type, std::string text)</td></tr>
  60 <tr><td>&nbsp;</td><td><font size=-1><em>Called whenever a user is about to NOTICE A user or a channel, before any processing is done.</em> <a href="#a17"></a><em></em></font><br><br></td></tr>
  61 <tr><td nowrap align=right valign=top>virtual int&nbsp;</td><td valign=bottom><a class="el" href="classModule.html#a18">OnUserPreNick</a> (<a class="el" href="classuserrec.html">userrec</a> *user, std::string newnick)</td></tr>
  62 <tr><td>&nbsp;</td><td><font size=-1><em>Called before any nickchange, local or remote.</em> <a href="#a18"></a><em></em></font><br><br></td></tr>
  63 <tr><td nowrap align=right valign=top>virtual int&nbsp;</td><td valign=bottom><a class="el" href="classModule.html#a19">OnAccessCheck</a> (<a class="el" href="classuserrec.html">userrec</a> *source, <a class="el" href="classuserrec.html">userrec</a> *dest, <a class="el" href="classchanrec.html">chanrec</a> *channel, int access_type)</td></tr>
  64 <tr><td>&nbsp;</td><td><font size=-1><em>Called before an action which requires a channel privilage check.</em> <a href="#a19"></a><em></em></font><br><br></td></tr>
  65 </table>
  66 <hr><a name="_details"></a><h2>Detailed Description</h2>
  67 Base class for all InspIRCd modules This class is the base class for InspIRCd modules.
  68 <p>
  69 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.
  70 <p>
  71
  72 <p>
  73 Definition at line <a class="el" href="modules_8h-source.html#l00112">112</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
  74 <a name="a0" doxytag="Module::Module"></a><p>
  75 <table width="100%" cellpadding="2" cellspacing="0" border="0">
  76   <tr>
  77     <td class="md">
  78       <table cellpadding="0" cellspacing="0" border="0">
  79         <tr>
  80           <td class="md" nowrap valign="top"> Module::Module </td>
  81           <td class="md" valign="top">(&nbsp;</td>
  82           <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
  83           <td class="md" valign="top">)&nbsp;</td>
  84           <td class="md" nowrap></td>
  85         </tr>
  86
  87       </table>
  88     </td>
  89   </tr>
  90 </table>
  91 <table cellspacing=5 cellpadding=0 border=0>
  92   <tr>
  93     <td>
  94       &nbsp;
  95     </td>
  96     <td>
  97
  98 <p>
  99 Default constructor creates a module class.
 100 <p>
 101
 102 <p>
 103 Definition at line <a class="el" href="modules_8cpp-source.html#l00139">139</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 104 <p>
 105 <div class="fragment"><pre>00139 { }
 106 </pre></div>    </td>
 107   </tr>
 108 </table>
 109 <a name="a1" doxytag="Module::~Module"></a><p>
 110 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 111   <tr>
 112     <td class="md">
 113       <table cellpadding="0" cellspacing="0" border="0">
 114         <tr>
 115           <td class="md" nowrap valign="top"> Module::~Module </td>
 116           <td class="md" valign="top">(&nbsp;</td>
 117           <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
 118           <td class="md" valign="top">)&nbsp;</td>
 119           <td class="md" nowrap><code> [virtual]</code></td>
 120         </tr>
 121
 122       </table>
 123     </td>
 124   </tr>
 125 </table>
 126 <table cellspacing=5 cellpadding=0 border=0>
 127   <tr>
 128     <td>
 129       &nbsp;
 130     </td>
 131     <td>
 132
 133 <p>
 134 Default destructor destroys a module class.
 135 <p>
 136
 137 <p>
 138 Definition at line <a class="el" href="modules_8cpp-source.html#l00140">140</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 139 <p>
 140 <div class="fragment"><pre>00140 { }
 141 </pre></div>    </td>
 142   </tr>
 143 </table>
 144 <hr><h2>Member Function Documentation</h2>
 145 <a name="a2" doxytag="Module::GetVersion"></a><p>
 146 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 147   <tr>
 148     <td class="md">
 149       <table cellpadding="0" cellspacing="0" border="0">
 150         <tr>
 151           <td class="md" nowrap valign="top"> <a class="el" href="classVersion.html">Version</a> Module::GetVersion </td>
 152           <td class="md" valign="top">(&nbsp;</td>
 153           <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
 154           <td class="md" valign="top">)&nbsp;</td>
 155           <td class="md" nowrap><code> [virtual]</code></td>
 156         </tr>
 157
 158       </table>
 159     </td>
 160   </tr>
 161 </table>
 162 <table cellspacing=5 cellpadding=0 border=0>
 163   <tr>
 164     <td>
 165       &nbsp;
 166     </td>
 167     <td>
 168
 169 <p>
 170 Returns the version number of a Module.
 171 <p>
 172 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>
 173 <p>
 174 Definition at line <a class="el" href="modules_8cpp-source.html#l00151">151</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 175 <p>
 176 <div class="fragment"><pre>00151 { <span class="keywordflow">return</span> <a class="code" href="classVersion.html">Version</a>(1,0,0,0); }
 177 </pre></div>    </td>
 178   </tr>
 179 </table>
 180 <a name="a19" doxytag="Module::OnAccessCheck"></a><p>
 181 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 182   <tr>
 183     <td class="md">
 184       <table cellpadding="0" cellspacing="0" border="0">
 185         <tr>
 186           <td class="md" nowrap valign="top"> int Module::OnAccessCheck </td>
 187           <td class="md" valign="top">(&nbsp;</td>
 188           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 189           <td class="mdname" nowrap>&nbsp; <em>source</em>, </td>
 190         </tr>
 191         <tr>
 192           <td></td>
 193           <td></td>
 194           <td class="md" nowrap><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 195           <td class="mdname" nowrap>&nbsp; <em>dest</em>, </td>
 196         </tr>
 197         <tr>
 198           <td></td>
 199           <td></td>
 200           <td class="md" nowrap><a class="el" href="classchanrec.html">chanrec</a> *&nbsp;</td>
 201           <td class="mdname" nowrap>&nbsp; <em>channel</em>, </td>
 202         </tr>
 203         <tr>
 204           <td></td>
 205           <td></td>
 206           <td class="md" nowrap>int&nbsp;</td>
 207           <td class="mdname" nowrap>&nbsp; <em>access_type</em></td>
 208         </tr>
 209         <tr>
 210           <td></td>
 211           <td class="md">)&nbsp;</td>
 212           <td class="md" colspan="2"><code> [virtual]</code></td>
 213         </tr>
 214
 215       </table>
 216     </td>
 217   </tr>
 218 </table>
 219 <table cellspacing=5 cellpadding=0 border=0>
 220   <tr>
 221     <td>
 222       &nbsp;
 223     </td>
 224     <td>
 225
 226 <p>
 227 Called before an action which requires a channel privilage check.
 228 <p>
 229 This function is called before many functions which check a users status on a channel, for example before opping a user, deopping a user, kicking a user, etc. There are several values for access_type which indicate for what reason access is being checked. These are:<br>
 230  AC_KICK (0) - A user is being kicked<br>
 231  AC_DEOP (1) - a user is being deopped<br>
 232  AC_OP (2) - a user is being opped<br>
 233  AC_VOICE (3) - a user is being voiced<br>
 234  AC_DEVOICE (4) - a user is being devoiced<br>
 235  AC_HALFOP (5) - a user is being halfopped<br>
 236  AC_DEHALFOP (6) - a user is being dehalfopped<br>
 237  AC_INVITE (7) - a user is being invited<br>
 238  AC_GENERAL_MODE (8) - a user channel mode is being changed<br>
 239  Upon returning from your function you must return either ACR_DEFAULT, to indicate the module wishes to do nothing, or ACR_DENY where approprate to deny the action, and ACR_ALLOW where appropriate to allow the action. Please note that in the case of some access checks (such as AC_GENERAL_MODE) access may be denied 'upstream' causing other checks such as AC_DEOP to not be reached. Be very careful with use of the AC_GENERAL_MODE type, as it may inadvertently override the behaviour of other modules. When the access_type is AC_GENERAL_MODE, the destination of the mode will be NULL (as it has not yet been determined).
 240 <p>
 241 Definition at line <a class="el" href="modules_8cpp-source.html#l00158">158</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 242 <p>
 243 References <a class="el" href="modules_8h-source.html#l00027">ACR_DEFAULT</a>.
 244 <p>
 245 <div class="fragment"><pre>00158 { <span class="keywordflow">return</span> <a class="code" href="modules_8h.html#a8">ACR_DEFAULT</a>; };
 246 </pre></div>    </td>
 247   </tr>
 248 </table>
 249 <a name="a11" doxytag="Module::OnExtendedMode"></a><p>
 250 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 251   <tr>
 252     <td class="md">
 253       <table cellpadding="0" cellspacing="0" border="0">
 254         <tr>
 255           <td class="md" nowrap valign="top"> int Module::OnExtendedMode </td>
 256           <td class="md" valign="top">(&nbsp;</td>
 257           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 258           <td class="mdname" nowrap>&nbsp; <em>user</em>, </td>
 259         </tr>
 260         <tr>
 261           <td></td>
 262           <td></td>
 263           <td class="md" nowrap>void *&nbsp;</td>
 264           <td class="mdname" nowrap>&nbsp; <em>target</em>, </td>
 265         </tr>
 266         <tr>
 267           <td></td>
 268           <td></td>
 269           <td class="md" nowrap>char&nbsp;</td>
 270           <td class="mdname" nowrap>&nbsp; <em>modechar</em>, </td>
 271         </tr>
 272         <tr>
 273           <td></td>
 274           <td></td>
 275           <td class="md" nowrap>int&nbsp;</td>
 276           <td class="mdname" nowrap>&nbsp; <em>type</em>, </td>
 277         </tr>
 278         <tr>
 279           <td></td>
 280           <td></td>
 281           <td class="md" nowrap>bool&nbsp;</td>
 282           <td class="mdname" nowrap>&nbsp; <em>mode_on</em>, </td>
 283         </tr>
 284         <tr>
 285           <td></td>
 286           <td></td>
 287           <td class="md" nowrap><a class="el" href="modules_8h.html#a23">string_list</a> &amp;&nbsp;</td>
 288           <td class="mdname" nowrap>&nbsp; <em>params</em></td>
 289         </tr>
 290         <tr>
 291           <td></td>
 292           <td class="md">)&nbsp;</td>
 293           <td class="md" colspan="2"><code> [virtual]</code></td>
 294         </tr>
 295
 296       </table>
 297     </td>
 298   </tr>
 299 </table>
 300 <table cellspacing=5 cellpadding=0 border=0>
 301   <tr>
 302     <td>
 303       &nbsp;
 304     </td>
 305     <td>
 306
 307 <p>
 308 Called whenever an extended mode is to be processed.
 309 <p>
 310 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#a21">Server::AddExtendedMode</a> If the mode is a channel mode, target is a chanrec*, and if it is a user mode, target is a userrec*. You must cast this value yourself to make use of it.
 311 <p>
 312 Definition at line <a class="el" href="modules_8cpp-source.html#l00150">150</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 313 <p>
 314 <div class="fragment"><pre>00150 { <span class="keywordflow">return</span> <span class="keyword">false</span>; }
 315 </pre></div>    </td>
 316   </tr>
 317 </table>
 318 <a name="a14" doxytag="Module::OnInfo"></a><p>
 319 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 320   <tr>
 321     <td class="md">
 322       <table cellpadding="0" cellspacing="0" border="0">
 323         <tr>
 324           <td class="md" nowrap valign="top"> void Module::OnInfo </td>
 325           <td class="md" valign="top">(&nbsp;</td>
 326           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 327           <td class="mdname1" valign="top" nowrap>&nbsp; <em>user</em>          </td>
 328           <td class="md" valign="top">)&nbsp;</td>
 329           <td class="md" nowrap><code> [virtual]</code></td>
 330         </tr>
 331
 332       </table>
 333     </td>
 334   </tr>
 335 </table>
 336 <table cellspacing=5 cellpadding=0 border=0>
 337   <tr>
 338     <td>
 339       &nbsp;
 340     </td>
 341     <td>
 342
 343 <p>
 344 Called whenever a user types /INFO.
 345 <p>
 346 The userrec will contain the information of the user who typed the command. Modules may use this method to output their own credits in /INFO (which is the ircd's version of an about box). It is purposefully not possible to modify any info that has already been output, or halt the list. You must write a 371 numeric to the user, containing your info in the following format:<p>
 347 :information here
 348 <p>
 349 Definition at line <a class="el" href="modules_8cpp-source.html#l00153">153</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 350 <p>
 351 <div class="fragment"><pre>00153 { };
 352 </pre></div>    </td>
 353   </tr>
 354 </table>
 355 <a name="a13" doxytag="Module::OnOper"></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::OnOper </td>
 362           <td class="md" valign="top">(&nbsp;</td>
 363           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 364           <td class="mdname1" valign="top" nowrap>&nbsp; <em>user</em>          </td>
 365           <td class="md" valign="top">)&nbsp;</td>
 366           <td class="md" nowrap><code> [virtual]</code></td>
 367         </tr>
 368
 369       </table>
 370     </td>
 371   </tr>
 372 </table>
 373 <table cellspacing=5 cellpadding=0 border=0>
 374   <tr>
 375     <td>
 376       &nbsp;
 377     </td>
 378     <td>
 379
 380 <p>
 381 Called whenever a user opers locally.
 382 <p>
 383 The userrec will contain the oper mode 'o' as this function is called after any modifications are made to the user's structure by the core.
 384 <p>
 385 Definition at line <a class="el" href="modules_8cpp-source.html#l00152">152</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 386 <p>
 387 <div class="fragment"><pre>00152 { };
 388 </pre></div>    </td>
 389   </tr>
 390 </table>
 391 <a name="a8" doxytag="Module::OnPacketReceive"></a><p>
 392 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 393   <tr>
 394     <td class="md">
 395       <table cellpadding="0" cellspacing="0" border="0">
 396         <tr>
 397           <td class="md" nowrap valign="top"> void Module::OnPacketReceive </td>
 398           <td class="md" valign="top">(&nbsp;</td>
 399           <td class="md" nowrap valign="top">char *&nbsp;</td>
 400           <td class="mdname1" valign="top" nowrap>&nbsp; <em>p</em>          </td>
 401           <td class="md" valign="top">)&nbsp;</td>
 402           <td class="md" nowrap><code> [virtual]</code></td>
 403         </tr>
 404
 405       </table>
 406     </td>
 407   </tr>
 408 </table>
 409 <table cellspacing=5 cellpadding=0 border=0>
 410   <tr>
 411     <td>
 412       &nbsp;
 413     </td>
 414     <td>
 415
 416 <p>
 417 Called after a packet is received from another irc server.
 418 <p>
 419 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.
 420 <p>
 421 Definition at line <a class="el" href="modules_8cpp-source.html#l00146">146</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 422 <p>
 423 <div class="fragment"><pre>00146 { }
 424 </pre></div>    </td>
 425   </tr>
 426 </table>
 427 <a name="a7" doxytag="Module::OnPacketTransmit"></a><p>
 428 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 429   <tr>
 430     <td class="md">
 431       <table cellpadding="0" cellspacing="0" border="0">
 432         <tr>
 433           <td class="md" nowrap valign="top"> void Module::OnPacketTransmit </td>
 434           <td class="md" valign="top">(&nbsp;</td>
 435           <td class="md" nowrap valign="top">char *&nbsp;</td>
 436           <td class="mdname1" valign="top" nowrap>&nbsp; <em>p</em>          </td>
 437           <td class="md" valign="top">)&nbsp;</td>
 438           <td class="md" nowrap><code> [virtual]</code></td>
 439         </tr>
 440
 441       </table>
 442     </td>
 443   </tr>
 444 </table>
 445 <table cellspacing=5 cellpadding=0 border=0>
 446   <tr>
 447     <td>
 448       &nbsp;
 449     </td>
 450     <td>
 451
 452 <p>
 453 Called before a packet is transmitted across the irc network between two irc servers.
 454 <p>
 455 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.
 456 <p>
 457 Definition at line <a class="el" href="modules_8cpp-source.html#l00145">145</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 458 <p>
 459 <div class="fragment"><pre>00145 { }
 460 </pre></div>    </td>
 461   </tr>
 462 </table>
 463 <a name="a9" doxytag="Module::OnRehash"></a><p>
 464 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 465   <tr>
 466     <td class="md">
 467       <table cellpadding="0" cellspacing="0" border="0">
 468         <tr>
 469           <td class="md" nowrap valign="top"> void Module::OnRehash </td>
 470           <td class="md" valign="top">(&nbsp;</td>
 471           <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
 472           <td class="md" valign="top">)&nbsp;</td>
 473           <td class="md" nowrap><code> [virtual]</code></td>
 474         </tr>
 475
 476       </table>
 477     </td>
 478   </tr>
 479 </table>
 480 <table cellspacing=5 cellpadding=0 border=0>
 481   <tr>
 482     <td>
 483       &nbsp;
 484     </td>
 485     <td>
 486
 487 <p>
 488 Called on rehash.
 489 <p>
 490 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.
 491 <p>
 492 Definition at line <a class="el" href="modules_8cpp-source.html#l00147">147</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 493 <p>
 494 <div class="fragment"><pre>00147 { }
 495 </pre></div>    </td>
 496   </tr>
 497 </table>
 498 <a name="a10" doxytag="Module::OnServerRaw"></a><p>
 499 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 500   <tr>
 501     <td class="md">
 502       <table cellpadding="0" cellspacing="0" border="0">
 503         <tr>
 504           <td class="md" nowrap valign="top"> void Module::OnServerRaw </td>
 505           <td class="md" valign="top">(&nbsp;</td>
 506           <td class="md" nowrap valign="top">std::string &amp;&nbsp;</td>
 507           <td class="mdname" nowrap>&nbsp; <em>raw</em>, </td>
 508         </tr>
 509         <tr>
 510           <td></td>
 511           <td></td>
 512           <td class="md" nowrap>bool&nbsp;</td>
 513           <td class="mdname" nowrap>&nbsp; <em>inbound</em>, </td>
 514         </tr>
 515         <tr>
 516           <td></td>
 517           <td></td>
 518           <td class="md" nowrap><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 519           <td class="mdname" nowrap>&nbsp; <em>user</em></td>
 520         </tr>
 521         <tr>
 522           <td></td>
 523           <td class="md">)&nbsp;</td>
 524           <td class="md" colspan="2"><code> [virtual]</code></td>
 525         </tr>
 526
 527       </table>
 528     </td>
 529   </tr>
 530 </table>
 531 <table cellspacing=5 cellpadding=0 border=0>
 532   <tr>
 533     <td>
 534       &nbsp;
 535     </td>
 536     <td>
 537
 538 <p>
 539 Called when a raw command is transmitted or received.
 540 <p>
 541 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. For INBOUND messages only (where inbound is set to true) the value of user will be the userrec of the connection sending the data. This is not possible for outbound data because the data may be being routed to multiple targets.
 542 <p>
 543 Definition at line <a class="el" href="modules_8cpp-source.html#l00148">148</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 544 <p>
 545 <div class="fragment"><pre>00148 { }
 546 </pre></div>    </td>
 547   </tr>
 548 </table>
 549 <a name="a3" doxytag="Module::OnUserConnect"></a><p>
 550 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 551   <tr>
 552     <td class="md">
 553       <table cellpadding="0" cellspacing="0" border="0">
 554         <tr>
 555           <td class="md" nowrap valign="top"> void Module::OnUserConnect </td>
 556           <td class="md" valign="top">(&nbsp;</td>
 557           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 558           <td class="mdname1" valign="top" nowrap>&nbsp; <em>user</em>          </td>
 559           <td class="md" valign="top">)&nbsp;</td>
 560           <td class="md" nowrap><code> [virtual]</code></td>
 561         </tr>
 562
 563       </table>
 564     </td>
 565   </tr>
 566 </table>
 567 <table cellspacing=5 cellpadding=0 border=0>
 568   <tr>
 569     <td>
 570       &nbsp;
 571     </td>
 572     <td>
 573
 574 <p>
 575 Called when a user connects.
 576 <p>
 577 The details of the connecting user are available to you in the parameter userrec *user
 578 <p>
 579 Definition at line <a class="el" href="modules_8cpp-source.html#l00141">141</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 580 <p>
 581 <div class="fragment"><pre>00141 { }
 582 </pre></div>    </td>
 583   </tr>
 584 </table>
 585 <a name="a5" doxytag="Module::OnUserJoin"></a><p>
 586 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 587   <tr>
 588     <td class="md">
 589       <table cellpadding="0" cellspacing="0" border="0">
 590         <tr>
 591           <td class="md" nowrap valign="top"> void Module::OnUserJoin </td>
 592           <td class="md" valign="top">(&nbsp;</td>
 593           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 594           <td class="mdname" nowrap>&nbsp; <em>user</em>, </td>
 595         </tr>
 596         <tr>
 597           <td></td>
 598           <td></td>
 599           <td class="md" nowrap><a class="el" href="classchanrec.html">chanrec</a> *&nbsp;</td>
 600           <td class="mdname" nowrap>&nbsp; <em>channel</em></td>
 601         </tr>
 602         <tr>
 603           <td></td>
 604           <td class="md">)&nbsp;</td>
 605           <td class="md" colspan="2"><code> [virtual]</code></td>
 606         </tr>
 607
 608       </table>
 609     </td>
 610   </tr>
 611 </table>
 612 <table cellspacing=5 cellpadding=0 border=0>
 613   <tr>
 614     <td>
 615       &nbsp;
 616     </td>
 617     <td>
 618
 619 <p>
 620 Called when a user joins a channel.
 621 <p>
 622 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
 623 <p>
 624 Definition at line <a class="el" href="modules_8cpp-source.html#l00143">143</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 625 <p>
 626 <div class="fragment"><pre>00143 { }
 627 </pre></div>    </td>
 628   </tr>
 629 </table>
 630 <a name="a6" doxytag="Module::OnUserPart"></a><p>
 631 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 632   <tr>
 633     <td class="md">
 634       <table cellpadding="0" cellspacing="0" border="0">
 635         <tr>
 636           <td class="md" nowrap valign="top"> void Module::OnUserPart </td>
 637           <td class="md" valign="top">(&nbsp;</td>
 638           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 639           <td class="mdname" nowrap>&nbsp; <em>user</em>, </td>
 640         </tr>
 641         <tr>
 642           <td></td>
 643           <td></td>
 644           <td class="md" nowrap><a class="el" href="classchanrec.html">chanrec</a> *&nbsp;</td>
 645           <td class="mdname" nowrap>&nbsp; <em>channel</em></td>
 646         </tr>
 647         <tr>
 648           <td></td>
 649           <td class="md">)&nbsp;</td>
 650           <td class="md" colspan="2"><code> [virtual]</code></td>
 651         </tr>
 652
 653       </table>
 654     </td>
 655   </tr>
 656 </table>
 657 <table cellspacing=5 cellpadding=0 border=0>
 658   <tr>
 659     <td>
 660       &nbsp;
 661     </td>
 662     <td>
 663
 664 <p>
 665 Called when a user parts a channel.
 666 <p>
 667 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
 668 <p>
 669 Definition at line <a class="el" href="modules_8cpp-source.html#l00144">144</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 670 <p>
 671 <div class="fragment"><pre>00144 { }
 672 </pre></div>    </td>
 673   </tr>
 674 </table>
 675 <a name="a12" doxytag="Module::OnUserPreJoin"></a><p>
 676 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 677   <tr>
 678     <td class="md">
 679       <table cellpadding="0" cellspacing="0" border="0">
 680         <tr>
 681           <td class="md" nowrap valign="top"> int Module::OnUserPreJoin </td>
 682           <td class="md" valign="top">(&nbsp;</td>
 683           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 684           <td class="mdname" nowrap>&nbsp; <em>user</em>, </td>
 685         </tr>
 686         <tr>
 687           <td></td>
 688           <td></td>
 689           <td class="md" nowrap><a class="el" href="classchanrec.html">chanrec</a> *&nbsp;</td>
 690           <td class="mdname" nowrap>&nbsp; <em>chan</em>, </td>
 691         </tr>
 692         <tr>
 693           <td></td>
 694           <td></td>
 695           <td class="md" nowrap>const char *&nbsp;</td>
 696           <td class="mdname" nowrap>&nbsp; <em>cname</em></td>
 697         </tr>
 698         <tr>
 699           <td></td>
 700           <td class="md">)&nbsp;</td>
 701           <td class="md" colspan="2"><code> [virtual]</code></td>
 702         </tr>
 703
 704       </table>
 705     </td>
 706   </tr>
 707 </table>
 708 <table cellspacing=5 cellpadding=0 border=0>
 709   <tr>
 710     <td>
 711       &nbsp;
 712     </td>
 713     <td>
 714
 715 <p>
 716 Called whenever a user is about to join a channel, before any processing is done.
 717 <p>
 718 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>
 719 IMPORTANT NOTE!<p>
 720 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.
 721 <p>
 722 Definition at line <a class="el" href="modules_8cpp-source.html#l00149">149</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 723 <p>
 724 <div class="fragment"><pre>00149 { <span class="keywordflow">return</span> 0; }
 725 </pre></div>    </td>
 726   </tr>
 727 </table>
 728 <a name="a16" doxytag="Module::OnUserPreMessage"></a><p>
 729 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 730   <tr>
 731     <td class="md">
 732       <table cellpadding="0" cellspacing="0" border="0">
 733         <tr>
 734           <td class="md" nowrap valign="top"> int Module::OnUserPreMessage </td>
 735           <td class="md" valign="top">(&nbsp;</td>
 736           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 737           <td class="mdname" nowrap>&nbsp; <em>user</em>, </td>
 738         </tr>
 739         <tr>
 740           <td></td>
 741           <td></td>
 742           <td class="md" nowrap>void *&nbsp;</td>
 743           <td class="mdname" nowrap>&nbsp; <em>dest</em>, </td>
 744         </tr>
 745         <tr>
 746           <td></td>
 747           <td></td>
 748           <td class="md" nowrap>int&nbsp;</td>
 749           <td class="mdname" nowrap>&nbsp; <em>target_type</em>, </td>
 750         </tr>
 751         <tr>
 752           <td></td>
 753           <td></td>
 754           <td class="md" nowrap>std::string&nbsp;</td>
 755           <td class="mdname" nowrap>&nbsp; <em>text</em></td>
 756         </tr>
 757         <tr>
 758           <td></td>
 759           <td class="md">)&nbsp;</td>
 760           <td class="md" colspan="2"><code> [virtual]</code></td>
 761         </tr>
 762
 763       </table>
 764     </td>
 765   </tr>
 766 </table>
 767 <table cellspacing=5 cellpadding=0 border=0>
 768   <tr>
 769     <td>
 770       &nbsp;
 771     </td>
 772     <td>
 773
 774 <p>
 775 Called whenever a user is about to PRIVMSG A user or a channel, before any processing is done.
 776 <p>
 777 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 filter or redirect messages. target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user, you must cast dest to a userrec* otherwise you must cast it to a chanrec*, this is the details of where the message is destined to be sent.
 778 <p>
 779 Definition at line <a class="el" href="modules_8cpp-source.html#l00155">155</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 780 <p>
 781 <div class="fragment"><pre>00155 { <span class="keywordflow">return</span> 0; };
 782 </pre></div>    </td>
 783   </tr>
 784 </table>
 785 <a name="a18" doxytag="Module::OnUserPreNick"></a><p>
 786 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 787   <tr>
 788     <td class="md">
 789       <table cellpadding="0" cellspacing="0" border="0">
 790         <tr>
 791           <td class="md" nowrap valign="top"> int Module::OnUserPreNick </td>
 792           <td class="md" valign="top">(&nbsp;</td>
 793           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 794           <td class="mdname" nowrap>&nbsp; <em>user</em>, </td>
 795         </tr>
 796         <tr>
 797           <td></td>
 798           <td></td>
 799           <td class="md" nowrap>std::string&nbsp;</td>
 800           <td class="mdname" nowrap>&nbsp; <em>newnick</em></td>
 801         </tr>
 802         <tr>
 803           <td></td>
 804           <td class="md">)&nbsp;</td>
 805           <td class="md" colspan="2"><code> [virtual]</code></td>
 806         </tr>
 807
 808       </table>
 809     </td>
 810   </tr>
 811 </table>
 812 <table cellspacing=5 cellpadding=0 border=0>
 813   <tr>
 814     <td>
 815       &nbsp;
 816     </td>
 817     <td>
 818
 819 <p>
 820 Called before any nickchange, local or remote.
 821 <p>
 822 This can be used to implement Q-lines etc. Please note that although you can see remote nickchanges through this function, you should NOT make any changes to the userrec if the user is a remote user as this may cause a desnyc. check user-&gt;server before taking any action (including returning nonzero from the method). If your method returns nonzero, the nickchange is silently forbidden, and it is down to your module to generate some meaninful output.
 823 <p>
 824 Definition at line <a class="el" href="modules_8cpp-source.html#l00157">157</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 825 <p>
 826 <div class="fragment"><pre>00157 { <span class="keywordflow">return</span> 0; };
 827 </pre></div>    </td>
 828   </tr>
 829 </table>
 830 <a name="a17" doxytag="Module::OnUserPreNotice"></a><p>
 831 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 832   <tr>
 833     <td class="md">
 834       <table cellpadding="0" cellspacing="0" border="0">
 835         <tr>
 836           <td class="md" nowrap valign="top"> int Module::OnUserPreNotice </td>
 837           <td class="md" valign="top">(&nbsp;</td>
 838           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 839           <td class="mdname" nowrap>&nbsp; <em>user</em>, </td>
 840         </tr>
 841         <tr>
 842           <td></td>
 843           <td></td>
 844           <td class="md" nowrap>void *&nbsp;</td>
 845           <td class="mdname" nowrap>&nbsp; <em>dest</em>, </td>
 846         </tr>
 847         <tr>
 848           <td></td>
 849           <td></td>
 850           <td class="md" nowrap>int&nbsp;</td>
 851           <td class="mdname" nowrap>&nbsp; <em>target_type</em>, </td>
 852         </tr>
 853         <tr>
 854           <td></td>
 855           <td></td>
 856           <td class="md" nowrap>std::string&nbsp;</td>
 857           <td class="mdname" nowrap>&nbsp; <em>text</em></td>
 858         </tr>
 859         <tr>
 860           <td></td>
 861           <td class="md">)&nbsp;</td>
 862           <td class="md" colspan="2"><code> [virtual]</code></td>
 863         </tr>
 864
 865       </table>
 866     </td>
 867   </tr>
 868 </table>
 869 <table cellspacing=5 cellpadding=0 border=0>
 870   <tr>
 871     <td>
 872       &nbsp;
 873     </td>
 874     <td>
 875
 876 <p>
 877 Called whenever a user is about to NOTICE A user or a channel, before any processing is done.
 878 <p>
 879 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 filter or redirect messages. target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user, you must cast dest to a userrec* otherwise you must cast it to a chanrec*, this is the details of where the message is destined to be sent.
 880 <p>
 881 Definition at line <a class="el" href="modules_8cpp-source.html#l00156">156</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 882 <p>
 883 <div class="fragment"><pre>00156 { <span class="keywordflow">return</span> 0; };
 884 </pre></div>    </td>
 885   </tr>
 886 </table>
 887 <a name="a4" doxytag="Module::OnUserQuit"></a><p>
 888 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 889   <tr>
 890     <td class="md">
 891       <table cellpadding="0" cellspacing="0" border="0">
 892         <tr>
 893           <td class="md" nowrap valign="top"> void Module::OnUserQuit </td>
 894           <td class="md" valign="top">(&nbsp;</td>
 895           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 896           <td class="mdname1" valign="top" nowrap>&nbsp; <em>user</em>          </td>
 897           <td class="md" valign="top">)&nbsp;</td>
 898           <td class="md" nowrap><code> [virtual]</code></td>
 899         </tr>
 900
 901       </table>
 902     </td>
 903   </tr>
 904 </table>
 905 <table cellspacing=5 cellpadding=0 border=0>
 906   <tr>
 907     <td>
 908       &nbsp;
 909     </td>
 910     <td>
 911
 912 <p>
 913 Called when a user quits.
 914 <p>
 915 The details of the exiting user are available to you in the parameter userrec *user
 916 <p>
 917 Definition at line <a class="el" href="modules_8cpp-source.html#l00142">142</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 918 <p>
 919 <div class="fragment"><pre>00142 { }
 920 </pre></div>    </td>
 921   </tr>
 922 </table>
 923 <a name="a15" doxytag="Module::OnWhois"></a><p>
 924 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 925   <tr>
 926     <td class="md">
 927       <table cellpadding="0" cellspacing="0" border="0">
 928         <tr>
 929           <td class="md" nowrap valign="top"> void Module::OnWhois </td>
 930           <td class="md" valign="top">(&nbsp;</td>
 931           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 932           <td class="mdname" nowrap>&nbsp; <em>source</em>, </td>
 933         </tr>
 934         <tr>
 935           <td></td>
 936           <td></td>
 937           <td class="md" nowrap><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 938           <td class="mdname" nowrap>&nbsp; <em>dest</em></td>
 939         </tr>
 940         <tr>
 941           <td></td>
 942           <td class="md">)&nbsp;</td>
 943           <td class="md" colspan="2"><code> [virtual]</code></td>
 944         </tr>
 945
 946       </table>
 947     </td>
 948   </tr>
 949 </table>
 950 <table cellspacing=5 cellpadding=0 border=0>
 951   <tr>
 952     <td>
 953       &nbsp;
 954     </td>
 955     <td>
 956
 957 <p>
 958 Called whenever a /WHOIS is performed on a local user.
 959 <p>
 960 The source parameter contains the details of the user who issued the WHOIS command, and the dest parameter contains the information of the user they are whoising.
 961 <p>
 962 Definition at line <a class="el" href="modules_8cpp-source.html#l00154">154</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 963 <p>
 964 <div class="fragment"><pre>00154 { };
 965 </pre></div>    </td>
 966   </tr>
 967 </table>
 968 <hr>The documentation for this class was generated from the following files:<ul>
 969 <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>
 970 <hr><address style="align: right;"><small>Generated on Sat May 1 13:39:22 2004 for InspIRCd by
 971 <a href="http://www.doxygen.org/index.html">
 972 <img src="doxygen.png" alt="doxygen" align="middle" border=0
 973 width=110 height=53></a>1.3-rc3 </small></address>
 974 </body>
 975 </html>