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 <tr><td nowrap align=right valign=top>virtual <a class="el" href="modules_8h.html#a23">string_list</a>&nbsp;</td><td valign=bottom><a class="el" href="classModule.html#a20">OnUserSync</a> (<a class="el" href="classuserrec.html">userrec</a> *user)</td></tr>
  66 <tr><td>&nbsp;</td><td><font size=-1><em>Called during a netburst to sync user data.</em> <a href="#a20"></a><em></em></font><br><br></td></tr>
  67 <tr><td nowrap align=right valign=top>virtual <a class="el" href="modules_8h.html#a23">string_list</a>&nbsp;</td><td valign=bottom><a class="el" href="classModule.html#a21">OnChannelSync</a> (<a class="el" href="classchanrec.html">chanrec</a> *chan)</td></tr>
  68 <tr><td>&nbsp;</td><td><font size=-1><em>Called during a netburst to sync channel data.</em> <a href="#a21"></a><em></em></font><br><br></td></tr>
  69 </table>
  70 <hr><a name="_details"></a><h2>Detailed Description</h2>
  71 Base class for all InspIRCd modules This class is the base class for InspIRCd modules.
  72 <p>
  73 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.
  74 <p>
  75
  76 <p>
  77 Definition at line <a class="el" href="modules_8h-source.html#l00116">116</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
  78 <a name="a0" doxytag="Module::Module"></a><p>
  79 <table width="100%" cellpadding="2" cellspacing="0" border="0">
  80   <tr>
  81     <td class="md">
  82       <table cellpadding="0" cellspacing="0" border="0">
  83         <tr>
  84           <td class="md" nowrap valign="top"> Module::Module </td>
  85           <td class="md" valign="top">(&nbsp;</td>
  86           <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
  87           <td class="md" valign="top">)&nbsp;</td>
  88           <td class="md" nowrap></td>
  89         </tr>
  90
  91       </table>
  92     </td>
  93   </tr>
  94 </table>
  95 <table cellspacing=5 cellpadding=0 border=0>
  96   <tr>
  97     <td>
  98       &nbsp;
  99     </td>
 100     <td>
 101
 102 <p>
 103 Default constructor creates a module class.
 104 <p>
 105
 106 <p>
 107 Definition at line <a class="el" href="modules_8cpp-source.html#l00285">285</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 108 <p>
 109 <div class="fragment"><pre>00285 { }
 110 </pre></div>    </td>
 111   </tr>
 112 </table>
 113 <a name="a1" doxytag="Module::~Module"></a><p>
 114 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 115   <tr>
 116     <td class="md">
 117       <table cellpadding="0" cellspacing="0" border="0">
 118         <tr>
 119           <td class="md" nowrap valign="top"> Module::~Module </td>
 120           <td class="md" valign="top">(&nbsp;</td>
 121           <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
 122           <td class="md" valign="top">)&nbsp;</td>
 123           <td class="md" nowrap><code> [virtual]</code></td>
 124         </tr>
 125
 126       </table>
 127     </td>
 128   </tr>
 129 </table>
 130 <table cellspacing=5 cellpadding=0 border=0>
 131   <tr>
 132     <td>
 133       &nbsp;
 134     </td>
 135     <td>
 136
 137 <p>
 138 Default destructor destroys a module class.
 139 <p>
 140
 141 <p>
 142 Definition at line <a class="el" href="modules_8cpp-source.html#l00286">286</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 143 <p>
 144 <div class="fragment"><pre>00286 { }
 145 </pre></div>    </td>
 146   </tr>
 147 </table>
 148 <hr><h2>Member Function Documentation</h2>
 149 <a name="a2" doxytag="Module::GetVersion"></a><p>
 150 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 151   <tr>
 152     <td class="md">
 153       <table cellpadding="0" cellspacing="0" border="0">
 154         <tr>
 155           <td class="md" nowrap valign="top"> <a class="el" href="classVersion.html">Version</a> Module::GetVersion </td>
 156           <td class="md" valign="top">(&nbsp;</td>
 157           <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
 158           <td class="md" valign="top">)&nbsp;</td>
 159           <td class="md" nowrap><code> [virtual]</code></td>
 160         </tr>
 161
 162       </table>
 163     </td>
 164   </tr>
 165 </table>
 166 <table cellspacing=5 cellpadding=0 border=0>
 167   <tr>
 168     <td>
 169       &nbsp;
 170     </td>
 171     <td>
 172
 173 <p>
 174 Returns the version number of a Module.
 175 <p>
 176 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>
 177 <p>
 178 Definition at line <a class="el" href="modules_8cpp-source.html#l00297">297</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 179 <p>
 180 <div class="fragment"><pre>00297 { <span class="keywordflow">return</span> <a class="code" href="classVersion.html">Version</a>(1,0,0,0); }
 181 </pre></div>    </td>
 182   </tr>
 183 </table>
 184 <a name="a19" doxytag="Module::OnAccessCheck"></a><p>
 185 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 186   <tr>
 187     <td class="md">
 188       <table cellpadding="0" cellspacing="0" border="0">
 189         <tr>
 190           <td class="md" nowrap valign="top"> int Module::OnAccessCheck </td>
 191           <td class="md" valign="top">(&nbsp;</td>
 192           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 193           <td class="mdname" nowrap>&nbsp; <em>source</em>, </td>
 194         </tr>
 195         <tr>
 196           <td></td>
 197           <td></td>
 198           <td class="md" nowrap><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 199           <td class="mdname" nowrap>&nbsp; <em>dest</em>, </td>
 200         </tr>
 201         <tr>
 202           <td></td>
 203           <td></td>
 204           <td class="md" nowrap><a class="el" href="classchanrec.html">chanrec</a> *&nbsp;</td>
 205           <td class="mdname" nowrap>&nbsp; <em>channel</em>, </td>
 206         </tr>
 207         <tr>
 208           <td></td>
 209           <td></td>
 210           <td class="md" nowrap>int&nbsp;</td>
 211           <td class="mdname" nowrap>&nbsp; <em>access_type</em></td>
 212         </tr>
 213         <tr>
 214           <td></td>
 215           <td class="md">)&nbsp;</td>
 216           <td class="md" colspan="2"><code> [virtual]</code></td>
 217         </tr>
 218
 219       </table>
 220     </td>
 221   </tr>
 222 </table>
 223 <table cellspacing=5 cellpadding=0 border=0>
 224   <tr>
 225     <td>
 226       &nbsp;
 227     </td>
 228     <td>
 229
 230 <p>
 231 Called before an action which requires a channel privilage check.
 232 <p>
 233 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>
 234 <br>
 235  AC_KICK (0) - A user is being kicked<br>
 236  AC_DEOP (1) - a user is being deopped<br>
 237  AC_OP (2) - a user is being opped<br>
 238  AC_VOICE (3) - a user is being voiced<br>
 239  AC_DEVOICE (4) - a user is being devoiced<br>
 240  AC_HALFOP (5) - a user is being halfopped<br>
 241  AC_DEHALFOP (6) - a user is being dehalfopped<br>
 242  AC_INVITE (7) - a user is being invited<br>
 243  AC_GENERAL_MODE (8) - a user channel mode is being changed<br>
 244 <br>
 245  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).
 246 <p>
 247 Definition at line <a class="el" href="modules_8cpp-source.html#l00304">304</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 248 <p>
 249 References <a class="el" href="modules_8h-source.html#l00027">ACR_DEFAULT</a>.
 250 <p>
 251 <div class="fragment"><pre>00304 { <span class="keywordflow">return</span> <a class="code" href="modules_8h.html#a8">ACR_DEFAULT</a>; };
 252 </pre></div>    </td>
 253   </tr>
 254 </table>
 255 <a name="a21" doxytag="Module::OnChannelSync"></a><p>
 256 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 257   <tr>
 258     <td class="md">
 259       <table cellpadding="0" cellspacing="0" border="0">
 260         <tr>
 261           <td class="md" nowrap valign="top"> <a class="el" href="modules_8h.html#a23">string_list</a> Module::OnChannelSync </td>
 262           <td class="md" valign="top">(&nbsp;</td>
 263           <td class="md" nowrap valign="top"><a class="el" href="classchanrec.html">chanrec</a> *&nbsp;</td>
 264           <td class="mdname1" valign="top" nowrap>&nbsp; <em>chan</em>          </td>
 265           <td class="md" valign="top">)&nbsp;</td>
 266           <td class="md" nowrap><code> [virtual]</code></td>
 267         </tr>
 268
 269       </table>
 270     </td>
 271   </tr>
 272 </table>
 273 <table cellspacing=5 cellpadding=0 border=0>
 274   <tr>
 275     <td>
 276       &nbsp;
 277     </td>
 278     <td>
 279
 280 <p>
 281 Called during a netburst to sync channel data.
 282 <p>
 283 This is called during the netburst on a per-channel basis. You should use this call to up any special channel-related things which are implemented by your module, e.g. sending listmodes. You may return multiple commands in the string_list.
 284 <p>
 285 Definition at line <a class="el" href="modules_8cpp-source.html#l00306">306</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 286 <p>
 287 References <a class="el" href="modules_8h-source.html#l00051">string_list</a>.
 288 <p>
 289 <div class="fragment"><pre>00306 { <a class="code" href="modules_8h.html#a23">string_list</a> empty; <span class="keywordflow">return</span> empty; }
 290 </pre></div>    </td>
 291   </tr>
 292 </table>
 293 <a name="a11" doxytag="Module::OnExtendedMode"></a><p>
 294 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 295   <tr>
 296     <td class="md">
 297       <table cellpadding="0" cellspacing="0" border="0">
 298         <tr>
 299           <td class="md" nowrap valign="top"> int Module::OnExtendedMode </td>
 300           <td class="md" valign="top">(&nbsp;</td>
 301           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 302           <td class="mdname" nowrap>&nbsp; <em>user</em>, </td>
 303         </tr>
 304         <tr>
 305           <td></td>
 306           <td></td>
 307           <td class="md" nowrap>void *&nbsp;</td>
 308           <td class="mdname" nowrap>&nbsp; <em>target</em>, </td>
 309         </tr>
 310         <tr>
 311           <td></td>
 312           <td></td>
 313           <td class="md" nowrap>char&nbsp;</td>
 314           <td class="mdname" nowrap>&nbsp; <em>modechar</em>, </td>
 315         </tr>
 316         <tr>
 317           <td></td>
 318           <td></td>
 319           <td class="md" nowrap>int&nbsp;</td>
 320           <td class="mdname" nowrap>&nbsp; <em>type</em>, </td>
 321         </tr>
 322         <tr>
 323           <td></td>
 324           <td></td>
 325           <td class="md" nowrap>bool&nbsp;</td>
 326           <td class="mdname" nowrap>&nbsp; <em>mode_on</em>, </td>
 327         </tr>
 328         <tr>
 329           <td></td>
 330           <td></td>
 331           <td class="md" nowrap><a class="el" href="modules_8h.html#a23">string_list</a> &amp;&nbsp;</td>
 332           <td class="mdname" nowrap>&nbsp; <em>params</em></td>
 333         </tr>
 334         <tr>
 335           <td></td>
 336           <td class="md">)&nbsp;</td>
 337           <td class="md" colspan="2"><code> [virtual]</code></td>
 338         </tr>
 339
 340       </table>
 341     </td>
 342   </tr>
 343 </table>
 344 <table cellspacing=5 cellpadding=0 border=0>
 345   <tr>
 346     <td>
 347       &nbsp;
 348     </td>
 349     <td>
 350
 351 <p>
 352 Called whenever an extended mode is to be processed.
 353 <p>
 354 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.
 355 <p>
 356 Definition at line <a class="el" href="modules_8cpp-source.html#l00296">296</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 357 <p>
 358 <div class="fragment"><pre>00296 { <span class="keywordflow">return</span> <span class="keyword">false</span>; }
 359 </pre></div>    </td>
 360   </tr>
 361 </table>
 362 <a name="a14" doxytag="Module::OnInfo"></a><p>
 363 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 364   <tr>
 365     <td class="md">
 366       <table cellpadding="0" cellspacing="0" border="0">
 367         <tr>
 368           <td class="md" nowrap valign="top"> void Module::OnInfo </td>
 369           <td class="md" valign="top">(&nbsp;</td>
 370           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 371           <td class="mdname1" valign="top" nowrap>&nbsp; <em>user</em>          </td>
 372           <td class="md" valign="top">)&nbsp;</td>
 373           <td class="md" nowrap><code> [virtual]</code></td>
 374         </tr>
 375
 376       </table>
 377     </td>
 378   </tr>
 379 </table>
 380 <table cellspacing=5 cellpadding=0 border=0>
 381   <tr>
 382     <td>
 383       &nbsp;
 384     </td>
 385     <td>
 386
 387 <p>
 388 Called whenever a user types /INFO.
 389 <p>
 390 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>
 391 :information here
 392 <p>
 393 Definition at line <a class="el" href="modules_8cpp-source.html#l00299">299</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 394 <p>
 395 <div class="fragment"><pre>00299 { };
 396 </pre></div>    </td>
 397   </tr>
 398 </table>
 399 <a name="a13" doxytag="Module::OnOper"></a><p>
 400 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 401   <tr>
 402     <td class="md">
 403       <table cellpadding="0" cellspacing="0" border="0">
 404         <tr>
 405           <td class="md" nowrap valign="top"> void Module::OnOper </td>
 406           <td class="md" valign="top">(&nbsp;</td>
 407           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 408           <td class="mdname1" valign="top" nowrap>&nbsp; <em>user</em>          </td>
 409           <td class="md" valign="top">)&nbsp;</td>
 410           <td class="md" nowrap><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 whenever a user opers locally.
 426 <p>
 427 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.
 428 <p>
 429 Definition at line <a class="el" href="modules_8cpp-source.html#l00298">298</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 430 <p>
 431 <div class="fragment"><pre>00298 { };
 432 </pre></div>    </td>
 433   </tr>
 434 </table>
 435 <a name="a8" doxytag="Module::OnPacketReceive"></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::OnPacketReceive </td>
 442           <td class="md" valign="top">(&nbsp;</td>
 443           <td class="md" nowrap valign="top">char *&nbsp;</td>
 444           <td class="mdname1" valign="top" nowrap>&nbsp; <em>p</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 after a packet is received from another irc server.
 462 <p>
 463 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.
 464 <p>
 465 Definition at line <a class="el" href="modules_8cpp-source.html#l00292">292</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 466 <p>
 467 <div class="fragment"><pre>00292 { }
 468 </pre></div>    </td>
 469   </tr>
 470 </table>
 471 <a name="a7" doxytag="Module::OnPacketTransmit"></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::OnPacketTransmit </td>
 478           <td class="md" valign="top">(&nbsp;</td>
 479           <td class="md" nowrap valign="top">char *&nbsp;</td>
 480           <td class="mdname1" valign="top" nowrap>&nbsp; <em>p</em>          </td>
 481           <td class="md" valign="top">)&nbsp;</td>
 482           <td class="md" nowrap><code> [virtual]</code></td>
 483         </tr>
 484
 485       </table>
 486     </td>
 487   </tr>
 488 </table>
 489 <table cellspacing=5 cellpadding=0 border=0>
 490   <tr>
 491     <td>
 492       &nbsp;
 493     </td>
 494     <td>
 495
 496 <p>
 497 Called before a packet is transmitted across the irc network between two irc servers.
 498 <p>
 499 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.
 500 <p>
 501 Definition at line <a class="el" href="modules_8cpp-source.html#l00291">291</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 502 <p>
 503 <div class="fragment"><pre>00291 { }
 504 </pre></div>    </td>
 505   </tr>
 506 </table>
 507 <a name="a9" doxytag="Module::OnRehash"></a><p>
 508 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 509   <tr>
 510     <td class="md">
 511       <table cellpadding="0" cellspacing="0" border="0">
 512         <tr>
 513           <td class="md" nowrap valign="top"> void Module::OnRehash </td>
 514           <td class="md" valign="top">(&nbsp;</td>
 515           <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
 516           <td class="md" valign="top">)&nbsp;</td>
 517           <td class="md" nowrap><code> [virtual]</code></td>
 518         </tr>
 519
 520       </table>
 521     </td>
 522   </tr>
 523 </table>
 524 <table cellspacing=5 cellpadding=0 border=0>
 525   <tr>
 526     <td>
 527       &nbsp;
 528     </td>
 529     <td>
 530
 531 <p>
 532 Called on rehash.
 533 <p>
 534 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.
 535 <p>
 536 Definition at line <a class="el" href="modules_8cpp-source.html#l00293">293</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 537 <p>
 538 <div class="fragment"><pre>00293 { }
 539 </pre></div>    </td>
 540   </tr>
 541 </table>
 542 <a name="a10" doxytag="Module::OnServerRaw"></a><p>
 543 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 544   <tr>
 545     <td class="md">
 546       <table cellpadding="0" cellspacing="0" border="0">
 547         <tr>
 548           <td class="md" nowrap valign="top"> void Module::OnServerRaw </td>
 549           <td class="md" valign="top">(&nbsp;</td>
 550           <td class="md" nowrap valign="top">std::string &amp;&nbsp;</td>
 551           <td class="mdname" nowrap>&nbsp; <em>raw</em>, </td>
 552         </tr>
 553         <tr>
 554           <td></td>
 555           <td></td>
 556           <td class="md" nowrap>bool&nbsp;</td>
 557           <td class="mdname" nowrap>&nbsp; <em>inbound</em>, </td>
 558         </tr>
 559         <tr>
 560           <td></td>
 561           <td></td>
 562           <td class="md" nowrap><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 563           <td class="mdname" nowrap>&nbsp; <em>user</em></td>
 564         </tr>
 565         <tr>
 566           <td></td>
 567           <td class="md">)&nbsp;</td>
 568           <td class="md" colspan="2"><code> [virtual]</code></td>
 569         </tr>
 570
 571       </table>
 572     </td>
 573   </tr>
 574 </table>
 575 <table cellspacing=5 cellpadding=0 border=0>
 576   <tr>
 577     <td>
 578       &nbsp;
 579     </td>
 580     <td>
 581
 582 <p>
 583 Called when a raw command is transmitted or received.
 584 <p>
 585 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.
 586 <p>
 587 Definition at line <a class="el" href="modules_8cpp-source.html#l00294">294</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 588 <p>
 589 <div class="fragment"><pre>00294 { }
 590 </pre></div>    </td>
 591   </tr>
 592 </table>
 593 <a name="a3" doxytag="Module::OnUserConnect"></a><p>
 594 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 595   <tr>
 596     <td class="md">
 597       <table cellpadding="0" cellspacing="0" border="0">
 598         <tr>
 599           <td class="md" nowrap valign="top"> void Module::OnUserConnect </td>
 600           <td class="md" valign="top">(&nbsp;</td>
 601           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 602           <td class="mdname1" valign="top" nowrap>&nbsp; <em>user</em>          </td>
 603           <td class="md" valign="top">)&nbsp;</td>
 604           <td class="md" nowrap><code> [virtual]</code></td>
 605         </tr>
 606
 607       </table>
 608     </td>
 609   </tr>
 610 </table>
 611 <table cellspacing=5 cellpadding=0 border=0>
 612   <tr>
 613     <td>
 614       &nbsp;
 615     </td>
 616     <td>
 617
 618 <p>
 619 Called when a user connects.
 620 <p>
 621 The details of the connecting user are available to you in the parameter userrec *user
 622 <p>
 623 Definition at line <a class="el" href="modules_8cpp-source.html#l00287">287</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 624 <p>
 625 <div class="fragment"><pre>00287 { }
 626 </pre></div>    </td>
 627   </tr>
 628 </table>
 629 <a name="a5" doxytag="Module::OnUserJoin"></a><p>
 630 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 631   <tr>
 632     <td class="md">
 633       <table cellpadding="0" cellspacing="0" border="0">
 634         <tr>
 635           <td class="md" nowrap valign="top"> void Module::OnUserJoin </td>
 636           <td class="md" valign="top">(&nbsp;</td>
 637           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 638           <td class="mdname" nowrap>&nbsp; <em>user</em>, </td>
 639         </tr>
 640         <tr>
 641           <td></td>
 642           <td></td>
 643           <td class="md" nowrap><a class="el" href="classchanrec.html">chanrec</a> *&nbsp;</td>
 644           <td class="mdname" nowrap>&nbsp; <em>channel</em></td>
 645         </tr>
 646         <tr>
 647           <td></td>
 648           <td class="md">)&nbsp;</td>
 649           <td class="md" colspan="2"><code> [virtual]</code></td>
 650         </tr>
 651
 652       </table>
 653     </td>
 654   </tr>
 655 </table>
 656 <table cellspacing=5 cellpadding=0 border=0>
 657   <tr>
 658     <td>
 659       &nbsp;
 660     </td>
 661     <td>
 662
 663 <p>
 664 Called when a user joins a channel.
 665 <p>
 666 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
 667 <p>
 668 Definition at line <a class="el" href="modules_8cpp-source.html#l00289">289</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 669 <p>
 670 <div class="fragment"><pre>00289 { }
 671 </pre></div>    </td>
 672   </tr>
 673 </table>
 674 <a name="a6" doxytag="Module::OnUserPart"></a><p>
 675 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 676   <tr>
 677     <td class="md">
 678       <table cellpadding="0" cellspacing="0" border="0">
 679         <tr>
 680           <td class="md" nowrap valign="top"> void Module::OnUserPart </td>
 681           <td class="md" valign="top">(&nbsp;</td>
 682           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 683           <td class="mdname" nowrap>&nbsp; <em>user</em>, </td>
 684         </tr>
 685         <tr>
 686           <td></td>
 687           <td></td>
 688           <td class="md" nowrap><a class="el" href="classchanrec.html">chanrec</a> *&nbsp;</td>
 689           <td class="mdname" nowrap>&nbsp; <em>channel</em></td>
 690         </tr>
 691         <tr>
 692           <td></td>
 693           <td class="md">)&nbsp;</td>
 694           <td class="md" colspan="2"><code> [virtual]</code></td>
 695         </tr>
 696
 697       </table>
 698     </td>
 699   </tr>
 700 </table>
 701 <table cellspacing=5 cellpadding=0 border=0>
 702   <tr>
 703     <td>
 704       &nbsp;
 705     </td>
 706     <td>
 707
 708 <p>
 709 Called when a user parts a channel.
 710 <p>
 711 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
 712 <p>
 713 Definition at line <a class="el" href="modules_8cpp-source.html#l00290">290</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 714 <p>
 715 <div class="fragment"><pre>00290 { }
 716 </pre></div>    </td>
 717   </tr>
 718 </table>
 719 <a name="a12" doxytag="Module::OnUserPreJoin"></a><p>
 720 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 721   <tr>
 722     <td class="md">
 723       <table cellpadding="0" cellspacing="0" border="0">
 724         <tr>
 725           <td class="md" nowrap valign="top"> int Module::OnUserPreJoin </td>
 726           <td class="md" valign="top">(&nbsp;</td>
 727           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 728           <td class="mdname" nowrap>&nbsp; <em>user</em>, </td>
 729         </tr>
 730         <tr>
 731           <td></td>
 732           <td></td>
 733           <td class="md" nowrap><a class="el" href="classchanrec.html">chanrec</a> *&nbsp;</td>
 734           <td class="mdname" nowrap>&nbsp; <em>chan</em>, </td>
 735         </tr>
 736         <tr>
 737           <td></td>
 738           <td></td>
 739           <td class="md" nowrap>const char *&nbsp;</td>
 740           <td class="mdname" nowrap>&nbsp; <em>cname</em></td>
 741         </tr>
 742         <tr>
 743           <td></td>
 744           <td class="md">)&nbsp;</td>
 745           <td class="md" colspan="2"><code> [virtual]</code></td>
 746         </tr>
 747
 748       </table>
 749     </td>
 750   </tr>
 751 </table>
 752 <table cellspacing=5 cellpadding=0 border=0>
 753   <tr>
 754     <td>
 755       &nbsp;
 756     </td>
 757     <td>
 758
 759 <p>
 760 Called whenever a user is about to join a channel, before any processing is done.
 761 <p>
 762 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>
 763 IMPORTANT NOTE!<p>
 764 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.
 765 <p>
 766 Definition at line <a class="el" href="modules_8cpp-source.html#l00295">295</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 767 <p>
 768 <div class="fragment"><pre>00295 { <span class="keywordflow">return</span> 0; }
 769 </pre></div>    </td>
 770   </tr>
 771 </table>
 772 <a name="a16" doxytag="Module::OnUserPreMessage"></a><p>
 773 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 774   <tr>
 775     <td class="md">
 776       <table cellpadding="0" cellspacing="0" border="0">
 777         <tr>
 778           <td class="md" nowrap valign="top"> int Module::OnUserPreMessage </td>
 779           <td class="md" valign="top">(&nbsp;</td>
 780           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 781           <td class="mdname" nowrap>&nbsp; <em>user</em>, </td>
 782         </tr>
 783         <tr>
 784           <td></td>
 785           <td></td>
 786           <td class="md" nowrap>void *&nbsp;</td>
 787           <td class="mdname" nowrap>&nbsp; <em>dest</em>, </td>
 788         </tr>
 789         <tr>
 790           <td></td>
 791           <td></td>
 792           <td class="md" nowrap>int&nbsp;</td>
 793           <td class="mdname" nowrap>&nbsp; <em>target_type</em>, </td>
 794         </tr>
 795         <tr>
 796           <td></td>
 797           <td></td>
 798           <td class="md" nowrap>std::string&nbsp;</td>
 799           <td class="mdname" nowrap>&nbsp; <em>text</em></td>
 800         </tr>
 801         <tr>
 802           <td></td>
 803           <td class="md">)&nbsp;</td>
 804           <td class="md" colspan="2"><code> [virtual]</code></td>
 805         </tr>
 806
 807       </table>
 808     </td>
 809   </tr>
 810 </table>
 811 <table cellspacing=5 cellpadding=0 border=0>
 812   <tr>
 813     <td>
 814       &nbsp;
 815     </td>
 816     <td>
 817
 818 <p>
 819 Called whenever a user is about to PRIVMSG A user or a channel, before any processing is done.
 820 <p>
 821 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.
 822 <p>
 823 Definition at line <a class="el" href="modules_8cpp-source.html#l00301">301</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 824 <p>
 825 <div class="fragment"><pre>00301 { <span class="keywordflow">return</span> 0; };
 826 </pre></div>    </td>
 827   </tr>
 828 </table>
 829 <a name="a18" doxytag="Module::OnUserPreNick"></a><p>
 830 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 831   <tr>
 832     <td class="md">
 833       <table cellpadding="0" cellspacing="0" border="0">
 834         <tr>
 835           <td class="md" nowrap valign="top"> int Module::OnUserPreNick </td>
 836           <td class="md" valign="top">(&nbsp;</td>
 837           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 838           <td class="mdname" nowrap>&nbsp; <em>user</em>, </td>
 839         </tr>
 840         <tr>
 841           <td></td>
 842           <td></td>
 843           <td class="md" nowrap>std::string&nbsp;</td>
 844           <td class="mdname" nowrap>&nbsp; <em>newnick</em></td>
 845         </tr>
 846         <tr>
 847           <td></td>
 848           <td class="md">)&nbsp;</td>
 849           <td class="md" colspan="2"><code> [virtual]</code></td>
 850         </tr>
 851
 852       </table>
 853     </td>
 854   </tr>
 855 </table>
 856 <table cellspacing=5 cellpadding=0 border=0>
 857   <tr>
 858     <td>
 859       &nbsp;
 860     </td>
 861     <td>
 862
 863 <p>
 864 Called before any nickchange, local or remote.
 865 <p>
 866 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.
 867 <p>
 868 Definition at line <a class="el" href="modules_8cpp-source.html#l00303">303</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 869 <p>
 870 <div class="fragment"><pre>00303 { <span class="keywordflow">return</span> 0; };
 871 </pre></div>    </td>
 872   </tr>
 873 </table>
 874 <a name="a17" doxytag="Module::OnUserPreNotice"></a><p>
 875 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 876   <tr>
 877     <td class="md">
 878       <table cellpadding="0" cellspacing="0" border="0">
 879         <tr>
 880           <td class="md" nowrap valign="top"> int Module::OnUserPreNotice </td>
 881           <td class="md" valign="top">(&nbsp;</td>
 882           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 883           <td class="mdname" nowrap>&nbsp; <em>user</em>, </td>
 884         </tr>
 885         <tr>
 886           <td></td>
 887           <td></td>
 888           <td class="md" nowrap>void *&nbsp;</td>
 889           <td class="mdname" nowrap>&nbsp; <em>dest</em>, </td>
 890         </tr>
 891         <tr>
 892           <td></td>
 893           <td></td>
 894           <td class="md" nowrap>int&nbsp;</td>
 895           <td class="mdname" nowrap>&nbsp; <em>target_type</em>, </td>
 896         </tr>
 897         <tr>
 898           <td></td>
 899           <td></td>
 900           <td class="md" nowrap>std::string&nbsp;</td>
 901           <td class="mdname" nowrap>&nbsp; <em>text</em></td>
 902         </tr>
 903         <tr>
 904           <td></td>
 905           <td class="md">)&nbsp;</td>
 906           <td class="md" colspan="2"><code> [virtual]</code></td>
 907         </tr>
 908
 909       </table>
 910     </td>
 911   </tr>
 912 </table>
 913 <table cellspacing=5 cellpadding=0 border=0>
 914   <tr>
 915     <td>
 916       &nbsp;
 917     </td>
 918     <td>
 919
 920 <p>
 921 Called whenever a user is about to NOTICE A user or a channel, before any processing is done.
 922 <p>
 923 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.
 924 <p>
 925 Definition at line <a class="el" href="modules_8cpp-source.html#l00302">302</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 926 <p>
 927 <div class="fragment"><pre>00302 { <span class="keywordflow">return</span> 0; };
 928 </pre></div>    </td>
 929   </tr>
 930 </table>
 931 <a name="a4" doxytag="Module::OnUserQuit"></a><p>
 932 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 933   <tr>
 934     <td class="md">
 935       <table cellpadding="0" cellspacing="0" border="0">
 936         <tr>
 937           <td class="md" nowrap valign="top"> void Module::OnUserQuit </td>
 938           <td class="md" valign="top">(&nbsp;</td>
 939           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 940           <td class="mdname1" valign="top" nowrap>&nbsp; <em>user</em>          </td>
 941           <td class="md" valign="top">)&nbsp;</td>
 942           <td class="md" nowrap><code> [virtual]</code></td>
 943         </tr>
 944
 945       </table>
 946     </td>
 947   </tr>
 948 </table>
 949 <table cellspacing=5 cellpadding=0 border=0>
 950   <tr>
 951     <td>
 952       &nbsp;
 953     </td>
 954     <td>
 955
 956 <p>
 957 Called when a user quits.
 958 <p>
 959 The details of the exiting user are available to you in the parameter userrec *user
 960 <p>
 961 Definition at line <a class="el" href="modules_8cpp-source.html#l00288">288</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 962 <p>
 963 <div class="fragment"><pre>00288 { }
 964 </pre></div>    </td>
 965   </tr>
 966 </table>
 967 <a name="a20" doxytag="Module::OnUserSync"></a><p>
 968 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 969   <tr>
 970     <td class="md">
 971       <table cellpadding="0" cellspacing="0" border="0">
 972         <tr>
 973           <td class="md" nowrap valign="top"> <a class="el" href="modules_8h.html#a23">string_list</a> Module::OnUserSync </td>
 974           <td class="md" valign="top">(&nbsp;</td>
 975           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 976           <td class="mdname1" valign="top" nowrap>&nbsp; <em>user</em>          </td>
 977           <td class="md" valign="top">)&nbsp;</td>
 978           <td class="md" nowrap><code> [virtual]</code></td>
 979         </tr>
 980
 981       </table>
 982     </td>
 983   </tr>
 984 </table>
 985 <table cellspacing=5 cellpadding=0 border=0>
 986   <tr>
 987     <td>
 988       &nbsp;
 989     </td>
 990     <td>
 991
 992 <p>
 993 Called during a netburst to sync user data.
 994 <p>
 995 This is called during the netburst on a per-user basis. You should use this call to up any special user-related things which are implemented by your module, e.g. sending listmodes. You may return multiple commands in the string_list.
 996 <p>
 997 Definition at line <a class="el" href="modules_8cpp-source.html#l00305">305</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 998 <p>
 999 References <a class="el" href="modules_8h-source.html#l00051">string_list</a>.
1000 <p>
1001 <div class="fragment"><pre>00305 { <a class="code" href="modules_8h.html#a23">string_list</a> empty; <span class="keywordflow">return</span> empty; }
1002 </pre></div>    </td>
1003   </tr>
1004 </table>
1005 <a name="a15" doxytag="Module::OnWhois"></a><p>
1006 <table width="100%" cellpadding="2" cellspacing="0" border="0">
1007   <tr>
1008     <td class="md">
1009       <table cellpadding="0" cellspacing="0" border="0">
1010         <tr>
1011           <td class="md" nowrap valign="top"> void Module::OnWhois </td>
1012           <td class="md" valign="top">(&nbsp;</td>
1013           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
1014           <td class="mdname" nowrap>&nbsp; <em>source</em>, </td>
1015         </tr>
1016         <tr>
1017           <td></td>
1018           <td></td>
1019           <td class="md" nowrap><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
1020           <td class="mdname" nowrap>&nbsp; <em>dest</em></td>
1021         </tr>
1022         <tr>
1023           <td></td>
1024           <td class="md">)&nbsp;</td>
1025           <td class="md" colspan="2"><code> [virtual]</code></td>
1026         </tr>
1027
1028       </table>
1029     </td>
1030   </tr>
1031 </table>
1032 <table cellspacing=5 cellpadding=0 border=0>
1033   <tr>
1034     <td>
1035       &nbsp;
1036     </td>
1037     <td>
1038
1039 <p>
1040 Called whenever a /WHOIS is performed on a local user.
1041 <p>
1042 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.
1043 <p>
1044 Definition at line <a class="el" href="modules_8cpp-source.html#l00300">300</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1045 <p>
1046 <div class="fragment"><pre>00300 { };
1047 </pre></div>    </td>
1048   </tr>
1049 </table>
1050 <hr>The documentation for this class was generated from the following files:<ul>
1051 <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>
1052 <hr><address style="align: right;"><small>Generated on Sat May 1 17:50:31 2004 for InspIRCd by
1053 <a href="http://www.doxygen.org/index.html">
1054 <img src="doxygen.png" alt="doxygen" align="middle" border=0
1055 width=110 height=53></a>1.3-rc3 </small></address>
1056 </body>
1057 </html>