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">OnUserDisconnect</a> (<a class="el" href="classuserrec.html">userrec</a> *user)</td></tr>
  34
  35 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called whenever a user's socket is closed. </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">OnUserJoin</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 joins 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">OnUserPart</a> (<a class="el" href="classuserrec.html">userrec</a> *user, <a class="el" href="classchanrec.html">chanrec</a> *channel)</td></tr>
  40
  41 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called when a user parts a channel. </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">OnPacketTransmit</a> (std::string &amp;data, std::string serv)</td></tr>
  43
  44 <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="#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">OnPacketReceive</a> (std::string &amp;data, std::string serv)</td></tr>
  46
  47 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called after a packet is received from another irc server. </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">OnRehash</a> ()</td></tr>
  49
  50 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called on rehash. </em> <a href="#a10"></a><em><br><br></td></tr>
  51 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a11">OnServerRaw</a> (std::string &amp;raw, bool inbound, <a class="el" href="classuserrec.html">userrec</a> *user)</td></tr>
  52
  53 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called when a raw command is transmitted or received. </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">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>
  55
  56 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called whenever an extended mode is to be processed. </em> <a href="#a12"></a><em><br><br></td></tr>
  57 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual int&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a13">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>
  58
  59 <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="#a13"></a><em><br><br></td></tr>
  60 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual int&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a14">OnUserPreKick</a> (<a class="el" href="classuserrec.html">userrec</a> *source, <a class="el" href="classuserrec.html">userrec</a> *user, <a class="el" href="classchanrec.html">chanrec</a> *chan, std::string reason)</td></tr>
  61
  62 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called whenever a user is about to be kicked. </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">OnUserKick</a> (<a class="el" href="classuserrec.html">userrec</a> *source, <a class="el" href="classuserrec.html">userrec</a> *user, <a class="el" href="classchanrec.html">chanrec</a> *chan, std::string reason)</td></tr>
  64
  65 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called whenever a user is kicked. </em> <a href="#a15"></a><em><br><br></td></tr>
  66 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a16">OnOper</a> (<a class="el" href="classuserrec.html">userrec</a> *user)</td></tr>
  67
  68 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called whenever a user opers locally. </em> <a href="#a16"></a><em><br><br></td></tr>
  69 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a17">OnInfo</a> (<a class="el" href="classuserrec.html">userrec</a> *user)</td></tr>
  70
  71 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called whenever a user types /INFO. </em> <a href="#a17"></a><em><br><br></td></tr>
  72 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a18">OnWhois</a> (<a class="el" href="classuserrec.html">userrec</a> *source, <a class="el" href="classuserrec.html">userrec</a> *dest)</td></tr>
  73
  74 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called whenever a /WHOIS is performed on a local user. </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">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>
  76
  77 <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="#a19"></a><em><br><br></td></tr>
  78 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual int&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a20">OnUserPreMessage</a> (<a class="el" href="classuserrec.html">userrec</a> *user, void *dest, int target_type, std::string &amp;text)</td></tr>
  79
  80 <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="#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">OnUserPreNotice</a> (<a class="el" href="classuserrec.html">userrec</a> *user, void *dest, int target_type, std::string &amp;text)</td></tr>
  82
  83 <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="#a21"></a><em><br><br></td></tr>
  84 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual int&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a22">OnUserPreNick</a> (<a class="el" href="classuserrec.html">userrec</a> *user, std::string newnick)</td></tr>
  85
  86 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called before any nickchange, local or remote. </em> <a href="#a22"></a><em><br><br></td></tr>
  87 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a23">OnUserPostNick</a> (<a class="el" href="classuserrec.html">userrec</a> *user, std::string oldnick)</td></tr>
  88
  89 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called after any nickchange, local or remote. </em> <a href="#a23"></a><em><br><br></td></tr>
  90 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual int&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a24">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>
  91
  92 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called before an action which requires a channel privilage check. </em> <a href="#a24"></a><em><br><br></td></tr>
  93 <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#a25">OnUserSync</a> (<a class="el" href="classuserrec.html">userrec</a> *user)</td></tr>
  94
  95 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called during a netburst to sync user data. </em> <a href="#a25"></a><em><br><br></td></tr>
  96 <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#a26">OnChannelSync</a> (<a class="el" href="classchanrec.html">chanrec</a> *chan)</td></tr>
  97
  98 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called during a netburst to sync channel data. </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">On005Numeric</a> (std::string &amp;output)</td></tr>
 100
 101 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called when a 005 numeric is about to be output. </em> <a href="#a27"></a><em><br><br></td></tr>
 102 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual int&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a28">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>
 103
 104 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called when a client is disconnected by KILL. </em> <a href="#a28"></a><em><br><br></td></tr>
 105 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a29">OnLoadModule</a> (<a class="el" href="classModule.html">Module</a> *mod, std::string name)</td></tr>
 106
 107 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called whenever a module is loaded. </em> <a href="#a29"></a><em><br><br></td></tr>
 108 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a30">OnBackgroundTimer</a> (time_t curtime)</td></tr>
 109
 110 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called once every five seconds for background processing. </em> <a href="#a30"></a><em><br><br></td></tr>
 111 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a31">OnSendList</a> (<a class="el" href="classuserrec.html">userrec</a> *user, <a class="el" href="classchanrec.html">chanrec</a> *channel, char mode)</td></tr>
 112
 113 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called whenever a list is needed for a listmode. </em> <a href="#a31"></a><em><br><br></td></tr>
 114 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual int&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a32">OnPreCommand</a> (std::string command, char **parameters, int pcnt, <a class="el" href="classuserrec.html">userrec</a> *user)</td></tr>
 115
 116 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called whenever any command is about to be executed. </em> <a href="#a32"></a><em><br><br></td></tr>
 117 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a33">OnCheckReady</a> (<a class="el" href="classuserrec.html">userrec</a> *user)</td></tr>
 118
 119 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called to check if a user who is connecting can now be allowed to register If any modules return false for this function, the user is held in the waiting state until all modules return true. </em> <a href="#a33"></a><em><br><br></td></tr>
 120 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a34">OnUserRegister</a> (<a class="el" href="classuserrec.html">userrec</a> *user)</td></tr>
 121
 122 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called whenever a user is about to register their connection (e.g. </em> <a href="#a34"></a><em><br><br></td></tr>
 123 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual int&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a35">OnRawMode</a> (<a class="el" href="classuserrec.html">userrec</a> *user, <a class="el" href="classchanrec.html">chanrec</a> *chan, char mode, std::string param, bool adding, int pcnt)</td></tr>
 124
 125 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called whenever a mode character is processed. </em> <a href="#a35"></a><em><br><br></td></tr>
 126 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual int&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a36">OnCheckInvite</a> (<a class="el" href="classuserrec.html">userrec</a> *user, <a class="el" href="classchanrec.html">chanrec</a> *chan)</td></tr>
 127
 128 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called whenever a user joins a channel, to determine if invite checks should go ahead or not. </em> <a href="#a36"></a><em><br><br></td></tr>
 129 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual int&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a37">OnCheckKey</a> (<a class="el" href="classuserrec.html">userrec</a> *user, <a class="el" href="classchanrec.html">chanrec</a> *chan, std::string keygiven)</td></tr>
 130
 131 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called whenever a user joins a channel, to determine if key checks should go ahead or not. </em> <a href="#a37"></a><em><br><br></td></tr>
 132 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual int&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a38">OnCheckLimit</a> (<a class="el" href="classuserrec.html">userrec</a> *user, <a class="el" href="classchanrec.html">chanrec</a> *chan)</td></tr>
 133
 134 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called whenever a user joins a channel, to determine if channel limit checks should go ahead or not. </em> <a href="#a38"></a><em><br><br></td></tr>
 135 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual int&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a39">OnCheckBan</a> (<a class="el" href="classuserrec.html">userrec</a> *user, <a class="el" href="classchanrec.html">chanrec</a> *chan)</td></tr>
 136
 137 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called whenever a user joins a channel, to determine if banlist checks should go ahead or not. </em> <a href="#a39"></a><em><br><br></td></tr>
 138 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a40">OnStats</a> (char symbol)</td></tr>
 139
 140 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called on all /STATS commands This method is triggered for all /STATS use, including stats symbols handled by the core. </em> <a href="#a40"></a><em><br><br></td></tr>
 141 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual int&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a41">OnChangeLocalUserHost</a> (<a class="el" href="classuserrec.html">userrec</a> *user, std::string newhost)</td></tr>
 142
 143 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called whenever a change of a local users displayed host is attempted. </em> <a href="#a41"></a><em><br><br></td></tr>
 144 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual int&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a42">OnChangeLocalUserGECOS</a> (<a class="el" href="classuserrec.html">userrec</a> *user, std::string newhost)</td></tr>
 145
 146 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called whenever a change of a local users GECOS (fullname field) is attempted. </em> <a href="#a42"></a><em><br><br></td></tr>
 147 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual int&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a43">OnLocalTopicChange</a> (<a class="el" href="classuserrec.html">userrec</a> *user, <a class="el" href="classchanrec.html">chanrec</a> *chan, std::string topic)</td></tr>
 148
 149 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called whenever a topic is changed by a local user. </em> <a href="#a43"></a><em><br><br></td></tr>
 150 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual int&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a44">OnMeshToken</a> (char token, <a class="el" href="modules_8h.html#a32">string_list</a> params, <a class="el" href="classserverrec.html">serverrec</a> *source, <a class="el" href="classserverrec.html">serverrec</a> *reply, std::string tcp_host, std::string ipaddr, int port)</td></tr>
 151
 152 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called whenever an unknown token is received in a server to server link. </em> <a href="#a44"></a><em><br><br></td></tr>
 153 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a45">OnEvent</a> (<a class="el" href="classEvent.html">Event</a> *event)</td></tr>
 154
 155 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called whenever an <a class="el" href="classEvent.html">Event</a> class is sent to all module by another module. </em> <a href="#a45"></a><em><br><br></td></tr>
 156 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual char *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a46">OnRequest</a> (<a class="el" href="classRequest.html">Request</a> *request)</td></tr>
 157
 158 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called whenever a <a class="el" href="classRequest.html">Request</a> class is sent to your module by another module. </em> <a href="#a46"></a><em><br><br></td></tr>
 159 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual int&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a47">OnOperCompare</a> (std::string password, std::string input)</td></tr>
 160
 161 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called whenever an oper password is to be compared to what a user has input. </em> <a href="#a47"></a><em><br><br></td></tr>
 162 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a48">OnGlobalOper</a> (<a class="el" href="classuserrec.html">userrec</a> *user)</td></tr>
 163
 164 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called whenever a user is given usermode +o, anywhere on the network. </em> <a href="#a48"></a><em><br><br></td></tr>
 165 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a49">OnGlobalConnect</a> (<a class="el" href="classuserrec.html">userrec</a> *user)</td></tr>
 166
 167 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called whenever a user connects, anywhere on the network. </em> <a href="#a49"></a><em><br><br></td></tr>
 168 </table>
 169 <hr><a name="_details"></a><h2>Detailed Description</h2>
 170 Base class for all InspIRCd modules This class is the base class for InspIRCd modules.
 171 <p>
 172 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.
 173 <p>
 174
 175 <p>
 176 Definition at line <a class="el" href="modules_8h-source.html#l00236">236</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
 177 <a name="a0" doxytag="Module::Module"></a><p>
 178 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 179   <tr>
 180     <td class="mdRow">
 181       <table cellpadding="0" cellspacing="0" border="0">
 182         <tr>
 183           <td class="md" nowrap valign="top"> Module::Module </td>
 184           <td class="md" valign="top">(&nbsp;</td>
 185           <td class="mdname1" valign="top" nowrap>          </td>
 186           <td class="md" valign="top">&nbsp;)&nbsp;</td>
 187           <td class="md" nowrap></td>
 188         </tr>
 189
 190       </table>
 191     </td>
 192   </tr>
 193 </table>
 194 <table cellspacing=5 cellpadding=0 border=0>
 195   <tr>
 196     <td>
 197       &nbsp;
 198     </td>
 199     <td>
 200
 201 <p>
 202 Default constructor creates a module class.
 203 <p>
 204
 205 <p>
 206 Definition at line <a class="el" href="modules_8cpp-source.html#l00361">361</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 207 <p>
 208 <div class="fragment"><pre>00361 { }
 209 </pre></div>    </td>
 210   </tr>
 211 </table>
 212 <a name="a1" doxytag="Module::~Module"></a><p>
 213 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 214   <tr>
 215     <td class="mdRow">
 216       <table cellpadding="0" cellspacing="0" border="0">
 217         <tr>
 218           <td class="md" nowrap valign="top"> Module::~<a class="el" href="classModule.html">Module</a> </td>
 219           <td class="md" valign="top">(&nbsp;</td>
 220           <td class="mdname1" valign="top" nowrap>          </td>
 221           <td class="md" valign="top">&nbsp;)&nbsp;</td>
 222           <td class="md" nowrap><code> [virtual]</code></td>
 223         </tr>
 224
 225       </table>
 226     </td>
 227   </tr>
 228 </table>
 229 <table cellspacing=5 cellpadding=0 border=0>
 230   <tr>
 231     <td>
 232       &nbsp;
 233     </td>
 234     <td>
 235
 236 <p>
 237 Default destructor destroys a module class.
 238 <p>
 239
 240 <p>
 241 Definition at line <a class="el" href="modules_8cpp-source.html#l00362">362</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 242 <p>
 243 <div class="fragment"><pre>00362 { }
 244 </pre></div>    </td>
 245   </tr>
 246 </table>
 247 <hr><h2>Member Function Documentation</h2>
 248 <a name="a2" doxytag="Module::GetVersion"></a><p>
 249 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 250   <tr>
 251     <td class="mdRow">
 252       <table cellpadding="0" cellspacing="0" border="0">
 253         <tr>
 254           <td class="md" nowrap valign="top"> <a class="el" href="classVersion.html">Version</a> Module::GetVersion </td>
 255           <td class="md" valign="top">(&nbsp;</td>
 256           <td class="mdname1" valign="top" nowrap>          </td>
 257           <td class="md" valign="top">&nbsp;)&nbsp;</td>
 258           <td class="md" nowrap><code> [virtual]</code></td>
 259         </tr>
 260
 261       </table>
 262     </td>
 263   </tr>
 264 </table>
 265 <table cellspacing=5 cellpadding=0 border=0>
 266   <tr>
 267     <td>
 268       &nbsp;
 269     </td>
 270     <td>
 271
 272 <p>
 273 Returns the version number of a Module.
 274 <p>
 275 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>
 276 <p>
 277 Definition at line <a class="el" href="modules_8cpp-source.html#l00374">374</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 278 <p>
 279 References <a class="el" href="modules_8h-source.html#l00054">VF_VENDOR</a>.
 280 <p>
 281 <div class="fragment"><pre>00374 { <span class="keywordflow">return</span> <a class="code" href="classVersion.html">Version</a>(1,0,0,0,VF_VENDOR); }
 282 </pre></div>    </td>
 283   </tr>
 284 </table>
 285 <a name="a27" doxytag="Module::On005Numeric"></a><p>
 286 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 287   <tr>
 288     <td class="mdRow">
 289       <table cellpadding="0" cellspacing="0" border="0">
 290         <tr>
 291           <td class="md" nowrap valign="top"> void Module::On005Numeric </td>
 292           <td class="md" valign="top">(&nbsp;</td>
 293           <td class="md" nowrap valign="top">std::string &amp;&nbsp;</td>
 294           <td class="mdname1" valign="top" nowrap> <em>output</em>          </td>
 295           <td class="md" valign="top">&nbsp;)&nbsp;</td>
 296           <td class="md" nowrap><code> [virtual]</code></td>
 297         </tr>
 298
 299       </table>
 300     </td>
 301   </tr>
 302 </table>
 303 <table cellspacing=5 cellpadding=0 border=0>
 304   <tr>
 305     <td>
 306       &nbsp;
 307     </td>
 308     <td>
 309
 310 <p>
 311 Called when a 005 numeric is about to be output.
 312 <p>
 313 The module should modify the 005 numeric if needed to indicate its features.
 314 <p>
 315 Definition at line <a class="el" href="modules_8cpp-source.html#l00386">386</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 316 <p>
 317 <div class="fragment"><pre>00386 { };
 318 </pre></div>    </td>
 319   </tr>
 320 </table>
 321 <a name="a24" doxytag="Module::OnAccessCheck"></a><p>
 322 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 323   <tr>
 324     <td class="mdRow">
 325       <table cellpadding="0" cellspacing="0" border="0">
 326         <tr>
 327           <td class="md" nowrap valign="top"> int Module::OnAccessCheck </td>
 328           <td class="md" valign="top">(&nbsp;</td>
 329           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 330           <td class="mdname" nowrap> <em>source</em>, </td>
 331         </tr>
 332         <tr>
 333           <td></td>
 334           <td></td>
 335           <td class="md" nowrap><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 336           <td class="mdname" nowrap> <em>dest</em>, </td>
 337         </tr>
 338         <tr>
 339           <td></td>
 340           <td></td>
 341           <td class="md" nowrap><a class="el" href="classchanrec.html">chanrec</a> *&nbsp;</td>
 342           <td class="mdname" nowrap> <em>channel</em>, </td>
 343         </tr>
 344         <tr>
 345           <td></td>
 346           <td></td>
 347           <td class="md" nowrap>int&nbsp;</td>
 348           <td class="mdname" nowrap> <em>access_type</em></td>
 349         </tr>
 350         <tr>
 351           <td></td>
 352           <td class="md">)&nbsp;</td>
 353           <td class="md" colspan="2"><code> [virtual]</code></td>
 354         </tr>
 355
 356       </table>
 357     </td>
 358   </tr>
 359 </table>
 360 <table cellspacing=5 cellpadding=0 border=0>
 361   <tr>
 362     <td>
 363       &nbsp;
 364     </td>
 365     <td>
 366
 367 <p>
 368 Called before an action which requires a channel privilage check.
 369 <p>
 370 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>
 371 <br>
 372  AC_KICK (0) - A user is being kicked<br>
 373  AC_DEOP (1) - a user is being deopped<br>
 374  AC_OP (2) - a user is being opped<br>
 375  AC_VOICE (3) - a user is being voiced<br>
 376  AC_DEVOICE (4) - a user is being devoiced<br>
 377  AC_HALFOP (5) - a user is being halfopped<br>
 378  AC_DEHALFOP (6) - a user is being dehalfopped<br>
 379  AC_INVITE (7) - a user is being invited<br>
 380  AC_GENERAL_MODE (8) - a user channel mode is being changed<br>
 381 <br>
 382  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).
 383 <p>
 384 Definition at line <a class="el" href="modules_8cpp-source.html#l00383">383</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 385 <p>
 386 References <a class="el" href="modules_8h-source.html#l00037">ACR_DEFAULT</a>.
 387 <p>
 388 <div class="fragment"><pre>00383 { <span class="keywordflow">return</span> <a class="code" href="modules_8h.html#a8">ACR_DEFAULT</a>; };
 389 </pre></div>    </td>
 390   </tr>
 391 </table>
 392 <a name="a30" doxytag="Module::OnBackgroundTimer"></a><p>
 393 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 394   <tr>
 395     <td class="mdRow">
 396       <table cellpadding="0" cellspacing="0" border="0">
 397         <tr>
 398           <td class="md" nowrap valign="top"> void Module::OnBackgroundTimer </td>
 399           <td class="md" valign="top">(&nbsp;</td>
 400           <td class="md" nowrap valign="top">time_t&nbsp;</td>
 401           <td class="mdname1" valign="top" nowrap> <em>curtime</em>          </td>
 402           <td class="md" valign="top">&nbsp;)&nbsp;</td>
 403           <td class="md" nowrap><code> [virtual]</code></td>
 404         </tr>
 405
 406       </table>
 407     </td>
 408   </tr>
 409 </table>
 410 <table cellspacing=5 cellpadding=0 border=0>
 411   <tr>
 412     <td>
 413       &nbsp;
 414     </td>
 415     <td>
 416
 417 <p>
 418 Called once every five seconds for background processing.
 419 <p>
 420 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.
 421 <p>
 422 Definition at line <a class="el" href="modules_8cpp-source.html#l00389">389</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 423 <p>
 424 <div class="fragment"><pre>00389 { };
 425 </pre></div>    </td>
 426   </tr>
 427 </table>
 428 <a name="a42" doxytag="Module::OnChangeLocalUserGECOS"></a><p>
 429 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 430   <tr>
 431     <td class="mdRow">
 432       <table cellpadding="0" cellspacing="0" border="0">
 433         <tr>
 434           <td class="md" nowrap valign="top"> int Module::OnChangeLocalUserGECOS </td>
 435           <td class="md" valign="top">(&nbsp;</td>
 436           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 437           <td class="mdname" nowrap> <em>user</em>, </td>
 438         </tr>
 439         <tr>
 440           <td></td>
 441           <td></td>
 442           <td class="md" nowrap>std::string&nbsp;</td>
 443           <td class="mdname" nowrap> <em>newhost</em></td>
 444         </tr>
 445         <tr>
 446           <td></td>
 447           <td class="md">)&nbsp;</td>
 448           <td class="md" colspan="2"><code> [virtual]</code></td>
 449         </tr>
 450
 451       </table>
 452     </td>
 453   </tr>
 454 </table>
 455 <table cellspacing=5 cellpadding=0 border=0>
 456   <tr>
 457     <td>
 458       &nbsp;
 459     </td>
 460     <td>
 461
 462 <p>
 463 Called whenever a change of a local users GECOS (fullname field) is attempted.
 464 <p>
 465 return 1 to deny the name change, or 0 to allow it.
 466 <p>
 467 Definition at line <a class="el" href="modules_8cpp-source.html#l00403">403</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 468 <p>
 469 <div class="fragment"><pre>00403 { <span class="keywordflow">return</span> 0; };
 470 </pre></div>    </td>
 471   </tr>
 472 </table>
 473 <a name="a41" doxytag="Module::OnChangeLocalUserHost"></a><p>
 474 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 475   <tr>
 476     <td class="mdRow">
 477       <table cellpadding="0" cellspacing="0" border="0">
 478         <tr>
 479           <td class="md" nowrap valign="top"> int Module::OnChangeLocalUserHost </td>
 480           <td class="md" valign="top">(&nbsp;</td>
 481           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 482           <td class="mdname" nowrap> <em>user</em>, </td>
 483         </tr>
 484         <tr>
 485           <td></td>
 486           <td></td>
 487           <td class="md" nowrap>std::string&nbsp;</td>
 488           <td class="mdname" nowrap> <em>newhost</em></td>
 489         </tr>
 490         <tr>
 491           <td></td>
 492           <td class="md">)&nbsp;</td>
 493           <td class="md" colspan="2"><code> [virtual]</code></td>
 494         </tr>
 495
 496       </table>
 497     </td>
 498   </tr>
 499 </table>
 500 <table cellspacing=5 cellpadding=0 border=0>
 501   <tr>
 502     <td>
 503       &nbsp;
 504     </td>
 505     <td>
 506
 507 <p>
 508 Called whenever a change of a local users displayed host is attempted.
 509 <p>
 510 Return 1 to deny the host change, or 0 to allow it.
 511 <p>
 512 Definition at line <a class="el" href="modules_8cpp-source.html#l00402">402</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 513 <p>
 514 <div class="fragment"><pre>00402 { <span class="keywordflow">return</span> 0; };
 515 </pre></div>    </td>
 516   </tr>
 517 </table>
 518 <a name="a26" doxytag="Module::OnChannelSync"></a><p>
 519 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 520   <tr>
 521     <td class="mdRow">
 522       <table cellpadding="0" cellspacing="0" border="0">
 523         <tr>
 524           <td class="md" nowrap valign="top"> <a class="el" href="modules_8h.html#a32">string_list</a> Module::OnChannelSync </td>
 525           <td class="md" valign="top">(&nbsp;</td>
 526           <td class="md" nowrap valign="top"><a class="el" href="classchanrec.html">chanrec</a> *&nbsp;</td>
 527           <td class="mdname1" valign="top" nowrap> <em>chan</em>          </td>
 528           <td class="md" valign="top">&nbsp;)&nbsp;</td>
 529           <td class="md" nowrap><code> [virtual]</code></td>
 530         </tr>
 531
 532       </table>
 533     </td>
 534   </tr>
 535 </table>
 536 <table cellspacing=5 cellpadding=0 border=0>
 537   <tr>
 538     <td>
 539       &nbsp;
 540     </td>
 541     <td>
 542
 543 <p>
 544 Called during a netburst to sync channel data.
 545 <p>
 546 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.
 547 <p>
 548 Definition at line <a class="el" href="modules_8cpp-source.html#l00385">385</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 549 <p>
 550 References <a class="el" href="modules_8h-source.html#l00068">string_list</a>.
 551 <p>
 552 <div class="fragment"><pre>00385 { <a class="code" href="modules_8h.html#a32">string_list</a> empty; <span class="keywordflow">return</span> empty; }
 553 </pre></div>    </td>
 554   </tr>
 555 </table>
 556 <a name="a39" doxytag="Module::OnCheckBan"></a><p>
 557 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 558   <tr>
 559     <td class="mdRow">
 560       <table cellpadding="0" cellspacing="0" border="0">
 561         <tr>
 562           <td class="md" nowrap valign="top"> int Module::OnCheckBan </td>
 563           <td class="md" valign="top">(&nbsp;</td>
 564           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 565           <td class="mdname" nowrap> <em>user</em>, </td>
 566         </tr>
 567         <tr>
 568           <td></td>
 569           <td></td>
 570           <td class="md" nowrap><a class="el" href="classchanrec.html">chanrec</a> *&nbsp;</td>
 571           <td class="mdname" nowrap> <em>chan</em></td>
 572         </tr>
 573         <tr>
 574           <td></td>
 575           <td class="md">)&nbsp;</td>
 576           <td class="md" colspan="2"><code> [virtual]</code></td>
 577         </tr>
 578
 579       </table>
 580     </td>
 581   </tr>
 582 </table>
 583 <table cellspacing=5 cellpadding=0 border=0>
 584   <tr>
 585     <td>
 586       &nbsp;
 587     </td>
 588     <td>
 589
 590 <p>
 591 Called whenever a user joins a channel, to determine if banlist checks should go ahead or not.
 592 <p>
 593 This method will always be called for each join, wether or not the user actually matches a channel ban, and determines the outcome of an if statement around the whole section of ban checking code. return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
 594 <p>
 595 Definition at line <a class="el" href="modules_8cpp-source.html#l00400">400</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 596 <p>
 597 <div class="fragment"><pre>00400 { <span class="keywordflow">return</span> 0; };
 598 </pre></div>    </td>
 599   </tr>
 600 </table>
 601 <a name="a36" doxytag="Module::OnCheckInvite"></a><p>
 602 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 603   <tr>
 604     <td class="mdRow">
 605       <table cellpadding="0" cellspacing="0" border="0">
 606         <tr>
 607           <td class="md" nowrap valign="top"> int Module::OnCheckInvite </td>
 608           <td class="md" valign="top">(&nbsp;</td>
 609           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 610           <td class="mdname" nowrap> <em>user</em>, </td>
 611         </tr>
 612         <tr>
 613           <td></td>
 614           <td></td>
 615           <td class="md" nowrap><a class="el" href="classchanrec.html">chanrec</a> *&nbsp;</td>
 616           <td class="mdname" nowrap> <em>chan</em></td>
 617         </tr>
 618         <tr>
 619           <td></td>
 620           <td class="md">)&nbsp;</td>
 621           <td class="md" colspan="2"><code> [virtual]</code></td>
 622         </tr>
 623
 624       </table>
 625     </td>
 626   </tr>
 627 </table>
 628 <table cellspacing=5 cellpadding=0 border=0>
 629   <tr>
 630     <td>
 631       &nbsp;
 632     </td>
 633     <td>
 634
 635 <p>
 636 Called whenever a user joins a channel, to determine if invite checks should go ahead or not.
 637 <p>
 638 This method will always be called for each join, wether or not the channel is actually +i, and determines the outcome of an if statement around the whole section of invite checking code. return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
 639 <p>
 640 Definition at line <a class="el" href="modules_8cpp-source.html#l00397">397</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 641 <p>
 642 <div class="fragment"><pre>00397 { <span class="keywordflow">return</span> 0; };
 643 </pre></div>    </td>
 644   </tr>
 645 </table>
 646 <a name="a37" doxytag="Module::OnCheckKey"></a><p>
 647 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 648   <tr>
 649     <td class="mdRow">
 650       <table cellpadding="0" cellspacing="0" border="0">
 651         <tr>
 652           <td class="md" nowrap valign="top"> int Module::OnCheckKey </td>
 653           <td class="md" valign="top">(&nbsp;</td>
 654           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 655           <td class="mdname" nowrap> <em>user</em>, </td>
 656         </tr>
 657         <tr>
 658           <td></td>
 659           <td></td>
 660           <td class="md" nowrap><a class="el" href="classchanrec.html">chanrec</a> *&nbsp;</td>
 661           <td class="mdname" nowrap> <em>chan</em>, </td>
 662         </tr>
 663         <tr>
 664           <td></td>
 665           <td></td>
 666           <td class="md" nowrap>std::string&nbsp;</td>
 667           <td class="mdname" nowrap> <em>keygiven</em></td>
 668         </tr>
 669         <tr>
 670           <td></td>
 671           <td class="md">)&nbsp;</td>
 672           <td class="md" colspan="2"><code> [virtual]</code></td>
 673         </tr>
 674
 675       </table>
 676     </td>
 677   </tr>
 678 </table>
 679 <table cellspacing=5 cellpadding=0 border=0>
 680   <tr>
 681     <td>
 682       &nbsp;
 683     </td>
 684     <td>
 685
 686 <p>
 687 Called whenever a user joins a channel, to determine if key checks should go ahead or not.
 688 <p>
 689 This method will always be called for each join, wether or not the channel is actually +k, and determines the outcome of an if statement around the whole section of key checking code. if the user specified no key, the keygiven string will be a valid but empty value. return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
 690 <p>
 691 Definition at line <a class="el" href="modules_8cpp-source.html#l00398">398</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 692 <p>
 693 <div class="fragment"><pre>00398 { <span class="keywordflow">return</span> 0; };
 694 </pre></div>    </td>
 695   </tr>
 696 </table>
 697 <a name="a38" doxytag="Module::OnCheckLimit"></a><p>
 698 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 699   <tr>
 700     <td class="mdRow">
 701       <table cellpadding="0" cellspacing="0" border="0">
 702         <tr>
 703           <td class="md" nowrap valign="top"> int Module::OnCheckLimit </td>
 704           <td class="md" valign="top">(&nbsp;</td>
 705           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 706           <td class="mdname" nowrap> <em>user</em>, </td>
 707         </tr>
 708         <tr>
 709           <td></td>
 710           <td></td>
 711           <td class="md" nowrap><a class="el" href="classchanrec.html">chanrec</a> *&nbsp;</td>
 712           <td class="mdname" nowrap> <em>chan</em></td>
 713         </tr>
 714         <tr>
 715           <td></td>
 716           <td class="md">)&nbsp;</td>
 717           <td class="md" colspan="2"><code> [virtual]</code></td>
 718         </tr>
 719
 720       </table>
 721     </td>
 722   </tr>
 723 </table>
 724 <table cellspacing=5 cellpadding=0 border=0>
 725   <tr>
 726     <td>
 727       &nbsp;
 728     </td>
 729     <td>
 730
 731 <p>
 732 Called whenever a user joins a channel, to determine if channel limit checks should go ahead or not.
 733 <p>
 734 This method will always be called for each join, wether or not the channel is actually +l, and determines the outcome of an if statement around the whole section of channel limit checking code. return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
 735 <p>
 736 Definition at line <a class="el" href="modules_8cpp-source.html#l00399">399</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 737 <p>
 738 <div class="fragment"><pre>00399 { <span class="keywordflow">return</span> 0; };
 739 </pre></div>    </td>
 740   </tr>
 741 </table>
 742 <a name="a33" doxytag="Module::OnCheckReady"></a><p>
 743 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 744   <tr>
 745     <td class="mdRow">
 746       <table cellpadding="0" cellspacing="0" border="0">
 747         <tr>
 748           <td class="md" nowrap valign="top"> bool Module::OnCheckReady </td>
 749           <td class="md" valign="top">(&nbsp;</td>
 750           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 751           <td class="mdname1" valign="top" nowrap> <em>user</em>          </td>
 752           <td class="md" valign="top">&nbsp;)&nbsp;</td>
 753           <td class="md" nowrap><code> [virtual]</code></td>
 754         </tr>
 755
 756       </table>
 757     </td>
 758   </tr>
 759 </table>
 760 <table cellspacing=5 cellpadding=0 border=0>
 761   <tr>
 762     <td>
 763       &nbsp;
 764     </td>
 765     <td>
 766
 767 <p>
 768 Called to check if a user who is connecting can now be allowed to register If any modules return false for this function, the user is held in the waiting state until all modules return true.
 769 <p>
 770 For example a module which implements ident lookups will continue to return false for a user until their ident lookup is completed. Note that the registration timeout for a user overrides these checks, if the registration timeout is reached, the user is disconnected even if modules report that the user is not ready to connect.
 771 <p>
 772 Definition at line <a class="el" href="modules_8cpp-source.html#l00392">392</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 773 <p>
 774 <div class="fragment"><pre>00392 { <span class="keywordflow">return</span> <span class="keyword">true</span>; };
 775 </pre></div>    </td>
 776   </tr>
 777 </table>
 778 <a name="a45" doxytag="Module::OnEvent"></a><p>
 779 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 780   <tr>
 781     <td class="mdRow">
 782       <table cellpadding="0" cellspacing="0" border="0">
 783         <tr>
 784           <td class="md" nowrap valign="top"> void Module::OnEvent </td>
 785           <td class="md" valign="top">(&nbsp;</td>
 786           <td class="md" nowrap valign="top"><a class="el" href="classEvent.html">Event</a> *&nbsp;</td>
 787           <td class="mdname1" valign="top" nowrap> <em>event</em>          </td>
 788           <td class="md" valign="top">&nbsp;)&nbsp;</td>
 789           <td class="md" nowrap><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 whenever an <a class="el" href="classEvent.html">Event</a> class is sent to all module by another module.
 805 <p>
 806 Please see the documentation of <a class="el" href="classEvent.html#a4">Event::Send()</a> for further information. The <a class="el" href="classEvent.html">Event</a> sent can always be assumed to be non-NULL, you should *always* check the value of <a class="el" href="classEvent.html#a3">Event::GetEventID()</a> before doing anything to the event data, and you should *not* change the event data in any way!
 807 <p>
 808 Definition at line <a class="el" href="modules_8cpp-source.html#l00406">406</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 809 <p>
 810 <div class="fragment"><pre>00406 { <span class="keywordflow">return</span>; };
 811 </pre></div>    </td>
 812   </tr>
 813 </table>
 814 <a name="a12" doxytag="Module::OnExtendedMode"></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"> int Module::OnExtendedMode </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="mdname" nowrap> <em>user</em>, </td>
 824         </tr>
 825         <tr>
 826           <td></td>
 827           <td></td>
 828           <td class="md" nowrap>void *&nbsp;</td>
 829           <td class="mdname" nowrap> <em>target</em>, </td>
 830         </tr>
 831         <tr>
 832           <td></td>
 833           <td></td>
 834           <td class="md" nowrap>char&nbsp;</td>
 835           <td class="mdname" nowrap> <em>modechar</em>, </td>
 836         </tr>
 837         <tr>
 838           <td></td>
 839           <td></td>
 840           <td class="md" nowrap>int&nbsp;</td>
 841           <td class="mdname" nowrap> <em>type</em>, </td>
 842         </tr>
 843         <tr>
 844           <td></td>
 845           <td></td>
 846           <td class="md" nowrap>bool&nbsp;</td>
 847           <td class="mdname" nowrap> <em>mode_on</em>, </td>
 848         </tr>
 849         <tr>
 850           <td></td>
 851           <td></td>
 852           <td class="md" nowrap><a class="el" href="modules_8h.html#a32">string_list</a> &amp;&nbsp;</td>
 853           <td class="mdname" nowrap> <em>params</em></td>
 854         </tr>
 855         <tr>
 856           <td></td>
 857           <td class="md">)&nbsp;</td>
 858           <td class="md" colspan="2"><code> [virtual]</code></td>
 859         </tr>
 860
 861       </table>
 862     </td>
 863   </tr>
 864 </table>
 865 <table cellspacing=5 cellpadding=0 border=0>
 866   <tr>
 867     <td>
 868       &nbsp;
 869     </td>
 870     <td>
 871
 872 <p>
 873 Called whenever an extended mode is to be processed.
 874 <p>
 875 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.
 876 <p>
 877 Definition at line <a class="el" href="modules_8cpp-source.html#l00373">373</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 878 <p>
 879 <div class="fragment"><pre>00373 { <span class="keywordflow">return</span> <span class="keyword">false</span>; }
 880 </pre></div>    </td>
 881   </tr>
 882 </table>
 883 <a name="a49" doxytag="Module::OnGlobalConnect"></a><p>
 884 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 885   <tr>
 886     <td class="mdRow">
 887       <table cellpadding="0" cellspacing="0" border="0">
 888         <tr>
 889           <td class="md" nowrap valign="top"> void Module::OnGlobalConnect </td>
 890           <td class="md" valign="top">(&nbsp;</td>
 891           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 892           <td class="mdname1" valign="top" nowrap> <em>user</em>          </td>
 893           <td class="md" valign="top">&nbsp;)&nbsp;</td>
 894           <td class="md" nowrap><code> [virtual]</code></td>
 895         </tr>
 896
 897       </table>
 898     </td>
 899   </tr>
 900 </table>
 901 <table cellspacing=5 cellpadding=0 border=0>
 902   <tr>
 903     <td>
 904       &nbsp;
 905     </td>
 906     <td>
 907
 908 <p>
 909 Called whenever a user connects, anywhere on the network.
 910 <p>
 911 This event is informational only. You should not change any user information in this event. To do so, use the OnUserConnect method to change the state of local users.
 912 <p>
 913 Definition at line <a class="el" href="modules_8cpp-source.html#l00410">410</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 914 <p>
 915 <div class="fragment"><pre>00410 { };
 916 </pre></div>    </td>
 917   </tr>
 918 </table>
 919 <a name="a48" doxytag="Module::OnGlobalOper"></a><p>
 920 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 921   <tr>
 922     <td class="mdRow">
 923       <table cellpadding="0" cellspacing="0" border="0">
 924         <tr>
 925           <td class="md" nowrap valign="top"> void Module::OnGlobalOper </td>
 926           <td class="md" valign="top">(&nbsp;</td>
 927           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 928           <td class="mdname1" valign="top" nowrap> <em>user</em>          </td>
 929           <td class="md" valign="top">&nbsp;)&nbsp;</td>
 930           <td class="md" nowrap><code> [virtual]</code></td>
 931         </tr>
 932
 933       </table>
 934     </td>
 935   </tr>
 936 </table>
 937 <table cellspacing=5 cellpadding=0 border=0>
 938   <tr>
 939     <td>
 940       &nbsp;
 941     </td>
 942     <td>
 943
 944 <p>
 945 Called whenever a user is given usermode +o, anywhere on the network.
 946 <p>
 947 You cannot override this and prevent it from happening as it is already happened and such a task must be performed by another server. You can however bounce modes by sending servermodes out to reverse mode changes.
 948 <p>
 949 Definition at line <a class="el" href="modules_8cpp-source.html#l00409">409</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 950 <p>
 951 <div class="fragment"><pre>00409 { };
 952 </pre></div>    </td>
 953   </tr>
 954 </table>
 955 <a name="a17" doxytag="Module::OnInfo"></a><p>
 956 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 957   <tr>
 958     <td class="mdRow">
 959       <table cellpadding="0" cellspacing="0" border="0">
 960         <tr>
 961           <td class="md" nowrap valign="top"> void Module::OnInfo </td>
 962           <td class="md" valign="top">(&nbsp;</td>
 963           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 964           <td class="mdname1" valign="top" nowrap> <em>user</em>          </td>
 965           <td class="md" valign="top">&nbsp;)&nbsp;</td>
 966           <td class="md" nowrap><code> [virtual]</code></td>
 967         </tr>
 968
 969       </table>
 970     </td>
 971   </tr>
 972 </table>
 973 <table cellspacing=5 cellpadding=0 border=0>
 974   <tr>
 975     <td>
 976       &nbsp;
 977     </td>
 978     <td>
 979
 980 <p>
 981 Called whenever a user types /INFO.
 982 <p>
 983 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>
 984 &lt;nick&gt; :information here
 985 <p>
 986 Definition at line <a class="el" href="modules_8cpp-source.html#l00376">376</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 987 <p>
 988 <div class="fragment"><pre>00376 { };
 989 </pre></div>    </td>
 990   </tr>
 991 </table>
 992 <a name="a28" doxytag="Module::OnKill"></a><p>
 993 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 994   <tr>
 995     <td class="mdRow">
 996       <table cellpadding="0" cellspacing="0" border="0">
 997         <tr>
 998           <td class="md" nowrap valign="top"> int Module::OnKill </td>
 999           <td class="md" valign="top">(&nbsp;</td>
1000           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
1001           <td class="mdname" nowrap> <em>source</em>, </td>
1002         </tr>
1003         <tr>
1004           <td></td>
1005           <td></td>
1006           <td class="md" nowrap><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
1007           <td class="mdname" nowrap> <em>dest</em>, </td>
1008         </tr>
1009         <tr>
1010           <td></td>
1011           <td></td>
1012           <td class="md" nowrap>std::string&nbsp;</td>
1013           <td class="mdname" nowrap> <em>reason</em></td>
1014         </tr>
1015         <tr>
1016           <td></td>
1017           <td class="md">)&nbsp;</td>
1018           <td class="md" colspan="2"><code> [virtual]</code></td>
1019         </tr>
1020
1021       </table>
1022     </td>
1023   </tr>
1024 </table>
1025 <table cellspacing=5 cellpadding=0 border=0>
1026   <tr>
1027     <td>
1028       &nbsp;
1029     </td>
1030     <td>
1031
1032 <p>
1033 Called when a client is disconnected by KILL.
1034 <p>
1035 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!
1036 <p>
1037 Definition at line <a class="el" href="modules_8cpp-source.html#l00387">387</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1038 <p>
1039 <div class="fragment"><pre>00387 { <span class="keywordflow">return</span> 0; };
1040 </pre></div>    </td>
1041   </tr>
1042 </table>
1043 <a name="a29" doxytag="Module::OnLoadModule"></a><p>
1044 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1045   <tr>
1046     <td class="mdRow">
1047       <table cellpadding="0" cellspacing="0" border="0">
1048         <tr>
1049           <td class="md" nowrap valign="top"> void Module::OnLoadModule </td>
1050           <td class="md" valign="top">(&nbsp;</td>
1051           <td class="md" nowrap valign="top"><a class="el" href="classModule.html">Module</a> *&nbsp;</td>
1052           <td class="mdname" nowrap> <em>mod</em>, </td>
1053         </tr>
1054         <tr>
1055           <td></td>
1056           <td></td>
1057           <td class="md" nowrap>std::string&nbsp;</td>
1058           <td class="mdname" nowrap> <em>name</em></td>
1059         </tr>
1060         <tr>
1061           <td></td>
1062           <td class="md">)&nbsp;</td>
1063           <td class="md" colspan="2"><code> [virtual]</code></td>
1064         </tr>
1065
1066       </table>
1067     </td>
1068   </tr>
1069 </table>
1070 <table cellspacing=5 cellpadding=0 border=0>
1071   <tr>
1072     <td>
1073       &nbsp;
1074     </td>
1075     <td>
1076
1077 <p>
1078 Called whenever a module is loaded.
1079 <p>
1080 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).
1081 <p>
1082 Definition at line <a class="el" href="modules_8cpp-source.html#l00388">388</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1083 <p>
1084 <div class="fragment"><pre>00388 { };
1085 </pre></div>    </td>
1086   </tr>
1087 </table>
1088 <a name="a43" doxytag="Module::OnLocalTopicChange"></a><p>
1089 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1090   <tr>
1091     <td class="mdRow">
1092       <table cellpadding="0" cellspacing="0" border="0">
1093         <tr>
1094           <td class="md" nowrap valign="top"> int Module::OnLocalTopicChange </td>
1095           <td class="md" valign="top">(&nbsp;</td>
1096           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
1097           <td class="mdname" nowrap> <em>user</em>, </td>
1098         </tr>
1099         <tr>
1100           <td></td>
1101           <td></td>
1102           <td class="md" nowrap><a class="el" href="classchanrec.html">chanrec</a> *&nbsp;</td>
1103           <td class="mdname" nowrap> <em>chan</em>, </td>
1104         </tr>
1105         <tr>
1106           <td></td>
1107           <td></td>
1108           <td class="md" nowrap>std::string&nbsp;</td>
1109           <td class="mdname" nowrap> <em>topic</em></td>
1110         </tr>
1111         <tr>
1112           <td></td>
1113           <td class="md">)&nbsp;</td>
1114           <td class="md" colspan="2"><code> [virtual]</code></td>
1115         </tr>
1116
1117       </table>
1118     </td>
1119   </tr>
1120 </table>
1121 <table cellspacing=5 cellpadding=0 border=0>
1122   <tr>
1123     <td>
1124       &nbsp;
1125     </td>
1126     <td>
1127
1128 <p>
1129 Called whenever a topic is changed by a local user.
1130 <p>
1131 Return 1 to deny the topic change, or 0 to allow it.
1132 <p>
1133 Definition at line <a class="el" href="modules_8cpp-source.html#l00404">404</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1134 <p>
1135 <div class="fragment"><pre>00404 { <span class="keywordflow">return</span> 0; };
1136 </pre></div>    </td>
1137   </tr>
1138 </table>
1139 <a name="a44" doxytag="Module::OnMeshToken"></a><p>
1140 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1141   <tr>
1142     <td class="mdRow">
1143       <table cellpadding="0" cellspacing="0" border="0">
1144         <tr>
1145           <td class="md" nowrap valign="top"> int Module::OnMeshToken </td>
1146           <td class="md" valign="top">(&nbsp;</td>
1147           <td class="md" nowrap valign="top">char&nbsp;</td>
1148           <td class="mdname" nowrap> <em>token</em>, </td>
1149         </tr>
1150         <tr>
1151           <td></td>
1152           <td></td>
1153           <td class="md" nowrap><a class="el" href="modules_8h.html#a32">string_list</a>&nbsp;</td>
1154           <td class="mdname" nowrap> <em>params</em>, </td>
1155         </tr>
1156         <tr>
1157           <td></td>
1158           <td></td>
1159           <td class="md" nowrap><a class="el" href="classserverrec.html">serverrec</a> *&nbsp;</td>
1160           <td class="mdname" nowrap> <em>source</em>, </td>
1161         </tr>
1162         <tr>
1163           <td></td>
1164           <td></td>
1165           <td class="md" nowrap><a class="el" href="classserverrec.html">serverrec</a> *&nbsp;</td>
1166           <td class="mdname" nowrap> <em>reply</em>, </td>
1167         </tr>
1168         <tr>
1169           <td></td>
1170           <td></td>
1171           <td class="md" nowrap>std::string&nbsp;</td>
1172           <td class="mdname" nowrap> <em>tcp_host</em>, </td>
1173         </tr>
1174         <tr>
1175           <td></td>
1176           <td></td>
1177           <td class="md" nowrap>std::string&nbsp;</td>
1178           <td class="mdname" nowrap> <em>ipaddr</em>, </td>
1179         </tr>
1180         <tr>
1181           <td></td>
1182           <td></td>
1183           <td class="md" nowrap>int&nbsp;</td>
1184           <td class="mdname" nowrap> <em>port</em></td>
1185         </tr>
1186         <tr>
1187           <td></td>
1188           <td class="md">)&nbsp;</td>
1189           <td class="md" colspan="2"><code> [virtual]</code></td>
1190         </tr>
1191
1192       </table>
1193     </td>
1194   </tr>
1195 </table>
1196 <table cellspacing=5 cellpadding=0 border=0>
1197   <tr>
1198     <td>
1199       &nbsp;
1200     </td>
1201     <td>
1202
1203 <p>
1204 Called whenever an unknown token is received in a server to server link.
1205 <p>
1206 The token value is the unknown token -- please check that no other modules are using the token that you use. Returning 1 supresses the 'unknown token type' error which is usually sent to all opers with +s. The params list is a list of parameters, and if any parameters start with a colon (:) it is treated as the whole of the last parameter, identical to how RFC messages are handled. source is the sender of the message, and reply is what should be replied to for a unicast message. Note that there are not many messages in the mesh protocol which require unicast messaging. tcp_host is the server name as a string, ipaddr is its ip address in dotted decimal notation and port is the port number it is using.
1207 <p>
1208 Definition at line <a class="el" href="modules_8cpp-source.html#l00405">405</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1209 <p>
1210 <div class="fragment"><pre>00405 { <span class="keywordflow">return</span> 0; };
1211 </pre></div>    </td>
1212   </tr>
1213 </table>
1214 <a name="a16" doxytag="Module::OnOper"></a><p>
1215 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1216   <tr>
1217     <td class="mdRow">
1218       <table cellpadding="0" cellspacing="0" border="0">
1219         <tr>
1220           <td class="md" nowrap valign="top"> void Module::OnOper </td>
1221           <td class="md" valign="top">(&nbsp;</td>
1222           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
1223           <td class="mdname1" valign="top" nowrap> <em>user</em>          </td>
1224           <td class="md" valign="top">&nbsp;)&nbsp;</td>
1225           <td class="md" nowrap><code> [virtual]</code></td>
1226         </tr>
1227
1228       </table>
1229     </td>
1230   </tr>
1231 </table>
1232 <table cellspacing=5 cellpadding=0 border=0>
1233   <tr>
1234     <td>
1235       &nbsp;
1236     </td>
1237     <td>
1238
1239 <p>
1240 Called whenever a user opers locally.
1241 <p>
1242 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.
1243 <p>
1244 Definition at line <a class="el" href="modules_8cpp-source.html#l00375">375</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1245 <p>
1246 <div class="fragment"><pre>00375 { };
1247 </pre></div>    </td>
1248   </tr>
1249 </table>
1250 <a name="a47" doxytag="Module::OnOperCompare"></a><p>
1251 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1252   <tr>
1253     <td class="mdRow">
1254       <table cellpadding="0" cellspacing="0" border="0">
1255         <tr>
1256           <td class="md" nowrap valign="top"> int Module::OnOperCompare </td>
1257           <td class="md" valign="top">(&nbsp;</td>
1258           <td class="md" nowrap valign="top">std::string&nbsp;</td>
1259           <td class="mdname" nowrap> <em>password</em>, </td>
1260         </tr>
1261         <tr>
1262           <td></td>
1263           <td></td>
1264           <td class="md" nowrap>std::string&nbsp;</td>
1265           <td class="mdname" nowrap> <em>input</em></td>
1266         </tr>
1267         <tr>
1268           <td></td>
1269           <td class="md">)&nbsp;</td>
1270           <td class="md" colspan="2"><code> [virtual]</code></td>
1271         </tr>
1272
1273       </table>
1274     </td>
1275   </tr>
1276 </table>
1277 <table cellspacing=5 cellpadding=0 border=0>
1278   <tr>
1279     <td>
1280       &nbsp;
1281     </td>
1282     <td>
1283
1284 <p>
1285 Called whenever an oper password is to be compared to what a user has input.
1286 <p>
1287 The password field (from the config file) is in 'password' and is to be compared against 'input'. This method allows for encryption of oper passwords and much more besides. You should return a nonzero value if you want to allow the comparison or zero if you wish to do nothing.
1288 <p>
1289 Definition at line <a class="el" href="modules_8cpp-source.html#l00408">408</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1290 <p>
1291 <div class="fragment"><pre>00408 { <span class="keywordflow">return</span> 0; };
1292 </pre></div>    </td>
1293   </tr>
1294 </table>
1295 <a name="a9" doxytag="Module::OnPacketReceive"></a><p>
1296 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1297   <tr>
1298     <td class="mdRow">
1299       <table cellpadding="0" cellspacing="0" border="0">
1300         <tr>
1301           <td class="md" nowrap valign="top"> void Module::OnPacketReceive </td>
1302           <td class="md" valign="top">(&nbsp;</td>
1303           <td class="md" nowrap valign="top">std::string &amp;&nbsp;</td>
1304           <td class="mdname" nowrap> <em>data</em>, </td>
1305         </tr>
1306         <tr>
1307           <td></td>
1308           <td></td>
1309           <td class="md" nowrap>std::string&nbsp;</td>
1310           <td class="mdname" nowrap> <em>serv</em></td>
1311         </tr>
1312         <tr>
1313           <td></td>
1314           <td class="md">)&nbsp;</td>
1315           <td class="md" colspan="2"><code> [virtual]</code></td>
1316         </tr>
1317
1318       </table>
1319     </td>
1320   </tr>
1321 </table>
1322 <table cellspacing=5 cellpadding=0 border=0>
1323   <tr>
1324     <td>
1325       &nbsp;
1326     </td>
1327     <td>
1328
1329 <p>
1330 Called after a packet is received from another irc server.
1331 <p>
1332 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.
1333 <p>
1334 Definition at line <a class="el" href="modules_8cpp-source.html#l00369">369</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1335 <p>
1336 <div class="fragment"><pre>00369 { }
1337 </pre></div>    </td>
1338   </tr>
1339 </table>
1340 <a name="a8" doxytag="Module::OnPacketTransmit"></a><p>
1341 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1342   <tr>
1343     <td class="mdRow">
1344       <table cellpadding="0" cellspacing="0" border="0">
1345         <tr>
1346           <td class="md" nowrap valign="top"> void Module::OnPacketTransmit </td>
1347           <td class="md" valign="top">(&nbsp;</td>
1348           <td class="md" nowrap valign="top">std::string &amp;&nbsp;</td>
1349           <td class="mdname" nowrap> <em>data</em>, </td>
1350         </tr>
1351         <tr>
1352           <td></td>
1353           <td></td>
1354           <td class="md" nowrap>std::string&nbsp;</td>
1355           <td class="mdname" nowrap> <em>serv</em></td>
1356         </tr>
1357         <tr>
1358           <td></td>
1359           <td class="md">)&nbsp;</td>
1360           <td class="md" colspan="2"><code> [virtual]</code></td>
1361         </tr>
1362
1363       </table>
1364     </td>
1365   </tr>
1366 </table>
1367 <table cellspacing=5 cellpadding=0 border=0>
1368   <tr>
1369     <td>
1370       &nbsp;
1371     </td>
1372     <td>
1373
1374 <p>
1375 Called before a packet is transmitted across the irc network between two irc servers.
1376 <p>
1377 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.
1378 <p>
1379 Definition at line <a class="el" href="modules_8cpp-source.html#l00368">368</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1380 <p>
1381 <div class="fragment"><pre>00368 { }
1382 </pre></div>    </td>
1383   </tr>
1384 </table>
1385 <a name="a32" doxytag="Module::OnPreCommand"></a><p>
1386 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1387   <tr>
1388     <td class="mdRow">
1389       <table cellpadding="0" cellspacing="0" border="0">
1390         <tr>
1391           <td class="md" nowrap valign="top"> int Module::OnPreCommand </td>
1392           <td class="md" valign="top">(&nbsp;</td>
1393           <td class="md" nowrap valign="top">std::string&nbsp;</td>
1394           <td class="mdname" nowrap> <em>command</em>, </td>
1395         </tr>
1396         <tr>
1397           <td></td>
1398           <td></td>
1399           <td class="md" nowrap>char **&nbsp;</td>
1400           <td class="mdname" nowrap> <em>parameters</em>, </td>
1401         </tr>
1402         <tr>
1403           <td></td>
1404           <td></td>
1405           <td class="md" nowrap>int&nbsp;</td>
1406           <td class="mdname" nowrap> <em>pcnt</em>, </td>
1407         </tr>
1408         <tr>
1409           <td></td>
1410           <td></td>
1411           <td class="md" nowrap><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
1412           <td class="mdname" nowrap> <em>user</em></td>
1413         </tr>
1414         <tr>
1415           <td></td>
1416           <td class="md">)&nbsp;</td>
1417           <td class="md" colspan="2"><code> [virtual]</code></td>
1418         </tr>
1419
1420       </table>
1421     </td>
1422   </tr>
1423 </table>
1424 <table cellspacing=5 cellpadding=0 border=0>
1425   <tr>
1426     <td>
1427       &nbsp;
1428     </td>
1429     <td>
1430
1431 <p>
1432 Called whenever any command is about to be executed.
1433 <p>
1434 This event occurs for all registered commands, wether they are registered in the core, or another module, but it will not occur for invalid commands (e.g. ones which do not exist within the command table). By returning 1 from this method you may prevent the command being executed. If you do this, no output is created by the core, and it is down to your module to produce any output neccessary. Note that unless you return 1, you should not destroy any structures (e.g. by using <a class="el" href="classServer.html#a29">Server::QuitUser</a>) otherwise when the command's handler function executes after your method returns, it will be passed an invalid pointer to the user object and crash!)
1435 <p>
1436 Definition at line <a class="el" href="modules_8cpp-source.html#l00391">391</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1437 <p>
1438 <div class="fragment"><pre>00391 { <span class="keywordflow">return</span> 0; };
1439 </pre></div>    </td>
1440   </tr>
1441 </table>
1442 <a name="a35" doxytag="Module::OnRawMode"></a><p>
1443 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1444   <tr>
1445     <td class="mdRow">
1446       <table cellpadding="0" cellspacing="0" border="0">
1447         <tr>
1448           <td class="md" nowrap valign="top"> int Module::OnRawMode </td>
1449           <td class="md" valign="top">(&nbsp;</td>
1450           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
1451           <td class="mdname" nowrap> <em>user</em>, </td>
1452         </tr>
1453         <tr>
1454           <td></td>
1455           <td></td>
1456           <td class="md" nowrap><a class="el" href="classchanrec.html">chanrec</a> *&nbsp;</td>
1457           <td class="mdname" nowrap> <em>chan</em>, </td>
1458         </tr>
1459         <tr>
1460           <td></td>
1461           <td></td>
1462           <td class="md" nowrap>char&nbsp;</td>
1463           <td class="mdname" nowrap> <em>mode</em>, </td>
1464         </tr>
1465         <tr>
1466           <td></td>
1467           <td></td>
1468           <td class="md" nowrap>std::string&nbsp;</td>
1469           <td class="mdname" nowrap> <em>param</em>, </td>
1470         </tr>
1471         <tr>
1472           <td></td>
1473           <td></td>
1474           <td class="md" nowrap>bool&nbsp;</td>
1475           <td class="mdname" nowrap> <em>adding</em>, </td>
1476         </tr>
1477         <tr>
1478           <td></td>
1479           <td></td>
1480           <td class="md" nowrap>int&nbsp;</td>
1481           <td class="mdname" nowrap> <em>pcnt</em></td>
1482         </tr>
1483         <tr>
1484           <td></td>
1485           <td class="md">)&nbsp;</td>
1486           <td class="md" colspan="2"><code> [virtual]</code></td>
1487         </tr>
1488
1489       </table>
1490     </td>
1491   </tr>
1492 </table>
1493 <table cellspacing=5 cellpadding=0 border=0>
1494   <tr>
1495     <td>
1496       &nbsp;
1497     </td>
1498     <td>
1499
1500 <p>
1501 Called whenever a mode character is processed.
1502 <p>
1503 Return 1 from this function to block the mode character from being processed entirely, so that you may perform your own code instead. Note that this method allows you to override modes defined by other modes, but this is NOT RECOMMENDED!
1504 <p>
1505 Definition at line <a class="el" href="modules_8cpp-source.html#l00396">396</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1506 <p>
1507 <div class="fragment"><pre>00396 { <span class="keywordflow">return</span> 0; };
1508 </pre></div>    </td>
1509   </tr>
1510 </table>
1511 <a name="a10" doxytag="Module::OnRehash"></a><p>
1512 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1513   <tr>
1514     <td class="mdRow">
1515       <table cellpadding="0" cellspacing="0" border="0">
1516         <tr>
1517           <td class="md" nowrap valign="top"> void Module::OnRehash </td>
1518           <td class="md" valign="top">(&nbsp;</td>
1519           <td class="mdname1" valign="top" nowrap>          </td>
1520           <td class="md" valign="top">&nbsp;)&nbsp;</td>
1521           <td class="md" nowrap><code> [virtual]</code></td>
1522         </tr>
1523
1524       </table>
1525     </td>
1526   </tr>
1527 </table>
1528 <table cellspacing=5 cellpadding=0 border=0>
1529   <tr>
1530     <td>
1531       &nbsp;
1532     </td>
1533     <td>
1534
1535 <p>
1536 Called on rehash.
1537 <p>
1538 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.
1539 <p>
1540 Definition at line <a class="el" href="modules_8cpp-source.html#l00370">370</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1541 <p>
1542 <div class="fragment"><pre>00370 { }
1543 </pre></div>    </td>
1544   </tr>
1545 </table>
1546 <a name="a46" doxytag="Module::OnRequest"></a><p>
1547 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1548   <tr>
1549     <td class="mdRow">
1550       <table cellpadding="0" cellspacing="0" border="0">
1551         <tr>
1552           <td class="md" nowrap valign="top"> char * Module::OnRequest </td>
1553           <td class="md" valign="top">(&nbsp;</td>
1554           <td class="md" nowrap valign="top"><a class="el" href="classRequest.html">Request</a> *&nbsp;</td>
1555           <td class="mdname1" valign="top" nowrap> <em>request</em>          </td>
1556           <td class="md" valign="top">&nbsp;)&nbsp;</td>
1557           <td class="md" nowrap><code> [virtual]</code></td>
1558         </tr>
1559
1560       </table>
1561     </td>
1562   </tr>
1563 </table>
1564 <table cellspacing=5 cellpadding=0 border=0>
1565   <tr>
1566     <td>
1567       &nbsp;
1568     </td>
1569     <td>
1570
1571 <p>
1572 Called whenever a <a class="el" href="classRequest.html">Request</a> class is sent to your module by another module.
1573 <p>
1574 Please see the documentation of <a class="el" href="classRequest.html#a4">Request::Send()</a> for further information. The <a class="el" href="classRequest.html">Request</a> sent can always be assumed to be non-NULL, you should not change the request object or its data. Your method may return arbitary data in the char* result which the requesting module may be able to use for pre-determined purposes (e.g. the results of an SQL query, etc).
1575 <p>
1576 Definition at line <a class="el" href="modules_8cpp-source.html#l00407">407</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1577 <p>
1578 Referenced by <a class="el" href="modules_8cpp-source.html#l00325">Request::Send()</a>.
1579 <p>
1580 <div class="fragment"><pre>00407 { <span class="keywordflow">return</span> NULL; };
1581 </pre></div>    </td>
1582   </tr>
1583 </table>
1584 <a name="a31" doxytag="Module::OnSendList"></a><p>
1585 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1586   <tr>
1587     <td class="mdRow">
1588       <table cellpadding="0" cellspacing="0" border="0">
1589         <tr>
1590           <td class="md" nowrap valign="top"> void Module::OnSendList </td>
1591           <td class="md" valign="top">(&nbsp;</td>
1592           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
1593           <td class="mdname" nowrap> <em>user</em>, </td>
1594         </tr>
1595         <tr>
1596           <td></td>
1597           <td></td>
1598           <td class="md" nowrap><a class="el" href="classchanrec.html">chanrec</a> *&nbsp;</td>
1599           <td class="mdname" nowrap> <em>channel</em>, </td>
1600         </tr>
1601         <tr>
1602           <td></td>
1603           <td></td>
1604           <td class="md" nowrap>char&nbsp;</td>
1605           <td class="mdname" nowrap> <em>mode</em></td>
1606         </tr>
1607         <tr>
1608           <td></td>
1609           <td class="md">)&nbsp;</td>
1610           <td class="md" colspan="2"><code> [virtual]</code></td>
1611         </tr>
1612
1613       </table>
1614     </td>
1615   </tr>
1616 </table>
1617 <table cellspacing=5 cellpadding=0 border=0>
1618   <tr>
1619     <td>
1620       &nbsp;
1621     </td>
1622     <td>
1623
1624 <p>
1625 Called whenever a list is needed for a listmode.
1626 <p>
1627 For example, when a /MODE #channel +b (without any other parameters) is called, if a module was handling +b this function would be called. The function can then output any lists it wishes to. Please note that all modules will see all mode characters to provide the ability to extend each other, so please only output a list if the mode character given matches the one(s) you want to handle.
1628 <p>
1629 Definition at line <a class="el" href="modules_8cpp-source.html#l00390">390</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1630 <p>
1631 <div class="fragment"><pre>00390 { };
1632 </pre></div>    </td>
1633   </tr>
1634 </table>
1635 <a name="a11" doxytag="Module::OnServerRaw"></a><p>
1636 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1637   <tr>
1638     <td class="mdRow">
1639       <table cellpadding="0" cellspacing="0" border="0">
1640         <tr>
1641           <td class="md" nowrap valign="top"> void Module::OnServerRaw </td>
1642           <td class="md" valign="top">(&nbsp;</td>
1643           <td class="md" nowrap valign="top">std::string &amp;&nbsp;</td>
1644           <td class="mdname" nowrap> <em>raw</em>, </td>
1645         </tr>
1646         <tr>
1647           <td></td>
1648           <td></td>
1649           <td class="md" nowrap>bool&nbsp;</td>
1650           <td class="mdname" nowrap> <em>inbound</em>, </td>
1651         </tr>
1652         <tr>
1653           <td></td>
1654           <td></td>
1655           <td class="md" nowrap><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
1656           <td class="mdname" nowrap> <em>user</em></td>
1657         </tr>
1658         <tr>
1659           <td></td>
1660           <td class="md">)&nbsp;</td>
1661           <td class="md" colspan="2"><code> [virtual]</code></td>
1662         </tr>
1663
1664       </table>
1665     </td>
1666   </tr>
1667 </table>
1668 <table cellspacing=5 cellpadding=0 border=0>
1669   <tr>
1670     <td>
1671       &nbsp;
1672     </td>
1673     <td>
1674
1675 <p>
1676 Called when a raw command is transmitted or received.
1677 <p>
1678 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.
1679 <p>
1680 Definition at line <a class="el" href="modules_8cpp-source.html#l00371">371</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1681 <p>
1682 <div class="fragment"><pre>00371 { }
1683 </pre></div>    </td>
1684   </tr>
1685 </table>
1686 <a name="a40" doxytag="Module::OnStats"></a><p>
1687 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1688   <tr>
1689     <td class="mdRow">
1690       <table cellpadding="0" cellspacing="0" border="0">
1691         <tr>
1692           <td class="md" nowrap valign="top"> void Module::OnStats </td>
1693           <td class="md" valign="top">(&nbsp;</td>
1694           <td class="md" nowrap valign="top">char&nbsp;</td>
1695           <td class="mdname1" valign="top" nowrap> <em>symbol</em>          </td>
1696           <td class="md" valign="top">&nbsp;)&nbsp;</td>
1697           <td class="md" nowrap><code> [virtual]</code></td>
1698         </tr>
1699
1700       </table>
1701     </td>
1702   </tr>
1703 </table>
1704 <table cellspacing=5 cellpadding=0 border=0>
1705   <tr>
1706     <td>
1707       &nbsp;
1708     </td>
1709     <td>
1710
1711 <p>
1712 Called on all /STATS commands This method is triggered for all /STATS use, including stats symbols handled by the core.
1713 <p>
1714
1715 <p>
1716 Definition at line <a class="el" href="modules_8cpp-source.html#l00401">401</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1717 <p>
1718 <div class="fragment"><pre>00401 { };
1719 </pre></div>    </td>
1720   </tr>
1721 </table>
1722 <a name="a3" doxytag="Module::OnUserConnect"></a><p>
1723 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1724   <tr>
1725     <td class="mdRow">
1726       <table cellpadding="0" cellspacing="0" border="0">
1727         <tr>
1728           <td class="md" nowrap valign="top"> void Module::OnUserConnect </td>
1729           <td class="md" valign="top">(&nbsp;</td>
1730           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
1731           <td class="mdname1" valign="top" nowrap> <em>user</em>          </td>
1732           <td class="md" valign="top">&nbsp;)&nbsp;</td>
1733           <td class="md" nowrap><code> [virtual]</code></td>
1734         </tr>
1735
1736       </table>
1737     </td>
1738   </tr>
1739 </table>
1740 <table cellspacing=5 cellpadding=0 border=0>
1741   <tr>
1742     <td>
1743       &nbsp;
1744     </td>
1745     <td>
1746
1747 <p>
1748 Called when a user connects.
1749 <p>
1750 The details of the connecting user are available to you in the parameter userrec *user
1751 <p>
1752 Definition at line <a class="el" href="modules_8cpp-source.html#l00363">363</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1753 <p>
1754 <div class="fragment"><pre>00363 { }
1755 </pre></div>    </td>
1756   </tr>
1757 </table>
1758 <a name="a5" doxytag="Module::OnUserDisconnect"></a><p>
1759 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1760   <tr>
1761     <td class="mdRow">
1762       <table cellpadding="0" cellspacing="0" border="0">
1763         <tr>
1764           <td class="md" nowrap valign="top"> void Module::OnUserDisconnect </td>
1765           <td class="md" valign="top">(&nbsp;</td>
1766           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
1767           <td class="mdname1" valign="top" nowrap> <em>user</em>          </td>
1768           <td class="md" valign="top">&nbsp;)&nbsp;</td>
1769           <td class="md" nowrap><code> [virtual]</code></td>
1770         </tr>
1771
1772       </table>
1773     </td>
1774   </tr>
1775 </table>
1776 <table cellspacing=5 cellpadding=0 border=0>
1777   <tr>
1778     <td>
1779       &nbsp;
1780     </td>
1781     <td>
1782
1783 <p>
1784 Called whenever a user's socket is closed.
1785 <p>
1786 The details of the exiting user are available to you in the parameter userrec *user This event is called for all users, registered or not, as a cleanup method for modules which might assign resources to user, such as dns lookups, objects and sockets.
1787 <p>
1788 Definition at line <a class="el" href="modules_8cpp-source.html#l00365">365</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1789 <p>
1790 <div class="fragment"><pre>00365 { }
1791 </pre></div>    </td>
1792   </tr>
1793 </table>
1794 <a name="a6" doxytag="Module::OnUserJoin"></a><p>
1795 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1796   <tr>
1797     <td class="mdRow">
1798       <table cellpadding="0" cellspacing="0" border="0">
1799         <tr>
1800           <td class="md" nowrap valign="top"> void Module::OnUserJoin </td>
1801           <td class="md" valign="top">(&nbsp;</td>
1802           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
1803           <td class="mdname" nowrap> <em>user</em>, </td>
1804         </tr>
1805         <tr>
1806           <td></td>
1807           <td></td>
1808           <td class="md" nowrap><a class="el" href="classchanrec.html">chanrec</a> *&nbsp;</td>
1809           <td class="mdname" nowrap> <em>channel</em></td>
1810         </tr>
1811         <tr>
1812           <td></td>
1813           <td class="md">)&nbsp;</td>
1814           <td class="md" colspan="2"><code> [virtual]</code></td>
1815         </tr>
1816
1817       </table>
1818     </td>
1819   </tr>
1820 </table>
1821 <table cellspacing=5 cellpadding=0 border=0>
1822   <tr>
1823     <td>
1824       &nbsp;
1825     </td>
1826     <td>
1827
1828 <p>
1829 Called when a user joins a channel.
1830 <p>
1831 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
1832 <p>
1833 Definition at line <a class="el" href="modules_8cpp-source.html#l00366">366</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1834 <p>
1835 <div class="fragment"><pre>00366 { }
1836 </pre></div>    </td>
1837   </tr>
1838 </table>
1839 <a name="a15" doxytag="Module::OnUserKick"></a><p>
1840 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1841   <tr>
1842     <td class="mdRow">
1843       <table cellpadding="0" cellspacing="0" border="0">
1844         <tr>
1845           <td class="md" nowrap valign="top"> void Module::OnUserKick </td>
1846           <td class="md" valign="top">(&nbsp;</td>
1847           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
1848           <td class="mdname" nowrap> <em>source</em>, </td>
1849         </tr>
1850         <tr>
1851           <td></td>
1852           <td></td>
1853           <td class="md" nowrap><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
1854           <td class="mdname" nowrap> <em>user</em>, </td>
1855         </tr>
1856         <tr>
1857           <td></td>
1858           <td></td>
1859           <td class="md" nowrap><a class="el" href="classchanrec.html">chanrec</a> *&nbsp;</td>
1860           <td class="mdname" nowrap> <em>chan</em>, </td>
1861         </tr>
1862         <tr>
1863           <td></td>
1864           <td></td>
1865           <td class="md" nowrap>std::string&nbsp;</td>
1866           <td class="mdname" nowrap> <em>reason</em></td>
1867         </tr>
1868         <tr>
1869           <td></td>
1870           <td class="md">)&nbsp;</td>
1871           <td class="md" colspan="2"><code> [virtual]</code></td>
1872         </tr>
1873
1874       </table>
1875     </td>
1876   </tr>
1877 </table>
1878 <table cellspacing=5 cellpadding=0 border=0>
1879   <tr>
1880     <td>
1881       &nbsp;
1882     </td>
1883     <td>
1884
1885 <p>
1886 Called whenever a user is kicked.
1887 <p>
1888 If this method is called, the kick is already underway and cannot be prevented, so to prevent a kick, please use <a class="el" href="classModule.html#a14">Module::OnUserPreKick</a> instead of this method.
1889 <p>
1890 Definition at line <a class="el" href="modules_8cpp-source.html#l00395">395</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1891 <p>
1892 <div class="fragment"><pre>00395 { };
1893 </pre></div>    </td>
1894   </tr>
1895 </table>
1896 <a name="a7" doxytag="Module::OnUserPart"></a><p>
1897 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1898   <tr>
1899     <td class="mdRow">
1900       <table cellpadding="0" cellspacing="0" border="0">
1901         <tr>
1902           <td class="md" nowrap valign="top"> void Module::OnUserPart </td>
1903           <td class="md" valign="top">(&nbsp;</td>
1904           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
1905           <td class="mdname" nowrap> <em>user</em>, </td>
1906         </tr>
1907         <tr>
1908           <td></td>
1909           <td></td>
1910           <td class="md" nowrap><a class="el" href="classchanrec.html">chanrec</a> *&nbsp;</td>
1911           <td class="mdname" nowrap> <em>channel</em></td>
1912         </tr>
1913         <tr>
1914           <td></td>
1915           <td class="md">)&nbsp;</td>
1916           <td class="md" colspan="2"><code> [virtual]</code></td>
1917         </tr>
1918
1919       </table>
1920     </td>
1921   </tr>
1922 </table>
1923 <table cellspacing=5 cellpadding=0 border=0>
1924   <tr>
1925     <td>
1926       &nbsp;
1927     </td>
1928     <td>
1929
1930 <p>
1931 Called when a user parts a channel.
1932 <p>
1933 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
1934 <p>
1935 Definition at line <a class="el" href="modules_8cpp-source.html#l00367">367</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1936 <p>
1937 <div class="fragment"><pre>00367 { }
1938 </pre></div>    </td>
1939   </tr>
1940 </table>
1941 <a name="a23" doxytag="Module::OnUserPostNick"></a><p>
1942 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1943   <tr>
1944     <td class="mdRow">
1945       <table cellpadding="0" cellspacing="0" border="0">
1946         <tr>
1947           <td class="md" nowrap valign="top"> void Module::OnUserPostNick </td>
1948           <td class="md" valign="top">(&nbsp;</td>
1949           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
1950           <td class="mdname" nowrap> <em>user</em>, </td>
1951         </tr>
1952         <tr>
1953           <td></td>
1954           <td></td>
1955           <td class="md" nowrap>std::string&nbsp;</td>
1956           <td class="mdname" nowrap> <em>oldnick</em></td>
1957         </tr>
1958         <tr>
1959           <td></td>
1960           <td class="md">)&nbsp;</td>
1961           <td class="md" colspan="2"><code> [virtual]</code></td>
1962         </tr>
1963
1964       </table>
1965     </td>
1966   </tr>
1967 </table>
1968 <table cellspacing=5 cellpadding=0 border=0>
1969   <tr>
1970     <td>
1971       &nbsp;
1972     </td>
1973     <td>
1974
1975 <p>
1976 Called after any nickchange, local or remote.
1977 <p>
1978 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.
1979 <p>
1980 Definition at line <a class="el" href="modules_8cpp-source.html#l00382">382</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1981 <p>
1982 <div class="fragment"><pre>00382 { };
1983 </pre></div>    </td>
1984   </tr>
1985 </table>
1986 <a name="a19" doxytag="Module::OnUserPreInvite"></a><p>
1987 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1988   <tr>
1989     <td class="mdRow">
1990       <table cellpadding="0" cellspacing="0" border="0">
1991         <tr>
1992           <td class="md" nowrap valign="top"> int Module::OnUserPreInvite </td>
1993           <td class="md" valign="top">(&nbsp;</td>
1994           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
1995           <td class="mdname" nowrap> <em>source</em>, </td>
1996         </tr>
1997         <tr>
1998           <td></td>
1999           <td></td>
2000           <td class="md" nowrap><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
2001           <td class="mdname" nowrap> <em>dest</em>, </td>
2002         </tr>
2003         <tr>
2004           <td></td>
2005           <td></td>
2006           <td class="md" nowrap><a class="el" href="classchanrec.html">chanrec</a> *&nbsp;</td>
2007           <td class="mdname" nowrap> <em>channel</em></td>
2008         </tr>
2009         <tr>
2010           <td></td>
2011           <td class="md">)&nbsp;</td>
2012           <td class="md" colspan="2"><code> [virtual]</code></td>
2013         </tr>
2014
2015       </table>
2016     </td>
2017   </tr>
2018 </table>
2019 <table cellspacing=5 cellpadding=0 border=0>
2020   <tr>
2021     <td>
2022       &nbsp;
2023     </td>
2024     <td>
2025
2026 <p>
2027 Called whenever a user is about to invite another user into a channel, before any processing is done.
2028 <p>
2029 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.
2030 <p>
2031 Definition at line <a class="el" href="modules_8cpp-source.html#l00378">378</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
2032 <p>
2033 <div class="fragment"><pre>00378 { <span class="keywordflow">return</span> 0; };
2034 </pre></div>    </td>
2035   </tr>
2036 </table>
2037 <a name="a13" doxytag="Module::OnUserPreJoin"></a><p>
2038 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
2039   <tr>
2040     <td class="mdRow">
2041       <table cellpadding="0" cellspacing="0" border="0">
2042         <tr>
2043           <td class="md" nowrap valign="top"> int Module::OnUserPreJoin </td>
2044           <td class="md" valign="top">(&nbsp;</td>
2045           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
2046           <td class="mdname" nowrap> <em>user</em>, </td>
2047         </tr>
2048         <tr>
2049           <td></td>
2050           <td></td>
2051           <td class="md" nowrap><a class="el" href="classchanrec.html">chanrec</a> *&nbsp;</td>
2052           <td class="mdname" nowrap> <em>chan</em>, </td>
2053         </tr>
2054         <tr>
2055           <td></td>
2056           <td></td>
2057           <td class="md" nowrap>const char *&nbsp;</td>
2058           <td class="mdname" nowrap> <em>cname</em></td>
2059         </tr>
2060         <tr>
2061           <td></td>
2062           <td class="md">)&nbsp;</td>
2063           <td class="md" colspan="2"><code> [virtual]</code></td>
2064         </tr>
2065
2066       </table>
2067     </td>
2068   </tr>
2069 </table>
2070 <table cellspacing=5 cellpadding=0 border=0>
2071   <tr>
2072     <td>
2073       &nbsp;
2074     </td>
2075     <td>
2076
2077 <p>
2078 Called whenever a user is about to join a channel, before any processing is done.
2079 <p>
2080 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>
2081 IMPORTANT NOTE!<p>
2082 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.
2083 <p>
2084 Definition at line <a class="el" href="modules_8cpp-source.html#l00372">372</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
2085 <p>
2086 <div class="fragment"><pre>00372 { <span class="keywordflow">return</span> 0; }
2087 </pre></div>    </td>
2088   </tr>
2089 </table>
2090 <a name="a14" doxytag="Module::OnUserPreKick"></a><p>
2091 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
2092   <tr>
2093     <td class="mdRow">
2094       <table cellpadding="0" cellspacing="0" border="0">
2095         <tr>
2096           <td class="md" nowrap valign="top"> int Module::OnUserPreKick </td>
2097           <td class="md" valign="top">(&nbsp;</td>
2098           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
2099           <td class="mdname" nowrap> <em>source</em>, </td>
2100         </tr>
2101         <tr>
2102           <td></td>
2103           <td></td>
2104           <td class="md" nowrap><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
2105           <td class="mdname" nowrap> <em>user</em>, </td>
2106         </tr>
2107         <tr>
2108           <td></td>
2109           <td></td>
2110           <td class="md" nowrap><a class="el" href="classchanrec.html">chanrec</a> *&nbsp;</td>
2111           <td class="mdname" nowrap> <em>chan</em>, </td>
2112         </tr>
2113         <tr>
2114           <td></td>
2115           <td></td>
2116           <td class="md" nowrap>std::string&nbsp;</td>
2117           <td class="mdname" nowrap> <em>reason</em></td>
2118         </tr>
2119         <tr>
2120           <td></td>
2121           <td class="md">)&nbsp;</td>
2122           <td class="md" colspan="2"><code> [virtual]</code></td>
2123         </tr>
2124
2125       </table>
2126     </td>
2127   </tr>
2128 </table>
2129 <table cellspacing=5 cellpadding=0 border=0>
2130   <tr>
2131     <td>
2132       &nbsp;
2133     </td>
2134     <td>
2135
2136 <p>
2137 Called whenever a user is about to be kicked.
2138 <p>
2139 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.
2140 <p>
2141 Definition at line <a class="el" href="modules_8cpp-source.html#l00394">394</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
2142 <p>
2143 <div class="fragment"><pre>00394 { <span class="keywordflow">return</span> 0; };
2144 </pre></div>    </td>
2145   </tr>
2146 </table>
2147 <a name="a20" doxytag="Module::OnUserPreMessage"></a><p>
2148 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
2149   <tr>
2150     <td class="mdRow">
2151       <table cellpadding="0" cellspacing="0" border="0">
2152         <tr>
2153           <td class="md" nowrap valign="top"> int Module::OnUserPreMessage </td>
2154           <td class="md" valign="top">(&nbsp;</td>
2155           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
2156           <td class="mdname" nowrap> <em>user</em>, </td>
2157         </tr>
2158         <tr>
2159           <td></td>
2160           <td></td>
2161           <td class="md" nowrap>void *&nbsp;</td>
2162           <td class="mdname" nowrap> <em>dest</em>, </td>
2163         </tr>
2164         <tr>
2165           <td></td>
2166           <td></td>
2167           <td class="md" nowrap>int&nbsp;</td>
2168           <td class="mdname" nowrap> <em>target_type</em>, </td>
2169         </tr>
2170         <tr>
2171           <td></td>
2172           <td></td>
2173           <td class="md" nowrap>std::string &amp;&nbsp;</td>
2174           <td class="mdname" nowrap> <em>text</em></td>
2175         </tr>
2176         <tr>
2177           <td></td>
2178           <td class="md">)&nbsp;</td>
2179           <td class="md" colspan="2"><code> [virtual]</code></td>
2180         </tr>
2181
2182       </table>
2183     </td>
2184   </tr>
2185 </table>
2186 <table cellspacing=5 cellpadding=0 border=0>
2187   <tr>
2188     <td>
2189       &nbsp;
2190     </td>
2191     <td>
2192
2193 <p>
2194 Called whenever a user is about to PRIVMSG A user or a channel, before any processing is done.
2195 <p>
2196 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.
2197 <p>
2198 Definition at line <a class="el" href="modules_8cpp-source.html#l00379">379</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
2199 <p>
2200 <div class="fragment"><pre>00379 { <span class="keywordflow">return</span> 0; };
2201 </pre></div>    </td>
2202   </tr>
2203 </table>
2204 <a name="a22" doxytag="Module::OnUserPreNick"></a><p>
2205 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
2206   <tr>
2207     <td class="mdRow">
2208       <table cellpadding="0" cellspacing="0" border="0">
2209         <tr>
2210           <td class="md" nowrap valign="top"> int Module::OnUserPreNick </td>
2211           <td class="md" valign="top">(&nbsp;</td>
2212           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
2213           <td class="mdname" nowrap> <em>user</em>, </td>
2214         </tr>
2215         <tr>
2216           <td></td>
2217           <td></td>
2218           <td class="md" nowrap>std::string&nbsp;</td>
2219           <td class="mdname" nowrap> <em>newnick</em></td>
2220         </tr>
2221         <tr>
2222           <td></td>
2223           <td class="md">)&nbsp;</td>
2224           <td class="md" colspan="2"><code> [virtual]</code></td>
2225         </tr>
2226
2227       </table>
2228     </td>
2229   </tr>
2230 </table>
2231 <table cellspacing=5 cellpadding=0 border=0>
2232   <tr>
2233     <td>
2234       &nbsp;
2235     </td>
2236     <td>
2237
2238 <p>
2239 Called before any nickchange, local or remote.
2240 <p>
2241 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.
2242 <p>
2243 Definition at line <a class="el" href="modules_8cpp-source.html#l00381">381</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
2244 <p>
2245 <div class="fragment"><pre>00381 { <span class="keywordflow">return</span> 0; };
2246 </pre></div>    </td>
2247   </tr>
2248 </table>
2249 <a name="a21" doxytag="Module::OnUserPreNotice"></a><p>
2250 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
2251   <tr>
2252     <td class="mdRow">
2253       <table cellpadding="0" cellspacing="0" border="0">
2254         <tr>
2255           <td class="md" nowrap valign="top"> int Module::OnUserPreNotice </td>
2256           <td class="md" valign="top">(&nbsp;</td>
2257           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
2258           <td class="mdname" nowrap> <em>user</em>, </td>
2259         </tr>
2260         <tr>
2261           <td></td>
2262           <td></td>
2263           <td class="md" nowrap>void *&nbsp;</td>
2264           <td class="mdname" nowrap> <em>dest</em>, </td>
2265         </tr>
2266         <tr>
2267           <td></td>
2268           <td></td>
2269           <td class="md" nowrap>int&nbsp;</td>
2270           <td class="mdname" nowrap> <em>target_type</em>, </td>
2271         </tr>
2272         <tr>
2273           <td></td>
2274           <td></td>
2275           <td class="md" nowrap>std::string &amp;&nbsp;</td>
2276           <td class="mdname" nowrap> <em>text</em></td>
2277         </tr>
2278         <tr>
2279           <td></td>
2280           <td class="md">)&nbsp;</td>
2281           <td class="md" colspan="2"><code> [virtual]</code></td>
2282         </tr>
2283
2284       </table>
2285     </td>
2286   </tr>
2287 </table>
2288 <table cellspacing=5 cellpadding=0 border=0>
2289   <tr>
2290     <td>
2291       &nbsp;
2292     </td>
2293     <td>
2294
2295 <p>
2296 Called whenever a user is about to NOTICE A user or a channel, before any processing is done.
2297 <p>
2298 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.
2299 <p>
2300 Definition at line <a class="el" href="modules_8cpp-source.html#l00380">380</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
2301 <p>
2302 <div class="fragment"><pre>00380 { <span class="keywordflow">return</span> 0; };
2303 </pre></div>    </td>
2304   </tr>
2305 </table>
2306 <a name="a4" doxytag="Module::OnUserQuit"></a><p>
2307 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
2308   <tr>
2309     <td class="mdRow">
2310       <table cellpadding="0" cellspacing="0" border="0">
2311         <tr>
2312           <td class="md" nowrap valign="top"> void Module::OnUserQuit </td>
2313           <td class="md" valign="top">(&nbsp;</td>
2314           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
2315           <td class="mdname1" valign="top" nowrap> <em>user</em>          </td>
2316           <td class="md" valign="top">&nbsp;)&nbsp;</td>
2317           <td class="md" nowrap><code> [virtual]</code></td>
2318         </tr>
2319
2320       </table>
2321     </td>
2322   </tr>
2323 </table>
2324 <table cellspacing=5 cellpadding=0 border=0>
2325   <tr>
2326     <td>
2327       &nbsp;
2328     </td>
2329     <td>
2330
2331 <p>
2332 Called when a user quits.
2333 <p>
2334 The details of the exiting user are available to you in the parameter userrec *user This event is only called when the user is fully registered when they quit. To catch raw disconnections, use the OnUserDisconnect method.
2335 <p>
2336 Definition at line <a class="el" href="modules_8cpp-source.html#l00364">364</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
2337 <p>
2338 <div class="fragment"><pre>00364 { }
2339 </pre></div>    </td>
2340   </tr>
2341 </table>
2342 <a name="a34" doxytag="Module::OnUserRegister"></a><p>
2343 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
2344   <tr>
2345     <td class="mdRow">
2346       <table cellpadding="0" cellspacing="0" border="0">
2347         <tr>
2348           <td class="md" nowrap valign="top"> void Module::OnUserRegister </td>
2349           <td class="md" valign="top">(&nbsp;</td>
2350           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
2351           <td class="mdname1" valign="top" nowrap> <em>user</em>          </td>
2352           <td class="md" valign="top">&nbsp;)&nbsp;</td>
2353           <td class="md" nowrap><code> [virtual]</code></td>
2354         </tr>
2355
2356       </table>
2357     </td>
2358   </tr>
2359 </table>
2360 <table cellspacing=5 cellpadding=0 border=0>
2361   <tr>
2362     <td>
2363       &nbsp;
2364     </td>
2365     <td>
2366
2367 <p>
2368 Called whenever a user is about to register their connection (e.g.
2369 <p>
2370 before the user is sent the MOTD etc). Modules can use this method if they are performing a function which must be done before the actual connection is completed (e.g. ident lookups, dnsbl lookups, etc). Note that you should NOT delete the user record here by causing a disconnection! Use OnUserConnect for that instead.
2371 <p>
2372 Definition at line <a class="el" href="modules_8cpp-source.html#l00393">393</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
2373 <p>
2374 <div class="fragment"><pre>00393 { };
2375 </pre></div>    </td>
2376   </tr>
2377 </table>
2378 <a name="a25" doxytag="Module::OnUserSync"></a><p>
2379 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
2380   <tr>
2381     <td class="mdRow">
2382       <table cellpadding="0" cellspacing="0" border="0">
2383         <tr>
2384           <td class="md" nowrap valign="top"> <a class="el" href="modules_8h.html#a32">string_list</a> Module::OnUserSync </td>
2385           <td class="md" valign="top">(&nbsp;</td>
2386           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
2387           <td class="mdname1" valign="top" nowrap> <em>user</em>          </td>
2388           <td class="md" valign="top">&nbsp;)&nbsp;</td>
2389           <td class="md" nowrap><code> [virtual]</code></td>
2390         </tr>
2391
2392       </table>
2393     </td>
2394   </tr>
2395 </table>
2396 <table cellspacing=5 cellpadding=0 border=0>
2397   <tr>
2398     <td>
2399       &nbsp;
2400     </td>
2401     <td>
2402
2403 <p>
2404 Called during a netburst to sync user data.
2405 <p>
2406 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.
2407 <p>
2408 Definition at line <a class="el" href="modules_8cpp-source.html#l00384">384</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
2409 <p>
2410 References <a class="el" href="modules_8h-source.html#l00068">string_list</a>.
2411 <p>
2412 <div class="fragment"><pre>00384 { <a class="code" href="modules_8h.html#a32">string_list</a> empty; <span class="keywordflow">return</span> empty; }
2413 </pre></div>    </td>
2414   </tr>
2415 </table>
2416 <a name="a18" doxytag="Module::OnWhois"></a><p>
2417 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
2418   <tr>
2419     <td class="mdRow">
2420       <table cellpadding="0" cellspacing="0" border="0">
2421         <tr>
2422           <td class="md" nowrap valign="top"> void Module::OnWhois </td>
2423           <td class="md" valign="top">(&nbsp;</td>
2424           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
2425           <td class="mdname" nowrap> <em>source</em>, </td>
2426         </tr>
2427         <tr>
2428           <td></td>
2429           <td></td>
2430           <td class="md" nowrap><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
2431           <td class="mdname" nowrap> <em>dest</em></td>
2432         </tr>
2433         <tr>
2434           <td></td>
2435           <td class="md">)&nbsp;</td>
2436           <td class="md" colspan="2"><code> [virtual]</code></td>
2437         </tr>
2438
2439       </table>
2440     </td>
2441   </tr>
2442 </table>
2443 <table cellspacing=5 cellpadding=0 border=0>
2444   <tr>
2445     <td>
2446       &nbsp;
2447     </td>
2448     <td>
2449
2450 <p>
2451 Called whenever a /WHOIS is performed on a local user.
2452 <p>
2453 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.
2454 <p>
2455 Definition at line <a class="el" href="modules_8cpp-source.html#l00377">377</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
2456 <p>
2457 <div class="fragment"><pre>00377 { };
2458 </pre></div>    </td>
2459   </tr>
2460 </table>
2461 <hr>The documentation for this class was generated from the following files:<ul>
2462 <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>
2463 <hr size="1"><address style="align: right;"><small>Generated on Tue Apr 26 17:11:49 2005 for InspIRCd by
2464 <a href="http://www.doxygen.org/index.html">
2465 <img src="doxygen.png" alt="doxygen" align="middle" border=0 >
2466 </a>1.3.3 </small></address>
2467 </body>
2468 </html>