docs/module-doc/classModule.html

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