docs/module-doc/classModule.html

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