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>InspIRCd: Module class Reference</title>
   4 <link href="inspircd.css" rel="stylesheet" type="text/css">
   5 </head><body>
   6 <!-- Generated by Doxygen 1.3.3 -->
   7 <div class="qindex"><a class="qindex" href="main.html">Main&nbsp;Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class&nbsp;Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical&nbsp;List</a> | <a class="qindex" href="annotated.html">Compound&nbsp;List</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="functions.html">Compound&nbsp;Members</a> | <a class="qindex" href="globals.html">File&nbsp;Members</a></div>
   8 <h1>Module Class Reference</h1>Base class for all InspIRCd modules This class is the base class for InspIRCd modules.
   9 <a href="#_details">More...</a>
  10 <p>
  11 <code>#include &lt;<a class="el" href="modules_8h-source.html">modules.h</a>&gt;</code>
  12 <p>
  13 Inherits <a class="el" href="classclassbase.html">classbase</a>.
  14 <p>
  15 <a href="classModule-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
  16 <tr><td></td></tr>
  17 <tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
  18 <tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a0">Module</a> ()</td></tr>
  19
  20 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor creates a module class. </em> <a href="#a0"></a><em><br><br></td></tr>
  21 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a1">~Module</a> ()</td></tr>
  22
  23 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default destructor destroys a module class. </em> <a href="#a1"></a><em><br><br></td></tr>
  24 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="classVersion.html">Version</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a2">GetVersion</a> ()</td></tr>
  25
  26 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the version number of a Module. </em> <a href="#a2"></a><em><br><br></td></tr>
  27 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a3">OnUserConnect</a> (<a class="el" href="classuserrec.html">userrec</a> *user)</td></tr>
  28
  29 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called when a user connects. </em> <a href="#a3"></a><em><br><br></td></tr>
  30 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a4">OnUserQuit</a> (<a class="el" href="classuserrec.html">userrec</a> *user)</td></tr>
  31
  32 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called when a user quits. </em> <a href="#a4"></a><em><br><br></td></tr>
  33 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" 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>
  34
  35 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called when a user joins a channel. </em> <a href="#a5"></a><em><br><br></td></tr>
  36 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" 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>
  37
  38 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called when a user parts a channel. </em> <a href="#a6"></a><em><br><br></td></tr>
  39 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a7">OnPacketTransmit</a> (std::string &amp;data, std::string serv)</td></tr>
  40
  41 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called before a packet is transmitted across the irc network between two irc servers. </em> <a href="#a7"></a><em><br><br></td></tr>
  42 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a8">OnPacketReceive</a> (std::string &amp;data, std::string serv)</td></tr>
  43
  44 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called after a packet is received from another irc server. </em> <a href="#a8"></a><em><br><br></td></tr>
  45 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a9">OnRehash</a> ()</td></tr>
  46
  47 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called on rehash. </em> <a href="#a9"></a><em><br><br></td></tr>
  48 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" 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>
  49
  50 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called when a raw command is transmitted or received. </em> <a href="#a10"></a><em><br><br></td></tr>
  51 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual int&nbsp;</td><td class="memItemRight" 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#a32">string_list</a> &amp;params)</td></tr>
  52
  53 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called whenever an extended mode is to be processed. </em> <a href="#a11"></a><em><br><br></td></tr>
  54 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual int&nbsp;</td><td class="memItemRight" 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>
  55
  56 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called whenever a user is about to join a channel, before any processing is done. </em> <a href="#a12"></a><em><br><br></td></tr>
  57 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a13">OnOper</a> (<a class="el" href="classuserrec.html">userrec</a> *user)</td></tr>
  58
  59 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called whenever a user opers locally. </em> <a href="#a13"></a><em><br><br></td></tr>
  60 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a14">OnInfo</a> (<a class="el" href="classuserrec.html">userrec</a> *user)</td></tr>
  61
  62 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called whenever a user types /INFO. </em> <a href="#a14"></a><em><br><br></td></tr>
  63 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" 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>
  64
  65 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called whenever a /WHOIS is performed on a local user. </em> <a href="#a15"></a><em><br><br></td></tr>
  66 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual int&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a16">OnUserPreInvite</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)</td></tr>
  67
  68 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called whenever a user is about to invite another user into a channel, before any processing is done. </em> <a href="#a16"></a><em><br><br></td></tr>
  69 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual int&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a17">OnUserPreMessage</a> (<a class="el" href="classuserrec.html">userrec</a> *user, void *dest, int target_type, std::string &amp;text)</td></tr>
  70
  71 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called whenever a user is about to PRIVMSG A user or a channel, before any processing is done. </em> <a href="#a17"></a><em><br><br></td></tr>
  72 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual int&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a18">OnUserPreNotice</a> (<a class="el" href="classuserrec.html">userrec</a> *user, void *dest, int target_type, std::string &amp;text)</td></tr>
  73
  74 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called whenever a user is about to NOTICE A user or a channel, before any processing is done. </em> <a href="#a18"></a><em><br><br></td></tr>
  75 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual int&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a19">OnUserPreNick</a> (<a class="el" href="classuserrec.html">userrec</a> *user, std::string newnick)</td></tr>
  76
  77 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called before any nickchange, local or remote. </em> <a href="#a19"></a><em><br><br></td></tr>
  78 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a20">OnUserPostNick</a> (<a class="el" href="classuserrec.html">userrec</a> *user, std::string oldnick)</td></tr>
  79
  80 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called after any nickchange, local or remote. </em> <a href="#a20"></a><em><br><br></td></tr>
  81 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual int&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a21">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>
  82
  83 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called before an action which requires a channel privilage check. </em> <a href="#a21"></a><em><br><br></td></tr>
  84 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="modules_8h.html#a32">string_list</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a22">OnUserSync</a> (<a class="el" href="classuserrec.html">userrec</a> *user)</td></tr>
  85
  86 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called during a netburst to sync user data. </em> <a href="#a22"></a><em><br><br></td></tr>
  87 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="modules_8h.html#a32">string_list</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a23">OnChannelSync</a> (<a class="el" href="classchanrec.html">chanrec</a> *chan)</td></tr>
  88
  89 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called during a netburst to sync channel data. </em> <a href="#a23"></a><em><br><br></td></tr>
  90 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a24">On005Numeric</a> (std::string &amp;output)</td></tr>
  91
  92 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called when a 005 numeric is about to be output. </em> <a href="#a24"></a><em><br><br></td></tr>
  93 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual int&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a25">OnKill</a> (<a class="el" href="classuserrec.html">userrec</a> *source, <a class="el" href="classuserrec.html">userrec</a> *dest, std::string reason)</td></tr>
  94
  95 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called when a client is disconnected by KILL. </em> <a href="#a25"></a><em><br><br></td></tr>
  96 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a26">OnLoadModule</a> (<a class="el" href="classModule.html">Module</a> *mod, std::string name)</td></tr>
  97
  98 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called whenever a module is loaded. </em> <a href="#a26"></a><em><br><br></td></tr>
  99 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a27">OnBackgroundTimer</a> (time_t curtime)</td></tr>
 100
 101 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called once every five seconds for background processing. </em> <a href="#a27"></a><em><br><br></td></tr>
 102 </table>
 103 <hr><a name="_details"></a><h2>Detailed Description</h2>
 104 Base class for all InspIRCd modules This class is the base class for InspIRCd modules.
 105 <p>
 106 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.
 107 <p>
 108
 109 <p>
 110 Definition at line <a class="el" href="modules_8h-source.html#l00135">135</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
 111 <a name="a0" doxytag="Module::Module"></a><p>
 112 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 113   <tr>
 114     <td class="mdRow">
 115       <table cellpadding="0" cellspacing="0" border="0">
 116         <tr>
 117           <td class="md" nowrap valign="top"> Module::Module </td>
 118           <td class="md" valign="top">(&nbsp;</td>
 119           <td class="mdname1" valign="top" nowrap>          </td>
 120           <td class="md" valign="top">&nbsp;)&nbsp;</td>
 121           <td class="md" nowrap></td>
 122         </tr>
 123
 124       </table>
 125     </td>
 126   </tr>
 127 </table>
 128 <table cellspacing=5 cellpadding=0 border=0>
 129   <tr>
 130     <td>
 131       &nbsp;
 132     </td>
 133     <td>
 134
 135 <p>
 136 Default constructor creates a module class.
 137 <p>
 138
 139 <p>
 140 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>.
 141 <p>
 142 <div class="fragment"><pre>00306 { }
 143 </pre></div>    </td>
 144   </tr>
 145 </table>
 146 <a name="a1" doxytag="Module::~Module"></a><p>
 147 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 148   <tr>
 149     <td class="mdRow">
 150       <table cellpadding="0" cellspacing="0" border="0">
 151         <tr>
 152           <td class="md" nowrap valign="top"> Module::~<a class="el" href="classModule.html">Module</a> </td>
 153           <td class="md" valign="top">(&nbsp;</td>
 154           <td class="mdname1" valign="top" nowrap>          </td>
 155           <td class="md" valign="top">&nbsp;)&nbsp;</td>
 156           <td class="md" nowrap><code> [virtual]</code></td>
 157         </tr>
 158
 159       </table>
 160     </td>
 161   </tr>
 162 </table>
 163 <table cellspacing=5 cellpadding=0 border=0>
 164   <tr>
 165     <td>
 166       &nbsp;
 167     </td>
 168     <td>
 169
 170 <p>
 171 Default destructor destroys a module class.
 172 <p>
 173
 174 <p>
 175 Definition at line <a class="el" href="modules_8cpp-source.html#l00307">307</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 176 <p>
 177 <div class="fragment"><pre>00307 { }
 178 </pre></div>    </td>
 179   </tr>
 180 </table>
 181 <hr><h2>Member Function Documentation</h2>
 182 <a name="a2" doxytag="Module::GetVersion"></a><p>
 183 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 184   <tr>
 185     <td class="mdRow">
 186       <table cellpadding="0" cellspacing="0" border="0">
 187         <tr>
 188           <td class="md" nowrap valign="top"> <a class="el" href="classVersion.html">Version</a> Module::GetVersion </td>
 189           <td class="md" valign="top">(&nbsp;</td>
 190           <td class="mdname1" valign="top" nowrap>          </td>
 191           <td class="md" valign="top">&nbsp;)&nbsp;</td>
 192           <td class="md" nowrap><code> [virtual]</code></td>
 193         </tr>
 194
 195       </table>
 196     </td>
 197   </tr>
 198 </table>
 199 <table cellspacing=5 cellpadding=0 border=0>
 200   <tr>
 201     <td>
 202       &nbsp;
 203     </td>
 204     <td>
 205
 206 <p>
 207 Returns the version number of a Module.
 208 <p>
 209 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>
 210 <p>
 211 Definition at line <a class="el" href="modules_8cpp-source.html#l00318">318</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 212 <p>
 213 References <a class="el" href="modules_8h-source.html#l00054">VF_VENDOR</a>.
 214 <p>
 215 <div class="fragment"><pre>00318 { <span class="keywordflow">return</span> <a class="code" href="classVersion.html">Version</a>(1,0,0,0,VF_VENDOR); }
 216 </pre></div>    </td>
 217   </tr>
 218 </table>
 219 <a name="a24" doxytag="Module::On005Numeric"></a><p>
 220 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 221   <tr>
 222     <td class="mdRow">
 223       <table cellpadding="0" cellspacing="0" border="0">
 224         <tr>
 225           <td class="md" nowrap valign="top"> void Module::On005Numeric </td>
 226           <td class="md" valign="top">(&nbsp;</td>
 227           <td class="md" nowrap valign="top">std::string &amp;&nbsp;</td>
 228           <td class="mdname1" valign="top" nowrap> <em>output</em>          </td>
 229           <td class="md" valign="top">&nbsp;)&nbsp;</td>
 230           <td class="md" nowrap><code> [virtual]</code></td>
 231         </tr>
 232
 233       </table>
 234     </td>
 235   </tr>
 236 </table>
 237 <table cellspacing=5 cellpadding=0 border=0>
 238   <tr>
 239     <td>
 240       &nbsp;
 241     </td>
 242     <td>
 243
 244 <p>
 245 Called when a 005 numeric is about to be output.
 246 <p>
 247 The module should modify the 005 numeric if needed to indicate its features.
 248 <p>
 249 Definition at line <a class="el" href="modules_8cpp-source.html#l00330">330</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 250 <p>
 251 <div class="fragment"><pre>00330 { };
 252 </pre></div>    </td>
 253   </tr>
 254 </table>
 255 <a name="a21" doxytag="Module::OnAccessCheck"></a><p>
 256 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 257   <tr>
 258     <td class="mdRow">
 259       <table cellpadding="0" cellspacing="0" border="0">
 260         <tr>
 261           <td class="md" nowrap valign="top"> int Module::OnAccessCheck </td>
 262           <td class="md" valign="top">(&nbsp;</td>
 263           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 264           <td class="mdname" nowrap> <em>source</em>, </td>
 265         </tr>
 266         <tr>
 267           <td></td>
 268           <td></td>
 269           <td class="md" nowrap><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 270           <td class="mdname" nowrap> <em>dest</em>, </td>
 271         </tr>
 272         <tr>
 273           <td></td>
 274           <td></td>
 275           <td class="md" nowrap><a class="el" href="classchanrec.html">chanrec</a> *&nbsp;</td>
 276           <td class="mdname" nowrap> <em>channel</em>, </td>
 277         </tr>
 278         <tr>
 279           <td></td>
 280           <td></td>
 281           <td class="md" nowrap>int&nbsp;</td>
 282           <td class="mdname" nowrap> <em>access_type</em></td>
 283         </tr>
 284         <tr>
 285           <td></td>
 286           <td class="md">)&nbsp;</td>
 287           <td class="md" colspan="2"><code> [virtual]</code></td>
 288         </tr>
 289
 290       </table>
 291     </td>
 292   </tr>
 293 </table>
 294 <table cellspacing=5 cellpadding=0 border=0>
 295   <tr>
 296     <td>
 297       &nbsp;
 298     </td>
 299     <td>
 300
 301 <p>
 302 Called before an action which requires a channel privilage check.
 303 <p>
 304 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>
 305 <br>
 306  AC_KICK (0) - A user is being kicked<br>
 307  AC_DEOP (1) - a user is being deopped<br>
 308  AC_OP (2) - a user is being opped<br>
 309  AC_VOICE (3) - a user is being voiced<br>
 310  AC_DEVOICE (4) - a user is being devoiced<br>
 311  AC_HALFOP (5) - a user is being halfopped<br>
 312  AC_DEHALFOP (6) - a user is being dehalfopped<br>
 313  AC_INVITE (7) - a user is being invited<br>
 314  AC_GENERAL_MODE (8) - a user channel mode is being changed<br>
 315 <br>
 316  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).
 317 <p>
 318 Definition at line <a class="el" href="modules_8cpp-source.html#l00327">327</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 319 <p>
 320 References <a class="el" href="modules_8h-source.html#l00037">ACR_DEFAULT</a>.
 321 <p>
 322 <div class="fragment"><pre>00327 { <span class="keywordflow">return</span> <a class="code" href="modules_8h.html#a8">ACR_DEFAULT</a>; };
 323 </pre></div>    </td>
 324   </tr>
 325 </table>
 326 <a name="a27" doxytag="Module::OnBackgroundTimer"></a><p>
 327 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 328   <tr>
 329     <td class="mdRow">
 330       <table cellpadding="0" cellspacing="0" border="0">
 331         <tr>
 332           <td class="md" nowrap valign="top"> void Module::OnBackgroundTimer </td>
 333           <td class="md" valign="top">(&nbsp;</td>
 334           <td class="md" nowrap valign="top">time_t&nbsp;</td>
 335           <td class="mdname1" valign="top" nowrap> <em>curtime</em>          </td>
 336           <td class="md" valign="top">&nbsp;)&nbsp;</td>
 337           <td class="md" nowrap><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 once every five seconds for background processing.
 353 <p>
 354 This timer can be used to control timed features. Its period is not accurate enough to be used as a clock, but it is gauranteed to be called at least once in any five second period, directly from the main loop of the server.
 355 <p>
 356 Definition at line <a class="el" href="modules_8cpp-source.html#l00333">333</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 357 <p>
 358 <div class="fragment"><pre>00333 { };
 359 </pre></div>    </td>
 360   </tr>
 361 </table>
 362 <a name="a23" doxytag="Module::OnChannelSync"></a><p>
 363 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 364   <tr>
 365     <td class="mdRow">
 366       <table cellpadding="0" cellspacing="0" border="0">
 367         <tr>
 368           <td class="md" nowrap valign="top"> <a class="el" href="modules_8h.html#a32">string_list</a> Module::OnChannelSync </td>
 369           <td class="md" valign="top">(&nbsp;</td>
 370           <td class="md" nowrap valign="top"><a class="el" href="classchanrec.html">chanrec</a> *&nbsp;</td>
 371           <td class="mdname1" valign="top" nowrap> <em>chan</em>          </td>
 372           <td class="md" valign="top">&nbsp;)&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 during a netburst to sync channel data.
 389 <p>
 390 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.
 391 <p>
 392 Definition at line <a class="el" href="modules_8cpp-source.html#l00329">329</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 393 <p>
 394 References <a class="el" href="modules_8h-source.html#l00068">string_list</a>.
 395 <p>
 396 <div class="fragment"><pre>00329 { <a class="code" href="modules_8h.html#a32">string_list</a> empty; <span class="keywordflow">return</span> empty; }
 397 </pre></div>    </td>
 398   </tr>
 399 </table>
 400 <a name="a11" doxytag="Module::OnExtendedMode"></a><p>
 401 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 402   <tr>
 403     <td class="mdRow">
 404       <table cellpadding="0" cellspacing="0" border="0">
 405         <tr>
 406           <td class="md" nowrap valign="top"> int Module::OnExtendedMode </td>
 407           <td class="md" valign="top">(&nbsp;</td>
 408           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 409           <td class="mdname" nowrap> <em>user</em>, </td>
 410         </tr>
 411         <tr>
 412           <td></td>
 413           <td></td>
 414           <td class="md" nowrap>void *&nbsp;</td>
 415           <td class="mdname" nowrap> <em>target</em>, </td>
 416         </tr>
 417         <tr>
 418           <td></td>
 419           <td></td>
 420           <td class="md" nowrap>char&nbsp;</td>
 421           <td class="mdname" nowrap> <em>modechar</em>, </td>
 422         </tr>
 423         <tr>
 424           <td></td>
 425           <td></td>
 426           <td class="md" nowrap>int&nbsp;</td>
 427           <td class="mdname" nowrap> <em>type</em>, </td>
 428         </tr>
 429         <tr>
 430           <td></td>
 431           <td></td>
 432           <td class="md" nowrap>bool&nbsp;</td>
 433           <td class="mdname" nowrap> <em>mode_on</em>, </td>
 434         </tr>
 435         <tr>
 436           <td></td>
 437           <td></td>
 438           <td class="md" nowrap><a class="el" href="modules_8h.html#a32">string_list</a> &amp;&nbsp;</td>
 439           <td class="mdname" nowrap> <em>params</em></td>
 440         </tr>
 441         <tr>
 442           <td></td>
 443           <td class="md">)&nbsp;</td>
 444           <td class="md" colspan="2"><code> [virtual]</code></td>
 445         </tr>
 446
 447       </table>
 448     </td>
 449   </tr>
 450 </table>
 451 <table cellspacing=5 cellpadding=0 border=0>
 452   <tr>
 453     <td>
 454       &nbsp;
 455     </td>
 456     <td>
 457
 458 <p>
 459 Called whenever an extended mode is to be processed.
 460 <p>
 461 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.
 462 <p>
 463 Definition at line <a class="el" href="modules_8cpp-source.html#l00317">317</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 464 <p>
 465 <div class="fragment"><pre>00317 { <span class="keywordflow">return</span> <span class="keyword">false</span>; }
 466 </pre></div>    </td>
 467   </tr>
 468 </table>
 469 <a name="a14" doxytag="Module::OnInfo"></a><p>
 470 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 471   <tr>
 472     <td class="mdRow">
 473       <table cellpadding="0" cellspacing="0" border="0">
 474         <tr>
 475           <td class="md" nowrap valign="top"> void Module::OnInfo </td>
 476           <td class="md" valign="top">(&nbsp;</td>
 477           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 478           <td class="mdname1" valign="top" nowrap> <em>user</em>          </td>
 479           <td class="md" valign="top">&nbsp;)&nbsp;</td>
 480           <td class="md" nowrap><code> [virtual]</code></td>
 481         </tr>
 482
 483       </table>
 484     </td>
 485   </tr>
 486 </table>
 487 <table cellspacing=5 cellpadding=0 border=0>
 488   <tr>
 489     <td>
 490       &nbsp;
 491     </td>
 492     <td>
 493
 494 <p>
 495 Called whenever a user types /INFO.
 496 <p>
 497 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>
 498 &lt;nick&gt; :information here
 499 <p>
 500 Definition at line <a class="el" href="modules_8cpp-source.html#l00320">320</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 501 <p>
 502 <div class="fragment"><pre>00320 { };
 503 </pre></div>    </td>
 504   </tr>
 505 </table>
 506 <a name="a25" doxytag="Module::OnKill"></a><p>
 507 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 508   <tr>
 509     <td class="mdRow">
 510       <table cellpadding="0" cellspacing="0" border="0">
 511         <tr>
 512           <td class="md" nowrap valign="top"> int Module::OnKill </td>
 513           <td class="md" valign="top">(&nbsp;</td>
 514           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 515           <td class="mdname" nowrap> <em>source</em>, </td>
 516         </tr>
 517         <tr>
 518           <td></td>
 519           <td></td>
 520           <td class="md" nowrap><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 521           <td class="mdname" nowrap> <em>dest</em>, </td>
 522         </tr>
 523         <tr>
 524           <td></td>
 525           <td></td>
 526           <td class="md" nowrap>std::string&nbsp;</td>
 527           <td class="mdname" nowrap> <em>reason</em></td>
 528         </tr>
 529         <tr>
 530           <td></td>
 531           <td class="md">)&nbsp;</td>
 532           <td class="md" colspan="2"><code> [virtual]</code></td>
 533         </tr>
 534
 535       </table>
 536     </td>
 537   </tr>
 538 </table>
 539 <table cellspacing=5 cellpadding=0 border=0>
 540   <tr>
 541     <td>
 542       &nbsp;
 543     </td>
 544     <td>
 545
 546 <p>
 547 Called when a client is disconnected by KILL.
 548 <p>
 549 If a client is killed by a server, e.g. a nickname collision or protocol error, source is NULL. Return 1 from this function to prevent the kill, and 0 from this function to allow it as normal. If you prevent the kill no output will be sent to the client, it is down to your module to generate this information. NOTE: It is NOT advisable to stop kills which originate from servers. If you do so youre risking race conditions, desyncs and worse!
 550 <p>
 551 Definition at line <a class="el" href="modules_8cpp-source.html#l00331">331</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 552 <p>
 553 <div class="fragment"><pre>00331 { <span class="keywordflow">return</span> 0; };
 554 </pre></div>    </td>
 555   </tr>
 556 </table>
 557 <a name="a26" doxytag="Module::OnLoadModule"></a><p>
 558 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 559   <tr>
 560     <td class="mdRow">
 561       <table cellpadding="0" cellspacing="0" border="0">
 562         <tr>
 563           <td class="md" nowrap valign="top"> void Module::OnLoadModule </td>
 564           <td class="md" valign="top">(&nbsp;</td>
 565           <td class="md" nowrap valign="top"><a class="el" href="classModule.html">Module</a> *&nbsp;</td>
 566           <td class="mdname" nowrap> <em>mod</em>, </td>
 567         </tr>
 568         <tr>
 569           <td></td>
 570           <td></td>
 571           <td class="md" nowrap>std::string&nbsp;</td>
 572           <td class="mdname" nowrap> <em>name</em></td>
 573         </tr>
 574         <tr>
 575           <td></td>
 576           <td class="md">)&nbsp;</td>
 577           <td class="md" colspan="2"><code> [virtual]</code></td>
 578         </tr>
 579
 580       </table>
 581     </td>
 582   </tr>
 583 </table>
 584 <table cellspacing=5 cellpadding=0 border=0>
 585   <tr>
 586     <td>
 587       &nbsp;
 588     </td>
 589     <td>
 590
 591 <p>
 592 Called whenever a module is loaded.
 593 <p>
 594 mod will contain a pointer to the module, and string will contain its name, for example m_widgets.so. This function is primary for dependency checking, your module may decide to enable some extra features if it sees that you have for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly recommended that modules do *NOT* bail if they cannot satisfy dependencies, but instead operate under reduced functionality, unless the dependency is absolutely neccessary (e.g. a module that extends the features of another module).
 595 <p>
 596 Definition at line <a class="el" href="modules_8cpp-source.html#l00332">332</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 597 <p>
 598 <div class="fragment"><pre>00332 { };
 599 </pre></div>    </td>
 600   </tr>
 601 </table>
 602 <a name="a13" doxytag="Module::OnOper"></a><p>
 603 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 604   <tr>
 605     <td class="mdRow">
 606       <table cellpadding="0" cellspacing="0" border="0">
 607         <tr>
 608           <td class="md" nowrap valign="top"> void Module::OnOper </td>
 609           <td class="md" valign="top">(&nbsp;</td>
 610           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 611           <td class="mdname1" valign="top" nowrap> <em>user</em>          </td>
 612           <td class="md" valign="top">&nbsp;)&nbsp;</td>
 613           <td class="md" nowrap><code> [virtual]</code></td>
 614         </tr>
 615
 616       </table>
 617     </td>
 618   </tr>
 619 </table>
 620 <table cellspacing=5 cellpadding=0 border=0>
 621   <tr>
 622     <td>
 623       &nbsp;
 624     </td>
 625     <td>
 626
 627 <p>
 628 Called whenever a user opers locally.
 629 <p>
 630 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.
 631 <p>
 632 Definition at line <a class="el" href="modules_8cpp-source.html#l00319">319</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 633 <p>
 634 <div class="fragment"><pre>00319 { };
 635 </pre></div>    </td>
 636   </tr>
 637 </table>
 638 <a name="a8" doxytag="Module::OnPacketReceive"></a><p>
 639 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 640   <tr>
 641     <td class="mdRow">
 642       <table cellpadding="0" cellspacing="0" border="0">
 643         <tr>
 644           <td class="md" nowrap valign="top"> void Module::OnPacketReceive </td>
 645           <td class="md" valign="top">(&nbsp;</td>
 646           <td class="md" nowrap valign="top">std::string &amp;&nbsp;</td>
 647           <td class="mdname" nowrap> <em>data</em>, </td>
 648         </tr>
 649         <tr>
 650           <td></td>
 651           <td></td>
 652           <td class="md" nowrap>std::string&nbsp;</td>
 653           <td class="mdname" nowrap> <em>serv</em></td>
 654         </tr>
 655         <tr>
 656           <td></td>
 657           <td class="md">)&nbsp;</td>
 658           <td class="md" colspan="2"><code> [virtual]</code></td>
 659         </tr>
 660
 661       </table>
 662     </td>
 663   </tr>
 664 </table>
 665 <table cellspacing=5 cellpadding=0 border=0>
 666   <tr>
 667     <td>
 668       &nbsp;
 669     </td>
 670     <td>
 671
 672 <p>
 673 Called after a packet is received from another irc server.
 674 <p>
 675 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.
 676 <p>
 677 Definition at line <a class="el" href="modules_8cpp-source.html#l00313">313</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 678 <p>
 679 <div class="fragment"><pre>00313 { }
 680 </pre></div>    </td>
 681   </tr>
 682 </table>
 683 <a name="a7" doxytag="Module::OnPacketTransmit"></a><p>
 684 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 685   <tr>
 686     <td class="mdRow">
 687       <table cellpadding="0" cellspacing="0" border="0">
 688         <tr>
 689           <td class="md" nowrap valign="top"> void Module::OnPacketTransmit </td>
 690           <td class="md" valign="top">(&nbsp;</td>
 691           <td class="md" nowrap valign="top">std::string &amp;&nbsp;</td>
 692           <td class="mdname" nowrap> <em>data</em>, </td>
 693         </tr>
 694         <tr>
 695           <td></td>
 696           <td></td>
 697           <td class="md" nowrap>std::string&nbsp;</td>
 698           <td class="mdname" nowrap> <em>serv</em></td>
 699         </tr>
 700         <tr>
 701           <td></td>
 702           <td class="md">)&nbsp;</td>
 703           <td class="md" colspan="2"><code> [virtual]</code></td>
 704         </tr>
 705
 706       </table>
 707     </td>
 708   </tr>
 709 </table>
 710 <table cellspacing=5 cellpadding=0 border=0>
 711   <tr>
 712     <td>
 713       &nbsp;
 714     </td>
 715     <td>
 716
 717 <p>
 718 Called before a packet is transmitted across the irc network between two irc servers.
 719 <p>
 720 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.
 721 <p>
 722 Definition at line <a class="el" href="modules_8cpp-source.html#l00312">312</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 723 <p>
 724 <div class="fragment"><pre>00312 { }
 725 </pre></div>    </td>
 726   </tr>
 727 </table>
 728 <a name="a9" doxytag="Module::OnRehash"></a><p>
 729 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 730   <tr>
 731     <td class="mdRow">
 732       <table cellpadding="0" cellspacing="0" border="0">
 733         <tr>
 734           <td class="md" nowrap valign="top"> void Module::OnRehash </td>
 735           <td class="md" valign="top">(&nbsp;</td>
 736           <td class="mdname1" valign="top" nowrap>          </td>
 737           <td class="md" valign="top">&nbsp;)&nbsp;</td>
 738           <td class="md" nowrap><code> [virtual]</code></td>
 739         </tr>
 740
 741       </table>
 742     </td>
 743   </tr>
 744 </table>
 745 <table cellspacing=5 cellpadding=0 border=0>
 746   <tr>
 747     <td>
 748       &nbsp;
 749     </td>
 750     <td>
 751
 752 <p>
 753 Called on rehash.
 754 <p>
 755 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.
 756 <p>
 757 Definition at line <a class="el" href="modules_8cpp-source.html#l00314">314</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 758 <p>
 759 <div class="fragment"><pre>00314 { }
 760 </pre></div>    </td>
 761   </tr>
 762 </table>
 763 <a name="a10" doxytag="Module::OnServerRaw"></a><p>
 764 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 765   <tr>
 766     <td class="mdRow">
 767       <table cellpadding="0" cellspacing="0" border="0">
 768         <tr>
 769           <td class="md" nowrap valign="top"> void Module::OnServerRaw </td>
 770           <td class="md" valign="top">(&nbsp;</td>
 771           <td class="md" nowrap valign="top">std::string &amp;&nbsp;</td>
 772           <td class="mdname" nowrap> <em>raw</em>, </td>
 773         </tr>
 774         <tr>
 775           <td></td>
 776           <td></td>
 777           <td class="md" nowrap>bool&nbsp;</td>
 778           <td class="mdname" nowrap> <em>inbound</em>, </td>
 779         </tr>
 780         <tr>
 781           <td></td>
 782           <td></td>
 783           <td class="md" nowrap><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 784           <td class="mdname" nowrap> <em>user</em></td>
 785         </tr>
 786         <tr>
 787           <td></td>
 788           <td class="md">)&nbsp;</td>
 789           <td class="md" colspan="2"><code> [virtual]</code></td>
 790         </tr>
 791
 792       </table>
 793     </td>
 794   </tr>
 795 </table>
 796 <table cellspacing=5 cellpadding=0 border=0>
 797   <tr>
 798     <td>
 799       &nbsp;
 800     </td>
 801     <td>
 802
 803 <p>
 804 Called when a raw command is transmitted or received.
 805 <p>
 806 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.
 807 <p>
 808 Definition at line <a class="el" href="modules_8cpp-source.html#l00315">315</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 809 <p>
 810 <div class="fragment"><pre>00315 { }
 811 </pre></div>    </td>
 812   </tr>
 813 </table>
 814 <a name="a3" doxytag="Module::OnUserConnect"></a><p>
 815 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 816   <tr>
 817     <td class="mdRow">
 818       <table cellpadding="0" cellspacing="0" border="0">
 819         <tr>
 820           <td class="md" nowrap valign="top"> void Module::OnUserConnect </td>
 821           <td class="md" valign="top">(&nbsp;</td>
 822           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 823           <td class="mdname1" valign="top" nowrap> <em>user</em>          </td>
 824           <td class="md" valign="top">&nbsp;)&nbsp;</td>
 825           <td class="md" nowrap><code> [virtual]</code></td>
 826         </tr>
 827
 828       </table>
 829     </td>
 830   </tr>
 831 </table>
 832 <table cellspacing=5 cellpadding=0 border=0>
 833   <tr>
 834     <td>
 835       &nbsp;
 836     </td>
 837     <td>
 838
 839 <p>
 840 Called when a user connects.
 841 <p>
 842 The details of the connecting user are available to you in the parameter userrec *user
 843 <p>
 844 Definition at line <a class="el" href="modules_8cpp-source.html#l00308">308</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 845 <p>
 846 <div class="fragment"><pre>00308 { }
 847 </pre></div>    </td>
 848   </tr>
 849 </table>
 850 <a name="a5" doxytag="Module::OnUserJoin"></a><p>
 851 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 852   <tr>
 853     <td class="mdRow">
 854       <table cellpadding="0" cellspacing="0" border="0">
 855         <tr>
 856           <td class="md" nowrap valign="top"> void Module::OnUserJoin </td>
 857           <td class="md" valign="top">(&nbsp;</td>
 858           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 859           <td class="mdname" nowrap> <em>user</em>, </td>
 860         </tr>
 861         <tr>
 862           <td></td>
 863           <td></td>
 864           <td class="md" nowrap><a class="el" href="classchanrec.html">chanrec</a> *&nbsp;</td>
 865           <td class="mdname" nowrap> <em>channel</em></td>
 866         </tr>
 867         <tr>
 868           <td></td>
 869           <td class="md">)&nbsp;</td>
 870           <td class="md" colspan="2"><code> [virtual]</code></td>
 871         </tr>
 872
 873       </table>
 874     </td>
 875   </tr>
 876 </table>
 877 <table cellspacing=5 cellpadding=0 border=0>
 878   <tr>
 879     <td>
 880       &nbsp;
 881     </td>
 882     <td>
 883
 884 <p>
 885 Called when a user joins a channel.
 886 <p>
 887 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
 888 <p>
 889 Definition at line <a class="el" href="modules_8cpp-source.html#l00310">310</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 890 <p>
 891 <div class="fragment"><pre>00310 { }
 892 </pre></div>    </td>
 893   </tr>
 894 </table>
 895 <a name="a6" doxytag="Module::OnUserPart"></a><p>
 896 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 897   <tr>
 898     <td class="mdRow">
 899       <table cellpadding="0" cellspacing="0" border="0">
 900         <tr>
 901           <td class="md" nowrap valign="top"> void Module::OnUserPart </td>
 902           <td class="md" valign="top">(&nbsp;</td>
 903           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 904           <td class="mdname" nowrap> <em>user</em>, </td>
 905         </tr>
 906         <tr>
 907           <td></td>
 908           <td></td>
 909           <td class="md" nowrap><a class="el" href="classchanrec.html">chanrec</a> *&nbsp;</td>
 910           <td class="mdname" nowrap> <em>channel</em></td>
 911         </tr>
 912         <tr>
 913           <td></td>
 914           <td class="md">)&nbsp;</td>
 915           <td class="md" colspan="2"><code> [virtual]</code></td>
 916         </tr>
 917
 918       </table>
 919     </td>
 920   </tr>
 921 </table>
 922 <table cellspacing=5 cellpadding=0 border=0>
 923   <tr>
 924     <td>
 925       &nbsp;
 926     </td>
 927     <td>
 928
 929 <p>
 930 Called when a user parts a channel.
 931 <p>
 932 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
 933 <p>
 934 Definition at line <a class="el" href="modules_8cpp-source.html#l00311">311</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 935 <p>
 936 <div class="fragment"><pre>00311 { }
 937 </pre></div>    </td>
 938   </tr>
 939 </table>
 940 <a name="a20" doxytag="Module::OnUserPostNick"></a><p>
 941 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 942   <tr>
 943     <td class="mdRow">
 944       <table cellpadding="0" cellspacing="0" border="0">
 945         <tr>
 946           <td class="md" nowrap valign="top"> void Module::OnUserPostNick </td>
 947           <td class="md" valign="top">(&nbsp;</td>
 948           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 949           <td class="mdname" nowrap> <em>user</em>, </td>
 950         </tr>
 951         <tr>
 952           <td></td>
 953           <td></td>
 954           <td class="md" nowrap>std::string&nbsp;</td>
 955           <td class="mdname" nowrap> <em>oldnick</em></td>
 956         </tr>
 957         <tr>
 958           <td></td>
 959           <td class="md">)&nbsp;</td>
 960           <td class="md" colspan="2"><code> [virtual]</code></td>
 961         </tr>
 962
 963       </table>
 964     </td>
 965   </tr>
 966 </table>
 967 <table cellspacing=5 cellpadding=0 border=0>
 968   <tr>
 969     <td>
 970       &nbsp;
 971     </td>
 972     <td>
 973
 974 <p>
 975 Called after any nickchange, local or remote.
 976 <p>
 977 This can be used to track users after nickchanges have been applied. 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). Because this method is called after the nickchange is taken place, no return values are possible to indicate forbidding of the nick change. Use OnUserPreNick for this.
 978 <p>
 979 Definition at line <a class="el" href="modules_8cpp-source.html#l00326">326</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 980 <p>
 981 <div class="fragment"><pre>00326 { };
 982 </pre></div>    </td>
 983   </tr>
 984 </table>
 985 <a name="a16" doxytag="Module::OnUserPreInvite"></a><p>
 986 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 987   <tr>
 988     <td class="mdRow">
 989       <table cellpadding="0" cellspacing="0" border="0">
 990         <tr>
 991           <td class="md" nowrap valign="top"> int Module::OnUserPreInvite </td>
 992           <td class="md" valign="top">(&nbsp;</td>
 993           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 994           <td class="mdname" nowrap> <em>source</em>, </td>
 995         </tr>
 996         <tr>
 997           <td></td>
 998           <td></td>
 999           <td class="md" nowrap><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
1000           <td class="mdname" nowrap> <em>dest</em>, </td>
1001         </tr>
1002         <tr>
1003           <td></td>
1004           <td></td>
1005           <td class="md" nowrap><a class="el" href="classchanrec.html">chanrec</a> *&nbsp;</td>
1006           <td class="mdname" nowrap> <em>channel</em></td>
1007         </tr>
1008         <tr>
1009           <td></td>
1010           <td class="md">)&nbsp;</td>
1011           <td class="md" colspan="2"><code> [virtual]</code></td>
1012         </tr>
1013
1014       </table>
1015     </td>
1016   </tr>
1017 </table>
1018 <table cellspacing=5 cellpadding=0 border=0>
1019   <tr>
1020     <td>
1021       &nbsp;
1022     </td>
1023     <td>
1024
1025 <p>
1026 Called whenever a user is about to invite another user into a channel, before any processing is done.
1027 <p>
1028 Returning 1 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 invites to channels.
1029 <p>
1030 Definition at line <a class="el" href="modules_8cpp-source.html#l00322">322</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1031 <p>
1032 <div class="fragment"><pre>00322 { <span class="keywordflow">return</span> 0; };
1033 </pre></div>    </td>
1034   </tr>
1035 </table>
1036 <a name="a12" doxytag="Module::OnUserPreJoin"></a><p>
1037 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1038   <tr>
1039     <td class="mdRow">
1040       <table cellpadding="0" cellspacing="0" border="0">
1041         <tr>
1042           <td class="md" nowrap valign="top"> int Module::OnUserPreJoin </td>
1043           <td class="md" valign="top">(&nbsp;</td>
1044           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
1045           <td class="mdname" nowrap> <em>user</em>, </td>
1046         </tr>
1047         <tr>
1048           <td></td>
1049           <td></td>
1050           <td class="md" nowrap><a class="el" href="classchanrec.html">chanrec</a> *&nbsp;</td>
1051           <td class="mdname" nowrap> <em>chan</em>, </td>
1052         </tr>
1053         <tr>
1054           <td></td>
1055           <td></td>
1056           <td class="md" nowrap>const char *&nbsp;</td>
1057           <td class="mdname" nowrap> <em>cname</em></td>
1058         </tr>
1059         <tr>
1060           <td></td>
1061           <td class="md">)&nbsp;</td>
1062           <td class="md" colspan="2"><code> [virtual]</code></td>
1063         </tr>
1064
1065       </table>
1066     </td>
1067   </tr>
1068 </table>
1069 <table cellspacing=5 cellpadding=0 border=0>
1070   <tr>
1071     <td>
1072       &nbsp;
1073     </td>
1074     <td>
1075
1076 <p>
1077 Called whenever a user is about to join a channel, before any processing is done.
1078 <p>
1079 Returning a value of 1 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. Returning -1 from this function forces the join to be allowed, bypassing restrictions such as banlists, invite, keys etc.<p>
1080 IMPORTANT NOTE!<p>
1081 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.
1082 <p>
1083 Definition at line <a class="el" href="modules_8cpp-source.html#l00316">316</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1084 <p>
1085 <div class="fragment"><pre>00316 { <span class="keywordflow">return</span> 0; }
1086 </pre></div>    </td>
1087   </tr>
1088 </table>
1089 <a name="a17" doxytag="Module::OnUserPreMessage"></a><p>
1090 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1091   <tr>
1092     <td class="mdRow">
1093       <table cellpadding="0" cellspacing="0" border="0">
1094         <tr>
1095           <td class="md" nowrap valign="top"> int Module::OnUserPreMessage </td>
1096           <td class="md" valign="top">(&nbsp;</td>
1097           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
1098           <td class="mdname" nowrap> <em>user</em>, </td>
1099         </tr>
1100         <tr>
1101           <td></td>
1102           <td></td>
1103           <td class="md" nowrap>void *&nbsp;</td>
1104           <td class="mdname" nowrap> <em>dest</em>, </td>
1105         </tr>
1106         <tr>
1107           <td></td>
1108           <td></td>
1109           <td class="md" nowrap>int&nbsp;</td>
1110           <td class="mdname" nowrap> <em>target_type</em>, </td>
1111         </tr>
1112         <tr>
1113           <td></td>
1114           <td></td>
1115           <td class="md" nowrap>std::string &amp;&nbsp;</td>
1116           <td class="mdname" nowrap> <em>text</em></td>
1117         </tr>
1118         <tr>
1119           <td></td>
1120           <td class="md">)&nbsp;</td>
1121           <td class="md" colspan="2"><code> [virtual]</code></td>
1122         </tr>
1123
1124       </table>
1125     </td>
1126   </tr>
1127 </table>
1128 <table cellspacing=5 cellpadding=0 border=0>
1129   <tr>
1130     <td>
1131       &nbsp;
1132     </td>
1133     <td>
1134
1135 <p>
1136 Called whenever a user is about to PRIVMSG A user or a channel, before any processing is done.
1137 <p>
1138 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.
1139 <p>
1140 Definition at line <a class="el" href="modules_8cpp-source.html#l00323">323</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1141 <p>
1142 <div class="fragment"><pre>00323 { <span class="keywordflow">return</span> 0; };
1143 </pre></div>    </td>
1144   </tr>
1145 </table>
1146 <a name="a19" doxytag="Module::OnUserPreNick"></a><p>
1147 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1148   <tr>
1149     <td class="mdRow">
1150       <table cellpadding="0" cellspacing="0" border="0">
1151         <tr>
1152           <td class="md" nowrap valign="top"> int Module::OnUserPreNick </td>
1153           <td class="md" valign="top">(&nbsp;</td>
1154           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
1155           <td class="mdname" nowrap> <em>user</em>, </td>
1156         </tr>
1157         <tr>
1158           <td></td>
1159           <td></td>
1160           <td class="md" nowrap>std::string&nbsp;</td>
1161           <td class="mdname" nowrap> <em>newnick</em></td>
1162         </tr>
1163         <tr>
1164           <td></td>
1165           <td class="md">)&nbsp;</td>
1166           <td class="md" colspan="2"><code> [virtual]</code></td>
1167         </tr>
1168
1169       </table>
1170     </td>
1171   </tr>
1172 </table>
1173 <table cellspacing=5 cellpadding=0 border=0>
1174   <tr>
1175     <td>
1176       &nbsp;
1177     </td>
1178     <td>
1179
1180 <p>
1181 Called before any nickchange, local or remote.
1182 <p>
1183 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.
1184 <p>
1185 Definition at line <a class="el" href="modules_8cpp-source.html#l00325">325</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1186 <p>
1187 <div class="fragment"><pre>00325 { <span class="keywordflow">return</span> 0; };
1188 </pre></div>    </td>
1189   </tr>
1190 </table>
1191 <a name="a18" doxytag="Module::OnUserPreNotice"></a><p>
1192 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1193   <tr>
1194     <td class="mdRow">
1195       <table cellpadding="0" cellspacing="0" border="0">
1196         <tr>
1197           <td class="md" nowrap valign="top"> int Module::OnUserPreNotice </td>
1198           <td class="md" valign="top">(&nbsp;</td>
1199           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
1200           <td class="mdname" nowrap> <em>user</em>, </td>
1201         </tr>
1202         <tr>
1203           <td></td>
1204           <td></td>
1205           <td class="md" nowrap>void *&nbsp;</td>
1206           <td class="mdname" nowrap> <em>dest</em>, </td>
1207         </tr>
1208         <tr>
1209           <td></td>
1210           <td></td>
1211           <td class="md" nowrap>int&nbsp;</td>
1212           <td class="mdname" nowrap> <em>target_type</em>, </td>
1213         </tr>
1214         <tr>
1215           <td></td>
1216           <td></td>
1217           <td class="md" nowrap>std::string &amp;&nbsp;</td>
1218           <td class="mdname" nowrap> <em>text</em></td>
1219         </tr>
1220         <tr>
1221           <td></td>
1222           <td class="md">)&nbsp;</td>
1223           <td class="md" colspan="2"><code> [virtual]</code></td>
1224         </tr>
1225
1226       </table>
1227     </td>
1228   </tr>
1229 </table>
1230 <table cellspacing=5 cellpadding=0 border=0>
1231   <tr>
1232     <td>
1233       &nbsp;
1234     </td>
1235     <td>
1236
1237 <p>
1238 Called whenever a user is about to NOTICE A user or a channel, before any processing is done.
1239 <p>
1240 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. You may alter the message text as you wish before relinquishing control to the next module in the chain, and if no other modules block the text this altered form of the text will be sent out to the user and possibly to other servers.
1241 <p>
1242 Definition at line <a class="el" href="modules_8cpp-source.html#l00324">324</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1243 <p>
1244 <div class="fragment"><pre>00324 { <span class="keywordflow">return</span> 0; };
1245 </pre></div>    </td>
1246   </tr>
1247 </table>
1248 <a name="a4" doxytag="Module::OnUserQuit"></a><p>
1249 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1250   <tr>
1251     <td class="mdRow">
1252       <table cellpadding="0" cellspacing="0" border="0">
1253         <tr>
1254           <td class="md" nowrap valign="top"> void Module::OnUserQuit </td>
1255           <td class="md" valign="top">(&nbsp;</td>
1256           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
1257           <td class="mdname1" valign="top" nowrap> <em>user</em>          </td>
1258           <td class="md" valign="top">&nbsp;)&nbsp;</td>
1259           <td class="md" nowrap><code> [virtual]</code></td>
1260         </tr>
1261
1262       </table>
1263     </td>
1264   </tr>
1265 </table>
1266 <table cellspacing=5 cellpadding=0 border=0>
1267   <tr>
1268     <td>
1269       &nbsp;
1270     </td>
1271     <td>
1272
1273 <p>
1274 Called when a user quits.
1275 <p>
1276 The details of the exiting user are available to you in the parameter userrec *user
1277 <p>
1278 Definition at line <a class="el" href="modules_8cpp-source.html#l00309">309</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1279 <p>
1280 <div class="fragment"><pre>00309 { }
1281 </pre></div>    </td>
1282   </tr>
1283 </table>
1284 <a name="a22" doxytag="Module::OnUserSync"></a><p>
1285 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1286   <tr>
1287     <td class="mdRow">
1288       <table cellpadding="0" cellspacing="0" border="0">
1289         <tr>
1290           <td class="md" nowrap valign="top"> <a class="el" href="modules_8h.html#a32">string_list</a> Module::OnUserSync </td>
1291           <td class="md" valign="top">(&nbsp;</td>
1292           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
1293           <td class="mdname1" valign="top" nowrap> <em>user</em>          </td>
1294           <td class="md" valign="top">&nbsp;)&nbsp;</td>
1295           <td class="md" nowrap><code> [virtual]</code></td>
1296         </tr>
1297
1298       </table>
1299     </td>
1300   </tr>
1301 </table>
1302 <table cellspacing=5 cellpadding=0 border=0>
1303   <tr>
1304     <td>
1305       &nbsp;
1306     </td>
1307     <td>
1308
1309 <p>
1310 Called during a netburst to sync user data.
1311 <p>
1312 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.
1313 <p>
1314 Definition at line <a class="el" href="modules_8cpp-source.html#l00328">328</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1315 <p>
1316 References <a class="el" href="modules_8h-source.html#l00068">string_list</a>.
1317 <p>
1318 <div class="fragment"><pre>00328 { <a class="code" href="modules_8h.html#a32">string_list</a> empty; <span class="keywordflow">return</span> empty; }
1319 </pre></div>    </td>
1320   </tr>
1321 </table>
1322 <a name="a15" doxytag="Module::OnWhois"></a><p>
1323 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1324   <tr>
1325     <td class="mdRow">
1326       <table cellpadding="0" cellspacing="0" border="0">
1327         <tr>
1328           <td class="md" nowrap valign="top"> void Module::OnWhois </td>
1329           <td class="md" valign="top">(&nbsp;</td>
1330           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
1331           <td class="mdname" nowrap> <em>source</em>, </td>
1332         </tr>
1333         <tr>
1334           <td></td>
1335           <td></td>
1336           <td class="md" nowrap><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
1337           <td class="mdname" nowrap> <em>dest</em></td>
1338         </tr>
1339         <tr>
1340           <td></td>
1341           <td class="md">)&nbsp;</td>
1342           <td class="md" colspan="2"><code> [virtual]</code></td>
1343         </tr>
1344
1345       </table>
1346     </td>
1347   </tr>
1348 </table>
1349 <table cellspacing=5 cellpadding=0 border=0>
1350   <tr>
1351     <td>
1352       &nbsp;
1353     </td>
1354     <td>
1355
1356 <p>
1357 Called whenever a /WHOIS is performed on a local user.
1358 <p>
1359 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.
1360 <p>
1361 Definition at line <a class="el" href="modules_8cpp-source.html#l00321">321</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1362 <p>
1363 <div class="fragment"><pre>00321 { };
1364 </pre></div>    </td>
1365   </tr>
1366 </table>
1367 <hr>The documentation for this class was generated from the following files:<ul>
1368 <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>
1369 <hr size="1"><address style="align: right;"><small>Generated on Wed Apr 13 12:32:26 2005 for InspIRCd by
1370 <a href="http://www.doxygen.org/index.html">
1371 <img src="doxygen.png" alt="doxygen" align="middle" border=0 >
1372 </a>1.3.3 </small></address>
1373 </body>
1374 </html>