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