docs/module-doc/classModule.html

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