docs/module-doc/classModule.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
   2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
   3 <title>InspIRCd: Module class Reference</title>
   4 <link href="inspircd.css" rel="stylesheet" type="text/css">
   5 </head><body>
   6 <!-- Generated by Doxygen 1.3.3 -->
   7 <div class="qindex"><a class="qindex" href="main.html">Main&nbsp;Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class&nbsp;Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical&nbsp;List</a> | <a class="qindex" href="annotated.html">Compound&nbsp;List</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="functions.html">Compound&nbsp;Members</a> | <a class="qindex" href="globals.html">File&nbsp;Members</a></div>
   8 <h1>Module Class Reference</h1>Base class for all InspIRCd modules This class is the base class for InspIRCd modules.
   9 <a href="#_details">More...</a>
  10 <p>
  11 <code>#include &lt;<a class="el" href="modules_8h-source.html">modules.h</a>&gt;</code>
  12 <p>
  13 Inherits <a class="el" href="classclassbase.html">classbase</a>.
  14 <p>
  15 <a href="classModule-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
  16 <tr><td></td></tr>
  17 <tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
  18 <tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a0">Module</a> ()</td></tr>
  19
  20 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor creates a module class. </em> <a href="#a0"></a><em><br><br></td></tr>
  21 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a1">~Module</a> ()</td></tr>
  22
  23 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default destructor destroys a module class. </em> <a href="#a1"></a><em><br><br></td></tr>
  24 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="classVersion.html">Version</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a2">GetVersion</a> ()</td></tr>
  25
  26 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the version number of a Module. </em> <a href="#a2"></a><em><br><br></td></tr>
  27 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a3">OnUserConnect</a> (<a class="el" href="classuserrec.html">userrec</a> *user)</td></tr>
  28
  29 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called when a user connects. </em> <a href="#a3"></a><em><br><br></td></tr>
  30 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a4">OnUserQuit</a> (<a class="el" href="classuserrec.html">userrec</a> *user)</td></tr>
  31
  32 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called when a user quits. </em> <a href="#a4"></a><em><br><br></td></tr>
  33 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a5">OnUserJoin</a> (<a class="el" href="classuserrec.html">userrec</a> *user, <a class="el" href="classchanrec.html">chanrec</a> *channel)</td></tr>
  34
  35 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called when a user joins a channel. </em> <a href="#a5"></a><em><br><br></td></tr>
  36 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a6">OnUserPart</a> (<a class="el" href="classuserrec.html">userrec</a> *user, <a class="el" href="classchanrec.html">chanrec</a> *channel)</td></tr>
  37
  38 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called when a user parts a channel. </em> <a href="#a6"></a><em><br><br></td></tr>
  39 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a7">OnPacketTransmit</a> (std::string &amp;data, std::string serv)</td></tr>
  40
  41 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called before a packet is transmitted across the irc network between two irc servers. </em> <a href="#a7"></a><em><br><br></td></tr>
  42 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a8">OnPacketReceive</a> (std::string &amp;data, std::string serv)</td></tr>
  43
  44 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called after a packet is received from another irc server. </em> <a href="#a8"></a><em><br><br></td></tr>
  45 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a9">OnRehash</a> ()</td></tr>
  46
  47 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called on rehash. </em> <a href="#a9"></a><em><br><br></td></tr>
  48 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a10">OnServerRaw</a> (std::string &amp;raw, bool inbound, <a class="el" href="classuserrec.html">userrec</a> *user)</td></tr>
  49
  50 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called when a raw command is transmitted or received. </em> <a href="#a10"></a><em><br><br></td></tr>
  51 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual int&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a11">OnExtendedMode</a> (<a class="el" href="classuserrec.html">userrec</a> *user, void *target, char modechar, int type, bool mode_on, <a class="el" href="modules_8h.html#a32">string_list</a> &amp;params)</td></tr>
  52
  53 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called whenever an extended mode is to be processed. </em> <a href="#a11"></a><em><br><br></td></tr>
  54 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual int&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a12">OnUserPreJoin</a> (<a class="el" href="classuserrec.html">userrec</a> *user, <a class="el" href="classchanrec.html">chanrec</a> *chan, const char *cname)</td></tr>
  55
  56 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called whenever a user is about to join a channel, before any processing is done. </em> <a href="#a12"></a><em><br><br></td></tr>
  57 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual int&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a13">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>
  58
  59 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called whenever a user is about to be kicked. </em> <a href="#a13"></a><em><br><br></td></tr>
  60 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a14">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>
  61
  62 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called whenever a user is 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">OnOper</a> (<a class="el" href="classuserrec.html">userrec</a> *user)</td></tr>
  64
  65 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called whenever a user opers locally. </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">OnInfo</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 types /INFO. </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">OnWhois</a> (<a class="el" href="classuserrec.html">userrec</a> *source, <a class="el" href="classuserrec.html">userrec</a> *dest)</td></tr>
  70
  71 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called whenever a /WHOIS is performed on a local user. </em> <a href="#a17"></a><em><br><br></td></tr>
  72 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual int&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a18">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>
  73
  74 <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="#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">OnUserPreMessage</a> (<a class="el" href="classuserrec.html">userrec</a> *user, void *dest, int target_type, std::string &amp;text)</td></tr>
  76
  77 <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="#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">OnUserPreNotice</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 NOTICE 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">OnUserPreNick</a> (<a class="el" href="classuserrec.html">userrec</a> *user, std::string newnick)</td></tr>
  82
  83 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called before any nickchange, local or remote. </em> <a href="#a21"></a><em><br><br></td></tr>
  84 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a22">OnUserPostNick</a> (<a class="el" href="classuserrec.html">userrec</a> *user, std::string oldnick)</td></tr>
  85
  86 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called after 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 int&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a23">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>
  88
  89 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called before an action which requires a channel privilage check. </em> <a href="#a23"></a><em><br><br></td></tr>
  90 <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#a24">OnUserSync</a> (<a class="el" href="classuserrec.html">userrec</a> *user)</td></tr>
  91
  92 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called during a netburst to sync user data. </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">OnChannelSync</a> (<a class="el" href="classchanrec.html">chanrec</a> *chan)</td></tr>
  94
  95 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called during a netburst to sync channel data. </em> <a href="#a25"></a><em><br><br></td></tr>
  96 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a26">On005Numeric</a> (std::string &amp;output)</td></tr>
  97
  98 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called when a 005 numeric is about to be output. </em> <a href="#a26"></a><em><br><br></td></tr>
  99 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual int&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a27">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>
 100
 101 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called when a client is disconnected by KILL. </em> <a href="#a27"></a><em><br><br></td></tr>
 102 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a28">OnLoadModule</a> (<a class="el" href="classModule.html">Module</a> *mod, std::string name)</td></tr>
 103
 104 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called whenever a module is loaded. </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">OnBackgroundTimer</a> (time_t curtime)</td></tr>
 106
 107 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called once every five seconds for background processing. </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">OnSendList</a> (<a class="el" href="classuserrec.html">userrec</a> *user, <a class="el" href="classchanrec.html">chanrec</a> *channel, char mode)</td></tr>
 109
 110 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called whenever a list is needed for a listmode. </em> <a href="#a30"></a><em><br><br></td></tr>
 111 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual int&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a31">OnPreCommand</a> (std::string command, char **parameters, int pcnt, <a class="el" href="classuserrec.html">userrec</a> *user)</td></tr>
 112
 113 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called whenever any command is about to be executed. </em> <a href="#a31"></a><em><br><br></td></tr>
 114 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a32">OnCheckReady</a> (<a class="el" href="classuserrec.html">userrec</a> *user)</td></tr>
 115
 116 <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="#a32"></a><em><br><br></td></tr>
 117 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a33">OnUserRegister</a> (<a class="el" href="classuserrec.html">userrec</a> *user)</td></tr>
 118
 119 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called whenever a user is about to register their connection (e.g. </em> <a href="#a33"></a><em><br><br></td></tr>
 120 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual int&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a34">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>
 121
 122 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called whenever a mode character is processed. </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">OnCheckInvite</a> (<a class="el" href="classuserrec.html">userrec</a> *user, <a class="el" href="classchanrec.html">chanrec</a> *chan)</td></tr>
 124
 125 <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="#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">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>
 127
 128 <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="#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">OnCheckLimit</a> (<a class="el" href="classuserrec.html">userrec</a> *user, <a class="el" href="classchanrec.html">chanrec</a> *chan)</td></tr>
 130
 131 <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="#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">OnCheckBan</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 banlist 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 void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a39">OnStats</a> (char symbol)</td></tr>
 136
 137 <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="#a39"></a><em><br><br></td></tr>
 138 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual int&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a40">OnChangeLocalUserHost</a> (<a class="el" href="classuserrec.html">userrec</a> *user, std::string newhost)</td></tr>
 139
 140 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called whenever a change of a local users displayed host is attempted. </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">OnChangeLocalUserGECOS</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 GECOS (fullname field) 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">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>
 145
 146 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called whenever a topic is changed by a local user. </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">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>
 148
 149 <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="#a43"></a><em><br><br></td></tr>
 150 </table>
 151 <hr><a name="_details"></a><h2>Detailed Description</h2>
 152 Base class for all InspIRCd modules This class is the base class for InspIRCd modules.
 153 <p>
 154 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.
 155 <p>
 156
 157 <p>
 158 Definition at line <a class="el" href="modules_8h-source.html#l00135">135</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
 159 <a name="a0" doxytag="Module::Module"></a><p>
 160 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 161   <tr>
 162     <td class="mdRow">
 163       <table cellpadding="0" cellspacing="0" border="0">
 164         <tr>
 165           <td class="md" nowrap valign="top"> Module::Module </td>
 166           <td class="md" valign="top">(&nbsp;</td>
 167           <td class="mdname1" valign="top" nowrap>          </td>
 168           <td class="md" valign="top">&nbsp;)&nbsp;</td>
 169           <td class="md" nowrap></td>
 170         </tr>
 171
 172       </table>
 173     </td>
 174   </tr>
 175 </table>
 176 <table cellspacing=5 cellpadding=0 border=0>
 177   <tr>
 178     <td>
 179       &nbsp;
 180     </td>
 181     <td>
 182
 183 <p>
 184 Default constructor creates a module class.
 185 <p>
 186
 187 <p>
 188 Definition at line <a class="el" href="modules_8cpp-source.html#l00306">306</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 189 <p>
 190 <div class="fragment"><pre>00306 { }
 191 </pre></div>    </td>
 192   </tr>
 193 </table>
 194 <a name="a1" doxytag="Module::~Module"></a><p>
 195 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 196   <tr>
 197     <td class="mdRow">
 198       <table cellpadding="0" cellspacing="0" border="0">
 199         <tr>
 200           <td class="md" nowrap valign="top"> Module::~<a class="el" href="classModule.html">Module</a> </td>
 201           <td class="md" valign="top">(&nbsp;</td>
 202           <td class="mdname1" valign="top" nowrap>          </td>
 203           <td class="md" valign="top">&nbsp;)&nbsp;</td>
 204           <td class="md" nowrap><code> [virtual]</code></td>
 205         </tr>
 206
 207       </table>
 208     </td>
 209   </tr>
 210 </table>
 211 <table cellspacing=5 cellpadding=0 border=0>
 212   <tr>
 213     <td>
 214       &nbsp;
 215     </td>
 216     <td>
 217
 218 <p>
 219 Default destructor destroys a module class.
 220 <p>
 221
 222 <p>
 223 Definition at line <a class="el" href="modules_8cpp-source.html#l00307">307</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 224 <p>
 225 <div class="fragment"><pre>00307 { }
 226 </pre></div>    </td>
 227   </tr>
 228 </table>
 229 <hr><h2>Member Function Documentation</h2>
 230 <a name="a2" doxytag="Module::GetVersion"></a><p>
 231 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 232   <tr>
 233     <td class="mdRow">
 234       <table cellpadding="0" cellspacing="0" border="0">
 235         <tr>
 236           <td class="md" nowrap valign="top"> <a class="el" href="classVersion.html">Version</a> Module::GetVersion </td>
 237           <td class="md" valign="top">(&nbsp;</td>
 238           <td class="mdname1" valign="top" nowrap>          </td>
 239           <td class="md" valign="top">&nbsp;)&nbsp;</td>
 240           <td class="md" nowrap><code> [virtual]</code></td>
 241         </tr>
 242
 243       </table>
 244     </td>
 245   </tr>
 246 </table>
 247 <table cellspacing=5 cellpadding=0 border=0>
 248   <tr>
 249     <td>
 250       &nbsp;
 251     </td>
 252     <td>
 253
 254 <p>
 255 Returns the version number of a Module.
 256 <p>
 257 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>
 258 <p>
 259 Definition at line <a class="el" href="modules_8cpp-source.html#l00318">318</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 260 <p>
 261 References <a class="el" href="modules_8h-source.html#l00054">VF_VENDOR</a>.
 262 <p>
 263 <div class="fragment"><pre>00318 { <span class="keywordflow">return</span> <a class="code" href="classVersion.html">Version</a>(1,0,0,0,VF_VENDOR); }
 264 </pre></div>    </td>
 265   </tr>
 266 </table>
 267 <a name="a26" doxytag="Module::On005Numeric"></a><p>
 268 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 269   <tr>
 270     <td class="mdRow">
 271       <table cellpadding="0" cellspacing="0" border="0">
 272         <tr>
 273           <td class="md" nowrap valign="top"> void Module::On005Numeric </td>
 274           <td class="md" valign="top">(&nbsp;</td>
 275           <td class="md" nowrap valign="top">std::string &amp;&nbsp;</td>
 276           <td class="mdname1" valign="top" nowrap> <em>output</em>          </td>
 277           <td class="md" valign="top">&nbsp;)&nbsp;</td>
 278           <td class="md" nowrap><code> [virtual]</code></td>
 279         </tr>
 280
 281       </table>
 282     </td>
 283   </tr>
 284 </table>
 285 <table cellspacing=5 cellpadding=0 border=0>
 286   <tr>
 287     <td>
 288       &nbsp;
 289     </td>
 290     <td>
 291
 292 <p>
 293 Called when a 005 numeric is about to be output.
 294 <p>
 295 The module should modify the 005 numeric if needed to indicate its features.
 296 <p>
 297 Definition at line <a class="el" href="modules_8cpp-source.html#l00330">330</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 298 <p>
 299 <div class="fragment"><pre>00330 { };
 300 </pre></div>    </td>
 301   </tr>
 302 </table>
 303 <a name="a23" doxytag="Module::OnAccessCheck"></a><p>
 304 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 305   <tr>
 306     <td class="mdRow">
 307       <table cellpadding="0" cellspacing="0" border="0">
 308         <tr>
 309           <td class="md" nowrap valign="top"> int Module::OnAccessCheck </td>
 310           <td class="md" valign="top">(&nbsp;</td>
 311           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 312           <td class="mdname" nowrap> <em>source</em>, </td>
 313         </tr>
 314         <tr>
 315           <td></td>
 316           <td></td>
 317           <td class="md" nowrap><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 318           <td class="mdname" nowrap> <em>dest</em>, </td>
 319         </tr>
 320         <tr>
 321           <td></td>
 322           <td></td>
 323           <td class="md" nowrap><a class="el" href="classchanrec.html">chanrec</a> *&nbsp;</td>
 324           <td class="mdname" nowrap> <em>channel</em>, </td>
 325         </tr>
 326         <tr>
 327           <td></td>
 328           <td></td>
 329           <td class="md" nowrap>int&nbsp;</td>
 330           <td class="mdname" nowrap> <em>access_type</em></td>
 331         </tr>
 332         <tr>
 333           <td></td>
 334           <td class="md">)&nbsp;</td>
 335           <td class="md" colspan="2"><code> [virtual]</code></td>
 336         </tr>
 337
 338       </table>
 339     </td>
 340   </tr>
 341 </table>
 342 <table cellspacing=5 cellpadding=0 border=0>
 343   <tr>
 344     <td>
 345       &nbsp;
 346     </td>
 347     <td>
 348
 349 <p>
 350 Called before an action which requires a channel privilage check.
 351 <p>
 352 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>
 353 <br>
 354  AC_KICK (0) - A user is being kicked<br>
 355  AC_DEOP (1) - a user is being deopped<br>
 356  AC_OP (2) - a user is being opped<br>
 357  AC_VOICE (3) - a user is being voiced<br>
 358  AC_DEVOICE (4) - a user is being devoiced<br>
 359  AC_HALFOP (5) - a user is being halfopped<br>
 360  AC_DEHALFOP (6) - a user is being dehalfopped<br>
 361  AC_INVITE (7) - a user is being invited<br>
 362  AC_GENERAL_MODE (8) - a user channel mode is being changed<br>
 363 <br>
 364  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).
 365 <p>
 366 Definition at line <a class="el" href="modules_8cpp-source.html#l00327">327</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 367 <p>
 368 References <a class="el" href="modules_8h-source.html#l00037">ACR_DEFAULT</a>.
 369 <p>
 370 <div class="fragment"><pre>00327 { <span class="keywordflow">return</span> <a class="code" href="modules_8h.html#a8">ACR_DEFAULT</a>; };
 371 </pre></div>    </td>
 372   </tr>
 373 </table>
 374 <a name="a29" doxytag="Module::OnBackgroundTimer"></a><p>
 375 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 376   <tr>
 377     <td class="mdRow">
 378       <table cellpadding="0" cellspacing="0" border="0">
 379         <tr>
 380           <td class="md" nowrap valign="top"> void Module::OnBackgroundTimer </td>
 381           <td class="md" valign="top">(&nbsp;</td>
 382           <td class="md" nowrap valign="top">time_t&nbsp;</td>
 383           <td class="mdname1" valign="top" nowrap> <em>curtime</em>          </td>
 384           <td class="md" valign="top">&nbsp;)&nbsp;</td>
 385           <td class="md" nowrap><code> [virtual]</code></td>
 386         </tr>
 387
 388       </table>
 389     </td>
 390   </tr>
 391 </table>
 392 <table cellspacing=5 cellpadding=0 border=0>
 393   <tr>
 394     <td>
 395       &nbsp;
 396     </td>
 397     <td>
 398
 399 <p>
 400 Called once every five seconds for background processing.
 401 <p>
 402 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.
 403 <p>
 404 Definition at line <a class="el" href="modules_8cpp-source.html#l00333">333</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 405 <p>
 406 <div class="fragment"><pre>00333 { };
 407 </pre></div>    </td>
 408   </tr>
 409 </table>
 410 <a name="a41" doxytag="Module::OnChangeLocalUserGECOS"></a><p>
 411 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 412   <tr>
 413     <td class="mdRow">
 414       <table cellpadding="0" cellspacing="0" border="0">
 415         <tr>
 416           <td class="md" nowrap valign="top"> int Module::OnChangeLocalUserGECOS </td>
 417           <td class="md" valign="top">(&nbsp;</td>
 418           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 419           <td class="mdname" nowrap> <em>user</em>, </td>
 420         </tr>
 421         <tr>
 422           <td></td>
 423           <td></td>
 424           <td class="md" nowrap>std::string&nbsp;</td>
 425           <td class="mdname" nowrap> <em>newhost</em></td>
 426         </tr>
 427         <tr>
 428           <td></td>
 429           <td class="md">)&nbsp;</td>
 430           <td class="md" colspan="2"><code> [virtual]</code></td>
 431         </tr>
 432
 433       </table>
 434     </td>
 435   </tr>
 436 </table>
 437 <table cellspacing=5 cellpadding=0 border=0>
 438   <tr>
 439     <td>
 440       &nbsp;
 441     </td>
 442     <td>
 443
 444 <p>
 445 Called whenever a change of a local users GECOS (fullname field) is attempted.
 446 <p>
 447 return 1 to deny the name change, or 0 to allow it.
 448 <p>
 449 Definition at line <a class="el" href="modules_8cpp-source.html#l00347">347</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 450 <p>
 451 <div class="fragment"><pre>00347 { <span class="keywordflow">return</span> 0; };
 452 </pre></div>    </td>
 453   </tr>
 454 </table>
 455 <a name="a40" doxytag="Module::OnChangeLocalUserHost"></a><p>
 456 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 457   <tr>
 458     <td class="mdRow">
 459       <table cellpadding="0" cellspacing="0" border="0">
 460         <tr>
 461           <td class="md" nowrap valign="top"> int Module::OnChangeLocalUserHost </td>
 462           <td class="md" valign="top">(&nbsp;</td>
 463           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 464           <td class="mdname" nowrap> <em>user</em>, </td>
 465         </tr>
 466         <tr>
 467           <td></td>
 468           <td></td>
 469           <td class="md" nowrap>std::string&nbsp;</td>
 470           <td class="mdname" nowrap> <em>newhost</em></td>
 471         </tr>
 472         <tr>
 473           <td></td>
 474           <td class="md">)&nbsp;</td>
 475           <td class="md" colspan="2"><code> [virtual]</code></td>
 476         </tr>
 477
 478       </table>
 479     </td>
 480   </tr>
 481 </table>
 482 <table cellspacing=5 cellpadding=0 border=0>
 483   <tr>
 484     <td>
 485       &nbsp;
 486     </td>
 487     <td>
 488
 489 <p>
 490 Called whenever a change of a local users displayed host is attempted.
 491 <p>
 492 Return 1 to deny the host change, or 0 to allow it.
 493 <p>
 494 Definition at line <a class="el" href="modules_8cpp-source.html#l00346">346</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 495 <p>
 496 <div class="fragment"><pre>00346 { <span class="keywordflow">return</span> 0; };
 497 </pre></div>    </td>
 498   </tr>
 499 </table>
 500 <a name="a25" doxytag="Module::OnChannelSync"></a><p>
 501 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 502   <tr>
 503     <td class="mdRow">
 504       <table cellpadding="0" cellspacing="0" border="0">
 505         <tr>
 506           <td class="md" nowrap valign="top"> <a class="el" href="modules_8h.html#a32">string_list</a> Module::OnChannelSync </td>
 507           <td class="md" valign="top">(&nbsp;</td>
 508           <td class="md" nowrap valign="top"><a class="el" href="classchanrec.html">chanrec</a> *&nbsp;</td>
 509           <td class="mdname1" valign="top" nowrap> <em>chan</em>          </td>
 510           <td class="md" valign="top">&nbsp;)&nbsp;</td>
 511           <td class="md" nowrap><code> [virtual]</code></td>
 512         </tr>
 513
 514       </table>
 515     </td>
 516   </tr>
 517 </table>
 518 <table cellspacing=5 cellpadding=0 border=0>
 519   <tr>
 520     <td>
 521       &nbsp;
 522     </td>
 523     <td>
 524
 525 <p>
 526 Called during a netburst to sync channel data.
 527 <p>
 528 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.
 529 <p>
 530 Definition at line <a class="el" href="modules_8cpp-source.html#l00329">329</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 531 <p>
 532 References <a class="el" href="modules_8h-source.html#l00068">string_list</a>.
 533 <p>
 534 <div class="fragment"><pre>00329 { <a class="code" href="modules_8h.html#a32">string_list</a> empty; <span class="keywordflow">return</span> empty; }
 535 </pre></div>    </td>
 536   </tr>
 537 </table>
 538 <a name="a38" doxytag="Module::OnCheckBan"></a><p>
 539 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 540   <tr>
 541     <td class="mdRow">
 542       <table cellpadding="0" cellspacing="0" border="0">
 543         <tr>
 544           <td class="md" nowrap valign="top"> int Module::OnCheckBan </td>
 545           <td class="md" valign="top">(&nbsp;</td>
 546           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 547           <td class="mdname" nowrap> <em>user</em>, </td>
 548         </tr>
 549         <tr>
 550           <td></td>
 551           <td></td>
 552           <td class="md" nowrap><a class="el" href="classchanrec.html">chanrec</a> *&nbsp;</td>
 553           <td class="mdname" nowrap> <em>chan</em></td>
 554         </tr>
 555         <tr>
 556           <td></td>
 557           <td class="md">)&nbsp;</td>
 558           <td class="md" colspan="2"><code> [virtual]</code></td>
 559         </tr>
 560
 561       </table>
 562     </td>
 563   </tr>
 564 </table>
 565 <table cellspacing=5 cellpadding=0 border=0>
 566   <tr>
 567     <td>
 568       &nbsp;
 569     </td>
 570     <td>
 571
 572 <p>
 573 Called whenever a user joins a channel, to determine if banlist checks should go ahead or not.
 574 <p>
 575 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.
 576 <p>
 577 Definition at line <a class="el" href="modules_8cpp-source.html#l00344">344</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 578 <p>
 579 <div class="fragment"><pre>00344 { <span class="keywordflow">return</span> 0; };
 580 </pre></div>    </td>
 581   </tr>
 582 </table>
 583 <a name="a35" doxytag="Module::OnCheckInvite"></a><p>
 584 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 585   <tr>
 586     <td class="mdRow">
 587       <table cellpadding="0" cellspacing="0" border="0">
 588         <tr>
 589           <td class="md" nowrap valign="top"> int Module::OnCheckInvite </td>
 590           <td class="md" valign="top">(&nbsp;</td>
 591           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 592           <td class="mdname" nowrap> <em>user</em>, </td>
 593         </tr>
 594         <tr>
 595           <td></td>
 596           <td></td>
 597           <td class="md" nowrap><a class="el" href="classchanrec.html">chanrec</a> *&nbsp;</td>
 598           <td class="mdname" nowrap> <em>chan</em></td>
 599         </tr>
 600         <tr>
 601           <td></td>
 602           <td class="md">)&nbsp;</td>
 603           <td class="md" colspan="2"><code> [virtual]</code></td>
 604         </tr>
 605
 606       </table>
 607     </td>
 608   </tr>
 609 </table>
 610 <table cellspacing=5 cellpadding=0 border=0>
 611   <tr>
 612     <td>
 613       &nbsp;
 614     </td>
 615     <td>
 616
 617 <p>
 618 Called whenever a user joins a channel, to determine if invite checks should go ahead or not.
 619 <p>
 620 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.
 621 <p>
 622 Definition at line <a class="el" href="modules_8cpp-source.html#l00341">341</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 623 <p>
 624 <div class="fragment"><pre>00341 { <span class="keywordflow">return</span> 0; };
 625 </pre></div>    </td>
 626   </tr>
 627 </table>
 628 <a name="a36" doxytag="Module::OnCheckKey"></a><p>
 629 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 630   <tr>
 631     <td class="mdRow">
 632       <table cellpadding="0" cellspacing="0" border="0">
 633         <tr>
 634           <td class="md" nowrap valign="top"> int Module::OnCheckKey </td>
 635           <td class="md" valign="top">(&nbsp;</td>
 636           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 637           <td class="mdname" nowrap> <em>user</em>, </td>
 638         </tr>
 639         <tr>
 640           <td></td>
 641           <td></td>
 642           <td class="md" nowrap><a class="el" href="classchanrec.html">chanrec</a> *&nbsp;</td>
 643           <td class="mdname" nowrap> <em>chan</em>, </td>
 644         </tr>
 645         <tr>
 646           <td></td>
 647           <td></td>
 648           <td class="md" nowrap>std::string&nbsp;</td>
 649           <td class="mdname" nowrap> <em>keygiven</em></td>
 650         </tr>
 651         <tr>
 652           <td></td>
 653           <td class="md">)&nbsp;</td>
 654           <td class="md" colspan="2"><code> [virtual]</code></td>
 655         </tr>
 656
 657       </table>
 658     </td>
 659   </tr>
 660 </table>
 661 <table cellspacing=5 cellpadding=0 border=0>
 662   <tr>
 663     <td>
 664       &nbsp;
 665     </td>
 666     <td>
 667
 668 <p>
 669 Called whenever a user joins a channel, to determine if key checks should go ahead or not.
 670 <p>
 671 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.
 672 <p>
 673 Definition at line <a class="el" href="modules_8cpp-source.html#l00342">342</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 674 <p>
 675 <div class="fragment"><pre>00342 { <span class="keywordflow">return</span> 0; };
 676 </pre></div>    </td>
 677   </tr>
 678 </table>
 679 <a name="a37" doxytag="Module::OnCheckLimit"></a><p>
 680 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 681   <tr>
 682     <td class="mdRow">
 683       <table cellpadding="0" cellspacing="0" border="0">
 684         <tr>
 685           <td class="md" nowrap valign="top"> int Module::OnCheckLimit </td>
 686           <td class="md" valign="top">(&nbsp;</td>
 687           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 688           <td class="mdname" nowrap> <em>user</em>, </td>
 689         </tr>
 690         <tr>
 691           <td></td>
 692           <td></td>
 693           <td class="md" nowrap><a class="el" href="classchanrec.html">chanrec</a> *&nbsp;</td>
 694           <td class="mdname" nowrap> <em>chan</em></td>
 695         </tr>
 696         <tr>
 697           <td></td>
 698           <td class="md">)&nbsp;</td>
 699           <td class="md" colspan="2"><code> [virtual]</code></td>
 700         </tr>
 701
 702       </table>
 703     </td>
 704   </tr>
 705 </table>
 706 <table cellspacing=5 cellpadding=0 border=0>
 707   <tr>
 708     <td>
 709       &nbsp;
 710     </td>
 711     <td>
 712
 713 <p>
 714 Called whenever a user joins a channel, to determine if channel limit checks should go ahead or not.
 715 <p>
 716 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.
 717 <p>
 718 Definition at line <a class="el" href="modules_8cpp-source.html#l00343">343</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 719 <p>
 720 <div class="fragment"><pre>00343 { <span class="keywordflow">return</span> 0; };
 721 </pre></div>    </td>
 722   </tr>
 723 </table>
 724 <a name="a32" doxytag="Module::OnCheckReady"></a><p>
 725 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 726   <tr>
 727     <td class="mdRow">
 728       <table cellpadding="0" cellspacing="0" border="0">
 729         <tr>
 730           <td class="md" nowrap valign="top"> bool Module::OnCheckReady </td>
 731           <td class="md" valign="top">(&nbsp;</td>
 732           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 733           <td class="mdname1" valign="top" nowrap> <em>user</em>          </td>
 734           <td class="md" valign="top">&nbsp;)&nbsp;</td>
 735           <td class="md" nowrap><code> [virtual]</code></td>
 736         </tr>
 737
 738       </table>
 739     </td>
 740   </tr>
 741 </table>
 742 <table cellspacing=5 cellpadding=0 border=0>
 743   <tr>
 744     <td>
 745       &nbsp;
 746     </td>
 747     <td>
 748
 749 <p>
 750 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.
 751 <p>
 752 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.
 753 <p>
 754 Definition at line <a class="el" href="modules_8cpp-source.html#l00336">336</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 755 <p>
 756 <div class="fragment"><pre>00336 { <span class="keywordflow">return</span> <span class="keyword">true</span>; };
 757 </pre></div>    </td>
 758   </tr>
 759 </table>
 760 <a name="a11" doxytag="Module::OnExtendedMode"></a><p>
 761 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 762   <tr>
 763     <td class="mdRow">
 764       <table cellpadding="0" cellspacing="0" border="0">
 765         <tr>
 766           <td class="md" nowrap valign="top"> int Module::OnExtendedMode </td>
 767           <td class="md" valign="top">(&nbsp;</td>
 768           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 769           <td class="mdname" nowrap> <em>user</em>, </td>
 770         </tr>
 771         <tr>
 772           <td></td>
 773           <td></td>
 774           <td class="md" nowrap>void *&nbsp;</td>
 775           <td class="mdname" nowrap> <em>target</em>, </td>
 776         </tr>
 777         <tr>
 778           <td></td>
 779           <td></td>
 780           <td class="md" nowrap>char&nbsp;</td>
 781           <td class="mdname" nowrap> <em>modechar</em>, </td>
 782         </tr>
 783         <tr>
 784           <td></td>
 785           <td></td>
 786           <td class="md" nowrap>int&nbsp;</td>
 787           <td class="mdname" nowrap> <em>type</em>, </td>
 788         </tr>
 789         <tr>
 790           <td></td>
 791           <td></td>
 792           <td class="md" nowrap>bool&nbsp;</td>
 793           <td class="mdname" nowrap> <em>mode_on</em>, </td>
 794         </tr>
 795         <tr>
 796           <td></td>
 797           <td></td>
 798           <td class="md" nowrap><a class="el" href="modules_8h.html#a32">string_list</a> &amp;&nbsp;</td>
 799           <td class="mdname" nowrap> <em>params</em></td>
 800         </tr>
 801         <tr>
 802           <td></td>
 803           <td class="md">)&nbsp;</td>
 804           <td class="md" colspan="2"><code> [virtual]</code></td>
 805         </tr>
 806
 807       </table>
 808     </td>
 809   </tr>
 810 </table>
 811 <table cellspacing=5 cellpadding=0 border=0>
 812   <tr>
 813     <td>
 814       &nbsp;
 815     </td>
 816     <td>
 817
 818 <p>
 819 Called whenever an extended mode is to be processed.
 820 <p>
 821 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.
 822 <p>
 823 Definition at line <a class="el" href="modules_8cpp-source.html#l00317">317</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 824 <p>
 825 <div class="fragment"><pre>00317 { <span class="keywordflow">return</span> <span class="keyword">false</span>; }
 826 </pre></div>    </td>
 827   </tr>
 828 </table>
 829 <a name="a16" doxytag="Module::OnInfo"></a><p>
 830 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 831   <tr>
 832     <td class="mdRow">
 833       <table cellpadding="0" cellspacing="0" border="0">
 834         <tr>
 835           <td class="md" nowrap valign="top"> void Module::OnInfo </td>
 836           <td class="md" valign="top">(&nbsp;</td>
 837           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 838           <td class="mdname1" valign="top" nowrap> <em>user</em>          </td>
 839           <td class="md" valign="top">&nbsp;)&nbsp;</td>
 840           <td class="md" nowrap><code> [virtual]</code></td>
 841         </tr>
 842
 843       </table>
 844     </td>
 845   </tr>
 846 </table>
 847 <table cellspacing=5 cellpadding=0 border=0>
 848   <tr>
 849     <td>
 850       &nbsp;
 851     </td>
 852     <td>
 853
 854 <p>
 855 Called whenever a user types /INFO.
 856 <p>
 857 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>
 858 &lt;nick&gt; :information here
 859 <p>
 860 Definition at line <a class="el" href="modules_8cpp-source.html#l00320">320</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 861 <p>
 862 <div class="fragment"><pre>00320 { };
 863 </pre></div>    </td>
 864   </tr>
 865 </table>
 866 <a name="a27" doxytag="Module::OnKill"></a><p>
 867 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 868   <tr>
 869     <td class="mdRow">
 870       <table cellpadding="0" cellspacing="0" border="0">
 871         <tr>
 872           <td class="md" nowrap valign="top"> int Module::OnKill </td>
 873           <td class="md" valign="top">(&nbsp;</td>
 874           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 875           <td class="mdname" nowrap> <em>source</em>, </td>
 876         </tr>
 877         <tr>
 878           <td></td>
 879           <td></td>
 880           <td class="md" nowrap><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 881           <td class="mdname" nowrap> <em>dest</em>, </td>
 882         </tr>
 883         <tr>
 884           <td></td>
 885           <td></td>
 886           <td class="md" nowrap>std::string&nbsp;</td>
 887           <td class="mdname" nowrap> <em>reason</em></td>
 888         </tr>
 889         <tr>
 890           <td></td>
 891           <td class="md">)&nbsp;</td>
 892           <td class="md" colspan="2"><code> [virtual]</code></td>
 893         </tr>
 894
 895       </table>
 896     </td>
 897   </tr>
 898 </table>
 899 <table cellspacing=5 cellpadding=0 border=0>
 900   <tr>
 901     <td>
 902       &nbsp;
 903     </td>
 904     <td>
 905
 906 <p>
 907 Called when a client is disconnected by KILL.
 908 <p>
 909 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!
 910 <p>
 911 Definition at line <a class="el" href="modules_8cpp-source.html#l00331">331</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 912 <p>
 913 <div class="fragment"><pre>00331 { <span class="keywordflow">return</span> 0; };
 914 </pre></div>    </td>
 915   </tr>
 916 </table>
 917 <a name="a28" doxytag="Module::OnLoadModule"></a><p>
 918 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 919   <tr>
 920     <td class="mdRow">
 921       <table cellpadding="0" cellspacing="0" border="0">
 922         <tr>
 923           <td class="md" nowrap valign="top"> void Module::OnLoadModule </td>
 924           <td class="md" valign="top">(&nbsp;</td>
 925           <td class="md" nowrap valign="top"><a class="el" href="classModule.html">Module</a> *&nbsp;</td>
 926           <td class="mdname" nowrap> <em>mod</em>, </td>
 927         </tr>
 928         <tr>
 929           <td></td>
 930           <td></td>
 931           <td class="md" nowrap>std::string&nbsp;</td>
 932           <td class="mdname" nowrap> <em>name</em></td>
 933         </tr>
 934         <tr>
 935           <td></td>
 936           <td class="md">)&nbsp;</td>
 937           <td class="md" colspan="2"><code> [virtual]</code></td>
 938         </tr>
 939
 940       </table>
 941     </td>
 942   </tr>
 943 </table>
 944 <table cellspacing=5 cellpadding=0 border=0>
 945   <tr>
 946     <td>
 947       &nbsp;
 948     </td>
 949     <td>
 950
 951 <p>
 952 Called whenever a module is loaded.
 953 <p>
 954 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).
 955 <p>
 956 Definition at line <a class="el" href="modules_8cpp-source.html#l00332">332</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 957 <p>
 958 <div class="fragment"><pre>00332 { };
 959 </pre></div>    </td>
 960   </tr>
 961 </table>
 962 <a name="a42" doxytag="Module::OnLocalTopicChange"></a><p>
 963 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 964   <tr>
 965     <td class="mdRow">
 966       <table cellpadding="0" cellspacing="0" border="0">
 967         <tr>
 968           <td class="md" nowrap valign="top"> int Module::OnLocalTopicChange </td>
 969           <td class="md" valign="top">(&nbsp;</td>
 970           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 971           <td class="mdname" nowrap> <em>user</em>, </td>
 972         </tr>
 973         <tr>
 974           <td></td>
 975           <td></td>
 976           <td class="md" nowrap><a class="el" href="classchanrec.html">chanrec</a> *&nbsp;</td>
 977           <td class="mdname" nowrap> <em>chan</em>, </td>
 978         </tr>
 979         <tr>
 980           <td></td>
 981           <td></td>
 982           <td class="md" nowrap>std::string&nbsp;</td>
 983           <td class="mdname" nowrap> <em>topic</em></td>
 984         </tr>
 985         <tr>
 986           <td></td>
 987           <td class="md">)&nbsp;</td>
 988           <td class="md" colspan="2"><code> [virtual]</code></td>
 989         </tr>
 990
 991       </table>
 992     </td>
 993   </tr>
 994 </table>
 995 <table cellspacing=5 cellpadding=0 border=0>
 996   <tr>
 997     <td>
 998       &nbsp;
 999     </td>
1000     <td>
1001
1002 <p>
1003 Called whenever a topic is changed by a local user.
1004 <p>
1005 Return 1 to deny the topic change, or 0 to allow it.
1006 <p>
1007 Definition at line <a class="el" href="modules_8cpp-source.html#l00348">348</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1008 <p>
1009 <div class="fragment"><pre>00348 { <span class="keywordflow">return</span> 0; };
1010 </pre></div>    </td>
1011   </tr>
1012 </table>
1013 <a name="a43" doxytag="Module::OnMeshToken"></a><p>
1014 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1015   <tr>
1016     <td class="mdRow">
1017       <table cellpadding="0" cellspacing="0" border="0">
1018         <tr>
1019           <td class="md" nowrap valign="top"> int Module::OnMeshToken </td>
1020           <td class="md" valign="top">(&nbsp;</td>
1021           <td class="md" nowrap valign="top">char&nbsp;</td>
1022           <td class="mdname" nowrap> <em>token</em>, </td>
1023         </tr>
1024         <tr>
1025           <td></td>
1026           <td></td>
1027           <td class="md" nowrap><a class="el" href="modules_8h.html#a32">string_list</a>&nbsp;</td>
1028           <td class="mdname" nowrap> <em>params</em>, </td>
1029         </tr>
1030         <tr>
1031           <td></td>
1032           <td></td>
1033           <td class="md" nowrap><a class="el" href="classserverrec.html">serverrec</a> *&nbsp;</td>
1034           <td class="mdname" nowrap> <em>source</em>, </td>
1035         </tr>
1036         <tr>
1037           <td></td>
1038           <td></td>
1039           <td class="md" nowrap><a class="el" href="classserverrec.html">serverrec</a> *&nbsp;</td>
1040           <td class="mdname" nowrap> <em>reply</em>, </td>
1041         </tr>
1042         <tr>
1043           <td></td>
1044           <td></td>
1045           <td class="md" nowrap>std::string&nbsp;</td>
1046           <td class="mdname" nowrap> <em>tcp_host</em>, </td>
1047         </tr>
1048         <tr>
1049           <td></td>
1050           <td></td>
1051           <td class="md" nowrap>std::string&nbsp;</td>
1052           <td class="mdname" nowrap> <em>ipaddr</em>, </td>
1053         </tr>
1054         <tr>
1055           <td></td>
1056           <td></td>
1057           <td class="md" nowrap>int&nbsp;</td>
1058           <td class="mdname" nowrap> <em>port</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 an unknown token is received in a server to server link.
1079 <p>
1080 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.
1081 <p>
1082 Definition at line <a class="el" href="modules_8cpp-source.html#l00349">349</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1083 <p>
1084 <div class="fragment"><pre>00349 { <span class="keywordflow">return</span> 0; };
1085 </pre></div>    </td>
1086   </tr>
1087 </table>
1088 <a name="a15" doxytag="Module::OnOper"></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"> void Module::OnOper </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="mdname1" valign="top" nowrap> <em>user</em>          </td>
1098           <td class="md" valign="top">&nbsp;)&nbsp;</td>
1099           <td class="md" nowrap><code> [virtual]</code></td>
1100         </tr>
1101
1102       </table>
1103     </td>
1104   </tr>
1105 </table>
1106 <table cellspacing=5 cellpadding=0 border=0>
1107   <tr>
1108     <td>
1109       &nbsp;
1110     </td>
1111     <td>
1112
1113 <p>
1114 Called whenever a user opers locally.
1115 <p>
1116 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.
1117 <p>
1118 Definition at line <a class="el" href="modules_8cpp-source.html#l00319">319</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1119 <p>
1120 <div class="fragment"><pre>00319 { };
1121 </pre></div>    </td>
1122   </tr>
1123 </table>
1124 <a name="a8" doxytag="Module::OnPacketReceive"></a><p>
1125 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1126   <tr>
1127     <td class="mdRow">
1128       <table cellpadding="0" cellspacing="0" border="0">
1129         <tr>
1130           <td class="md" nowrap valign="top"> void Module::OnPacketReceive </td>
1131           <td class="md" valign="top">(&nbsp;</td>
1132           <td class="md" nowrap valign="top">std::string &amp;&nbsp;</td>
1133           <td class="mdname" nowrap> <em>data</em>, </td>
1134         </tr>
1135         <tr>
1136           <td></td>
1137           <td></td>
1138           <td class="md" nowrap>std::string&nbsp;</td>
1139           <td class="mdname" nowrap> <em>serv</em></td>
1140         </tr>
1141         <tr>
1142           <td></td>
1143           <td class="md">)&nbsp;</td>
1144           <td class="md" colspan="2"><code> [virtual]</code></td>
1145         </tr>
1146
1147       </table>
1148     </td>
1149   </tr>
1150 </table>
1151 <table cellspacing=5 cellpadding=0 border=0>
1152   <tr>
1153     <td>
1154       &nbsp;
1155     </td>
1156     <td>
1157
1158 <p>
1159 Called after a packet is received from another irc server.
1160 <p>
1161 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.
1162 <p>
1163 Definition at line <a class="el" href="modules_8cpp-source.html#l00313">313</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1164 <p>
1165 <div class="fragment"><pre>00313 { }
1166 </pre></div>    </td>
1167   </tr>
1168 </table>
1169 <a name="a7" doxytag="Module::OnPacketTransmit"></a><p>
1170 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1171   <tr>
1172     <td class="mdRow">
1173       <table cellpadding="0" cellspacing="0" border="0">
1174         <tr>
1175           <td class="md" nowrap valign="top"> void Module::OnPacketTransmit </td>
1176           <td class="md" valign="top">(&nbsp;</td>
1177           <td class="md" nowrap valign="top">std::string &amp;&nbsp;</td>
1178           <td class="mdname" nowrap> <em>data</em>, </td>
1179         </tr>
1180         <tr>
1181           <td></td>
1182           <td></td>
1183           <td class="md" nowrap>std::string&nbsp;</td>
1184           <td class="mdname" nowrap> <em>serv</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 before a packet is transmitted across the irc network between two irc servers.
1205 <p>
1206 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.
1207 <p>
1208 Definition at line <a class="el" href="modules_8cpp-source.html#l00312">312</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1209 <p>
1210 <div class="fragment"><pre>00312 { }
1211 </pre></div>    </td>
1212   </tr>
1213 </table>
1214 <a name="a31" doxytag="Module::OnPreCommand"></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"> int Module::OnPreCommand </td>
1221           <td class="md" valign="top">(&nbsp;</td>
1222           <td class="md" nowrap valign="top">std::string&nbsp;</td>
1223           <td class="mdname" nowrap> <em>command</em>, </td>
1224         </tr>
1225         <tr>
1226           <td></td>
1227           <td></td>
1228           <td class="md" nowrap>char **&nbsp;</td>
1229           <td class="mdname" nowrap> <em>parameters</em>, </td>
1230         </tr>
1231         <tr>
1232           <td></td>
1233           <td></td>
1234           <td class="md" nowrap>int&nbsp;</td>
1235           <td class="mdname" nowrap> <em>pcnt</em>, </td>
1236         </tr>
1237         <tr>
1238           <td></td>
1239           <td></td>
1240           <td class="md" nowrap><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
1241           <td class="mdname" nowrap> <em>user</em></td>
1242         </tr>
1243         <tr>
1244           <td></td>
1245           <td class="md">)&nbsp;</td>
1246           <td class="md" colspan="2"><code> [virtual]</code></td>
1247         </tr>
1248
1249       </table>
1250     </td>
1251   </tr>
1252 </table>
1253 <table cellspacing=5 cellpadding=0 border=0>
1254   <tr>
1255     <td>
1256       &nbsp;
1257     </td>
1258     <td>
1259
1260 <p>
1261 Called whenever any command is about to be executed.
1262 <p>
1263 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!)
1264 <p>
1265 Definition at line <a class="el" href="modules_8cpp-source.html#l00335">335</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1266 <p>
1267 <div class="fragment"><pre>00335 { <span class="keywordflow">return</span> 0; };
1268 </pre></div>    </td>
1269   </tr>
1270 </table>
1271 <a name="a34" doxytag="Module::OnRawMode"></a><p>
1272 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1273   <tr>
1274     <td class="mdRow">
1275       <table cellpadding="0" cellspacing="0" border="0">
1276         <tr>
1277           <td class="md" nowrap valign="top"> int Module::OnRawMode </td>
1278           <td class="md" valign="top">(&nbsp;</td>
1279           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
1280           <td class="mdname" nowrap> <em>user</em>, </td>
1281         </tr>
1282         <tr>
1283           <td></td>
1284           <td></td>
1285           <td class="md" nowrap><a class="el" href="classchanrec.html">chanrec</a> *&nbsp;</td>
1286           <td class="mdname" nowrap> <em>chan</em>, </td>
1287         </tr>
1288         <tr>
1289           <td></td>
1290           <td></td>
1291           <td class="md" nowrap>char&nbsp;</td>
1292           <td class="mdname" nowrap> <em>mode</em>, </td>
1293         </tr>
1294         <tr>
1295           <td></td>
1296           <td></td>
1297           <td class="md" nowrap>std::string&nbsp;</td>
1298           <td class="mdname" nowrap> <em>param</em>, </td>
1299         </tr>
1300         <tr>
1301           <td></td>
1302           <td></td>
1303           <td class="md" nowrap>bool&nbsp;</td>
1304           <td class="mdname" nowrap> <em>adding</em>, </td>
1305         </tr>
1306         <tr>
1307           <td></td>
1308           <td></td>
1309           <td class="md" nowrap>int&nbsp;</td>
1310           <td class="mdname" nowrap> <em>pcnt</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 whenever a mode character is processed.
1331 <p>
1332 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!
1333 <p>
1334 Definition at line <a class="el" href="modules_8cpp-source.html#l00340">340</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1335 <p>
1336 <div class="fragment"><pre>00340 { <span class="keywordflow">return</span> 0; };
1337 </pre></div>    </td>
1338   </tr>
1339 </table>
1340 <a name="a9" doxytag="Module::OnRehash"></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::OnRehash </td>
1347           <td class="md" valign="top">(&nbsp;</td>
1348           <td class="mdname1" valign="top" nowrap>          </td>
1349           <td class="md" valign="top">&nbsp;)&nbsp;</td>
1350           <td class="md" nowrap><code> [virtual]</code></td>
1351         </tr>
1352
1353       </table>
1354     </td>
1355   </tr>
1356 </table>
1357 <table cellspacing=5 cellpadding=0 border=0>
1358   <tr>
1359     <td>
1360       &nbsp;
1361     </td>
1362     <td>
1363
1364 <p>
1365 Called on rehash.
1366 <p>
1367 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.
1368 <p>
1369 Definition at line <a class="el" href="modules_8cpp-source.html#l00314">314</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1370 <p>
1371 <div class="fragment"><pre>00314 { }
1372 </pre></div>    </td>
1373   </tr>
1374 </table>
1375 <a name="a30" doxytag="Module::OnSendList"></a><p>
1376 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1377   <tr>
1378     <td class="mdRow">
1379       <table cellpadding="0" cellspacing="0" border="0">
1380         <tr>
1381           <td class="md" nowrap valign="top"> void Module::OnSendList </td>
1382           <td class="md" valign="top">(&nbsp;</td>
1383           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
1384           <td class="mdname" nowrap> <em>user</em>, </td>
1385         </tr>
1386         <tr>
1387           <td></td>
1388           <td></td>
1389           <td class="md" nowrap><a class="el" href="classchanrec.html">chanrec</a> *&nbsp;</td>
1390           <td class="mdname" nowrap> <em>channel</em>, </td>
1391         </tr>
1392         <tr>
1393           <td></td>
1394           <td></td>
1395           <td class="md" nowrap>char&nbsp;</td>
1396           <td class="mdname" nowrap> <em>mode</em></td>
1397         </tr>
1398         <tr>
1399           <td></td>
1400           <td class="md">)&nbsp;</td>
1401           <td class="md" colspan="2"><code> [virtual]</code></td>
1402         </tr>
1403
1404       </table>
1405     </td>
1406   </tr>
1407 </table>
1408 <table cellspacing=5 cellpadding=0 border=0>
1409   <tr>
1410     <td>
1411       &nbsp;
1412     </td>
1413     <td>
1414
1415 <p>
1416 Called whenever a list is needed for a listmode.
1417 <p>
1418 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.
1419 <p>
1420 Definition at line <a class="el" href="modules_8cpp-source.html#l00334">334</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1421 <p>
1422 <div class="fragment"><pre>00334 { };
1423 </pre></div>    </td>
1424   </tr>
1425 </table>
1426 <a name="a10" doxytag="Module::OnServerRaw"></a><p>
1427 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1428   <tr>
1429     <td class="mdRow">
1430       <table cellpadding="0" cellspacing="0" border="0">
1431         <tr>
1432           <td class="md" nowrap valign="top"> void Module::OnServerRaw </td>
1433           <td class="md" valign="top">(&nbsp;</td>
1434           <td class="md" nowrap valign="top">std::string &amp;&nbsp;</td>
1435           <td class="mdname" nowrap> <em>raw</em>, </td>
1436         </tr>
1437         <tr>
1438           <td></td>
1439           <td></td>
1440           <td class="md" nowrap>bool&nbsp;</td>
1441           <td class="mdname" nowrap> <em>inbound</em>, </td>
1442         </tr>
1443         <tr>
1444           <td></td>
1445           <td></td>
1446           <td class="md" nowrap><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
1447           <td class="mdname" nowrap> <em>user</em></td>
1448         </tr>
1449         <tr>
1450           <td></td>
1451           <td class="md">)&nbsp;</td>
1452           <td class="md" colspan="2"><code> [virtual]</code></td>
1453         </tr>
1454
1455       </table>
1456     </td>
1457   </tr>
1458 </table>
1459 <table cellspacing=5 cellpadding=0 border=0>
1460   <tr>
1461     <td>
1462       &nbsp;
1463     </td>
1464     <td>
1465
1466 <p>
1467 Called when a raw command is transmitted or received.
1468 <p>
1469 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.
1470 <p>
1471 Definition at line <a class="el" href="modules_8cpp-source.html#l00315">315</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1472 <p>
1473 <div class="fragment"><pre>00315 { }
1474 </pre></div>    </td>
1475   </tr>
1476 </table>
1477 <a name="a39" doxytag="Module::OnStats"></a><p>
1478 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1479   <tr>
1480     <td class="mdRow">
1481       <table cellpadding="0" cellspacing="0" border="0">
1482         <tr>
1483           <td class="md" nowrap valign="top"> void Module::OnStats </td>
1484           <td class="md" valign="top">(&nbsp;</td>
1485           <td class="md" nowrap valign="top">char&nbsp;</td>
1486           <td class="mdname1" valign="top" nowrap> <em>symbol</em>          </td>
1487           <td class="md" valign="top">&nbsp;)&nbsp;</td>
1488           <td class="md" nowrap><code> [virtual]</code></td>
1489         </tr>
1490
1491       </table>
1492     </td>
1493   </tr>
1494 </table>
1495 <table cellspacing=5 cellpadding=0 border=0>
1496   <tr>
1497     <td>
1498       &nbsp;
1499     </td>
1500     <td>
1501
1502 <p>
1503 Called on all /STATS commands This method is triggered for all /STATS use, including stats symbols handled by the core.
1504 <p>
1505
1506 <p>
1507 Definition at line <a class="el" href="modules_8cpp-source.html#l00345">345</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1508 <p>
1509 <div class="fragment"><pre>00345 { };
1510 </pre></div>    </td>
1511   </tr>
1512 </table>
1513 <a name="a3" doxytag="Module::OnUserConnect"></a><p>
1514 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1515   <tr>
1516     <td class="mdRow">
1517       <table cellpadding="0" cellspacing="0" border="0">
1518         <tr>
1519           <td class="md" nowrap valign="top"> void Module::OnUserConnect </td>
1520           <td class="md" valign="top">(&nbsp;</td>
1521           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
1522           <td class="mdname1" valign="top" nowrap> <em>user</em>          </td>
1523           <td class="md" valign="top">&nbsp;)&nbsp;</td>
1524           <td class="md" nowrap><code> [virtual]</code></td>
1525         </tr>
1526
1527       </table>
1528     </td>
1529   </tr>
1530 </table>
1531 <table cellspacing=5 cellpadding=0 border=0>
1532   <tr>
1533     <td>
1534       &nbsp;
1535     </td>
1536     <td>
1537
1538 <p>
1539 Called when a user connects.
1540 <p>
1541 The details of the connecting user are available to you in the parameter userrec *user
1542 <p>
1543 Definition at line <a class="el" href="modules_8cpp-source.html#l00308">308</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1544 <p>
1545 <div class="fragment"><pre>00308 { }
1546 </pre></div>    </td>
1547   </tr>
1548 </table>
1549 <a name="a5" doxytag="Module::OnUserJoin"></a><p>
1550 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1551   <tr>
1552     <td class="mdRow">
1553       <table cellpadding="0" cellspacing="0" border="0">
1554         <tr>
1555           <td class="md" nowrap valign="top"> void Module::OnUserJoin </td>
1556           <td class="md" valign="top">(&nbsp;</td>
1557           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
1558           <td class="mdname" nowrap> <em>user</em>, </td>
1559         </tr>
1560         <tr>
1561           <td></td>
1562           <td></td>
1563           <td class="md" nowrap><a class="el" href="classchanrec.html">chanrec</a> *&nbsp;</td>
1564           <td class="mdname" nowrap> <em>channel</em></td>
1565         </tr>
1566         <tr>
1567           <td></td>
1568           <td class="md">)&nbsp;</td>
1569           <td class="md" colspan="2"><code> [virtual]</code></td>
1570         </tr>
1571
1572       </table>
1573     </td>
1574   </tr>
1575 </table>
1576 <table cellspacing=5 cellpadding=0 border=0>
1577   <tr>
1578     <td>
1579       &nbsp;
1580     </td>
1581     <td>
1582
1583 <p>
1584 Called when a user joins a channel.
1585 <p>
1586 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
1587 <p>
1588 Definition at line <a class="el" href="modules_8cpp-source.html#l00310">310</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1589 <p>
1590 <div class="fragment"><pre>00310 { }
1591 </pre></div>    </td>
1592   </tr>
1593 </table>
1594 <a name="a14" doxytag="Module::OnUserKick"></a><p>
1595 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1596   <tr>
1597     <td class="mdRow">
1598       <table cellpadding="0" cellspacing="0" border="0">
1599         <tr>
1600           <td class="md" nowrap valign="top"> void Module::OnUserKick </td>
1601           <td class="md" valign="top">(&nbsp;</td>
1602           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
1603           <td class="mdname" nowrap> <em>source</em>, </td>
1604         </tr>
1605         <tr>
1606           <td></td>
1607           <td></td>
1608           <td class="md" nowrap><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
1609           <td class="mdname" nowrap> <em>user</em>, </td>
1610         </tr>
1611         <tr>
1612           <td></td>
1613           <td></td>
1614           <td class="md" nowrap><a class="el" href="classchanrec.html">chanrec</a> *&nbsp;</td>
1615           <td class="mdname" nowrap> <em>chan</em>, </td>
1616         </tr>
1617         <tr>
1618           <td></td>
1619           <td></td>
1620           <td class="md" nowrap>std::string&nbsp;</td>
1621           <td class="mdname" nowrap> <em>reason</em></td>
1622         </tr>
1623         <tr>
1624           <td></td>
1625           <td class="md">)&nbsp;</td>
1626           <td class="md" colspan="2"><code> [virtual]</code></td>
1627         </tr>
1628
1629       </table>
1630     </td>
1631   </tr>
1632 </table>
1633 <table cellspacing=5 cellpadding=0 border=0>
1634   <tr>
1635     <td>
1636       &nbsp;
1637     </td>
1638     <td>
1639
1640 <p>
1641 Called whenever a user is kicked.
1642 <p>
1643 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#a13">Module::OnUserPreKick</a> instead of this method.
1644 <p>
1645 Definition at line <a class="el" href="modules_8cpp-source.html#l00339">339</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1646 <p>
1647 <div class="fragment"><pre>00339 { };
1648 </pre></div>    </td>
1649   </tr>
1650 </table>
1651 <a name="a6" doxytag="Module::OnUserPart"></a><p>
1652 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1653   <tr>
1654     <td class="mdRow">
1655       <table cellpadding="0" cellspacing="0" border="0">
1656         <tr>
1657           <td class="md" nowrap valign="top"> void Module::OnUserPart </td>
1658           <td class="md" valign="top">(&nbsp;</td>
1659           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
1660           <td class="mdname" nowrap> <em>user</em>, </td>
1661         </tr>
1662         <tr>
1663           <td></td>
1664           <td></td>
1665           <td class="md" nowrap><a class="el" href="classchanrec.html">chanrec</a> *&nbsp;</td>
1666           <td class="mdname" nowrap> <em>channel</em></td>
1667         </tr>
1668         <tr>
1669           <td></td>
1670           <td class="md">)&nbsp;</td>
1671           <td class="md" colspan="2"><code> [virtual]</code></td>
1672         </tr>
1673
1674       </table>
1675     </td>
1676   </tr>
1677 </table>
1678 <table cellspacing=5 cellpadding=0 border=0>
1679   <tr>
1680     <td>
1681       &nbsp;
1682     </td>
1683     <td>
1684
1685 <p>
1686 Called when a user parts a channel.
1687 <p>
1688 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
1689 <p>
1690 Definition at line <a class="el" href="modules_8cpp-source.html#l00311">311</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1691 <p>
1692 <div class="fragment"><pre>00311 { }
1693 </pre></div>    </td>
1694   </tr>
1695 </table>
1696 <a name="a22" doxytag="Module::OnUserPostNick"></a><p>
1697 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1698   <tr>
1699     <td class="mdRow">
1700       <table cellpadding="0" cellspacing="0" border="0">
1701         <tr>
1702           <td class="md" nowrap valign="top"> void Module::OnUserPostNick </td>
1703           <td class="md" valign="top">(&nbsp;</td>
1704           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
1705           <td class="mdname" nowrap> <em>user</em>, </td>
1706         </tr>
1707         <tr>
1708           <td></td>
1709           <td></td>
1710           <td class="md" nowrap>std::string&nbsp;</td>
1711           <td class="mdname" nowrap> <em>oldnick</em></td>
1712         </tr>
1713         <tr>
1714           <td></td>
1715           <td class="md">)&nbsp;</td>
1716           <td class="md" colspan="2"><code> [virtual]</code></td>
1717         </tr>
1718
1719       </table>
1720     </td>
1721   </tr>
1722 </table>
1723 <table cellspacing=5 cellpadding=0 border=0>
1724   <tr>
1725     <td>
1726       &nbsp;
1727     </td>
1728     <td>
1729
1730 <p>
1731 Called after any nickchange, local or remote.
1732 <p>
1733 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.
1734 <p>
1735 Definition at line <a class="el" href="modules_8cpp-source.html#l00326">326</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1736 <p>
1737 <div class="fragment"><pre>00326 { };
1738 </pre></div>    </td>
1739   </tr>
1740 </table>
1741 <a name="a18" doxytag="Module::OnUserPreInvite"></a><p>
1742 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1743   <tr>
1744     <td class="mdRow">
1745       <table cellpadding="0" cellspacing="0" border="0">
1746         <tr>
1747           <td class="md" nowrap valign="top"> int Module::OnUserPreInvite </td>
1748           <td class="md" valign="top">(&nbsp;</td>
1749           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
1750           <td class="mdname" nowrap> <em>source</em>, </td>
1751         </tr>
1752         <tr>
1753           <td></td>
1754           <td></td>
1755           <td class="md" nowrap><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
1756           <td class="mdname" nowrap> <em>dest</em>, </td>
1757         </tr>
1758         <tr>
1759           <td></td>
1760           <td></td>
1761           <td class="md" nowrap><a class="el" href="classchanrec.html">chanrec</a> *&nbsp;</td>
1762           <td class="mdname" nowrap> <em>channel</em></td>
1763         </tr>
1764         <tr>
1765           <td></td>
1766           <td class="md">)&nbsp;</td>
1767           <td class="md" colspan="2"><code> [virtual]</code></td>
1768         </tr>
1769
1770       </table>
1771     </td>
1772   </tr>
1773 </table>
1774 <table cellspacing=5 cellpadding=0 border=0>
1775   <tr>
1776     <td>
1777       &nbsp;
1778     </td>
1779     <td>
1780
1781 <p>
1782 Called whenever a user is about to invite another user into a channel, before any processing is done.
1783 <p>
1784 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.
1785 <p>
1786 Definition at line <a class="el" href="modules_8cpp-source.html#l00322">322</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1787 <p>
1788 <div class="fragment"><pre>00322 { <span class="keywordflow">return</span> 0; };
1789 </pre></div>    </td>
1790   </tr>
1791 </table>
1792 <a name="a12" doxytag="Module::OnUserPreJoin"></a><p>
1793 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1794   <tr>
1795     <td class="mdRow">
1796       <table cellpadding="0" cellspacing="0" border="0">
1797         <tr>
1798           <td class="md" nowrap valign="top"> int Module::OnUserPreJoin </td>
1799           <td class="md" valign="top">(&nbsp;</td>
1800           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
1801           <td class="mdname" nowrap> <em>user</em>, </td>
1802         </tr>
1803         <tr>
1804           <td></td>
1805           <td></td>
1806           <td class="md" nowrap><a class="el" href="classchanrec.html">chanrec</a> *&nbsp;</td>
1807           <td class="mdname" nowrap> <em>chan</em>, </td>
1808         </tr>
1809         <tr>
1810           <td></td>
1811           <td></td>
1812           <td class="md" nowrap>const char *&nbsp;</td>
1813           <td class="mdname" nowrap> <em>cname</em></td>
1814         </tr>
1815         <tr>
1816           <td></td>
1817           <td class="md">)&nbsp;</td>
1818           <td class="md" colspan="2"><code> [virtual]</code></td>
1819         </tr>
1820
1821       </table>
1822     </td>
1823   </tr>
1824 </table>
1825 <table cellspacing=5 cellpadding=0 border=0>
1826   <tr>
1827     <td>
1828       &nbsp;
1829     </td>
1830     <td>
1831
1832 <p>
1833 Called whenever a user is about to join a channel, before any processing is done.
1834 <p>
1835 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>
1836 IMPORTANT NOTE!<p>
1837 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.
1838 <p>
1839 Definition at line <a class="el" href="modules_8cpp-source.html#l00316">316</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1840 <p>
1841 <div class="fragment"><pre>00316 { <span class="keywordflow">return</span> 0; }
1842 </pre></div>    </td>
1843   </tr>
1844 </table>
1845 <a name="a13" doxytag="Module::OnUserPreKick"></a><p>
1846 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1847   <tr>
1848     <td class="mdRow">
1849       <table cellpadding="0" cellspacing="0" border="0">
1850         <tr>
1851           <td class="md" nowrap valign="top"> int Module::OnUserPreKick </td>
1852           <td class="md" valign="top">(&nbsp;</td>
1853           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
1854           <td class="mdname" nowrap> <em>source</em>, </td>
1855         </tr>
1856         <tr>
1857           <td></td>
1858           <td></td>
1859           <td class="md" nowrap><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
1860           <td class="mdname" nowrap> <em>user</em>, </td>
1861         </tr>
1862         <tr>
1863           <td></td>
1864           <td></td>
1865           <td class="md" nowrap><a class="el" href="classchanrec.html">chanrec</a> *&nbsp;</td>
1866           <td class="mdname" nowrap> <em>chan</em>, </td>
1867         </tr>
1868         <tr>
1869           <td></td>
1870           <td></td>
1871           <td class="md" nowrap>std::string&nbsp;</td>
1872           <td class="mdname" nowrap> <em>reason</em></td>
1873         </tr>
1874         <tr>
1875           <td></td>
1876           <td class="md">)&nbsp;</td>
1877           <td class="md" colspan="2"><code> [virtual]</code></td>
1878         </tr>
1879
1880       </table>
1881     </td>
1882   </tr>
1883 </table>
1884 <table cellspacing=5 cellpadding=0 border=0>
1885   <tr>
1886     <td>
1887       &nbsp;
1888     </td>
1889     <td>
1890
1891 <p>
1892 Called whenever a user is about to be kicked.
1893 <p>
1894 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.
1895 <p>
1896 Definition at line <a class="el" href="modules_8cpp-source.html#l00338">338</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1897 <p>
1898 <div class="fragment"><pre>00338 { <span class="keywordflow">return</span> 0; };
1899 </pre></div>    </td>
1900   </tr>
1901 </table>
1902 <a name="a19" doxytag="Module::OnUserPreMessage"></a><p>
1903 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1904   <tr>
1905     <td class="mdRow">
1906       <table cellpadding="0" cellspacing="0" border="0">
1907         <tr>
1908           <td class="md" nowrap valign="top"> int Module::OnUserPreMessage </td>
1909           <td class="md" valign="top">(&nbsp;</td>
1910           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
1911           <td class="mdname" nowrap> <em>user</em>, </td>
1912         </tr>
1913         <tr>
1914           <td></td>
1915           <td></td>
1916           <td class="md" nowrap>void *&nbsp;</td>
1917           <td class="mdname" nowrap> <em>dest</em>, </td>
1918         </tr>
1919         <tr>
1920           <td></td>
1921           <td></td>
1922           <td class="md" nowrap>int&nbsp;</td>
1923           <td class="mdname" nowrap> <em>target_type</em>, </td>
1924         </tr>
1925         <tr>
1926           <td></td>
1927           <td></td>
1928           <td class="md" nowrap>std::string &amp;&nbsp;</td>
1929           <td class="mdname" nowrap> <em>text</em></td>
1930         </tr>
1931         <tr>
1932           <td></td>
1933           <td class="md">)&nbsp;</td>
1934           <td class="md" colspan="2"><code> [virtual]</code></td>
1935         </tr>
1936
1937       </table>
1938     </td>
1939   </tr>
1940 </table>
1941 <table cellspacing=5 cellpadding=0 border=0>
1942   <tr>
1943     <td>
1944       &nbsp;
1945     </td>
1946     <td>
1947
1948 <p>
1949 Called whenever a user is about to PRIVMSG A user or a channel, before any processing is done.
1950 <p>
1951 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.
1952 <p>
1953 Definition at line <a class="el" href="modules_8cpp-source.html#l00323">323</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1954 <p>
1955 <div class="fragment"><pre>00323 { <span class="keywordflow">return</span> 0; };
1956 </pre></div>    </td>
1957   </tr>
1958 </table>
1959 <a name="a21" doxytag="Module::OnUserPreNick"></a><p>
1960 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1961   <tr>
1962     <td class="mdRow">
1963       <table cellpadding="0" cellspacing="0" border="0">
1964         <tr>
1965           <td class="md" nowrap valign="top"> int Module::OnUserPreNick </td>
1966           <td class="md" valign="top">(&nbsp;</td>
1967           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
1968           <td class="mdname" nowrap> <em>user</em>, </td>
1969         </tr>
1970         <tr>
1971           <td></td>
1972           <td></td>
1973           <td class="md" nowrap>std::string&nbsp;</td>
1974           <td class="mdname" nowrap> <em>newnick</em></td>
1975         </tr>
1976         <tr>
1977           <td></td>
1978           <td class="md">)&nbsp;</td>
1979           <td class="md" colspan="2"><code> [virtual]</code></td>
1980         </tr>
1981
1982       </table>
1983     </td>
1984   </tr>
1985 </table>
1986 <table cellspacing=5 cellpadding=0 border=0>
1987   <tr>
1988     <td>
1989       &nbsp;
1990     </td>
1991     <td>
1992
1993 <p>
1994 Called before any nickchange, local or remote.
1995 <p>
1996 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.
1997 <p>
1998 Definition at line <a class="el" href="modules_8cpp-source.html#l00325">325</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1999 <p>
2000 <div class="fragment"><pre>00325 { <span class="keywordflow">return</span> 0; };
2001 </pre></div>    </td>
2002   </tr>
2003 </table>
2004 <a name="a20" doxytag="Module::OnUserPreNotice"></a><p>
2005 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
2006   <tr>
2007     <td class="mdRow">
2008       <table cellpadding="0" cellspacing="0" border="0">
2009         <tr>
2010           <td class="md" nowrap valign="top"> int Module::OnUserPreNotice </td>
2011           <td class="md" valign="top">(&nbsp;</td>
2012           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
2013           <td class="mdname" nowrap> <em>user</em>, </td>
2014         </tr>
2015         <tr>
2016           <td></td>
2017           <td></td>
2018           <td class="md" nowrap>void *&nbsp;</td>
2019           <td class="mdname" nowrap> <em>dest</em>, </td>
2020         </tr>
2021         <tr>
2022           <td></td>
2023           <td></td>
2024           <td class="md" nowrap>int&nbsp;</td>
2025           <td class="mdname" nowrap> <em>target_type</em>, </td>
2026         </tr>
2027         <tr>
2028           <td></td>
2029           <td></td>
2030           <td class="md" nowrap>std::string &amp;&nbsp;</td>
2031           <td class="mdname" nowrap> <em>text</em></td>
2032         </tr>
2033         <tr>
2034           <td></td>
2035           <td class="md">)&nbsp;</td>
2036           <td class="md" colspan="2"><code> [virtual]</code></td>
2037         </tr>
2038
2039       </table>
2040     </td>
2041   </tr>
2042 </table>
2043 <table cellspacing=5 cellpadding=0 border=0>
2044   <tr>
2045     <td>
2046       &nbsp;
2047     </td>
2048     <td>
2049
2050 <p>
2051 Called whenever a user is about to NOTICE A user or a channel, before any processing is done.
2052 <p>
2053 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.
2054 <p>
2055 Definition at line <a class="el" href="modules_8cpp-source.html#l00324">324</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
2056 <p>
2057 <div class="fragment"><pre>00324 { <span class="keywordflow">return</span> 0; };
2058 </pre></div>    </td>
2059   </tr>
2060 </table>
2061 <a name="a4" doxytag="Module::OnUserQuit"></a><p>
2062 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
2063   <tr>
2064     <td class="mdRow">
2065       <table cellpadding="0" cellspacing="0" border="0">
2066         <tr>
2067           <td class="md" nowrap valign="top"> void Module::OnUserQuit </td>
2068           <td class="md" valign="top">(&nbsp;</td>
2069           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
2070           <td class="mdname1" valign="top" nowrap> <em>user</em>          </td>
2071           <td class="md" valign="top">&nbsp;)&nbsp;</td>
2072           <td class="md" nowrap><code> [virtual]</code></td>
2073         </tr>
2074
2075       </table>
2076     </td>
2077   </tr>
2078 </table>
2079 <table cellspacing=5 cellpadding=0 border=0>
2080   <tr>
2081     <td>
2082       &nbsp;
2083     </td>
2084     <td>
2085
2086 <p>
2087 Called when a user quits.
2088 <p>
2089 The details of the exiting user are available to you in the parameter userrec *user
2090 <p>
2091 Definition at line <a class="el" href="modules_8cpp-source.html#l00309">309</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
2092 <p>
2093 <div class="fragment"><pre>00309 { }
2094 </pre></div>    </td>
2095   </tr>
2096 </table>
2097 <a name="a33" doxytag="Module::OnUserRegister"></a><p>
2098 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
2099   <tr>
2100     <td class="mdRow">
2101       <table cellpadding="0" cellspacing="0" border="0">
2102         <tr>
2103           <td class="md" nowrap valign="top"> void Module::OnUserRegister </td>
2104           <td class="md" valign="top">(&nbsp;</td>
2105           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
2106           <td class="mdname1" valign="top" nowrap> <em>user</em>          </td>
2107           <td class="md" valign="top">&nbsp;)&nbsp;</td>
2108           <td class="md" nowrap><code> [virtual]</code></td>
2109         </tr>
2110
2111       </table>
2112     </td>
2113   </tr>
2114 </table>
2115 <table cellspacing=5 cellpadding=0 border=0>
2116   <tr>
2117     <td>
2118       &nbsp;
2119     </td>
2120     <td>
2121
2122 <p>
2123 Called whenever a user is about to register their connection (e.g.
2124 <p>
2125 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.
2126 <p>
2127 Definition at line <a class="el" href="modules_8cpp-source.html#l00337">337</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
2128 <p>
2129 <div class="fragment"><pre>00337 { };
2130 </pre></div>    </td>
2131   </tr>
2132 </table>
2133 <a name="a24" doxytag="Module::OnUserSync"></a><p>
2134 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
2135   <tr>
2136     <td class="mdRow">
2137       <table cellpadding="0" cellspacing="0" border="0">
2138         <tr>
2139           <td class="md" nowrap valign="top"> <a class="el" href="modules_8h.html#a32">string_list</a> Module::OnUserSync </td>
2140           <td class="md" valign="top">(&nbsp;</td>
2141           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
2142           <td class="mdname1" valign="top" nowrap> <em>user</em>          </td>
2143           <td class="md" valign="top">&nbsp;)&nbsp;</td>
2144           <td class="md" nowrap><code> [virtual]</code></td>
2145         </tr>
2146
2147       </table>
2148     </td>
2149   </tr>
2150 </table>
2151 <table cellspacing=5 cellpadding=0 border=0>
2152   <tr>
2153     <td>
2154       &nbsp;
2155     </td>
2156     <td>
2157
2158 <p>
2159 Called during a netburst to sync user data.
2160 <p>
2161 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.
2162 <p>
2163 Definition at line <a class="el" href="modules_8cpp-source.html#l00328">328</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
2164 <p>
2165 References <a class="el" href="modules_8h-source.html#l00068">string_list</a>.
2166 <p>
2167 <div class="fragment"><pre>00328 { <a class="code" href="modules_8h.html#a32">string_list</a> empty; <span class="keywordflow">return</span> empty; }
2168 </pre></div>    </td>
2169   </tr>
2170 </table>
2171 <a name="a17" doxytag="Module::OnWhois"></a><p>
2172 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
2173   <tr>
2174     <td class="mdRow">
2175       <table cellpadding="0" cellspacing="0" border="0">
2176         <tr>
2177           <td class="md" nowrap valign="top"> void Module::OnWhois </td>
2178           <td class="md" valign="top">(&nbsp;</td>
2179           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
2180           <td class="mdname" nowrap> <em>source</em>, </td>
2181         </tr>
2182         <tr>
2183           <td></td>
2184           <td></td>
2185           <td class="md" nowrap><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
2186           <td class="mdname" nowrap> <em>dest</em></td>
2187         </tr>
2188         <tr>
2189           <td></td>
2190           <td class="md">)&nbsp;</td>
2191           <td class="md" colspan="2"><code> [virtual]</code></td>
2192         </tr>
2193
2194       </table>
2195     </td>
2196   </tr>
2197 </table>
2198 <table cellspacing=5 cellpadding=0 border=0>
2199   <tr>
2200     <td>
2201       &nbsp;
2202     </td>
2203     <td>
2204
2205 <p>
2206 Called whenever a /WHOIS is performed on a local user.
2207 <p>
2208 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.
2209 <p>
2210 Definition at line <a class="el" href="modules_8cpp-source.html#l00321">321</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
2211 <p>
2212 <div class="fragment"><pre>00321 { };
2213 </pre></div>    </td>
2214   </tr>
2215 </table>
2216 <hr>The documentation for this class was generated from the following files:<ul>
2217 <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>
2218 <hr size="1"><address style="align: right;"><small>Generated on Sat Apr 16 18:57:20 2005 for InspIRCd by
2219 <a href="http://www.doxygen.org/index.html">
2220 <img src="doxygen.png" alt="doxygen" align="middle" border=0 >
2221 </a>1.3.3 </small></address>
2222 </body>
2223 </html>