docs/module-doc/classModule.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
   2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
   3 <title>InspIRCd: Module class Reference</title>
   4 <link href="inspircd.css" rel="stylesheet" type="text/css">
   5 </head><body>
   6 <!-- Generated by Doxygen 1.3.3 -->
   7 <div class="qindex"><a class="qindex" href="main.html">Main&nbsp;Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class&nbsp;Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical&nbsp;List</a> | <a class="qindex" href="annotated.html">Compound&nbsp;List</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="functions.html">Compound&nbsp;Members</a> | <a class="qindex" href="globals.html">File&nbsp;Members</a></div>
   8 <h1>Module Class Reference</h1>Base class for all InspIRCd modules This class is the base class for InspIRCd modules.
   9 <a href="#_details">More...</a>
  10 <p>
  11 <code>#include &lt;<a class="el" href="modules_8h-source.html">modules.h</a>&gt;</code>
  12 <p>
  13 Inherits <a class="el" href="classclassbase.html">classbase</a>.
  14 <p>
  15 <a href="classModule-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
  16 <tr><td></td></tr>
  17 <tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
  18 <tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a0">Module</a> ()</td></tr>
  19
  20 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor creates a module class. </em> <a href="#a0"></a><em><br><br></td></tr>
  21 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a1">~Module</a> ()</td></tr>
  22
  23 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default destructor destroys a module class. </em> <a href="#a1"></a><em><br><br></td></tr>
  24 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="classVersion.html">Version</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a2">GetVersion</a> ()</td></tr>
  25
  26 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the version number of a Module. </em> <a href="#a2"></a><em><br><br></td></tr>
  27 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a3">OnUserConnect</a> (<a class="el" href="classuserrec.html">userrec</a> *user)</td></tr>
  28
  29 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called when a user connects. </em> <a href="#a3"></a><em><br><br></td></tr>
  30 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a4">OnUserQuit</a> (<a class="el" href="classuserrec.html">userrec</a> *user)</td></tr>
  31
  32 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called when a user quits. </em> <a href="#a4"></a><em><br><br></td></tr>
  33 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a5">OnUserDisconnect</a> (<a class="el" href="classuserrec.html">userrec</a> *user)</td></tr>
  34
  35 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called whenever a user's socket is closed. </em> <a href="#a5"></a><em><br><br></td></tr>
  36 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a6">OnUserJoin</a> (<a class="el" href="classuserrec.html">userrec</a> *user, <a class="el" href="classchanrec.html">chanrec</a> *channel)</td></tr>
  37
  38 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called when a user joins a channel. </em> <a href="#a6"></a><em><br><br></td></tr>
  39 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a7">OnUserPart</a> (<a class="el" href="classuserrec.html">userrec</a> *user, <a class="el" href="classchanrec.html">chanrec</a> *channel)</td></tr>
  40
  41 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called when a user parts a channel. </em> <a href="#a7"></a><em><br><br></td></tr>
  42 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a8">OnPacketTransmit</a> (std::string &amp;data, std::string serv)</td></tr>
  43
  44 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called before a packet is transmitted across the irc network between two irc servers. </em> <a href="#a8"></a><em><br><br></td></tr>
  45 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a9">OnPacketReceive</a> (std::string &amp;data, std::string serv)</td></tr>
  46
  47 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called after a packet is received from another irc server. </em> <a href="#a9"></a><em><br><br></td></tr>
  48 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a10">OnRehash</a> ()</td></tr>
  49
  50 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called on rehash. </em> <a href="#a10"></a><em><br><br></td></tr>
  51 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a11">OnServerRaw</a> (std::string &amp;raw, bool inbound, <a class="el" href="classuserrec.html">userrec</a> *user)</td></tr>
  52
  53 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called when a raw command is transmitted or received. </em> <a href="#a11"></a><em><br><br></td></tr>
  54 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual int&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a12">OnExtendedMode</a> (<a class="el" href="classuserrec.html">userrec</a> *user, void *target, char modechar, int type, bool mode_on, <a class="el" href="modules_8h.html#a32">string_list</a> &amp;params)</td></tr>
  55
  56 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called whenever an extended mode is to be processed. </em> <a href="#a12"></a><em><br><br></td></tr>
  57 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual int&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a13">OnUserPreJoin</a> (<a class="el" href="classuserrec.html">userrec</a> *user, <a class="el" href="classchanrec.html">chanrec</a> *chan, const char *cname)</td></tr>
  58
  59 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called whenever a user is about to join a channel, before any processing is done. </em> <a href="#a13"></a><em><br><br></td></tr>
  60 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual int&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a14">OnUserPreKick</a> (<a class="el" href="classuserrec.html">userrec</a> *source, <a class="el" href="classuserrec.html">userrec</a> *user, <a class="el" href="classchanrec.html">chanrec</a> *chan, std::string reason)</td></tr>
  61
  62 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called whenever a user is about to be kicked. </em> <a href="#a14"></a><em><br><br></td></tr>
  63 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a15">OnUserKick</a> (<a class="el" href="classuserrec.html">userrec</a> *source, <a class="el" href="classuserrec.html">userrec</a> *user, <a class="el" href="classchanrec.html">chanrec</a> *chan, std::string reason)</td></tr>
  64
  65 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called whenever a user is kicked. </em> <a href="#a15"></a><em><br><br></td></tr>
  66 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a16">OnOper</a> (<a class="el" href="classuserrec.html">userrec</a> *user)</td></tr>
  67
  68 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called whenever a user opers locally. </em> <a href="#a16"></a><em><br><br></td></tr>
  69 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a17">OnInfo</a> (<a class="el" href="classuserrec.html">userrec</a> *user)</td></tr>
  70
  71 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called whenever a user types /INFO. </em> <a href="#a17"></a><em><br><br></td></tr>
  72 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a18">OnWhois</a> (<a class="el" href="classuserrec.html">userrec</a> *source, <a class="el" href="classuserrec.html">userrec</a> *dest)</td></tr>
  73
  74 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called whenever a /WHOIS is performed on a local user. </em> <a href="#a18"></a><em><br><br></td></tr>
  75 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual int&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a19">OnUserPreInvite</a> (<a class="el" href="classuserrec.html">userrec</a> *source, <a class="el" href="classuserrec.html">userrec</a> *dest, <a class="el" href="classchanrec.html">chanrec</a> *channel)</td></tr>
  76
  77 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called whenever a user is about to invite another user into a channel, before any processing is done. </em> <a href="#a19"></a><em><br><br></td></tr>
  78 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual int&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a20">OnUserPreMessage</a> (<a class="el" href="classuserrec.html">userrec</a> *user, void *dest, int target_type, std::string &amp;text)</td></tr>
  79
  80 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called whenever a user is about to PRIVMSG A user or a channel, before any processing is done. </em> <a href="#a20"></a><em><br><br></td></tr>
  81 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual int&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a21">OnUserPreNotice</a> (<a class="el" href="classuserrec.html">userrec</a> *user, void *dest, int target_type, std::string &amp;text)</td></tr>
  82
  83 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called whenever a user is about to NOTICE A user or a channel, before any processing is done. </em> <a href="#a21"></a><em><br><br></td></tr>
  84 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual int&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a22">OnUserPreNick</a> (<a class="el" href="classuserrec.html">userrec</a> *user, std::string newnick)</td></tr>
  85
  86 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called before any nickchange, local or remote. </em> <a href="#a22"></a><em><br><br></td></tr>
  87 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a23">OnUserPostNick</a> (<a class="el" href="classuserrec.html">userrec</a> *user, std::string oldnick)</td></tr>
  88
  89 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called after any nickchange, local or remote. </em> <a href="#a23"></a><em><br><br></td></tr>
  90 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual int&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a24">OnAccessCheck</a> (<a class="el" href="classuserrec.html">userrec</a> *source, <a class="el" href="classuserrec.html">userrec</a> *dest, <a class="el" href="classchanrec.html">chanrec</a> *channel, int access_type)</td></tr>
  91
  92 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called before an action which requires a channel privilage check. </em> <a href="#a24"></a><em><br><br></td></tr>
  93 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="modules_8h.html#a32">string_list</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a25">OnUserSync</a> (<a class="el" href="classuserrec.html">userrec</a> *user)</td></tr>
  94
  95 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called during a netburst to sync user data. </em> <a href="#a25"></a><em><br><br></td></tr>
  96 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="modules_8h.html#a32">string_list</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a26">OnChannelSync</a> (<a class="el" href="classchanrec.html">chanrec</a> *chan)</td></tr>
  97
  98 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called during a netburst to sync channel data. </em> <a href="#a26"></a><em><br><br></td></tr>
  99 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a27">On005Numeric</a> (std::string &amp;output)</td></tr>
 100
 101 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called when a 005 numeric is about to be output. </em> <a href="#a27"></a><em><br><br></td></tr>
 102 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual int&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a28">OnKill</a> (<a class="el" href="classuserrec.html">userrec</a> *source, <a class="el" href="classuserrec.html">userrec</a> *dest, std::string reason)</td></tr>
 103
 104 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called when a client is disconnected by KILL. </em> <a href="#a28"></a><em><br><br></td></tr>
 105 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a29">OnLoadModule</a> (<a class="el" href="classModule.html">Module</a> *mod, std::string name)</td></tr>
 106
 107 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called whenever a module is loaded. </em> <a href="#a29"></a><em><br><br></td></tr>
 108 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a30">OnBackgroundTimer</a> (time_t curtime)</td></tr>
 109
 110 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called once every five seconds for background processing. </em> <a href="#a30"></a><em><br><br></td></tr>
 111 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a31">OnSendList</a> (<a class="el" href="classuserrec.html">userrec</a> *user, <a class="el" href="classchanrec.html">chanrec</a> *channel, char mode)</td></tr>
 112
 113 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called whenever a list is needed for a listmode. </em> <a href="#a31"></a><em><br><br></td></tr>
 114 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual int&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a32">OnPreCommand</a> (std::string command, char **parameters, int pcnt, <a class="el" href="classuserrec.html">userrec</a> *user)</td></tr>
 115
 116 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called whenever any command is about to be executed. </em> <a href="#a32"></a><em><br><br></td></tr>
 117 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a33">OnCheckReady</a> (<a class="el" href="classuserrec.html">userrec</a> *user)</td></tr>
 118
 119 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called to check if a user who is connecting can now be allowed to register If any modules return false for this function, the user is held in the waiting state until all modules return true. </em> <a href="#a33"></a><em><br><br></td></tr>
 120 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a34">OnUserRegister</a> (<a class="el" href="classuserrec.html">userrec</a> *user)</td></tr>
 121
 122 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called whenever a user is about to register their connection (e.g. </em> <a href="#a34"></a><em><br><br></td></tr>
 123 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual int&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a35">OnRawMode</a> (<a class="el" href="classuserrec.html">userrec</a> *user, <a class="el" href="classchanrec.html">chanrec</a> *chan, char mode, std::string param, bool adding, int pcnt)</td></tr>
 124
 125 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called whenever a mode character is processed. </em> <a href="#a35"></a><em><br><br></td></tr>
 126 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual int&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a36">OnCheckInvite</a> (<a class="el" href="classuserrec.html">userrec</a> *user, <a class="el" href="classchanrec.html">chanrec</a> *chan)</td></tr>
 127
 128 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called whenever a user joins a channel, to determine if invite checks should go ahead or not. </em> <a href="#a36"></a><em><br><br></td></tr>
 129 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual int&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a37">OnCheckKey</a> (<a class="el" href="classuserrec.html">userrec</a> *user, <a class="el" href="classchanrec.html">chanrec</a> *chan, std::string keygiven)</td></tr>
 130
 131 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called whenever a user joins a channel, to determine if key checks should go ahead or not. </em> <a href="#a37"></a><em><br><br></td></tr>
 132 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual int&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a38">OnCheckLimit</a> (<a class="el" href="classuserrec.html">userrec</a> *user, <a class="el" href="classchanrec.html">chanrec</a> *chan)</td></tr>
 133
 134 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called whenever a user joins a channel, to determine if channel limit checks should go ahead or not. </em> <a href="#a38"></a><em><br><br></td></tr>
 135 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual int&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a39">OnCheckBan</a> (<a class="el" href="classuserrec.html">userrec</a> *user, <a class="el" href="classchanrec.html">chanrec</a> *chan)</td></tr>
 136
 137 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called whenever a user joins a channel, to determine if banlist checks should go ahead or not. </em> <a href="#a39"></a><em><br><br></td></tr>
 138 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a40">OnStats</a> (char symbol)</td></tr>
 139
 140 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called on all /STATS commands This method is triggered for all /STATS use, including stats symbols handled by the core. </em> <a href="#a40"></a><em><br><br></td></tr>
 141 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual int&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a41">OnChangeLocalUserHost</a> (<a class="el" href="classuserrec.html">userrec</a> *user, std::string newhost)</td></tr>
 142
 143 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called whenever a change of a local users displayed host is attempted. </em> <a href="#a41"></a><em><br><br></td></tr>
 144 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual int&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a42">OnChangeLocalUserGECOS</a> (<a class="el" href="classuserrec.html">userrec</a> *user, std::string newhost)</td></tr>
 145
 146 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called whenever a change of a local users GECOS (fullname field) is attempted. </em> <a href="#a42"></a><em><br><br></td></tr>
 147 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual int&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a43">OnLocalTopicChange</a> (<a class="el" href="classuserrec.html">userrec</a> *user, <a class="el" href="classchanrec.html">chanrec</a> *chan, std::string topic)</td></tr>
 148
 149 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called whenever a topic is changed by a local user. </em> <a href="#a43"></a><em><br><br></td></tr>
 150 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual int&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a44">OnMeshToken</a> (char token, <a class="el" href="modules_8h.html#a32">string_list</a> params, <a class="el" href="classserverrec.html">serverrec</a> *source, <a class="el" href="classserverrec.html">serverrec</a> *reply, std::string tcp_host, std::string ipaddr, int port)</td></tr>
 151
 152 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called whenever an unknown token is received in a server to server link. </em> <a href="#a44"></a><em><br><br></td></tr>
 153 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a45">OnEvent</a> (<a class="el" href="classEvent.html">Event</a> *event)</td></tr>
 154
 155 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called whenever an <a class="el" href="classEvent.html">Event</a> class is sent to all module by another module. </em> <a href="#a45"></a><em><br><br></td></tr>
 156 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual char *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a46">OnRequest</a> (<a class="el" href="classRequest.html">Request</a> *request)</td></tr>
 157
 158 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called whenever a <a class="el" href="classRequest.html">Request</a> class is sent to your module by another module. </em> <a href="#a46"></a><em><br><br></td></tr>
 159 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual int&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a47">OnOperCompare</a> (std::string password, std::string input)</td></tr>
 160
 161 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called whenever an oper password is to be compared to what a user has input. </em> <a href="#a47"></a><em><br><br></td></tr>
 162 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a48">OnGlobalOper</a> (<a class="el" href="classuserrec.html">userrec</a> *user)</td></tr>
 163
 164 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called whenever a user is given usermode +o, anywhere on the network. </em> <a href="#a48"></a><em><br><br></td></tr>
 165 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a49">OnGlobalConnect</a> (<a class="el" href="classuserrec.html">userrec</a> *user)</td></tr>
 166
 167 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called whenever a user connects, anywhere on the network. </em> <a href="#a49"></a><em><br><br></td></tr>
 168 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual int&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a50">OnAddBan</a> (<a class="el" href="classuserrec.html">userrec</a> *source, <a class="el" href="classchanrec.html">chanrec</a> *channel, std::string banmask)</td></tr>
 169
 170 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called whenever a ban is added to a channel's list. </em> <a href="#a50"></a><em><br><br></td></tr>
 171 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual int&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a51">OnDelBan</a> (<a class="el" href="classuserrec.html">userrec</a> *source, <a class="el" href="classchanrec.html">chanrec</a> *channel, std::string banmask)</td></tr>
 172
 173 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called whenever a ban is removed from a channel's list. </em> <a href="#a51"></a><em><br><br></td></tr>
 174 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a52">OnRawSocketAccept</a> (int fd, std::string ip, int localport)</td></tr>
 175
 176 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called immediately after any connection is accepted. </em> <a href="#a52"></a><em><br><br></td></tr>
 177 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual int&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a53">OnRawSocketWrite</a> (int fd, char *buffer, int count)</td></tr>
 178
 179 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called immediately before any write() operation on a user's socket in the core. </em> <a href="#a53"></a><em><br><br></td></tr>
 180 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a54">OnRawSocketClose</a> (int fd)</td></tr>
 181
 182 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called immediately before any socket is closed. </em> <a href="#a54"></a><em><br><br></td></tr>
 183 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual int&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a55">OnRawSocketRead</a> (int fd, char *buffer, unsigned int count, int &amp;readresult)</td></tr>
 184
 185 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called immediately before any read() operation on a client socket in the core. </em> <a href="#a55"></a><em><br><br></td></tr>
 186 </table>
 187 <hr><a name="_details"></a><h2>Detailed Description</h2>
 188 Base class for all InspIRCd modules This class is the base class for InspIRCd modules.
 189 <p>
 190 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.
 191 <p>
 192
 193 <p>
 194 Definition at line <a class="el" href="modules_8h-source.html#l00236">236</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
 195 <a name="a0" doxytag="Module::Module"></a><p>
 196 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 197   <tr>
 198     <td class="mdRow">
 199       <table cellpadding="0" cellspacing="0" border="0">
 200         <tr>
 201           <td class="md" nowrap valign="top"> Module::Module </td>
 202           <td class="md" valign="top">(&nbsp;</td>
 203           <td class="mdname1" valign="top" nowrap>          </td>
 204           <td class="md" valign="top">&nbsp;)&nbsp;</td>
 205           <td class="md" nowrap></td>
 206         </tr>
 207
 208       </table>
 209     </td>
 210   </tr>
 211 </table>
 212 <table cellspacing=5 cellpadding=0 border=0>
 213   <tr>
 214     <td>
 215       &nbsp;
 216     </td>
 217     <td>
 218
 219 <p>
 220 Default constructor creates a module class.
 221 <p>
 222
 223 <p>
 224 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>.
 225 <p>
 226 <div class="fragment"><pre>00370 { }
 227 </pre></div>    </td>
 228   </tr>
 229 </table>
 230 <a name="a1" doxytag="Module::~Module"></a><p>
 231 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 232   <tr>
 233     <td class="mdRow">
 234       <table cellpadding="0" cellspacing="0" border="0">
 235         <tr>
 236           <td class="md" nowrap valign="top"> Module::~<a class="el" href="classModule.html">Module</a> </td>
 237           <td class="md" valign="top">(&nbsp;</td>
 238           <td class="mdname1" valign="top" nowrap>          </td>
 239           <td class="md" valign="top">&nbsp;)&nbsp;</td>
 240           <td class="md" nowrap><code> [virtual]</code></td>
 241         </tr>
 242
 243       </table>
 244     </td>
 245   </tr>
 246 </table>
 247 <table cellspacing=5 cellpadding=0 border=0>
 248   <tr>
 249     <td>
 250       &nbsp;
 251     </td>
 252     <td>
 253
 254 <p>
 255 Default destructor destroys a module class.
 256 <p>
 257
 258 <p>
 259 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>.
 260 <p>
 261 <div class="fragment"><pre>00371 { }
 262 </pre></div>    </td>
 263   </tr>
 264 </table>
 265 <hr><h2>Member Function Documentation</h2>
 266 <a name="a2" doxytag="Module::GetVersion"></a><p>
 267 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 268   <tr>
 269     <td class="mdRow">
 270       <table cellpadding="0" cellspacing="0" border="0">
 271         <tr>
 272           <td class="md" nowrap valign="top"> <a class="el" href="classVersion.html">Version</a> Module::GetVersion </td>
 273           <td class="md" valign="top">(&nbsp;</td>
 274           <td class="mdname1" valign="top" nowrap>          </td>
 275           <td class="md" valign="top">&nbsp;)&nbsp;</td>
 276           <td class="md" nowrap><code> [virtual]</code></td>
 277         </tr>
 278
 279       </table>
 280     </td>
 281   </tr>
 282 </table>
 283 <table cellspacing=5 cellpadding=0 border=0>
 284   <tr>
 285     <td>
 286       &nbsp;
 287     </td>
 288     <td>
 289
 290 <p>
 291 Returns the version number of a Module.
 292 <p>
 293 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>
 294 <p>
 295 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>.
 296 <p>
 297 References <a class="el" href="modules_8h-source.html#l00054">VF_VENDOR</a>.
 298 <p>
 299 <div class="fragment"><pre>00383 { <span class="keywordflow">return</span> <a class="code" href="classVersion.html">Version</a>(1,0,0,0,VF_VENDOR); }
 300 </pre></div>    </td>
 301   </tr>
 302 </table>
 303 <a name="a27" doxytag="Module::On005Numeric"></a><p>
 304 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 305   <tr>
 306     <td class="mdRow">
 307       <table cellpadding="0" cellspacing="0" border="0">
 308         <tr>
 309           <td class="md" nowrap valign="top"> void Module::On005Numeric </td>
 310           <td class="md" valign="top">(&nbsp;</td>
 311           <td class="md" nowrap valign="top">std::string &amp;&nbsp;</td>
 312           <td class="mdname1" valign="top" nowrap> <em>output</em>          </td>
 313           <td class="md" valign="top">&nbsp;)&nbsp;</td>
 314           <td class="md" nowrap><code> [virtual]</code></td>
 315         </tr>
 316
 317       </table>
 318     </td>
 319   </tr>
 320 </table>
 321 <table cellspacing=5 cellpadding=0 border=0>
 322   <tr>
 323     <td>
 324       &nbsp;
 325     </td>
 326     <td>
 327
 328 <p>
 329 Called when a 005 numeric is about to be output.
 330 <p>
 331 The module should modify the 005 numeric if needed to indicate its features.
 332 <p>
 333 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>.
 334 <p>
 335 <div class="fragment"><pre>00395 { };
 336 </pre></div>    </td>
 337   </tr>
 338 </table>
 339 <a name="a24" doxytag="Module::OnAccessCheck"></a><p>
 340 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 341   <tr>
 342     <td class="mdRow">
 343       <table cellpadding="0" cellspacing="0" border="0">
 344         <tr>
 345           <td class="md" nowrap valign="top"> int Module::OnAccessCheck </td>
 346           <td class="md" valign="top">(&nbsp;</td>
 347           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 348           <td class="mdname" nowrap> <em>source</em>, </td>
 349         </tr>
 350         <tr>
 351           <td></td>
 352           <td></td>
 353           <td class="md" nowrap><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 354           <td class="mdname" nowrap> <em>dest</em>, </td>
 355         </tr>
 356         <tr>
 357           <td></td>
 358           <td></td>
 359           <td class="md" nowrap><a class="el" href="classchanrec.html">chanrec</a> *&nbsp;</td>
 360           <td class="mdname" nowrap> <em>channel</em>, </td>
 361         </tr>
 362         <tr>
 363           <td></td>
 364           <td></td>
 365           <td class="md" nowrap>int&nbsp;</td>
 366           <td class="mdname" nowrap> <em>access_type</em></td>
 367         </tr>
 368         <tr>
 369           <td></td>
 370           <td class="md">)&nbsp;</td>
 371           <td class="md" colspan="2"><code> [virtual]</code></td>
 372         </tr>
 373
 374       </table>
 375     </td>
 376   </tr>
 377 </table>
 378 <table cellspacing=5 cellpadding=0 border=0>
 379   <tr>
 380     <td>
 381       &nbsp;
 382     </td>
 383     <td>
 384
 385 <p>
 386 Called before an action which requires a channel privilage check.
 387 <p>
 388 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>
 389 <br>
 390  AC_KICK (0) - A user is being kicked<br>
 391  AC_DEOP (1) - a user is being deopped<br>
 392  AC_OP (2) - a user is being opped<br>
 393  AC_VOICE (3) - a user is being voiced<br>
 394  AC_DEVOICE (4) - a user is being devoiced<br>
 395  AC_HALFOP (5) - a user is being halfopped<br>
 396  AC_DEHALFOP (6) - a user is being dehalfopped<br>
 397  AC_INVITE (7) - a user is being invited<br>
 398  AC_GENERAL_MODE (8) - a user channel mode is being changed<br>
 399 <br>
 400  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).
 401 <p>
 402 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>.
 403 <p>
 404 References <a class="el" href="modules_8h-source.html#l00037">ACR_DEFAULT</a>.
 405 <p>
 406 <div class="fragment"><pre>00392 { <span class="keywordflow">return</span> <a class="code" href="modules_8h.html#a8">ACR_DEFAULT</a>; };
 407 </pre></div>    </td>
 408   </tr>
 409 </table>
 410 <a name="a50" doxytag="Module::OnAddBan"></a><p>
 411 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 412   <tr>
 413     <td class="mdRow">
 414       <table cellpadding="0" cellspacing="0" border="0">
 415         <tr>
 416           <td class="md" nowrap valign="top"> int Module::OnAddBan </td>
 417           <td class="md" valign="top">(&nbsp;</td>
 418           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 419           <td class="mdname" nowrap> <em>source</em>, </td>
 420         </tr>
 421         <tr>
 422           <td></td>
 423           <td></td>
 424           <td class="md" nowrap><a class="el" href="classchanrec.html">chanrec</a> *&nbsp;</td>
 425           <td class="mdname" nowrap> <em>channel</em>, </td>
 426         </tr>
 427         <tr>
 428           <td></td>
 429           <td></td>
 430           <td class="md" nowrap>std::string&nbsp;</td>
 431           <td class="mdname" nowrap> <em>banmask</em></td>
 432         </tr>
 433         <tr>
 434           <td></td>
 435           <td class="md">)&nbsp;</td>
 436           <td class="md" colspan="2"><code> [virtual]</code></td>
 437         </tr>
 438
 439       </table>
 440     </td>
 441   </tr>
 442 </table>
 443 <table cellspacing=5 cellpadding=0 border=0>
 444   <tr>
 445     <td>
 446       &nbsp;
 447     </td>
 448     <td>
 449
 450 <p>
 451 Called whenever a ban is added to a channel's list.
 452 <p>
 453 Return a non-zero value to 'eat' the mode change and prevent the ban from being added.
 454 <p>
 455 Definition at line <a class="el" href="modules_8cpp-source.html#l00420">420</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 456 <p>
 457 <div class="fragment"><pre>00420 { <span class="keywordflow">return</span> 0; };
 458 </pre></div>    </td>
 459   </tr>
 460 </table>
 461 <a name="a30" doxytag="Module::OnBackgroundTimer"></a><p>
 462 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 463   <tr>
 464     <td class="mdRow">
 465       <table cellpadding="0" cellspacing="0" border="0">
 466         <tr>
 467           <td class="md" nowrap valign="top"> void Module::OnBackgroundTimer </td>
 468           <td class="md" valign="top">(&nbsp;</td>
 469           <td class="md" nowrap valign="top">time_t&nbsp;</td>
 470           <td class="mdname1" valign="top" nowrap> <em>curtime</em>          </td>
 471           <td class="md" valign="top">&nbsp;)&nbsp;</td>
 472           <td class="md" nowrap><code> [virtual]</code></td>
 473         </tr>
 474
 475       </table>
 476     </td>
 477   </tr>
 478 </table>
 479 <table cellspacing=5 cellpadding=0 border=0>
 480   <tr>
 481     <td>
 482       &nbsp;
 483     </td>
 484     <td>
 485
 486 <p>
 487 Called once every five seconds for background processing.
 488 <p>
 489 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.
 490 <p>
 491 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>.
 492 <p>
 493 <div class="fragment"><pre>00398 { };
 494 </pre></div>    </td>
 495   </tr>
 496 </table>
 497 <a name="a42" doxytag="Module::OnChangeLocalUserGECOS"></a><p>
 498 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 499   <tr>
 500     <td class="mdRow">
 501       <table cellpadding="0" cellspacing="0" border="0">
 502         <tr>
 503           <td class="md" nowrap valign="top"> int Module::OnChangeLocalUserGECOS </td>
 504           <td class="md" valign="top">(&nbsp;</td>
 505           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 506           <td class="mdname" nowrap> <em>user</em>, </td>
 507         </tr>
 508         <tr>
 509           <td></td>
 510           <td></td>
 511           <td class="md" nowrap>std::string&nbsp;</td>
 512           <td class="mdname" nowrap> <em>newhost</em></td>
 513         </tr>
 514         <tr>
 515           <td></td>
 516           <td class="md">)&nbsp;</td>
 517           <td class="md" colspan="2"><code> [virtual]</code></td>
 518         </tr>
 519
 520       </table>
 521     </td>
 522   </tr>
 523 </table>
 524 <table cellspacing=5 cellpadding=0 border=0>
 525   <tr>
 526     <td>
 527       &nbsp;
 528     </td>
 529     <td>
 530
 531 <p>
 532 Called whenever a change of a local users GECOS (fullname field) is attempted.
 533 <p>
 534 return 1 to deny the name change, or 0 to allow it.
 535 <p>
 536 Definition at line <a class="el" href="modules_8cpp-source.html#l00412">412</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 537 <p>
 538 <div class="fragment"><pre>00412 { <span class="keywordflow">return</span> 0; };
 539 </pre></div>    </td>
 540   </tr>
 541 </table>
 542 <a name="a41" doxytag="Module::OnChangeLocalUserHost"></a><p>
 543 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 544   <tr>
 545     <td class="mdRow">
 546       <table cellpadding="0" cellspacing="0" border="0">
 547         <tr>
 548           <td class="md" nowrap valign="top"> int Module::OnChangeLocalUserHost </td>
 549           <td class="md" valign="top">(&nbsp;</td>
 550           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 551           <td class="mdname" nowrap> <em>user</em>, </td>
 552         </tr>
 553         <tr>
 554           <td></td>
 555           <td></td>
 556           <td class="md" nowrap>std::string&nbsp;</td>
 557           <td class="mdname" nowrap> <em>newhost</em></td>
 558         </tr>
 559         <tr>
 560           <td></td>
 561           <td class="md">)&nbsp;</td>
 562           <td class="md" colspan="2"><code> [virtual]</code></td>
 563         </tr>
 564
 565       </table>
 566     </td>
 567   </tr>
 568 </table>
 569 <table cellspacing=5 cellpadding=0 border=0>
 570   <tr>
 571     <td>
 572       &nbsp;
 573     </td>
 574     <td>
 575
 576 <p>
 577 Called whenever a change of a local users displayed host is attempted.
 578 <p>
 579 Return 1 to deny the host change, or 0 to allow it.
 580 <p>
 581 Definition at line <a class="el" href="modules_8cpp-source.html#l00411">411</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 582 <p>
 583 <div class="fragment"><pre>00411 { <span class="keywordflow">return</span> 0; };
 584 </pre></div>    </td>
 585   </tr>
 586 </table>
 587 <a name="a26" doxytag="Module::OnChannelSync"></a><p>
 588 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 589   <tr>
 590     <td class="mdRow">
 591       <table cellpadding="0" cellspacing="0" border="0">
 592         <tr>
 593           <td class="md" nowrap valign="top"> <a class="el" href="modules_8h.html#a32">string_list</a> Module::OnChannelSync </td>
 594           <td class="md" valign="top">(&nbsp;</td>
 595           <td class="md" nowrap valign="top"><a class="el" href="classchanrec.html">chanrec</a> *&nbsp;</td>
 596           <td class="mdname1" valign="top" nowrap> <em>chan</em>          </td>
 597           <td class="md" valign="top">&nbsp;)&nbsp;</td>
 598           <td class="md" nowrap><code> [virtual]</code></td>
 599         </tr>
 600
 601       </table>
 602     </td>
 603   </tr>
 604 </table>
 605 <table cellspacing=5 cellpadding=0 border=0>
 606   <tr>
 607     <td>
 608       &nbsp;
 609     </td>
 610     <td>
 611
 612 <p>
 613 Called during a netburst to sync channel data.
 614 <p>
 615 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.
 616 <p>
 617 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>.
 618 <p>
 619 References <a class="el" href="modules_8h-source.html#l00068">string_list</a>.
 620 <p>
 621 <div class="fragment"><pre>00394 { <a class="code" href="modules_8h.html#a32">string_list</a> empty; <span class="keywordflow">return</span> empty; }
 622 </pre></div>    </td>
 623   </tr>
 624 </table>
 625 <a name="a39" doxytag="Module::OnCheckBan"></a><p>
 626 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 627   <tr>
 628     <td class="mdRow">
 629       <table cellpadding="0" cellspacing="0" border="0">
 630         <tr>
 631           <td class="md" nowrap valign="top"> int Module::OnCheckBan </td>
 632           <td class="md" valign="top">(&nbsp;</td>
 633           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 634           <td class="mdname" nowrap> <em>user</em>, </td>
 635         </tr>
 636         <tr>
 637           <td></td>
 638           <td></td>
 639           <td class="md" nowrap><a class="el" href="classchanrec.html">chanrec</a> *&nbsp;</td>
 640           <td class="mdname" nowrap> <em>chan</em></td>
 641         </tr>
 642         <tr>
 643           <td></td>
 644           <td class="md">)&nbsp;</td>
 645           <td class="md" colspan="2"><code> [virtual]</code></td>
 646         </tr>
 647
 648       </table>
 649     </td>
 650   </tr>
 651 </table>
 652 <table cellspacing=5 cellpadding=0 border=0>
 653   <tr>
 654     <td>
 655       &nbsp;
 656     </td>
 657     <td>
 658
 659 <p>
 660 Called whenever a user joins a channel, to determine if banlist checks should go ahead or not.
 661 <p>
 662 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.
 663 <p>
 664 Definition at line <a class="el" href="modules_8cpp-source.html#l00409">409</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 665 <p>
 666 <div class="fragment"><pre>00409 { <span class="keywordflow">return</span> 0; };
 667 </pre></div>    </td>
 668   </tr>
 669 </table>
 670 <a name="a36" doxytag="Module::OnCheckInvite"></a><p>
 671 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 672   <tr>
 673     <td class="mdRow">
 674       <table cellpadding="0" cellspacing="0" border="0">
 675         <tr>
 676           <td class="md" nowrap valign="top"> int Module::OnCheckInvite </td>
 677           <td class="md" valign="top">(&nbsp;</td>
 678           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 679           <td class="mdname" nowrap> <em>user</em>, </td>
 680         </tr>
 681         <tr>
 682           <td></td>
 683           <td></td>
 684           <td class="md" nowrap><a class="el" href="classchanrec.html">chanrec</a> *&nbsp;</td>
 685           <td class="mdname" nowrap> <em>chan</em></td>
 686         </tr>
 687         <tr>
 688           <td></td>
 689           <td class="md">)&nbsp;</td>
 690           <td class="md" colspan="2"><code> [virtual]</code></td>
 691         </tr>
 692
 693       </table>
 694     </td>
 695   </tr>
 696 </table>
 697 <table cellspacing=5 cellpadding=0 border=0>
 698   <tr>
 699     <td>
 700       &nbsp;
 701     </td>
 702     <td>
 703
 704 <p>
 705 Called whenever a user joins a channel, to determine if invite checks should go ahead or not.
 706 <p>
 707 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.
 708 <p>
 709 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>.
 710 <p>
 711 <div class="fragment"><pre>00406 { <span class="keywordflow">return</span> 0; };
 712 </pre></div>    </td>
 713   </tr>
 714 </table>
 715 <a name="a37" doxytag="Module::OnCheckKey"></a><p>
 716 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 717   <tr>
 718     <td class="mdRow">
 719       <table cellpadding="0" cellspacing="0" border="0">
 720         <tr>
 721           <td class="md" nowrap valign="top"> int Module::OnCheckKey </td>
 722           <td class="md" valign="top">(&nbsp;</td>
 723           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 724           <td class="mdname" nowrap> <em>user</em>, </td>
 725         </tr>
 726         <tr>
 727           <td></td>
 728           <td></td>
 729           <td class="md" nowrap><a class="el" href="classchanrec.html">chanrec</a> *&nbsp;</td>
 730           <td class="mdname" nowrap> <em>chan</em>, </td>
 731         </tr>
 732         <tr>
 733           <td></td>
 734           <td></td>
 735           <td class="md" nowrap>std::string&nbsp;</td>
 736           <td class="mdname" nowrap> <em>keygiven</em></td>
 737         </tr>
 738         <tr>
 739           <td></td>
 740           <td class="md">)&nbsp;</td>
 741           <td class="md" colspan="2"><code> [virtual]</code></td>
 742         </tr>
 743
 744       </table>
 745     </td>
 746   </tr>
 747 </table>
 748 <table cellspacing=5 cellpadding=0 border=0>
 749   <tr>
 750     <td>
 751       &nbsp;
 752     </td>
 753     <td>
 754
 755 <p>
 756 Called whenever a user joins a channel, to determine if key checks should go ahead or not.
 757 <p>
 758 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.
 759 <p>
 760 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>.
 761 <p>
 762 <div class="fragment"><pre>00407 { <span class="keywordflow">return</span> 0; };
 763 </pre></div>    </td>
 764   </tr>
 765 </table>
 766 <a name="a38" doxytag="Module::OnCheckLimit"></a><p>
 767 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 768   <tr>
 769     <td class="mdRow">
 770       <table cellpadding="0" cellspacing="0" border="0">
 771         <tr>
 772           <td class="md" nowrap valign="top"> int Module::OnCheckLimit </td>
 773           <td class="md" valign="top">(&nbsp;</td>
 774           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 775           <td class="mdname" nowrap> <em>user</em>, </td>
 776         </tr>
 777         <tr>
 778           <td></td>
 779           <td></td>
 780           <td class="md" nowrap><a class="el" href="classchanrec.html">chanrec</a> *&nbsp;</td>
 781           <td class="mdname" nowrap> <em>chan</em></td>
 782         </tr>
 783         <tr>
 784           <td></td>
 785           <td class="md">)&nbsp;</td>
 786           <td class="md" colspan="2"><code> [virtual]</code></td>
 787         </tr>
 788
 789       </table>
 790     </td>
 791   </tr>
 792 </table>
 793 <table cellspacing=5 cellpadding=0 border=0>
 794   <tr>
 795     <td>
 796       &nbsp;
 797     </td>
 798     <td>
 799
 800 <p>
 801 Called whenever a user joins a channel, to determine if channel limit checks should go ahead or not.
 802 <p>
 803 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.
 804 <p>
 805 Definition at line <a class="el" href="modules_8cpp-source.html#l00408">408</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 806 <p>
 807 <div class="fragment"><pre>00408 { <span class="keywordflow">return</span> 0; };
 808 </pre></div>    </td>
 809   </tr>
 810 </table>
 811 <a name="a33" doxytag="Module::OnCheckReady"></a><p>
 812 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 813   <tr>
 814     <td class="mdRow">
 815       <table cellpadding="0" cellspacing="0" border="0">
 816         <tr>
 817           <td class="md" nowrap valign="top"> bool Module::OnCheckReady </td>
 818           <td class="md" valign="top">(&nbsp;</td>
 819           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 820           <td class="mdname1" valign="top" nowrap> <em>user</em>          </td>
 821           <td class="md" valign="top">&nbsp;)&nbsp;</td>
 822           <td class="md" nowrap><code> [virtual]</code></td>
 823         </tr>
 824
 825       </table>
 826     </td>
 827   </tr>
 828 </table>
 829 <table cellspacing=5 cellpadding=0 border=0>
 830   <tr>
 831     <td>
 832       &nbsp;
 833     </td>
 834     <td>
 835
 836 <p>
 837 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.
 838 <p>
 839 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.
 840 <p>
 841 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>.
 842 <p>
 843 <div class="fragment"><pre>00401 { <span class="keywordflow">return</span> <span class="keyword">true</span>; };
 844 </pre></div>    </td>
 845   </tr>
 846 </table>
 847 <a name="a51" doxytag="Module::OnDelBan"></a><p>
 848 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 849   <tr>
 850     <td class="mdRow">
 851       <table cellpadding="0" cellspacing="0" border="0">
 852         <tr>
 853           <td class="md" nowrap valign="top"> int Module::OnDelBan </td>
 854           <td class="md" valign="top">(&nbsp;</td>
 855           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 856           <td class="mdname" nowrap> <em>source</em>, </td>
 857         </tr>
 858         <tr>
 859           <td></td>
 860           <td></td>
 861           <td class="md" nowrap><a class="el" href="classchanrec.html">chanrec</a> *&nbsp;</td>
 862           <td class="mdname" nowrap> <em>channel</em>, </td>
 863         </tr>
 864         <tr>
 865           <td></td>
 866           <td></td>
 867           <td class="md" nowrap>std::string&nbsp;</td>
 868           <td class="mdname" nowrap> <em>banmask</em></td>
 869         </tr>
 870         <tr>
 871           <td></td>
 872           <td class="md">)&nbsp;</td>
 873           <td class="md" colspan="2"><code> [virtual]</code></td>
 874         </tr>
 875
 876       </table>
 877     </td>
 878   </tr>
 879 </table>
 880 <table cellspacing=5 cellpadding=0 border=0>
 881   <tr>
 882     <td>
 883       &nbsp;
 884     </td>
 885     <td>
 886
 887 <p>
 888 Called whenever a ban is removed from a channel's list.
 889 <p>
 890 Return a non-zero value to 'eat' the mode change and prevent the ban from being removed.
 891 <p>
 892 Definition at line <a class="el" href="modules_8cpp-source.html#l00421">421</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 893 <p>
 894 <div class="fragment"><pre>00421 { <span class="keywordflow">return</span> 0; };
 895 </pre></div>    </td>
 896   </tr>
 897 </table>
 898 <a name="a45" doxytag="Module::OnEvent"></a><p>
 899 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 900   <tr>
 901     <td class="mdRow">
 902       <table cellpadding="0" cellspacing="0" border="0">
 903         <tr>
 904           <td class="md" nowrap valign="top"> void Module::OnEvent </td>
 905           <td class="md" valign="top">(&nbsp;</td>
 906           <td class="md" nowrap valign="top"><a class="el" href="classEvent.html">Event</a> *&nbsp;</td>
 907           <td class="mdname1" valign="top" nowrap> <em>event</em>          </td>
 908           <td class="md" valign="top">&nbsp;)&nbsp;</td>
 909           <td class="md" nowrap><code> [virtual]</code></td>
 910         </tr>
 911
 912       </table>
 913     </td>
 914   </tr>
 915 </table>
 916 <table cellspacing=5 cellpadding=0 border=0>
 917   <tr>
 918     <td>
 919       &nbsp;
 920     </td>
 921     <td>
 922
 923 <p>
 924 Called whenever an <a class="el" href="classEvent.html">Event</a> class is sent to all module by another module.
 925 <p>
 926 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!
 927 <p>
 928 Definition at line <a class="el" href="modules_8cpp-source.html#l00415">415</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 929 <p>
 930 <div class="fragment"><pre>00415 { <span class="keywordflow">return</span>; };
 931 </pre></div>    </td>
 932   </tr>
 933 </table>
 934 <a name="a12" doxytag="Module::OnExtendedMode"></a><p>
 935 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 936   <tr>
 937     <td class="mdRow">
 938       <table cellpadding="0" cellspacing="0" border="0">
 939         <tr>
 940           <td class="md" nowrap valign="top"> int Module::OnExtendedMode </td>
 941           <td class="md" valign="top">(&nbsp;</td>
 942           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 943           <td class="mdname" nowrap> <em>user</em>, </td>
 944         </tr>
 945         <tr>
 946           <td></td>
 947           <td></td>
 948           <td class="md" nowrap>void *&nbsp;</td>
 949           <td class="mdname" nowrap> <em>target</em>, </td>
 950         </tr>
 951         <tr>
 952           <td></td>
 953           <td></td>
 954           <td class="md" nowrap>char&nbsp;</td>
 955           <td class="mdname" nowrap> <em>modechar</em>, </td>
 956         </tr>
 957         <tr>
 958           <td></td>
 959           <td></td>
 960           <td class="md" nowrap>int&nbsp;</td>
 961           <td class="mdname" nowrap> <em>type</em>, </td>
 962         </tr>
 963         <tr>
 964           <td></td>
 965           <td></td>
 966           <td class="md" nowrap>bool&nbsp;</td>
 967           <td class="mdname" nowrap> <em>mode_on</em>, </td>
 968         </tr>
 969         <tr>
 970           <td></td>
 971           <td></td>
 972           <td class="md" nowrap><a class="el" href="modules_8h.html#a32">string_list</a> &amp;&nbsp;</td>
 973           <td class="mdname" nowrap> <em>params</em></td>
 974         </tr>
 975         <tr>
 976           <td></td>
 977           <td class="md">)&nbsp;</td>
 978           <td class="md" colspan="2"><code> [virtual]</code></td>
 979         </tr>
 980
 981       </table>
 982     </td>
 983   </tr>
 984 </table>
 985 <table cellspacing=5 cellpadding=0 border=0>
 986   <tr>
 987     <td>
 988       &nbsp;
 989     </td>
 990     <td>
 991
 992 <p>
 993 Called whenever an extended mode is to be processed.
 994 <p>
 995 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#a23">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.
 996 <p>
 997 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>.
 998 <p>
 999 <div class="fragment"><pre>00382 { <span class="keywordflow">return</span> <span class="keyword">false</span>; }
1000 </pre></div>    </td>
1001   </tr>
1002 </table>
1003 <a name="a49" doxytag="Module::OnGlobalConnect"></a><p>
1004 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1005   <tr>
1006     <td class="mdRow">
1007       <table cellpadding="0" cellspacing="0" border="0">
1008         <tr>
1009           <td class="md" nowrap valign="top"> void Module::OnGlobalConnect </td>
1010           <td class="md" valign="top">(&nbsp;</td>
1011           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
1012           <td class="mdname1" valign="top" nowrap> <em>user</em>          </td>
1013           <td class="md" valign="top">&nbsp;)&nbsp;</td>
1014           <td class="md" nowrap><code> [virtual]</code></td>
1015         </tr>
1016
1017       </table>
1018     </td>
1019   </tr>
1020 </table>
1021 <table cellspacing=5 cellpadding=0 border=0>
1022   <tr>
1023     <td>
1024       &nbsp;
1025     </td>
1026     <td>
1027
1028 <p>
1029 Called whenever a user connects, anywhere on the network.
1030 <p>
1031 This event is informational only. You should not change any user information in this event. To do so, use the OnUserConnect method to change the state of local users.
1032 <p>
1033 Definition at line <a class="el" href="modules_8cpp-source.html#l00419">419</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1034 <p>
1035 <div class="fragment"><pre>00419 { };
1036 </pre></div>    </td>
1037   </tr>
1038 </table>
1039 <a name="a48" doxytag="Module::OnGlobalOper"></a><p>
1040 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1041   <tr>
1042     <td class="mdRow">
1043       <table cellpadding="0" cellspacing="0" border="0">
1044         <tr>
1045           <td class="md" nowrap valign="top"> void Module::OnGlobalOper </td>
1046           <td class="md" valign="top">(&nbsp;</td>
1047           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
1048           <td class="mdname1" valign="top" nowrap> <em>user</em>          </td>
1049           <td class="md" valign="top">&nbsp;)&nbsp;</td>
1050           <td class="md" nowrap><code> [virtual]</code></td>
1051         </tr>
1052
1053       </table>
1054     </td>
1055   </tr>
1056 </table>
1057 <table cellspacing=5 cellpadding=0 border=0>
1058   <tr>
1059     <td>
1060       &nbsp;
1061     </td>
1062     <td>
1063
1064 <p>
1065 Called whenever a user is given usermode +o, anywhere on the network.
1066 <p>
1067 You cannot override this and prevent it from happening as it is already happened and such a task must be performed by another server. You can however bounce modes by sending servermodes out to reverse mode changes.
1068 <p>
1069 Definition at line <a class="el" href="modules_8cpp-source.html#l00418">418</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1070 <p>
1071 <div class="fragment"><pre>00418 { };
1072 </pre></div>    </td>
1073   </tr>
1074 </table>
1075 <a name="a17" doxytag="Module::OnInfo"></a><p>
1076 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1077   <tr>
1078     <td class="mdRow">
1079       <table cellpadding="0" cellspacing="0" border="0">
1080         <tr>
1081           <td class="md" nowrap valign="top"> void Module::OnInfo </td>
1082           <td class="md" valign="top">(&nbsp;</td>
1083           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
1084           <td class="mdname1" valign="top" nowrap> <em>user</em>          </td>
1085           <td class="md" valign="top">&nbsp;)&nbsp;</td>
1086           <td class="md" nowrap><code> [virtual]</code></td>
1087         </tr>
1088
1089       </table>
1090     </td>
1091   </tr>
1092 </table>
1093 <table cellspacing=5 cellpadding=0 border=0>
1094   <tr>
1095     <td>
1096       &nbsp;
1097     </td>
1098     <td>
1099
1100 <p>
1101 Called whenever a user types /INFO.
1102 <p>
1103 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>
1104 &lt;nick&gt; :information here
1105 <p>
1106 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>.
1107 <p>
1108 <div class="fragment"><pre>00385 { };
1109 </pre></div>    </td>
1110   </tr>
1111 </table>
1112 <a name="a28" doxytag="Module::OnKill"></a><p>
1113 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1114   <tr>
1115     <td class="mdRow">
1116       <table cellpadding="0" cellspacing="0" border="0">
1117         <tr>
1118           <td class="md" nowrap valign="top"> int Module::OnKill </td>
1119           <td class="md" valign="top">(&nbsp;</td>
1120           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
1121           <td class="mdname" nowrap> <em>source</em>, </td>
1122         </tr>
1123         <tr>
1124           <td></td>
1125           <td></td>
1126           <td class="md" nowrap><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
1127           <td class="mdname" nowrap> <em>dest</em>, </td>
1128         </tr>
1129         <tr>
1130           <td></td>
1131           <td></td>
1132           <td class="md" nowrap>std::string&nbsp;</td>
1133           <td class="mdname" nowrap> <em>reason</em></td>
1134         </tr>
1135         <tr>
1136           <td></td>
1137           <td class="md">)&nbsp;</td>
1138           <td class="md" colspan="2"><code> [virtual]</code></td>
1139         </tr>
1140
1141       </table>
1142     </td>
1143   </tr>
1144 </table>
1145 <table cellspacing=5 cellpadding=0 border=0>
1146   <tr>
1147     <td>
1148       &nbsp;
1149     </td>
1150     <td>
1151
1152 <p>
1153 Called when a client is disconnected by KILL.
1154 <p>
1155 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!
1156 <p>
1157 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>.
1158 <p>
1159 <div class="fragment"><pre>00396 { <span class="keywordflow">return</span> 0; };
1160 </pre></div>    </td>
1161   </tr>
1162 </table>
1163 <a name="a29" doxytag="Module::OnLoadModule"></a><p>
1164 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1165   <tr>
1166     <td class="mdRow">
1167       <table cellpadding="0" cellspacing="0" border="0">
1168         <tr>
1169           <td class="md" nowrap valign="top"> void Module::OnLoadModule </td>
1170           <td class="md" valign="top">(&nbsp;</td>
1171           <td class="md" nowrap valign="top"><a class="el" href="classModule.html">Module</a> *&nbsp;</td>
1172           <td class="mdname" nowrap> <em>mod</em>, </td>
1173         </tr>
1174         <tr>
1175           <td></td>
1176           <td></td>
1177           <td class="md" nowrap>std::string&nbsp;</td>
1178           <td class="mdname" nowrap> <em>name</em></td>
1179         </tr>
1180         <tr>
1181           <td></td>
1182           <td class="md">)&nbsp;</td>
1183           <td class="md" colspan="2"><code> [virtual]</code></td>
1184         </tr>
1185
1186       </table>
1187     </td>
1188   </tr>
1189 </table>
1190 <table cellspacing=5 cellpadding=0 border=0>
1191   <tr>
1192     <td>
1193       &nbsp;
1194     </td>
1195     <td>
1196
1197 <p>
1198 Called whenever a module is loaded.
1199 <p>
1200 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).
1201 <p>
1202 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>.
1203 <p>
1204 <div class="fragment"><pre>00397 { };
1205 </pre></div>    </td>
1206   </tr>
1207 </table>
1208 <a name="a43" doxytag="Module::OnLocalTopicChange"></a><p>
1209 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1210   <tr>
1211     <td class="mdRow">
1212       <table cellpadding="0" cellspacing="0" border="0">
1213         <tr>
1214           <td class="md" nowrap valign="top"> int Module::OnLocalTopicChange </td>
1215           <td class="md" valign="top">(&nbsp;</td>
1216           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
1217           <td class="mdname" nowrap> <em>user</em>, </td>
1218         </tr>
1219         <tr>
1220           <td></td>
1221           <td></td>
1222           <td class="md" nowrap><a class="el" href="classchanrec.html">chanrec</a> *&nbsp;</td>
1223           <td class="mdname" nowrap> <em>chan</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>topic</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 whenever a topic is changed by a local user.
1250 <p>
1251 Return 1 to deny the topic change, or 0 to allow it.
1252 <p>
1253 Definition at line <a class="el" href="modules_8cpp-source.html#l00413">413</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1254 <p>
1255 <div class="fragment"><pre>00413 { <span class="keywordflow">return</span> 0; };
1256 </pre></div>    </td>
1257   </tr>
1258 </table>
1259 <a name="a44" doxytag="Module::OnMeshToken"></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::OnMeshToken </td>
1266           <td class="md" valign="top">(&nbsp;</td>
1267           <td class="md" nowrap valign="top">char&nbsp;</td>
1268           <td class="mdname" nowrap> <em>token</em>, </td>
1269         </tr>
1270         <tr>
1271           <td></td>
1272           <td></td>
1273           <td class="md" nowrap><a class="el" href="modules_8h.html#a32">string_list</a>&nbsp;</td>
1274           <td class="mdname" nowrap> <em>params</em>, </td>
1275         </tr>
1276         <tr>
1277           <td></td>
1278           <td></td>
1279           <td class="md" nowrap><a class="el" href="classserverrec.html">serverrec</a> *&nbsp;</td>
1280           <td class="mdname" nowrap> <em>source</em>, </td>
1281         </tr>
1282         <tr>
1283           <td></td>
1284           <td></td>
1285           <td class="md" nowrap><a class="el" href="classserverrec.html">serverrec</a> *&nbsp;</td>
1286           <td class="mdname" nowrap> <em>reply</em>, </td>
1287         </tr>
1288         <tr>
1289           <td></td>
1290           <td></td>
1291           <td class="md" nowrap>std::string&nbsp;</td>
1292           <td class="mdname" nowrap> <em>tcp_host</em>, </td>
1293         </tr>
1294         <tr>
1295           <td></td>
1296           <td></td>
1297           <td class="md" nowrap>std::string&nbsp;</td>
1298           <td class="mdname" nowrap> <em>ipaddr</em>, </td>
1299         </tr>
1300         <tr>
1301           <td></td>
1302           <td></td>
1303           <td class="md" nowrap>int&nbsp;</td>
1304           <td class="mdname" nowrap> <em>port</em></td>
1305         </tr>
1306         <tr>
1307           <td></td>
1308           <td class="md">)&nbsp;</td>
1309           <td class="md" colspan="2"><code> [virtual]</code></td>
1310         </tr>
1311
1312       </table>
1313     </td>
1314   </tr>
1315 </table>
1316 <table cellspacing=5 cellpadding=0 border=0>
1317   <tr>
1318     <td>
1319       &nbsp;
1320     </td>
1321     <td>
1322
1323 <p>
1324 Called whenever an unknown token is received in a server to server link.
1325 <p>
1326 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.
1327 <p>
1328 Definition at line <a class="el" href="modules_8cpp-source.html#l00414">414</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1329 <p>
1330 <div class="fragment"><pre>00414 { <span class="keywordflow">return</span> 0; };
1331 </pre></div>    </td>
1332   </tr>
1333 </table>
1334 <a name="a16" doxytag="Module::OnOper"></a><p>
1335 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1336   <tr>
1337     <td class="mdRow">
1338       <table cellpadding="0" cellspacing="0" border="0">
1339         <tr>
1340           <td class="md" nowrap valign="top"> void Module::OnOper </td>
1341           <td class="md" valign="top">(&nbsp;</td>
1342           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
1343           <td class="mdname1" valign="top" nowrap> <em>user</em>          </td>
1344           <td class="md" valign="top">&nbsp;)&nbsp;</td>
1345           <td class="md" nowrap><code> [virtual]</code></td>
1346         </tr>
1347
1348       </table>
1349     </td>
1350   </tr>
1351 </table>
1352 <table cellspacing=5 cellpadding=0 border=0>
1353   <tr>
1354     <td>
1355       &nbsp;
1356     </td>
1357     <td>
1358
1359 <p>
1360 Called whenever a user opers locally.
1361 <p>
1362 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.
1363 <p>
1364 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>.
1365 <p>
1366 <div class="fragment"><pre>00384 { };
1367 </pre></div>    </td>
1368   </tr>
1369 </table>
1370 <a name="a47" doxytag="Module::OnOperCompare"></a><p>
1371 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1372   <tr>
1373     <td class="mdRow">
1374       <table cellpadding="0" cellspacing="0" border="0">
1375         <tr>
1376           <td class="md" nowrap valign="top"> int Module::OnOperCompare </td>
1377           <td class="md" valign="top">(&nbsp;</td>
1378           <td class="md" nowrap valign="top">std::string&nbsp;</td>
1379           <td class="mdname" nowrap> <em>password</em>, </td>
1380         </tr>
1381         <tr>
1382           <td></td>
1383           <td></td>
1384           <td class="md" nowrap>std::string&nbsp;</td>
1385           <td class="mdname" nowrap> <em>input</em></td>
1386         </tr>
1387         <tr>
1388           <td></td>
1389           <td class="md">)&nbsp;</td>
1390           <td class="md" colspan="2"><code> [virtual]</code></td>
1391         </tr>
1392
1393       </table>
1394     </td>
1395   </tr>
1396 </table>
1397 <table cellspacing=5 cellpadding=0 border=0>
1398   <tr>
1399     <td>
1400       &nbsp;
1401     </td>
1402     <td>
1403
1404 <p>
1405 Called whenever an oper password is to be compared to what a user has input.
1406 <p>
1407 The password field (from the config file) is in 'password' and is to be compared against 'input'. This method allows for encryption of oper passwords and much more besides. You should return a nonzero value if you want to allow the comparison or zero if you wish to do nothing.
1408 <p>
1409 Definition at line <a class="el" href="modules_8cpp-source.html#l00417">417</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1410 <p>
1411 <div class="fragment"><pre>00417 { <span class="keywordflow">return</span> 0; };
1412 </pre></div>    </td>
1413   </tr>
1414 </table>
1415 <a name="a9" doxytag="Module::OnPacketReceive"></a><p>
1416 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1417   <tr>
1418     <td class="mdRow">
1419       <table cellpadding="0" cellspacing="0" border="0">
1420         <tr>
1421           <td class="md" nowrap valign="top"> void Module::OnPacketReceive </td>
1422           <td class="md" valign="top">(&nbsp;</td>
1423           <td class="md" nowrap valign="top">std::string &amp;&nbsp;</td>
1424           <td class="mdname" nowrap> <em>data</em>, </td>
1425         </tr>
1426         <tr>
1427           <td></td>
1428           <td></td>
1429           <td class="md" nowrap>std::string&nbsp;</td>
1430           <td class="mdname" nowrap> <em>serv</em></td>
1431         </tr>
1432         <tr>
1433           <td></td>
1434           <td class="md">)&nbsp;</td>
1435           <td class="md" colspan="2"><code> [virtual]</code></td>
1436         </tr>
1437
1438       </table>
1439     </td>
1440   </tr>
1441 </table>
1442 <table cellspacing=5 cellpadding=0 border=0>
1443   <tr>
1444     <td>
1445       &nbsp;
1446     </td>
1447     <td>
1448
1449 <p>
1450 Called after a packet is received from another irc server.
1451 <p>
1452 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.
1453 <p>
1454 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>.
1455 <p>
1456 <div class="fragment"><pre>00378 { }
1457 </pre></div>    </td>
1458   </tr>
1459 </table>
1460 <a name="a8" doxytag="Module::OnPacketTransmit"></a><p>
1461 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1462   <tr>
1463     <td class="mdRow">
1464       <table cellpadding="0" cellspacing="0" border="0">
1465         <tr>
1466           <td class="md" nowrap valign="top"> void Module::OnPacketTransmit </td>
1467           <td class="md" valign="top">(&nbsp;</td>
1468           <td class="md" nowrap valign="top">std::string &amp;&nbsp;</td>
1469           <td class="mdname" nowrap> <em>data</em>, </td>
1470         </tr>
1471         <tr>
1472           <td></td>
1473           <td></td>
1474           <td class="md" nowrap>std::string&nbsp;</td>
1475           <td class="mdname" nowrap> <em>serv</em></td>
1476         </tr>
1477         <tr>
1478           <td></td>
1479           <td class="md">)&nbsp;</td>
1480           <td class="md" colspan="2"><code> [virtual]</code></td>
1481         </tr>
1482
1483       </table>
1484     </td>
1485   </tr>
1486 </table>
1487 <table cellspacing=5 cellpadding=0 border=0>
1488   <tr>
1489     <td>
1490       &nbsp;
1491     </td>
1492     <td>
1493
1494 <p>
1495 Called before a packet is transmitted across the irc network between two irc servers.
1496 <p>
1497 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.
1498 <p>
1499 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>.
1500 <p>
1501 <div class="fragment"><pre>00377 { }
1502 </pre></div>    </td>
1503   </tr>
1504 </table>
1505 <a name="a32" doxytag="Module::OnPreCommand"></a><p>
1506 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1507   <tr>
1508     <td class="mdRow">
1509       <table cellpadding="0" cellspacing="0" border="0">
1510         <tr>
1511           <td class="md" nowrap valign="top"> int Module::OnPreCommand </td>
1512           <td class="md" valign="top">(&nbsp;</td>
1513           <td class="md" nowrap valign="top">std::string&nbsp;</td>
1514           <td class="mdname" nowrap> <em>command</em>, </td>
1515         </tr>
1516         <tr>
1517           <td></td>
1518           <td></td>
1519           <td class="md" nowrap>char **&nbsp;</td>
1520           <td class="mdname" nowrap> <em>parameters</em>, </td>
1521         </tr>
1522         <tr>
1523           <td></td>
1524           <td></td>
1525           <td class="md" nowrap>int&nbsp;</td>
1526           <td class="mdname" nowrap> <em>pcnt</em>, </td>
1527         </tr>
1528         <tr>
1529           <td></td>
1530           <td></td>
1531           <td class="md" nowrap><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
1532           <td class="mdname" nowrap> <em>user</em></td>
1533         </tr>
1534         <tr>
1535           <td></td>
1536           <td class="md">)&nbsp;</td>
1537           <td class="md" colspan="2"><code> [virtual]</code></td>
1538         </tr>
1539
1540       </table>
1541     </td>
1542   </tr>
1543 </table>
1544 <table cellspacing=5 cellpadding=0 border=0>
1545   <tr>
1546     <td>
1547       &nbsp;
1548     </td>
1549     <td>
1550
1551 <p>
1552 Called whenever any command is about to be executed.
1553 <p>
1554 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#a31">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!)
1555 <p>
1556 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>.
1557 <p>
1558 <div class="fragment"><pre>00400 { <span class="keywordflow">return</span> 0; };
1559 </pre></div>    </td>
1560   </tr>
1561 </table>
1562 <a name="a35" doxytag="Module::OnRawMode"></a><p>
1563 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1564   <tr>
1565     <td class="mdRow">
1566       <table cellpadding="0" cellspacing="0" border="0">
1567         <tr>
1568           <td class="md" nowrap valign="top"> int Module::OnRawMode </td>
1569           <td class="md" valign="top">(&nbsp;</td>
1570           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
1571           <td class="mdname" nowrap> <em>user</em>, </td>
1572         </tr>
1573         <tr>
1574           <td></td>
1575           <td></td>
1576           <td class="md" nowrap><a class="el" href="classchanrec.html">chanrec</a> *&nbsp;</td>
1577           <td class="mdname" nowrap> <em>chan</em>, </td>
1578         </tr>
1579         <tr>
1580           <td></td>
1581           <td></td>
1582           <td class="md" nowrap>char&nbsp;</td>
1583           <td class="mdname" nowrap> <em>mode</em>, </td>
1584         </tr>
1585         <tr>
1586           <td></td>
1587           <td></td>
1588           <td class="md" nowrap>std::string&nbsp;</td>
1589           <td class="mdname" nowrap> <em>param</em>, </td>
1590         </tr>
1591         <tr>
1592           <td></td>
1593           <td></td>
1594           <td class="md" nowrap>bool&nbsp;</td>
1595           <td class="mdname" nowrap> <em>adding</em>, </td>
1596         </tr>
1597         <tr>
1598           <td></td>
1599           <td></td>
1600           <td class="md" nowrap>int&nbsp;</td>
1601           <td class="mdname" nowrap> <em>pcnt</em></td>
1602         </tr>
1603         <tr>
1604           <td></td>
1605           <td class="md">)&nbsp;</td>
1606           <td class="md" colspan="2"><code> [virtual]</code></td>
1607         </tr>
1608
1609       </table>
1610     </td>
1611   </tr>
1612 </table>
1613 <table cellspacing=5 cellpadding=0 border=0>
1614   <tr>
1615     <td>
1616       &nbsp;
1617     </td>
1618     <td>
1619
1620 <p>
1621 Called whenever a mode character is processed.
1622 <p>
1623 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!
1624 <p>
1625 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>.
1626 <p>
1627 <div class="fragment"><pre>00405 { <span class="keywordflow">return</span> 0; };
1628 </pre></div>    </td>
1629   </tr>
1630 </table>
1631 <a name="a52" doxytag="Module::OnRawSocketAccept"></a><p>
1632 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1633   <tr>
1634     <td class="mdRow">
1635       <table cellpadding="0" cellspacing="0" border="0">
1636         <tr>
1637           <td class="md" nowrap valign="top"> void Module::OnRawSocketAccept </td>
1638           <td class="md" valign="top">(&nbsp;</td>
1639           <td class="md" nowrap valign="top">int&nbsp;</td>
1640           <td class="mdname" nowrap> <em>fd</em>, </td>
1641         </tr>
1642         <tr>
1643           <td></td>
1644           <td></td>
1645           <td class="md" nowrap>std::string&nbsp;</td>
1646           <td class="mdname" nowrap> <em>ip</em>, </td>
1647         </tr>
1648         <tr>
1649           <td></td>
1650           <td></td>
1651           <td class="md" nowrap>int&nbsp;</td>
1652           <td class="mdname" nowrap> <em>localport</em></td>
1653         </tr>
1654         <tr>
1655           <td></td>
1656           <td class="md">)&nbsp;</td>
1657           <td class="md" colspan="2"><code> [virtual]</code></td>
1658         </tr>
1659
1660       </table>
1661     </td>
1662   </tr>
1663 </table>
1664 <table cellspacing=5 cellpadding=0 border=0>
1665   <tr>
1666     <td>
1667       &nbsp;
1668     </td>
1669     <td>
1670
1671 <p>
1672 Called immediately after any connection is accepted.
1673 <p>
1674 This is intended for raw socket processing (e.g. modules which wrap the tcp connection within another library) and provides no information relating to a user record as the connection has not been assigned yet. There are no return values from this call as all modules get an opportunity if required to process the connection.
1675 <p>
1676 Definition at line <a class="el" href="modules_8cpp-source.html#l00422">422</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1677 <p>
1678 <div class="fragment"><pre>00422 { };
1679 </pre></div>    </td>
1680   </tr>
1681 </table>
1682 <a name="a54" doxytag="Module::OnRawSocketClose"></a><p>
1683 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1684   <tr>
1685     <td class="mdRow">
1686       <table cellpadding="0" cellspacing="0" border="0">
1687         <tr>
1688           <td class="md" nowrap valign="top"> void Module::OnRawSocketClose </td>
1689           <td class="md" valign="top">(&nbsp;</td>
1690           <td class="md" nowrap valign="top">int&nbsp;</td>
1691           <td class="mdname1" valign="top" nowrap> <em>fd</em>          </td>
1692           <td class="md" valign="top">&nbsp;)&nbsp;</td>
1693           <td class="md" nowrap><code> [virtual]</code></td>
1694         </tr>
1695
1696       </table>
1697     </td>
1698   </tr>
1699 </table>
1700 <table cellspacing=5 cellpadding=0 border=0>
1701   <tr>
1702     <td>
1703       &nbsp;
1704     </td>
1705     <td>
1706
1707 <p>
1708 Called immediately before any socket is closed.
1709 <p>
1710 When this event is called, shutdown() has not yet been called on the socket.
1711 <p>
1712 Definition at line <a class="el" href="modules_8cpp-source.html#l00424">424</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1713 <p>
1714 <div class="fragment"><pre>00424 { };
1715 </pre></div>    </td>
1716   </tr>
1717 </table>
1718 <a name="a55" doxytag="Module::OnRawSocketRead"></a><p>
1719 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1720   <tr>
1721     <td class="mdRow">
1722       <table cellpadding="0" cellspacing="0" border="0">
1723         <tr>
1724           <td class="md" nowrap valign="top"> int Module::OnRawSocketRead </td>
1725           <td class="md" valign="top">(&nbsp;</td>
1726           <td class="md" nowrap valign="top">int&nbsp;</td>
1727           <td class="mdname" nowrap> <em>fd</em>, </td>
1728         </tr>
1729         <tr>
1730           <td></td>
1731           <td></td>
1732           <td class="md" nowrap>char *&nbsp;</td>
1733           <td class="mdname" nowrap> <em>buffer</em>, </td>
1734         </tr>
1735         <tr>
1736           <td></td>
1737           <td></td>
1738           <td class="md" nowrap>unsigned int&nbsp;</td>
1739           <td class="mdname" nowrap> <em>count</em>, </td>
1740         </tr>
1741         <tr>
1742           <td></td>
1743           <td></td>
1744           <td class="md" nowrap>int &amp;&nbsp;</td>
1745           <td class="mdname" nowrap> <em>readresult</em></td>
1746         </tr>
1747         <tr>
1748           <td></td>
1749           <td class="md">)&nbsp;</td>
1750           <td class="md" colspan="2"><code> [virtual]</code></td>
1751         </tr>
1752
1753       </table>
1754     </td>
1755   </tr>
1756 </table>
1757 <table cellspacing=5 cellpadding=0 border=0>
1758   <tr>
1759     <td>
1760       &nbsp;
1761     </td>
1762     <td>
1763
1764 <p>
1765 Called immediately before any read() operation on a client socket in the core.
1766 <p>
1767 This occurs AFTER the select() or poll() so there is always data waiting to be read when this event occurs. Your event should return 1 if it has handled the reading itself, which prevents the core just using read(). You should place any data read into buffer, up to but NOT GREATER THAN the value of count. The value of readresult must be identical to an actual result that might be returned from the read() system call, for example, number of bytes read upon success, 0 upon EOF or closed socket, and -1 for error. If your function returns a nonzero value, you MUST set readresult.
1768 <p>
1769 Definition at line <a class="el" href="modules_8cpp-source.html#l00425">425</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1770 <p>
1771 <div class="fragment"><pre>00425 { <span class="keywordflow">return</span> 0; };
1772 </pre></div>    </td>
1773   </tr>
1774 </table>
1775 <a name="a53" doxytag="Module::OnRawSocketWrite"></a><p>
1776 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1777   <tr>
1778     <td class="mdRow">
1779       <table cellpadding="0" cellspacing="0" border="0">
1780         <tr>
1781           <td class="md" nowrap valign="top"> int Module::OnRawSocketWrite </td>
1782           <td class="md" valign="top">(&nbsp;</td>
1783           <td class="md" nowrap valign="top">int&nbsp;</td>
1784           <td class="mdname" nowrap> <em>fd</em>, </td>
1785         </tr>
1786         <tr>
1787           <td></td>
1788           <td></td>
1789           <td class="md" nowrap>char *&nbsp;</td>
1790           <td class="mdname" nowrap> <em>buffer</em>, </td>
1791         </tr>
1792         <tr>
1793           <td></td>
1794           <td></td>
1795           <td class="md" nowrap>int&nbsp;</td>
1796           <td class="mdname" nowrap> <em>count</em></td>
1797         </tr>
1798         <tr>
1799           <td></td>
1800           <td class="md">)&nbsp;</td>
1801           <td class="md" colspan="2"><code> [virtual]</code></td>
1802         </tr>
1803
1804       </table>
1805     </td>
1806   </tr>
1807 </table>
1808 <table cellspacing=5 cellpadding=0 border=0>
1809   <tr>
1810     <td>
1811       &nbsp;
1812     </td>
1813     <td>
1814
1815 <p>
1816 Called immediately before any write() operation on a user's socket in the core.
1817 <p>
1818 Because this event is a low level event no user information is associated with it. It is intended for use by modules which may wrap connections within another API such as SSL for example. return a non-zero result if you have handled the write operation, in which case the core will not call write().
1819 <p>
1820 Definition at line <a class="el" href="modules_8cpp-source.html#l00423">423</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1821 <p>
1822 <div class="fragment"><pre>00423 { <span class="keywordflow">return</span> 0; };
1823 </pre></div>    </td>
1824   </tr>
1825 </table>
1826 <a name="a10" doxytag="Module::OnRehash"></a><p>
1827 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1828   <tr>
1829     <td class="mdRow">
1830       <table cellpadding="0" cellspacing="0" border="0">
1831         <tr>
1832           <td class="md" nowrap valign="top"> void Module::OnRehash </td>
1833           <td class="md" valign="top">(&nbsp;</td>
1834           <td class="mdname1" valign="top" nowrap>          </td>
1835           <td class="md" valign="top">&nbsp;)&nbsp;</td>
1836           <td class="md" nowrap><code> [virtual]</code></td>
1837         </tr>
1838
1839       </table>
1840     </td>
1841   </tr>
1842 </table>
1843 <table cellspacing=5 cellpadding=0 border=0>
1844   <tr>
1845     <td>
1846       &nbsp;
1847     </td>
1848     <td>
1849
1850 <p>
1851 Called on rehash.
1852 <p>
1853 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.
1854 <p>
1855 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>.
1856 <p>
1857 <div class="fragment"><pre>00379 { }
1858 </pre></div>    </td>
1859   </tr>
1860 </table>
1861 <a name="a46" doxytag="Module::OnRequest"></a><p>
1862 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1863   <tr>
1864     <td class="mdRow">
1865       <table cellpadding="0" cellspacing="0" border="0">
1866         <tr>
1867           <td class="md" nowrap valign="top"> char * Module::OnRequest </td>
1868           <td class="md" valign="top">(&nbsp;</td>
1869           <td class="md" nowrap valign="top"><a class="el" href="classRequest.html">Request</a> *&nbsp;</td>
1870           <td class="mdname1" valign="top" nowrap> <em>request</em>          </td>
1871           <td class="md" valign="top">&nbsp;)&nbsp;</td>
1872           <td class="md" nowrap><code> [virtual]</code></td>
1873         </tr>
1874
1875       </table>
1876     </td>
1877   </tr>
1878 </table>
1879 <table cellspacing=5 cellpadding=0 border=0>
1880   <tr>
1881     <td>
1882       &nbsp;
1883     </td>
1884     <td>
1885
1886 <p>
1887 Called whenever a <a class="el" href="classRequest.html">Request</a> class is sent to your module by another module.
1888 <p>
1889 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).
1890 <p>
1891 Definition at line <a class="el" href="modules_8cpp-source.html#l00416">416</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1892 <p>
1893 Referenced by <a class="el" href="modules_8cpp-source.html#l00333">Request::Send()</a>.
1894 <p>
1895 <div class="fragment"><pre>00416 { <span class="keywordflow">return</span> NULL; };
1896 </pre></div>    </td>
1897   </tr>
1898 </table>
1899 <a name="a31" doxytag="Module::OnSendList"></a><p>
1900 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1901   <tr>
1902     <td class="mdRow">
1903       <table cellpadding="0" cellspacing="0" border="0">
1904         <tr>
1905           <td class="md" nowrap valign="top"> void Module::OnSendList </td>
1906           <td class="md" valign="top">(&nbsp;</td>
1907           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
1908           <td class="mdname" nowrap> <em>user</em>, </td>
1909         </tr>
1910         <tr>
1911           <td></td>
1912           <td></td>
1913           <td class="md" nowrap><a class="el" href="classchanrec.html">chanrec</a> *&nbsp;</td>
1914           <td class="mdname" nowrap> <em>channel</em>, </td>
1915         </tr>
1916         <tr>
1917           <td></td>
1918           <td></td>
1919           <td class="md" nowrap>char&nbsp;</td>
1920           <td class="mdname" nowrap> <em>mode</em></td>
1921         </tr>
1922         <tr>
1923           <td></td>
1924           <td class="md">)&nbsp;</td>
1925           <td class="md" colspan="2"><code> [virtual]</code></td>
1926         </tr>
1927
1928       </table>
1929     </td>
1930   </tr>
1931 </table>
1932 <table cellspacing=5 cellpadding=0 border=0>
1933   <tr>
1934     <td>
1935       &nbsp;
1936     </td>
1937     <td>
1938
1939 <p>
1940 Called whenever a list is needed for a listmode.
1941 <p>
1942 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.
1943 <p>
1944 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>.
1945 <p>
1946 <div class="fragment"><pre>00399 { };
1947 </pre></div>    </td>
1948   </tr>
1949 </table>
1950 <a name="a11" doxytag="Module::OnServerRaw"></a><p>
1951 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1952   <tr>
1953     <td class="mdRow">
1954       <table cellpadding="0" cellspacing="0" border="0">
1955         <tr>
1956           <td class="md" nowrap valign="top"> void Module::OnServerRaw </td>
1957           <td class="md" valign="top">(&nbsp;</td>
1958           <td class="md" nowrap valign="top">std::string &amp;&nbsp;</td>
1959           <td class="mdname" nowrap> <em>raw</em>, </td>
1960         </tr>
1961         <tr>
1962           <td></td>
1963           <td></td>
1964           <td class="md" nowrap>bool&nbsp;</td>
1965           <td class="mdname" nowrap> <em>inbound</em>, </td>
1966         </tr>
1967         <tr>
1968           <td></td>
1969           <td></td>
1970           <td class="md" nowrap><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
1971           <td class="mdname" nowrap> <em>user</em></td>
1972         </tr>
1973         <tr>
1974           <td></td>
1975           <td class="md">)&nbsp;</td>
1976           <td class="md" colspan="2"><code> [virtual]</code></td>
1977         </tr>
1978
1979       </table>
1980     </td>
1981   </tr>
1982 </table>
1983 <table cellspacing=5 cellpadding=0 border=0>
1984   <tr>
1985     <td>
1986       &nbsp;
1987     </td>
1988     <td>
1989
1990 <p>
1991 Called when a raw command is transmitted or received.
1992 <p>
1993 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.
1994 <p>
1995 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>.
1996 <p>
1997 <div class="fragment"><pre>00380 { }
1998 </pre></div>    </td>
1999   </tr>
2000 </table>
2001 <a name="a40" doxytag="Module::OnStats"></a><p>
2002 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
2003   <tr>
2004     <td class="mdRow">
2005       <table cellpadding="0" cellspacing="0" border="0">
2006         <tr>
2007           <td class="md" nowrap valign="top"> void Module::OnStats </td>
2008           <td class="md" valign="top">(&nbsp;</td>
2009           <td class="md" nowrap valign="top">char&nbsp;</td>
2010           <td class="mdname1" valign="top" nowrap> <em>symbol</em>          </td>
2011           <td class="md" valign="top">&nbsp;)&nbsp;</td>
2012           <td class="md" nowrap><code> [virtual]</code></td>
2013         </tr>
2014
2015       </table>
2016     </td>
2017   </tr>
2018 </table>
2019 <table cellspacing=5 cellpadding=0 border=0>
2020   <tr>
2021     <td>
2022       &nbsp;
2023     </td>
2024     <td>
2025
2026 <p>
2027 Called on all /STATS commands This method is triggered for all /STATS use, including stats symbols handled by the core.
2028 <p>
2029
2030 <p>
2031 Definition at line <a class="el" href="modules_8cpp-source.html#l00410">410</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
2032 <p>
2033 <div class="fragment"><pre>00410 { };
2034 </pre></div>    </td>
2035   </tr>
2036 </table>
2037 <a name="a3" doxytag="Module::OnUserConnect"></a><p>
2038 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
2039   <tr>
2040     <td class="mdRow">
2041       <table cellpadding="0" cellspacing="0" border="0">
2042         <tr>
2043           <td class="md" nowrap valign="top"> void Module::OnUserConnect </td>
2044           <td class="md" valign="top">(&nbsp;</td>
2045           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
2046           <td class="mdname1" valign="top" nowrap> <em>user</em>          </td>
2047           <td class="md" valign="top">&nbsp;)&nbsp;</td>
2048           <td class="md" nowrap><code> [virtual]</code></td>
2049         </tr>
2050
2051       </table>
2052     </td>
2053   </tr>
2054 </table>
2055 <table cellspacing=5 cellpadding=0 border=0>
2056   <tr>
2057     <td>
2058       &nbsp;
2059     </td>
2060     <td>
2061
2062 <p>
2063 Called when a user connects.
2064 <p>
2065 The details of the connecting user are available to you in the parameter userrec *user
2066 <p>
2067 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>.
2068 <p>
2069 <div class="fragment"><pre>00372 { }
2070 </pre></div>    </td>
2071   </tr>
2072 </table>
2073 <a name="a5" doxytag="Module::OnUserDisconnect"></a><p>
2074 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
2075   <tr>
2076     <td class="mdRow">
2077       <table cellpadding="0" cellspacing="0" border="0">
2078         <tr>
2079           <td class="md" nowrap valign="top"> void Module::OnUserDisconnect </td>
2080           <td class="md" valign="top">(&nbsp;</td>
2081           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
2082           <td class="mdname1" valign="top" nowrap> <em>user</em>          </td>
2083           <td class="md" valign="top">&nbsp;)&nbsp;</td>
2084           <td class="md" nowrap><code> [virtual]</code></td>
2085         </tr>
2086
2087       </table>
2088     </td>
2089   </tr>
2090 </table>
2091 <table cellspacing=5 cellpadding=0 border=0>
2092   <tr>
2093     <td>
2094       &nbsp;
2095     </td>
2096     <td>
2097
2098 <p>
2099 Called whenever a user's socket is closed.
2100 <p>
2101 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.
2102 <p>
2103 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>.
2104 <p>
2105 <div class="fragment"><pre>00374 { }
2106 </pre></div>    </td>
2107   </tr>
2108 </table>
2109 <a name="a6" doxytag="Module::OnUserJoin"></a><p>
2110 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
2111   <tr>
2112     <td class="mdRow">
2113       <table cellpadding="0" cellspacing="0" border="0">
2114         <tr>
2115           <td class="md" nowrap valign="top"> void Module::OnUserJoin </td>
2116           <td class="md" valign="top">(&nbsp;</td>
2117           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
2118           <td class="mdname" nowrap> <em>user</em>, </td>
2119         </tr>
2120         <tr>
2121           <td></td>
2122           <td></td>
2123           <td class="md" nowrap><a class="el" href="classchanrec.html">chanrec</a> *&nbsp;</td>
2124           <td class="mdname" nowrap> <em>channel</em></td>
2125         </tr>
2126         <tr>
2127           <td></td>
2128           <td class="md">)&nbsp;</td>
2129           <td class="md" colspan="2"><code> [virtual]</code></td>
2130         </tr>
2131
2132       </table>
2133     </td>
2134   </tr>
2135 </table>
2136 <table cellspacing=5 cellpadding=0 border=0>
2137   <tr>
2138     <td>
2139       &nbsp;
2140     </td>
2141     <td>
2142
2143 <p>
2144 Called when a user joins a channel.
2145 <p>
2146 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
2147 <p>
2148 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>.
2149 <p>
2150 <div class="fragment"><pre>00375 { }
2151 </pre></div>    </td>
2152   </tr>
2153 </table>
2154 <a name="a15" doxytag="Module::OnUserKick"></a><p>
2155 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
2156   <tr>
2157     <td class="mdRow">
2158       <table cellpadding="0" cellspacing="0" border="0">
2159         <tr>
2160           <td class="md" nowrap valign="top"> void Module::OnUserKick </td>
2161           <td class="md" valign="top">(&nbsp;</td>
2162           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
2163           <td class="mdname" nowrap> <em>source</em>, </td>
2164         </tr>
2165         <tr>
2166           <td></td>
2167           <td></td>
2168           <td class="md" nowrap><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
2169           <td class="mdname" nowrap> <em>user</em>, </td>
2170         </tr>
2171         <tr>
2172           <td></td>
2173           <td></td>
2174           <td class="md" nowrap><a class="el" href="classchanrec.html">chanrec</a> *&nbsp;</td>
2175           <td class="mdname" nowrap> <em>chan</em>, </td>
2176         </tr>
2177         <tr>
2178           <td></td>
2179           <td></td>
2180           <td class="md" nowrap>std::string&nbsp;</td>
2181           <td class="mdname" nowrap> <em>reason</em></td>
2182         </tr>
2183         <tr>
2184           <td></td>
2185           <td class="md">)&nbsp;</td>
2186           <td class="md" colspan="2"><code> [virtual]</code></td>
2187         </tr>
2188
2189       </table>
2190     </td>
2191   </tr>
2192 </table>
2193 <table cellspacing=5 cellpadding=0 border=0>
2194   <tr>
2195     <td>
2196       &nbsp;
2197     </td>
2198     <td>
2199
2200 <p>
2201 Called whenever a user is kicked.
2202 <p>
2203 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.
2204 <p>
2205 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>.
2206 <p>
2207 <div class="fragment"><pre>00404 { };
2208 </pre></div>    </td>
2209   </tr>
2210 </table>
2211 <a name="a7" doxytag="Module::OnUserPart"></a><p>
2212 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
2213   <tr>
2214     <td class="mdRow">
2215       <table cellpadding="0" cellspacing="0" border="0">
2216         <tr>
2217           <td class="md" nowrap valign="top"> void Module::OnUserPart </td>
2218           <td class="md" valign="top">(&nbsp;</td>
2219           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
2220           <td class="mdname" nowrap> <em>user</em>, </td>
2221         </tr>
2222         <tr>
2223           <td></td>
2224           <td></td>
2225           <td class="md" nowrap><a class="el" href="classchanrec.html">chanrec</a> *&nbsp;</td>
2226           <td class="mdname" nowrap> <em>channel</em></td>
2227         </tr>
2228         <tr>
2229           <td></td>
2230           <td class="md">)&nbsp;</td>
2231           <td class="md" colspan="2"><code> [virtual]</code></td>
2232         </tr>
2233
2234       </table>
2235     </td>
2236   </tr>
2237 </table>
2238 <table cellspacing=5 cellpadding=0 border=0>
2239   <tr>
2240     <td>
2241       &nbsp;
2242     </td>
2243     <td>
2244
2245 <p>
2246 Called when a user parts a channel.
2247 <p>
2248 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
2249 <p>
2250 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>.
2251 <p>
2252 <div class="fragment"><pre>00376 { }
2253 </pre></div>    </td>
2254   </tr>
2255 </table>
2256 <a name="a23" doxytag="Module::OnUserPostNick"></a><p>
2257 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
2258   <tr>
2259     <td class="mdRow">
2260       <table cellpadding="0" cellspacing="0" border="0">
2261         <tr>
2262           <td class="md" nowrap valign="top"> void Module::OnUserPostNick </td>
2263           <td class="md" valign="top">(&nbsp;</td>
2264           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
2265           <td class="mdname" nowrap> <em>user</em>, </td>
2266         </tr>
2267         <tr>
2268           <td></td>
2269           <td></td>
2270           <td class="md" nowrap>std::string&nbsp;</td>
2271           <td class="mdname" nowrap> <em>oldnick</em></td>
2272         </tr>
2273         <tr>
2274           <td></td>
2275           <td class="md">)&nbsp;</td>
2276           <td class="md" colspan="2"><code> [virtual]</code></td>
2277         </tr>
2278
2279       </table>
2280     </td>
2281   </tr>
2282 </table>
2283 <table cellspacing=5 cellpadding=0 border=0>
2284   <tr>
2285     <td>
2286       &nbsp;
2287     </td>
2288     <td>
2289
2290 <p>
2291 Called after any nickchange, local or remote.
2292 <p>
2293 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.
2294 <p>
2295 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>.
2296 <p>
2297 <div class="fragment"><pre>00391 { };
2298 </pre></div>    </td>
2299   </tr>
2300 </table>
2301 <a name="a19" doxytag="Module::OnUserPreInvite"></a><p>
2302 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
2303   <tr>
2304     <td class="mdRow">
2305       <table cellpadding="0" cellspacing="0" border="0">
2306         <tr>
2307           <td class="md" nowrap valign="top"> int Module::OnUserPreInvite </td>
2308           <td class="md" valign="top">(&nbsp;</td>
2309           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
2310           <td class="mdname" nowrap> <em>source</em>, </td>
2311         </tr>
2312         <tr>
2313           <td></td>
2314           <td></td>
2315           <td class="md" nowrap><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
2316           <td class="mdname" nowrap> <em>dest</em>, </td>
2317         </tr>
2318         <tr>
2319           <td></td>
2320           <td></td>
2321           <td class="md" nowrap><a class="el" href="classchanrec.html">chanrec</a> *&nbsp;</td>
2322           <td class="mdname" nowrap> <em>channel</em></td>
2323         </tr>
2324         <tr>
2325           <td></td>
2326           <td class="md">)&nbsp;</td>
2327           <td class="md" colspan="2"><code> [virtual]</code></td>
2328         </tr>
2329
2330       </table>
2331     </td>
2332   </tr>
2333 </table>
2334 <table cellspacing=5 cellpadding=0 border=0>
2335   <tr>
2336     <td>
2337       &nbsp;
2338     </td>
2339     <td>
2340
2341 <p>
2342 Called whenever a user is about to invite another user into a channel, before any processing is done.
2343 <p>
2344 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.
2345 <p>
2346 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>.
2347 <p>
2348 <div class="fragment"><pre>00387 { <span class="keywordflow">return</span> 0; };
2349 </pre></div>    </td>
2350   </tr>
2351 </table>
2352 <a name="a13" doxytag="Module::OnUserPreJoin"></a><p>
2353 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
2354   <tr>
2355     <td class="mdRow">
2356       <table cellpadding="0" cellspacing="0" border="0">
2357         <tr>
2358           <td class="md" nowrap valign="top"> int Module::OnUserPreJoin </td>
2359           <td class="md" valign="top">(&nbsp;</td>
2360           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
2361           <td class="mdname" nowrap> <em>user</em>, </td>
2362         </tr>
2363         <tr>
2364           <td></td>
2365           <td></td>
2366           <td class="md" nowrap><a class="el" href="classchanrec.html">chanrec</a> *&nbsp;</td>
2367           <td class="mdname" nowrap> <em>chan</em>, </td>
2368         </tr>
2369         <tr>
2370           <td></td>
2371           <td></td>
2372           <td class="md" nowrap>const char *&nbsp;</td>
2373           <td class="mdname" nowrap> <em>cname</em></td>
2374         </tr>
2375         <tr>
2376           <td></td>
2377           <td class="md">)&nbsp;</td>
2378           <td class="md" colspan="2"><code> [virtual]</code></td>
2379         </tr>
2380
2381       </table>
2382     </td>
2383   </tr>
2384 </table>
2385 <table cellspacing=5 cellpadding=0 border=0>
2386   <tr>
2387     <td>
2388       &nbsp;
2389     </td>
2390     <td>
2391
2392 <p>
2393 Called whenever a user is about to join a channel, before any processing is done.
2394 <p>
2395 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>
2396 IMPORTANT NOTE!<p>
2397 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.
2398 <p>
2399 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>.
2400 <p>
2401 <div class="fragment"><pre>00381 { <span class="keywordflow">return</span> 0; }
2402 </pre></div>    </td>
2403   </tr>
2404 </table>
2405 <a name="a14" doxytag="Module::OnUserPreKick"></a><p>
2406 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
2407   <tr>
2408     <td class="mdRow">
2409       <table cellpadding="0" cellspacing="0" border="0">
2410         <tr>
2411           <td class="md" nowrap valign="top"> int Module::OnUserPreKick </td>
2412           <td class="md" valign="top">(&nbsp;</td>
2413           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
2414           <td class="mdname" nowrap> <em>source</em>, </td>
2415         </tr>
2416         <tr>
2417           <td></td>
2418           <td></td>
2419           <td class="md" nowrap><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
2420           <td class="mdname" nowrap> <em>user</em>, </td>
2421         </tr>
2422         <tr>
2423           <td></td>
2424           <td></td>
2425           <td class="md" nowrap><a class="el" href="classchanrec.html">chanrec</a> *&nbsp;</td>
2426           <td class="mdname" nowrap> <em>chan</em>, </td>
2427         </tr>
2428         <tr>
2429           <td></td>
2430           <td></td>
2431           <td class="md" nowrap>std::string&nbsp;</td>
2432           <td class="mdname" nowrap> <em>reason</em></td>
2433         </tr>
2434         <tr>
2435           <td></td>
2436           <td class="md">)&nbsp;</td>
2437           <td class="md" colspan="2"><code> [virtual]</code></td>
2438         </tr>
2439
2440       </table>
2441     </td>
2442   </tr>
2443 </table>
2444 <table cellspacing=5 cellpadding=0 border=0>
2445   <tr>
2446     <td>
2447       &nbsp;
2448     </td>
2449     <td>
2450
2451 <p>
2452 Called whenever a user is about to be kicked.
2453 <p>
2454 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.
2455 <p>
2456 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>.
2457 <p>
2458 <div class="fragment"><pre>00403 { <span class="keywordflow">return</span> 0; };
2459 </pre></div>    </td>
2460   </tr>
2461 </table>
2462 <a name="a20" doxytag="Module::OnUserPreMessage"></a><p>
2463 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
2464   <tr>
2465     <td class="mdRow">
2466       <table cellpadding="0" cellspacing="0" border="0">
2467         <tr>
2468           <td class="md" nowrap valign="top"> int Module::OnUserPreMessage </td>
2469           <td class="md" valign="top">(&nbsp;</td>
2470           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
2471           <td class="mdname" nowrap> <em>user</em>, </td>
2472         </tr>
2473         <tr>
2474           <td></td>
2475           <td></td>
2476           <td class="md" nowrap>void *&nbsp;</td>
2477           <td class="mdname" nowrap> <em>dest</em>, </td>
2478         </tr>
2479         <tr>
2480           <td></td>
2481           <td></td>
2482           <td class="md" nowrap>int&nbsp;</td>
2483           <td class="mdname" nowrap> <em>target_type</em>, </td>
2484         </tr>
2485         <tr>
2486           <td></td>
2487           <td></td>
2488           <td class="md" nowrap>std::string &amp;&nbsp;</td>
2489           <td class="mdname" nowrap> <em>text</em></td>
2490         </tr>
2491         <tr>
2492           <td></td>
2493           <td class="md">)&nbsp;</td>
2494           <td class="md" colspan="2"><code> [virtual]</code></td>
2495         </tr>
2496
2497       </table>
2498     </td>
2499   </tr>
2500 </table>
2501 <table cellspacing=5 cellpadding=0 border=0>
2502   <tr>
2503     <td>
2504       &nbsp;
2505     </td>
2506     <td>
2507
2508 <p>
2509 Called whenever a user is about to PRIVMSG A user or a channel, before any processing is done.
2510 <p>
2511 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.
2512 <p>
2513 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>.
2514 <p>
2515 <div class="fragment"><pre>00388 { <span class="keywordflow">return</span> 0; };
2516 </pre></div>    </td>
2517   </tr>
2518 </table>
2519 <a name="a22" doxytag="Module::OnUserPreNick"></a><p>
2520 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
2521   <tr>
2522     <td class="mdRow">
2523       <table cellpadding="0" cellspacing="0" border="0">
2524         <tr>
2525           <td class="md" nowrap valign="top"> int Module::OnUserPreNick </td>
2526           <td class="md" valign="top">(&nbsp;</td>
2527           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
2528           <td class="mdname" nowrap> <em>user</em>, </td>
2529         </tr>
2530         <tr>
2531           <td></td>
2532           <td></td>
2533           <td class="md" nowrap>std::string&nbsp;</td>
2534           <td class="mdname" nowrap> <em>newnick</em></td>
2535         </tr>
2536         <tr>
2537           <td></td>
2538           <td class="md">)&nbsp;</td>
2539           <td class="md" colspan="2"><code> [virtual]</code></td>
2540         </tr>
2541
2542       </table>
2543     </td>
2544   </tr>
2545 </table>
2546 <table cellspacing=5 cellpadding=0 border=0>
2547   <tr>
2548     <td>
2549       &nbsp;
2550     </td>
2551     <td>
2552
2553 <p>
2554 Called before any nickchange, local or remote.
2555 <p>
2556 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.
2557 <p>
2558 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>.
2559 <p>
2560 <div class="fragment"><pre>00390 { <span class="keywordflow">return</span> 0; };
2561 </pre></div>    </td>
2562   </tr>
2563 </table>
2564 <a name="a21" doxytag="Module::OnUserPreNotice"></a><p>
2565 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
2566   <tr>
2567     <td class="mdRow">
2568       <table cellpadding="0" cellspacing="0" border="0">
2569         <tr>
2570           <td class="md" nowrap valign="top"> int Module::OnUserPreNotice </td>
2571           <td class="md" valign="top">(&nbsp;</td>
2572           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
2573           <td class="mdname" nowrap> <em>user</em>, </td>
2574         </tr>
2575         <tr>
2576           <td></td>
2577           <td></td>
2578           <td class="md" nowrap>void *&nbsp;</td>
2579           <td class="mdname" nowrap> <em>dest</em>, </td>
2580         </tr>
2581         <tr>
2582           <td></td>
2583           <td></td>
2584           <td class="md" nowrap>int&nbsp;</td>
2585           <td class="mdname" nowrap> <em>target_type</em>, </td>
2586         </tr>
2587         <tr>
2588           <td></td>
2589           <td></td>
2590           <td class="md" nowrap>std::string &amp;&nbsp;</td>
2591           <td class="mdname" nowrap> <em>text</em></td>
2592         </tr>
2593         <tr>
2594           <td></td>
2595           <td class="md">)&nbsp;</td>
2596           <td class="md" colspan="2"><code> [virtual]</code></td>
2597         </tr>
2598
2599       </table>
2600     </td>
2601   </tr>
2602 </table>
2603 <table cellspacing=5 cellpadding=0 border=0>
2604   <tr>
2605     <td>
2606       &nbsp;
2607     </td>
2608     <td>
2609
2610 <p>
2611 Called whenever a user is about to NOTICE A user or a channel, before any processing is done.
2612 <p>
2613 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.
2614 <p>
2615 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>.
2616 <p>
2617 <div class="fragment"><pre>00389 { <span class="keywordflow">return</span> 0; };
2618 </pre></div>    </td>
2619   </tr>
2620 </table>
2621 <a name="a4" doxytag="Module::OnUserQuit"></a><p>
2622 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
2623   <tr>
2624     <td class="mdRow">
2625       <table cellpadding="0" cellspacing="0" border="0">
2626         <tr>
2627           <td class="md" nowrap valign="top"> void Module::OnUserQuit </td>
2628           <td class="md" valign="top">(&nbsp;</td>
2629           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
2630           <td class="mdname1" valign="top" nowrap> <em>user</em>          </td>
2631           <td class="md" valign="top">&nbsp;)&nbsp;</td>
2632           <td class="md" nowrap><code> [virtual]</code></td>
2633         </tr>
2634
2635       </table>
2636     </td>
2637   </tr>
2638 </table>
2639 <table cellspacing=5 cellpadding=0 border=0>
2640   <tr>
2641     <td>
2642       &nbsp;
2643     </td>
2644     <td>
2645
2646 <p>
2647 Called when a user quits.
2648 <p>
2649 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.
2650 <p>
2651 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>.
2652 <p>
2653 <div class="fragment"><pre>00373 { }
2654 </pre></div>    </td>
2655   </tr>
2656 </table>
2657 <a name="a34" doxytag="Module::OnUserRegister"></a><p>
2658 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
2659   <tr>
2660     <td class="mdRow">
2661       <table cellpadding="0" cellspacing="0" border="0">
2662         <tr>
2663           <td class="md" nowrap valign="top"> void Module::OnUserRegister </td>
2664           <td class="md" valign="top">(&nbsp;</td>
2665           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
2666           <td class="mdname1" valign="top" nowrap> <em>user</em>          </td>
2667           <td class="md" valign="top">&nbsp;)&nbsp;</td>
2668           <td class="md" nowrap><code> [virtual]</code></td>
2669         </tr>
2670
2671       </table>
2672     </td>
2673   </tr>
2674 </table>
2675 <table cellspacing=5 cellpadding=0 border=0>
2676   <tr>
2677     <td>
2678       &nbsp;
2679     </td>
2680     <td>
2681
2682 <p>
2683 Called whenever a user is about to register their connection (e.g.
2684 <p>
2685 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.
2686 <p>
2687 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>.
2688 <p>
2689 <div class="fragment"><pre>00402 { };
2690 </pre></div>    </td>
2691   </tr>
2692 </table>
2693 <a name="a25" doxytag="Module::OnUserSync"></a><p>
2694 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
2695   <tr>
2696     <td class="mdRow">
2697       <table cellpadding="0" cellspacing="0" border="0">
2698         <tr>
2699           <td class="md" nowrap valign="top"> <a class="el" href="modules_8h.html#a32">string_list</a> Module::OnUserSync </td>
2700           <td class="md" valign="top">(&nbsp;</td>
2701           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
2702           <td class="mdname1" valign="top" nowrap> <em>user</em>          </td>
2703           <td class="md" valign="top">&nbsp;)&nbsp;</td>
2704           <td class="md" nowrap><code> [virtual]</code></td>
2705         </tr>
2706
2707       </table>
2708     </td>
2709   </tr>
2710 </table>
2711 <table cellspacing=5 cellpadding=0 border=0>
2712   <tr>
2713     <td>
2714       &nbsp;
2715     </td>
2716     <td>
2717
2718 <p>
2719 Called during a netburst to sync user data.
2720 <p>
2721 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.
2722 <p>
2723 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>.
2724 <p>
2725 References <a class="el" href="modules_8h-source.html#l00068">string_list</a>.
2726 <p>
2727 <div class="fragment"><pre>00393 { <a class="code" href="modules_8h.html#a32">string_list</a> empty; <span class="keywordflow">return</span> empty; }
2728 </pre></div>    </td>
2729   </tr>
2730 </table>
2731 <a name="a18" doxytag="Module::OnWhois"></a><p>
2732 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
2733   <tr>
2734     <td class="mdRow">
2735       <table cellpadding="0" cellspacing="0" border="0">
2736         <tr>
2737           <td class="md" nowrap valign="top"> void Module::OnWhois </td>
2738           <td class="md" valign="top">(&nbsp;</td>
2739           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
2740           <td class="mdname" nowrap> <em>source</em>, </td>
2741         </tr>
2742         <tr>
2743           <td></td>
2744           <td></td>
2745           <td class="md" nowrap><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
2746           <td class="mdname" nowrap> <em>dest</em></td>
2747         </tr>
2748         <tr>
2749           <td></td>
2750           <td class="md">)&nbsp;</td>
2751           <td class="md" colspan="2"><code> [virtual]</code></td>
2752         </tr>
2753
2754       </table>
2755     </td>
2756   </tr>
2757 </table>
2758 <table cellspacing=5 cellpadding=0 border=0>
2759   <tr>
2760     <td>
2761       &nbsp;
2762     </td>
2763     <td>
2764
2765 <p>
2766 Called whenever a /WHOIS is performed on a local user.
2767 <p>
2768 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.
2769 <p>
2770 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>.
2771 <p>
2772 <div class="fragment"><pre>00386 { };
2773 </pre></div>    </td>
2774   </tr>
2775 </table>
2776 <hr>The documentation for this class was generated from the following files:<ul>
2777 <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>
2778 <hr size="1"><address style="align: right;"><small>Generated on Thu May 12 22:59:04 2005 for InspIRCd by
2779 <a href="http://www.doxygen.org/index.html">
2780 <img src="doxygen.png" alt="doxygen" align="middle" border=0 >
2781 </a>1.3.3 </small></address>
2782 </body>
2783 </html>