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 <a class="el" href="classInspIRCd.html">InspIRCd</a> modules This class is the base class for <a class="el" href="classInspIRCd.html">InspIRCd</a> 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_28Server_20_2AMe_29">Module</a> (<a class="el" href="classServer.html">Server</a> *Me)</td></tr>
  25
  26 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor Creates a module class.  <a href="#Module_28Server_20_2AMe_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_2C_20std_3A_3Astring_20message_29">OnUserQuit</a> (<a class="el" href="classuserrec.html">userrec</a> *user, <a class="el" href="namespaceirc.html#string">std::string</a> message)</td></tr>
  37
  38 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called when a user quits.  <a href="#OnUserQuit_28userrec_20_2Auser_2C_20std_3A_3Astring_20message_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#OnRehash_28std_3A_3Astring_20parameter_29">OnRehash</a> (<a class="el" href="namespaceirc.html#string">std::string</a> parameter)</td></tr>
  49
  50 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called on rehash.  <a href="#OnRehash_28std_3A_3Astring_20parameter_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#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>
  52
  53 <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>
  54 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classModule.html#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>
  55
  56 <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>
  57 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classModule.html#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>
  58
  59 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called whenever a user is about to join a channel, before any processing is done.  <a href="#OnUserPreJoin_28userrec_20_2Auser_2C_20chanrec_20_2Achan_2C_20const_20char_20_2Acname_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#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>
  61
  62 <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>
  63 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classModule.html#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>
  64
  65 <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>
  66 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classModule.html#OnOper_28userrec_20_2Auser_2C_20std_3A_3Astring_20opertype_29">OnOper</a> (<a class="el" href="classuserrec.html">userrec</a> *user, <a class="el" href="namespaceirc.html#string">std::string</a> opertype)</td></tr>
  67
  68 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called whenever a user opers locally.  <a href="#OnOper_28userrec_20_2Auser_2C_20std_3A_3Astring_20opertype_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#OnInfo_28userrec_20_2Auser_29">OnInfo</a> (<a class="el" href="classuserrec.html">userrec</a> *user)</td></tr>
  70
  71 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called whenever a user types /INFO.  <a href="#OnInfo_28userrec_20_2Auser_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#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>
  73
  74 <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>
  75 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classModule.html#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>
  76
  77 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called whenever a user is about to invite another user into a channel, before any processing is done.  <a href="#OnUserPreInvite_28userrec_20_2Asource_2C_20userrec_20_2Adest_2C_20chanrec_20_2Achannel_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#OnUserInvite_28userrec_20_2Asource_2C_20userrec_20_2Adest_2C_20chanrec_20_2Achannel_29">OnUserInvite</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>
  79
  80 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called after a user has been successfully invited to a channel.  <a href="#OnUserInvite_28userrec_20_2Asource_2C_20userrec_20_2Adest_2C_20chanrec_20_2Achannel_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#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>
  82
  83 <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>
  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#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>
  85
  86 <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>
  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#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>
  88
  89 <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>
  90 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classModule.html#OnUserMessage_28userrec_20_2Auser_2C_20void_20_2Adest_2C_20int_20target_5Ftype_2C_20std_3A_3Astring_20text_29">OnUserMessage</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> text)</td></tr>
  91
  92 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called after any PRIVMSG sent from a user.  <a href="#OnUserMessage_28userrec_20_2Auser_2C_20void_20_2Adest_2C_20int_20target_5Ftype_2C_20std_3A_3Astring_20text_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#OnUserNotice_28userrec_20_2Auser_2C_20void_20_2Adest_2C_20int_20target_5Ftype_2C_20std_3A_3Astring_20text_29">OnUserNotice</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> text)</td></tr>
  94
  95 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called after any NOTICE sent from a user.  <a href="#OnUserNotice_28userrec_20_2Auser_2C_20void_20_2Adest_2C_20int_20target_5Ftype_2C_20std_3A_3Astring_20text_29"></a><br></td></tr>
  96 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classModule.html#OnMode_28userrec_20_2Auser_2C_20void_20_2Adest_2C_20int_20target_5Ftype_2C_20std_3A_3Astring_20text_29">OnMode</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> text)</td></tr>
  97
  98 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called after every MODE command sent from a user The dest variable contains a userrec* if target_type is TYPE_USER and a chanrec* if target_type is TYPE_CHANNEL.  <a href="#OnMode_28userrec_20_2Auser_2C_20void_20_2Adest_2C_20int_20target_5Ftype_2C_20std_3A_3Astring_20text_29"></a><br></td></tr>
  99 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classModule.html#OnGetServerDescription_28std_3A_3Astring_20servername_2C_20std_3A_3Astring_20_26description_29">OnGetServerDescription</a> (<a class="el" href="namespaceirc.html#string">std::string</a> servername, <a class="el" href="namespaceirc.html#string">std::string</a> &amp;description)</td></tr>
 100
 101 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Allows modules to alter or create server descriptions Whenever a module requires a server description, for example for display in WHOIS, this function is called in all modules.  <a href="#OnGetServerDescription_28std_3A_3Astring_20servername_2C_20std_3A_3Astring_20_26description_29"></a><br></td></tr>
 102 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classModule.html#OnSyncUser_28userrec_20_2Auser_2C_20Module_20_2Aproto_2C_20void_20_2Aopaque_29">OnSyncUser</a> (<a class="el" href="classuserrec.html">userrec</a> *user, <a class="el" href="classModule.html">Module</a> *proto, void *opaque)</td></tr>
 103
 104 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Allows modules to synchronize data which relates to users during a netburst.  <a href="#OnSyncUser_28userrec_20_2Auser_2C_20Module_20_2Aproto_2C_20void_20_2Aopaque_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#OnSyncChannel_28chanrec_20_2Achan_2C_20Module_20_2Aproto_2C_20void_20_2Aopaque_29">OnSyncChannel</a> (<a class="el" href="classchanrec.html">chanrec</a> *chan, <a class="el" href="classModule.html">Module</a> *proto, void *opaque)</td></tr>
 106
 107 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Allows modules to synchronize data which relates to channels during a netburst.  <a href="#OnSyncChannel_28chanrec_20_2Achan_2C_20Module_20_2Aproto_2C_20void_20_2Aopaque_29"></a><br></td></tr>
 108 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classModule.html#OnSyncChannelMetaData_28chanrec_20_2Achan_2C_20Module_20_2Aproto_2C_20void_20_2Aopaque_2C_20std_3A_3Astring_20extname_29">OnSyncChannelMetaData</a> (<a class="el" href="classchanrec.html">chanrec</a> *chan, <a class="el" href="classModule.html">Module</a> *proto, void *opaque, <a class="el" href="namespaceirc.html#string">std::string</a> extname)</td></tr>
 109
 110 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classModule.html#OnSyncUserMetaData_28userrec_20_2Auser_2C_20Module_20_2Aproto_2C_20void_20_2Aopaque_2C_20std_3A_3Astring_20extname_29">OnSyncUserMetaData</a> (<a class="el" href="classuserrec.html">userrec</a> *user, <a class="el" href="classModule.html">Module</a> *proto, void *opaque, <a class="el" href="namespaceirc.html#string">std::string</a> extname)</td></tr>
 111
 112 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classModule.html#OnDecodeMetaData_28int_20target_5Ftype_2C_20void_20_2Atarget_2C_20std_3A_3Astring_20extname_2C_20std_3A_3Astring_20extdata_29">OnDecodeMetaData</a> (int target_type, void *target, <a class="el" href="namespaceirc.html#string">std::string</a> extname, <a class="el" href="namespaceirc.html#string">std::string</a> extdata)</td></tr>
 113
 114 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Allows module data, sent via ProtoSendMetaData, to be decoded again by a receiving module.  <a href="#OnDecodeMetaData_28int_20target_5Ftype_2C_20void_20_2Atarget_2C_20std_3A_3Astring_20extname_2C_20std_3A_3Astring_20extdata_29"></a><br></td></tr>
 115 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classModule.html#ProtoSendMode_28void_20_2Aopaque_2C_20int_20target_5Ftype_2C_20void_20_2Atarget_2C_20std_3A_3Astring_20modeline_29">ProtoSendMode</a> (void *opaque, int target_type, void *target, <a class="el" href="namespaceirc.html#string">std::string</a> modeline)</td></tr>
 116
 117 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Implemented by modules which provide the ability to link servers.  <a href="#ProtoSendMode_28void_20_2Aopaque_2C_20int_20target_5Ftype_2C_20void_20_2Atarget_2C_20std_3A_3Astring_20modeline_29"></a><br></td></tr>
 118 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classModule.html#ProtoSendMetaData_28void_20_2Aopaque_2C_20int_20target_5Ftype_2C_20void_20_2Atarget_2C_20std_3A_3Astring_20extname_2C_20std_3A_3Astring_20extdata_29">ProtoSendMetaData</a> (void *opaque, int target_type, void *target, <a class="el" href="namespaceirc.html#string">std::string</a> extname, <a class="el" href="namespaceirc.html#string">std::string</a> extdata)</td></tr>
 119
 120 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Implemented by modules which provide the ability to link servers.  <a href="#ProtoSendMetaData_28void_20_2Aopaque_2C_20int_20target_5Ftype_2C_20void_20_2Atarget_2C_20std_3A_3Astring_20extname_2C_20std_3A_3Astring_20extdata_29"></a><br></td></tr>
 121 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classModule.html#OnWallops_28userrec_20_2Auser_2C_20std_3A_3Astring_20text_29">OnWallops</a> (<a class="el" href="classuserrec.html">userrec</a> *user, <a class="el" href="namespaceirc.html#string">std::string</a> text)</td></tr>
 122
 123 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called after every WALLOPS command.  <a href="#OnWallops_28userrec_20_2Auser_2C_20std_3A_3Astring_20text_29"></a><br></td></tr>
 124 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classModule.html#OnChangeHost_28userrec_20_2Auser_2C_20std_3A_3Astring_20newhost_29">OnChangeHost</a> (<a class="el" href="classuserrec.html">userrec</a> *user, <a class="el" href="namespaceirc.html#string">std::string</a> newhost)</td></tr>
 125
 126 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called whenever a user's hostname is changed.  <a href="#OnChangeHost_28userrec_20_2Auser_2C_20std_3A_3Astring_20newhost_29"></a><br></td></tr>
 127 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classModule.html#OnChangeName_28userrec_20_2Auser_2C_20std_3A_3Astring_20gecos_29">OnChangeName</a> (<a class="el" href="classuserrec.html">userrec</a> *user, <a class="el" href="namespaceirc.html#string">std::string</a> gecos)</td></tr>
 128
 129 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called whenever a user's GECOS (realname) is changed.  <a href="#OnChangeName_28userrec_20_2Auser_2C_20std_3A_3Astring_20gecos_29"></a><br></td></tr>
 130 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classModule.html#OnAddGLine_28long_20duration_2C_20userrec_20_2Asource_2C_20std_3A_3Astring_20reason_2C_20std_3A_3Astring_20hostmask_29">OnAddGLine</a> (long duration, <a class="el" href="classuserrec.html">userrec</a> *source, <a class="el" href="namespaceirc.html#string">std::string</a> reason, <a class="el" href="namespaceirc.html#string">std::string</a> hostmask)</td></tr>
 131
 132 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called whenever a gline is added by a local user.  <a href="#OnAddGLine_28long_20duration_2C_20userrec_20_2Asource_2C_20std_3A_3Astring_20reason_2C_20std_3A_3Astring_20hostmask_29"></a><br></td></tr>
 133 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classModule.html#OnAddZLine_28long_20duration_2C_20userrec_20_2Asource_2C_20std_3A_3Astring_20reason_2C_20std_3A_3Astring_20ipmask_29">OnAddZLine</a> (long duration, <a class="el" href="classuserrec.html">userrec</a> *source, <a class="el" href="namespaceirc.html#string">std::string</a> reason, <a class="el" href="namespaceirc.html#string">std::string</a> ipmask)</td></tr>
 134
 135 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called whenever a zline is added by a local user.  <a href="#OnAddZLine_28long_20duration_2C_20userrec_20_2Asource_2C_20std_3A_3Astring_20reason_2C_20std_3A_3Astring_20ipmask_29"></a><br></td></tr>
 136 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classModule.html#OnAddKLine_28long_20duration_2C_20userrec_20_2Asource_2C_20std_3A_3Astring_20reason_2C_20std_3A_3Astring_20hostmask_29">OnAddKLine</a> (long duration, <a class="el" href="classuserrec.html">userrec</a> *source, <a class="el" href="namespaceirc.html#string">std::string</a> reason, <a class="el" href="namespaceirc.html#string">std::string</a> hostmask)</td></tr>
 137
 138 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called whenever a kline is added by a local user.  <a href="#OnAddKLine_28long_20duration_2C_20userrec_20_2Asource_2C_20std_3A_3Astring_20reason_2C_20std_3A_3Astring_20hostmask_29"></a><br></td></tr>
 139 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classModule.html#OnAddQLine_28long_20duration_2C_20userrec_20_2Asource_2C_20std_3A_3Astring_20reason_2C_20std_3A_3Astring_20nickmask_29">OnAddQLine</a> (long duration, <a class="el" href="classuserrec.html">userrec</a> *source, <a class="el" href="namespaceirc.html#string">std::string</a> reason, <a class="el" href="namespaceirc.html#string">std::string</a> nickmask)</td></tr>
 140
 141 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called whenever a qline is added by a local user.  <a href="#OnAddQLine_28long_20duration_2C_20userrec_20_2Asource_2C_20std_3A_3Astring_20reason_2C_20std_3A_3Astring_20nickmask_29"></a><br></td></tr>
 142 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classModule.html#OnAddELine_28long_20duration_2C_20userrec_20_2Asource_2C_20std_3A_3Astring_20reason_2C_20std_3A_3Astring_20hostmask_29">OnAddELine</a> (long duration, <a class="el" href="classuserrec.html">userrec</a> *source, <a class="el" href="namespaceirc.html#string">std::string</a> reason, <a class="el" href="namespaceirc.html#string">std::string</a> hostmask)</td></tr>
 143
 144 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called whenever a eline is added by a local user.  <a href="#OnAddELine_28long_20duration_2C_20userrec_20_2Asource_2C_20std_3A_3Astring_20reason_2C_20std_3A_3Astring_20hostmask_29"></a><br></td></tr>
 145 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classModule.html#OnDelGLine_28userrec_20_2Asource_2C_20std_3A_3Astring_20hostmask_29">OnDelGLine</a> (<a class="el" href="classuserrec.html">userrec</a> *source, <a class="el" href="namespaceirc.html#string">std::string</a> hostmask)</td></tr>
 146
 147 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called whenever a gline is deleted.  <a href="#OnDelGLine_28userrec_20_2Asource_2C_20std_3A_3Astring_20hostmask_29"></a><br></td></tr>
 148 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classModule.html#OnDelZLine_28userrec_20_2Asource_2C_20std_3A_3Astring_20ipmask_29">OnDelZLine</a> (<a class="el" href="classuserrec.html">userrec</a> *source, <a class="el" href="namespaceirc.html#string">std::string</a> ipmask)</td></tr>
 149
 150 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called whenever a zline is deleted.  <a href="#OnDelZLine_28userrec_20_2Asource_2C_20std_3A_3Astring_20ipmask_29"></a><br></td></tr>
 151 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classModule.html#OnDelKLine_28userrec_20_2Asource_2C_20std_3A_3Astring_20hostmask_29">OnDelKLine</a> (<a class="el" href="classuserrec.html">userrec</a> *source, <a class="el" href="namespaceirc.html#string">std::string</a> hostmask)</td></tr>
 152
 153 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called whenever a kline is deleted.  <a href="#OnDelKLine_28userrec_20_2Asource_2C_20std_3A_3Astring_20hostmask_29"></a><br></td></tr>
 154 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classModule.html#OnDelQLine_28userrec_20_2Asource_2C_20std_3A_3Astring_20nickmask_29">OnDelQLine</a> (<a class="el" href="classuserrec.html">userrec</a> *source, <a class="el" href="namespaceirc.html#string">std::string</a> nickmask)</td></tr>
 155
 156 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called whenever a qline is deleted.  <a href="#OnDelQLine_28userrec_20_2Asource_2C_20std_3A_3Astring_20nickmask_29"></a><br></td></tr>
 157 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classModule.html#OnDelELine_28userrec_20_2Asource_2C_20std_3A_3Astring_20hostmask_29">OnDelELine</a> (<a class="el" href="classuserrec.html">userrec</a> *source, <a class="el" href="namespaceirc.html#string">std::string</a> hostmask)</td></tr>
 158
 159 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called whenever a eline is deleted.  <a href="#OnDelELine_28userrec_20_2Asource_2C_20std_3A_3Astring_20hostmask_29"></a><br></td></tr>
 160 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classModule.html#OnCleanup_28int_20target_5Ftype_2C_20void_20_2Aitem_29">OnCleanup</a> (int target_type, void *item)</td></tr>
 161
 162 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called before your module is unloaded to clean up Extensibles.  <a href="#OnCleanup_28int_20target_5Ftype_2C_20void_20_2Aitem_29"></a><br></td></tr>
 163 <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>
 164
 165 <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>
 166 <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>
 167
 168 <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>
 169 <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>
 170
 171 <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>
 172 <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>
 173
 174 <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>
 175 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classModule.html#OnRemoteKill_28userrec_20_2Asource_2C_20userrec_20_2Adest_2C_20std_3A_3Astring_20reason_29">OnRemoteKill</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>
 176
 177 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called when an oper wants to disconnect a remote user via KILL.  <a href="#OnRemoteKill_28userrec_20_2Asource_2C_20userrec_20_2Adest_2C_20std_3A_3Astring_20reason_29"></a><br></td></tr>
 178 <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>
 179
 180 <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>
 181 <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>
 182
 183 <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>
 184 <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>
 185
 186 <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>
 187 <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>
 188
 189 <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>
 190 <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>
 191
 192 <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>
 193 <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>
 194
 195 <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>
 196 <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>
 197
 198 <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>
 199 <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>
 200
 201 <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>
 202 <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>
 203
 204 <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>
 205 <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>
 206
 207 <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>
 208 <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>
 209
 210 <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>
 211 <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>
 212
 213 <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>
 214 <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>
 215
 216 <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>
 217 <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>
 218
 219 <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>
 220 <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>
 221
 222 <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>
 223 <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>
 224
 225 <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>
 226 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classModule.html#OnPostLocalTopicChange_28userrec_20_2Auser_2C_20chanrec_20_2Achan_2C_20std_3A_3Astring_20topic_29">OnPostLocalTopicChange</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>
 227
 228 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called whenever a local topic has been changed.  <a href="#OnPostLocalTopicChange_28userrec_20_2Auser_2C_20chanrec_20_2Achan_2C_20std_3A_3Astring_20topic_29"></a><br></td></tr>
 229 <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>
 230
 231 <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>
 232 <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>
 233
 234 <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>
 235 <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>
 236
 237 <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>
 238 <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>
 239
 240 <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>
 241 <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>
 242
 243 <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>
 244 <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>
 245
 246 <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>
 247 <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>
 248
 249 <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>
 250 <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>
 251
 252 <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>
 253 <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>
 254
 255 <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>
 256 <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>
 257
 258 <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>
 259 <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>
 260
 261 <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>
 262 </table>
 263 <hr><a name="_details"></a><h2>Detailed Description</h2>
 264 Base class for all <a class="el" href="classInspIRCd.html">InspIRCd</a> modules This class is the base class for <a class="el" href="classInspIRCd.html">InspIRCd</a> modules.
 265 <p>
 266 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.
 267 <p>
 268
 269 <p>
 270 Definition at line <a class="el" href="modules_8h-source.html#l00272">272</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
 271 <a class="anchor" name="Module_28Server_20_2AMe_29"></a><!-- doxytag: member="Module::Module" ref="Module_28Server_20_2AMe_29" args="(Server *Me)" --><p>
 272 <table class="mdTable" cellpadding="2" cellspacing="0">
 273   <tr>
 274     <td class="mdRow">
 275       <table cellpadding="0" cellspacing="0" border="0">
 276         <tr>
 277           <td class="md" nowrap valign="top">Module::Module           </td>
 278           <td class="md" valign="top">(&nbsp;</td>
 279           <td class="md" nowrap valign="top"><a class="el" href="classServer.html">Server</a> *&nbsp;</td>
 280           <td class="mdname1" valign="top" nowrap> <em>Me</em>          </td>
 281           <td class="md" valign="top">&nbsp;)&nbsp;</td>
 282           <td class="md" nowrap></td>
 283         </tr>
 284       </table>
 285     </td>
 286   </tr>
 287 </table>
 288 <table cellspacing="5" cellpadding="0" border="0">
 289   <tr>
 290     <td>
 291       &nbsp;
 292     </td>
 293     <td>
 294
 295 <p>
 296 Default constructor Creates a module class.
 297 <p>
 298 <dl compact><dt><b>Parameters:</b></dt><dd>
 299   <table border="0" cellspacing="2" cellpadding="0">
 300     <tr><td valign="top"></td><td valign="top"><em>Me</em>&nbsp;</td><td>An instance of the <a class="el" href="classServer.html">Server</a> class which can be saved for future use</td></tr>
 301   </table>
 302 </dl>
 303
 304 <p>
 305 Definition at line <a class="el" href="modules_8cpp-source.html#l00219">219</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00219"></a>00219 { }
 306 </pre></div>
 307 <p>
 308     </td>
 309   </tr>
 310 </table>
 311 <a class="anchor" name="_7EModule_28_29"></a><!-- doxytag: member="Module::~Module" ref="_7EModule_28_29" args="()" --><p>
 312 <table class="mdTable" cellpadding="2" cellspacing="0">
 313   <tr>
 314     <td class="mdRow">
 315       <table cellpadding="0" cellspacing="0" border="0">
 316         <tr>
 317           <td class="md" nowrap valign="top">Module::~Module           </td>
 318           <td class="md" valign="top">(&nbsp;</td>
 319           <td class="mdname1" valign="top" nowrap>          </td>
 320           <td class="md" valign="top">&nbsp;)&nbsp;</td>
 321           <td class="md" nowrap><code> [virtual]</code></td>
 322         </tr>
 323       </table>
 324     </td>
 325   </tr>
 326 </table>
 327 <table cellspacing="5" cellpadding="0" border="0">
 328   <tr>
 329     <td>
 330       &nbsp;
 331     </td>
 332     <td>
 333
 334 <p>
 335 Default destructor destroys a module class.
 336 <p>
 337
 338 <p>
 339 Definition at line <a class="el" href="modules_8cpp-source.html#l00220">220</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00220"></a>00220 { }
 340 </pre></div>
 341 <p>
 342     </td>
 343   </tr>
 344 </table>
 345 <hr><h2>Member Function Documentation</h2>
 346 <a class="anchor" name="GetVersion_28_29"></a><!-- doxytag: member="Module::GetVersion" ref="GetVersion_28_29" args="()" --><p>
 347 <table class="mdTable" cellpadding="2" cellspacing="0">
 348   <tr>
 349     <td class="mdRow">
 350       <table cellpadding="0" cellspacing="0" border="0">
 351         <tr>
 352           <td class="md" nowrap valign="top"><a class="el" href="classVersion.html">Version</a> Module::GetVersion           </td>
 353           <td class="md" valign="top">(&nbsp;</td>
 354           <td class="mdname1" valign="top" nowrap>          </td>
 355           <td class="md" valign="top">&nbsp;)&nbsp;</td>
 356           <td class="md" nowrap><code> [virtual]</code></td>
 357         </tr>
 358       </table>
 359     </td>
 360   </tr>
 361 </table>
 362 <table cellspacing="5" cellpadding="0" border="0">
 363   <tr>
 364     <td>
 365       &nbsp;
 366     </td>
 367     <td>
 368
 369 <p>
 370 Returns the version number of a Module.
 371 <p>
 372 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>
 373 <p>
 374 Definition at line <a class="el" href="modules_8cpp-source.html#l00231">231</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 375 <p>
 376 References <a class="el" href="modules_8h-source.html#l00053">VF_VENDOR</a>.<div class="fragment"><pre class="fragment"><a name="l00231"></a>00231 { <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>); }
 377 </pre></div>
 378 <p>
 379     </td>
 380   </tr>
 381 </table>
 382 <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>
 383 <table class="mdTable" cellpadding="2" cellspacing="0">
 384   <tr>
 385     <td class="mdRow">
 386       <table cellpadding="0" cellspacing="0" border="0">
 387         <tr>
 388           <td class="md" nowrap valign="top">void Module::On005Numeric           </td>
 389           <td class="md" valign="top">(&nbsp;</td>
 390           <td class="md" nowrap valign="top"><a class="el" href="namespaceirc.html#string">std::string</a> &amp;&nbsp;</td>
 391           <td class="mdname1" valign="top" nowrap> <em>output</em>          </td>
 392           <td class="md" valign="top">&nbsp;)&nbsp;</td>
 393           <td class="md" nowrap><code> [virtual]</code></td>
 394         </tr>
 395       </table>
 396     </td>
 397   </tr>
 398 </table>
 399 <table cellspacing="5" cellpadding="0" border="0">
 400   <tr>
 401     <td>
 402       &nbsp;
 403     </td>
 404     <td>
 405
 406 <p>
 407 Called when a 005 numeric is about to be output.
 408 <p>
 409 The module should modify the 005 numeric if needed to indicate its features. <dl compact><dt><b>Parameters:</b></dt><dd>
 410   <table border="0" cellspacing="2" cellpadding="0">
 411     <tr><td valign="top"></td><td valign="top"><em>output</em>&nbsp;</td><td>The 005 string to be modified if neccessary.</td></tr>
 412   </table>
 413 </dl>
 414
 415 <p>
 416 Definition at line <a class="el" href="modules_8cpp-source.html#l00241">241</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00241"></a>00241 { };
 417 </pre></div>
 418 <p>
 419     </td>
 420   </tr>
 421 </table>
 422 <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>
 423 <table class="mdTable" cellpadding="2" cellspacing="0">
 424   <tr>
 425     <td class="mdRow">
 426       <table cellpadding="0" cellspacing="0" border="0">
 427         <tr>
 428           <td class="md" nowrap valign="top">int Module::OnAccessCheck           </td>
 429           <td class="md" valign="top">(&nbsp;</td>
 430           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 431           <td class="mdname" nowrap> <em>source</em>, </td>
 432         </tr>
 433         <tr>
 434           <td class="md" nowrap align="right"></td>
 435           <td class="md"></td>
 436           <td class="md" nowrap><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 437           <td class="mdname" nowrap> <em>dest</em>, </td>
 438         </tr>
 439         <tr>
 440           <td class="md" nowrap align="right"></td>
 441           <td class="md"></td>
 442           <td class="md" nowrap><a class="el" href="classchanrec.html">chanrec</a> *&nbsp;</td>
 443           <td class="mdname" nowrap> <em>channel</em>, </td>
 444         </tr>
 445         <tr>
 446           <td class="md" nowrap align="right"></td>
 447           <td class="md"></td>
 448           <td class="md" nowrap>int&nbsp;</td>
 449           <td class="mdname" nowrap> <em>access_type</em></td>
 450         </tr>
 451         <tr>
 452           <td class="md"></td>
 453           <td class="md">)&nbsp;</td>
 454           <td class="md" colspan="2"><code> [virtual]</code></td>
 455         </tr>
 456       </table>
 457     </td>
 458   </tr>
 459 </table>
 460 <table cellspacing="5" cellpadding="0" border="0">
 461   <tr>
 462     <td>
 463       &nbsp;
 464     </td>
 465     <td>
 466
 467 <p>
 468 Called before an action which requires a channel privilage check.
 469 <p>
 470 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>
 471 <br>
 472  AC_KICK (0) - A user is being kicked<br>
 473  AC_DEOP (1) - a user is being deopped<br>
 474  AC_OP (2) - a user is being opped<br>
 475  AC_VOICE (3) - a user is being voiced<br>
 476  AC_DEVOICE (4) - a user is being devoiced<br>
 477  AC_HALFOP (5) - a user is being halfopped<br>
 478  AC_DEHALFOP (6) - a user is being dehalfopped<br>
 479  AC_INVITE (7) - a user is being invited<br>
 480  AC_GENERAL_MODE (8) - a user channel mode is being changed&lt;br&gt;<br>
 481  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). <dl compact><dt><b>Parameters:</b></dt><dd>
 482   <table border="0" cellspacing="2" cellpadding="0">
 483     <tr><td valign="top"></td><td valign="top"><em>source</em>&nbsp;</td><td>The source of the access check </td></tr>
 484     <tr><td valign="top"></td><td valign="top"><em>dest</em>&nbsp;</td><td>The destination of the access check </td></tr>
 485     <tr><td valign="top"></td><td valign="top"><em>channel</em>&nbsp;</td><td>The channel which is being checked </td></tr>
 486     <tr><td valign="top"></td><td valign="top"><em>access_type</em>&nbsp;</td><td>See above</td></tr>
 487   </table>
 488 </dl>
 489
 490 <p>
 491 Definition at line <a class="el" href="modules_8cpp-source.html#l00240">240</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 492 <p>
 493 References <a class="el" href="modules_8h-source.html#l00037">ACR_DEFAULT</a>.<div class="fragment"><pre class="fragment"><a name="l00240"></a>00240 { <span class="keywordflow">return</span> <a class="code" href="modules_8h.html#ACR_5FDEFAULT">ACR_DEFAULT</a>; };
 494 </pre></div>
 495 <p>
 496     </td>
 497   </tr>
 498 </table>
 499 <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>
 500 <table class="mdTable" cellpadding="2" cellspacing="0">
 501   <tr>
 502     <td class="mdRow">
 503       <table cellpadding="0" cellspacing="0" border="0">
 504         <tr>
 505           <td class="md" nowrap valign="top">int Module::OnAddBan           </td>
 506           <td class="md" valign="top">(&nbsp;</td>
 507           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 508           <td class="mdname" nowrap> <em>source</em>, </td>
 509         </tr>
 510         <tr>
 511           <td class="md" nowrap align="right"></td>
 512           <td class="md"></td>
 513           <td class="md" nowrap><a class="el" href="classchanrec.html">chanrec</a> *&nbsp;</td>
 514           <td class="mdname" nowrap> <em>channel</em>, </td>
 515         </tr>
 516         <tr>
 517           <td class="md" nowrap align="right"></td>
 518           <td class="md"></td>
 519           <td class="md" nowrap><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
 520           <td class="mdname" nowrap> <em>banmask</em></td>
 521         </tr>
 522         <tr>
 523           <td class="md"></td>
 524           <td class="md">)&nbsp;</td>
 525           <td class="md" colspan="2"><code> [virtual]</code></td>
 526         </tr>
 527       </table>
 528     </td>
 529   </tr>
 530 </table>
 531 <table cellspacing="5" cellpadding="0" border="0">
 532   <tr>
 533     <td>
 534       &nbsp;
 535     </td>
 536     <td>
 537
 538 <p>
 539 Called whenever a ban is added to a channel's list.
 540 <p>
 541 Return a non-zero value to 'eat' the mode change and prevent the ban from being added. <dl compact><dt><b>Parameters:</b></dt><dd>
 542   <table border="0" cellspacing="2" cellpadding="0">
 543     <tr><td valign="top"></td><td valign="top"><em>source</em>&nbsp;</td><td>The user adding the ban </td></tr>
 544     <tr><td valign="top"></td><td valign="top"><em>channel</em>&nbsp;</td><td>The channel the ban is being added to </td></tr>
 545     <tr><td valign="top"></td><td valign="top"><em>banmask</em>&nbsp;</td><td>The ban mask being added </td></tr>
 546   </table>
 547 </dl>
 548 <dl compact><dt><b>Returns:</b></dt><dd>1 to block the ban, 0 to continue as normal</dd></dl>
 549
 550 <p>
 551 Definition at line <a class="el" href="modules_8cpp-source.html#l00266">266</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00266"></a>00266 { <span class="keywordflow">return</span> 0; };
 552 </pre></div>
 553 <p>
 554     </td>
 555   </tr>
 556 </table>
 557 <a class="anchor" name="OnAddELine_28long_20duration_2C_20userrec_20_2Asource_2C_20std_3A_3Astring_20reason_2C_20std_3A_3Astring_20hostmask_29"></a><!-- doxytag: member="Module::OnAddELine" ref="OnAddELine_28long_20duration_2C_20userrec_20_2Asource_2C_20std_3A_3Astring_20reason_2C_20std_3A_3Astring_20hostmask_29" args="(long duration, userrec *source, std::string reason, std::string hostmask)" --><p>
 558 <table class="mdTable" cellpadding="2" cellspacing="0">
 559   <tr>
 560     <td class="mdRow">
 561       <table cellpadding="0" cellspacing="0" border="0">
 562         <tr>
 563           <td class="md" nowrap valign="top">void Module::OnAddELine           </td>
 564           <td class="md" valign="top">(&nbsp;</td>
 565           <td class="md" nowrap valign="top">long&nbsp;</td>
 566           <td class="mdname" nowrap> <em>duration</em>, </td>
 567         </tr>
 568         <tr>
 569           <td class="md" nowrap align="right"></td>
 570           <td class="md"></td>
 571           <td class="md" nowrap><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 572           <td class="mdname" nowrap> <em>source</em>, </td>
 573         </tr>
 574         <tr>
 575           <td class="md" nowrap align="right"></td>
 576           <td class="md"></td>
 577           <td class="md" nowrap><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
 578           <td class="mdname" nowrap> <em>reason</em>, </td>
 579         </tr>
 580         <tr>
 581           <td class="md" nowrap align="right"></td>
 582           <td class="md"></td>
 583           <td class="md" nowrap><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
 584           <td class="mdname" nowrap> <em>hostmask</em></td>
 585         </tr>
 586         <tr>
 587           <td class="md"></td>
 588           <td class="md">)&nbsp;</td>
 589           <td class="md" colspan="2"><code> [virtual]</code></td>
 590         </tr>
 591       </table>
 592     </td>
 593   </tr>
 594 </table>
 595 <table cellspacing="5" cellpadding="0" border="0">
 596   <tr>
 597     <td>
 598       &nbsp;
 599     </td>
 600     <td>
 601
 602 <p>
 603 Called whenever a eline is added by a local user.
 604 <p>
 605 This method is triggered after the line is added. <dl compact><dt><b>Parameters:</b></dt><dd>
 606   <table border="0" cellspacing="2" cellpadding="0">
 607     <tr><td valign="top"></td><td valign="top"><em>duration</em>&nbsp;</td><td>The duration of the line in seconds </td></tr>
 608     <tr><td valign="top"></td><td valign="top"><em>source</em>&nbsp;</td><td>The sender of the line </td></tr>
 609     <tr><td valign="top"></td><td valign="top"><em>reason</em>&nbsp;</td><td>The reason text to be displayed </td></tr>
 610     <tr><td valign="top"></td><td valign="top"><em>hostmask</em>&nbsp;</td><td>The hostmask to add</td></tr>
 611   </table>
 612 </dl>
 613
 614 <p>
 615 Definition at line <a class="el" href="modules_8cpp-source.html#l00292">292</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00292"></a>00292 { };
 616 </pre></div>
 617 <p>
 618     </td>
 619   </tr>
 620 </table>
 621 <a class="anchor" name="OnAddGLine_28long_20duration_2C_20userrec_20_2Asource_2C_20std_3A_3Astring_20reason_2C_20std_3A_3Astring_20hostmask_29"></a><!-- doxytag: member="Module::OnAddGLine" ref="OnAddGLine_28long_20duration_2C_20userrec_20_2Asource_2C_20std_3A_3Astring_20reason_2C_20std_3A_3Astring_20hostmask_29" args="(long duration, userrec *source, std::string reason, std::string hostmask)" --><p>
 622 <table class="mdTable" cellpadding="2" cellspacing="0">
 623   <tr>
 624     <td class="mdRow">
 625       <table cellpadding="0" cellspacing="0" border="0">
 626         <tr>
 627           <td class="md" nowrap valign="top">void Module::OnAddGLine           </td>
 628           <td class="md" valign="top">(&nbsp;</td>
 629           <td class="md" nowrap valign="top">long&nbsp;</td>
 630           <td class="mdname" nowrap> <em>duration</em>, </td>
 631         </tr>
 632         <tr>
 633           <td class="md" nowrap align="right"></td>
 634           <td class="md"></td>
 635           <td class="md" nowrap><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 636           <td class="mdname" nowrap> <em>source</em>, </td>
 637         </tr>
 638         <tr>
 639           <td class="md" nowrap align="right"></td>
 640           <td class="md"></td>
 641           <td class="md" nowrap><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
 642           <td class="mdname" nowrap> <em>reason</em>, </td>
 643         </tr>
 644         <tr>
 645           <td class="md" nowrap align="right"></td>
 646           <td class="md"></td>
 647           <td class="md" nowrap><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
 648           <td class="mdname" nowrap> <em>hostmask</em></td>
 649         </tr>
 650         <tr>
 651           <td class="md"></td>
 652           <td class="md">)&nbsp;</td>
 653           <td class="md" colspan="2"><code> [virtual]</code></td>
 654         </tr>
 655       </table>
 656     </td>
 657   </tr>
 658 </table>
 659 <table cellspacing="5" cellpadding="0" border="0">
 660   <tr>
 661     <td>
 662       &nbsp;
 663     </td>
 664     <td>
 665
 666 <p>
 667 Called whenever a gline is added by a local user.
 668 <p>
 669 This method is triggered after the line is added. <dl compact><dt><b>Parameters:</b></dt><dd>
 670   <table border="0" cellspacing="2" cellpadding="0">
 671     <tr><td valign="top"></td><td valign="top"><em>duration</em>&nbsp;</td><td>The duration of the line in seconds </td></tr>
 672     <tr><td valign="top"></td><td valign="top"><em>source</em>&nbsp;</td><td>The sender of the line </td></tr>
 673     <tr><td valign="top"></td><td valign="top"><em>reason</em>&nbsp;</td><td>The reason text to be displayed </td></tr>
 674     <tr><td valign="top"></td><td valign="top"><em>hostmask</em>&nbsp;</td><td>The hostmask to add</td></tr>
 675   </table>
 676 </dl>
 677
 678 <p>
 679 Definition at line <a class="el" href="modules_8cpp-source.html#l00288">288</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00288"></a>00288 { };
 680 </pre></div>
 681 <p>
 682     </td>
 683   </tr>
 684 </table>
 685 <a class="anchor" name="OnAddKLine_28long_20duration_2C_20userrec_20_2Asource_2C_20std_3A_3Astring_20reason_2C_20std_3A_3Astring_20hostmask_29"></a><!-- doxytag: member="Module::OnAddKLine" ref="OnAddKLine_28long_20duration_2C_20userrec_20_2Asource_2C_20std_3A_3Astring_20reason_2C_20std_3A_3Astring_20hostmask_29" args="(long duration, userrec *source, std::string reason, std::string hostmask)" --><p>
 686 <table class="mdTable" cellpadding="2" cellspacing="0">
 687   <tr>
 688     <td class="mdRow">
 689       <table cellpadding="0" cellspacing="0" border="0">
 690         <tr>
 691           <td class="md" nowrap valign="top">void Module::OnAddKLine           </td>
 692           <td class="md" valign="top">(&nbsp;</td>
 693           <td class="md" nowrap valign="top">long&nbsp;</td>
 694           <td class="mdname" nowrap> <em>duration</em>, </td>
 695         </tr>
 696         <tr>
 697           <td class="md" nowrap align="right"></td>
 698           <td class="md"></td>
 699           <td class="md" nowrap><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 700           <td class="mdname" nowrap> <em>source</em>, </td>
 701         </tr>
 702         <tr>
 703           <td class="md" nowrap align="right"></td>
 704           <td class="md"></td>
 705           <td class="md" nowrap><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
 706           <td class="mdname" nowrap> <em>reason</em>, </td>
 707         </tr>
 708         <tr>
 709           <td class="md" nowrap align="right"></td>
 710           <td class="md"></td>
 711           <td class="md" nowrap><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
 712           <td class="mdname" nowrap> <em>hostmask</em></td>
 713         </tr>
 714         <tr>
 715           <td class="md"></td>
 716           <td class="md">)&nbsp;</td>
 717           <td class="md" colspan="2"><code> [virtual]</code></td>
 718         </tr>
 719       </table>
 720     </td>
 721   </tr>
 722 </table>
 723 <table cellspacing="5" cellpadding="0" border="0">
 724   <tr>
 725     <td>
 726       &nbsp;
 727     </td>
 728     <td>
 729
 730 <p>
 731 Called whenever a kline is added by a local user.
 732 <p>
 733 This method is triggered after the line is added. <dl compact><dt><b>Parameters:</b></dt><dd>
 734   <table border="0" cellspacing="2" cellpadding="0">
 735     <tr><td valign="top"></td><td valign="top"><em>duration</em>&nbsp;</td><td>The duration of the line in seconds </td></tr>
 736     <tr><td valign="top"></td><td valign="top"><em>source</em>&nbsp;</td><td>The sender of the line </td></tr>
 737     <tr><td valign="top"></td><td valign="top"><em>reason</em>&nbsp;</td><td>The reason text to be displayed </td></tr>
 738     <tr><td valign="top"></td><td valign="top"><em>hostmask</em>&nbsp;</td><td>The hostmask to add</td></tr>
 739   </table>
 740 </dl>
 741
 742 <p>
 743 Definition at line <a class="el" href="modules_8cpp-source.html#l00290">290</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00290"></a>00290 { };
 744 </pre></div>
 745 <p>
 746     </td>
 747   </tr>
 748 </table>
 749 <a class="anchor" name="OnAddQLine_28long_20duration_2C_20userrec_20_2Asource_2C_20std_3A_3Astring_20reason_2C_20std_3A_3Astring_20nickmask_29"></a><!-- doxytag: member="Module::OnAddQLine" ref="OnAddQLine_28long_20duration_2C_20userrec_20_2Asource_2C_20std_3A_3Astring_20reason_2C_20std_3A_3Astring_20nickmask_29" args="(long duration, userrec *source, std::string reason, std::string nickmask)" --><p>
 750 <table class="mdTable" cellpadding="2" cellspacing="0">
 751   <tr>
 752     <td class="mdRow">
 753       <table cellpadding="0" cellspacing="0" border="0">
 754         <tr>
 755           <td class="md" nowrap valign="top">void Module::OnAddQLine           </td>
 756           <td class="md" valign="top">(&nbsp;</td>
 757           <td class="md" nowrap valign="top">long&nbsp;</td>
 758           <td class="mdname" nowrap> <em>duration</em>, </td>
 759         </tr>
 760         <tr>
 761           <td class="md" nowrap align="right"></td>
 762           <td class="md"></td>
 763           <td class="md" nowrap><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 764           <td class="mdname" nowrap> <em>source</em>, </td>
 765         </tr>
 766         <tr>
 767           <td class="md" nowrap align="right"></td>
 768           <td class="md"></td>
 769           <td class="md" nowrap><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
 770           <td class="mdname" nowrap> <em>reason</em>, </td>
 771         </tr>
 772         <tr>
 773           <td class="md" nowrap align="right"></td>
 774           <td class="md"></td>
 775           <td class="md" nowrap><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
 776           <td class="mdname" nowrap> <em>nickmask</em></td>
 777         </tr>
 778         <tr>
 779           <td class="md"></td>
 780           <td class="md">)&nbsp;</td>
 781           <td class="md" colspan="2"><code> [virtual]</code></td>
 782         </tr>
 783       </table>
 784     </td>
 785   </tr>
 786 </table>
 787 <table cellspacing="5" cellpadding="0" border="0">
 788   <tr>
 789     <td>
 790       &nbsp;
 791     </td>
 792     <td>
 793
 794 <p>
 795 Called whenever a qline is added by a local user.
 796 <p>
 797 This method is triggered after the line is added. <dl compact><dt><b>Parameters:</b></dt><dd>
 798   <table border="0" cellspacing="2" cellpadding="0">
 799     <tr><td valign="top"></td><td valign="top"><em>duration</em>&nbsp;</td><td>The duration of the line in seconds </td></tr>
 800     <tr><td valign="top"></td><td valign="top"><em>source</em>&nbsp;</td><td>The sender of the line </td></tr>
 801     <tr><td valign="top"></td><td valign="top"><em>reason</em>&nbsp;</td><td>The reason text to be displayed </td></tr>
 802     <tr><td valign="top"></td><td valign="top"><em>nickmask</em>&nbsp;</td><td>The hostmask to add</td></tr>
 803   </table>
 804 </dl>
 805
 806 <p>
 807 Definition at line <a class="el" href="modules_8cpp-source.html#l00291">291</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00291"></a>00291 { };
 808 </pre></div>
 809 <p>
 810     </td>
 811   </tr>
 812 </table>
 813 <a class="anchor" name="OnAddZLine_28long_20duration_2C_20userrec_20_2Asource_2C_20std_3A_3Astring_20reason_2C_20std_3A_3Astring_20ipmask_29"></a><!-- doxytag: member="Module::OnAddZLine" ref="OnAddZLine_28long_20duration_2C_20userrec_20_2Asource_2C_20std_3A_3Astring_20reason_2C_20std_3A_3Astring_20ipmask_29" args="(long duration, userrec *source, std::string reason, std::string ipmask)" --><p>
 814 <table class="mdTable" cellpadding="2" cellspacing="0">
 815   <tr>
 816     <td class="mdRow">
 817       <table cellpadding="0" cellspacing="0" border="0">
 818         <tr>
 819           <td class="md" nowrap valign="top">void Module::OnAddZLine           </td>
 820           <td class="md" valign="top">(&nbsp;</td>
 821           <td class="md" nowrap valign="top">long&nbsp;</td>
 822           <td class="mdname" nowrap> <em>duration</em>, </td>
 823         </tr>
 824         <tr>
 825           <td class="md" nowrap align="right"></td>
 826           <td class="md"></td>
 827           <td class="md" nowrap><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 828           <td class="mdname" nowrap> <em>source</em>, </td>
 829         </tr>
 830         <tr>
 831           <td class="md" nowrap align="right"></td>
 832           <td class="md"></td>
 833           <td class="md" nowrap><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
 834           <td class="mdname" nowrap> <em>reason</em>, </td>
 835         </tr>
 836         <tr>
 837           <td class="md" nowrap align="right"></td>
 838           <td class="md"></td>
 839           <td class="md" nowrap><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
 840           <td class="mdname" nowrap> <em>ipmask</em></td>
 841         </tr>
 842         <tr>
 843           <td class="md"></td>
 844           <td class="md">)&nbsp;</td>
 845           <td class="md" colspan="2"><code> [virtual]</code></td>
 846         </tr>
 847       </table>
 848     </td>
 849   </tr>
 850 </table>
 851 <table cellspacing="5" cellpadding="0" border="0">
 852   <tr>
 853     <td>
 854       &nbsp;
 855     </td>
 856     <td>
 857
 858 <p>
 859 Called whenever a zline is added by a local user.
 860 <p>
 861 This method is triggered after the line is added. <dl compact><dt><b>Parameters:</b></dt><dd>
 862   <table border="0" cellspacing="2" cellpadding="0">
 863     <tr><td valign="top"></td><td valign="top"><em>duration</em>&nbsp;</td><td>The duration of the line in seconds </td></tr>
 864     <tr><td valign="top"></td><td valign="top"><em>source</em>&nbsp;</td><td>The sender of the line </td></tr>
 865     <tr><td valign="top"></td><td valign="top"><em>reason</em>&nbsp;</td><td>The reason text to be displayed </td></tr>
 866     <tr><td valign="top"></td><td valign="top"><em>ipmask</em>&nbsp;</td><td>The hostmask to add</td></tr>
 867   </table>
 868 </dl>
 869
 870 <p>
 871 Definition at line <a class="el" href="modules_8cpp-source.html#l00289">289</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00289"></a>00289 { };
 872 </pre></div>
 873 <p>
 874     </td>
 875   </tr>
 876 </table>
 877 <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>
 878 <table class="mdTable" cellpadding="2" cellspacing="0">
 879   <tr>
 880     <td class="mdRow">
 881       <table cellpadding="0" cellspacing="0" border="0">
 882         <tr>
 883           <td class="md" nowrap valign="top">void Module::OnBackgroundTimer           </td>
 884           <td class="md" valign="top">(&nbsp;</td>
 885           <td class="md" nowrap valign="top">time_t&nbsp;</td>
 886           <td class="mdname1" valign="top" nowrap> <em>curtime</em>          </td>
 887           <td class="md" valign="top">&nbsp;)&nbsp;</td>
 888           <td class="md" nowrap><code> [virtual]</code></td>
 889         </tr>
 890       </table>
 891     </td>
 892   </tr>
 893 </table>
 894 <table cellspacing="5" cellpadding="0" border="0">
 895   <tr>
 896     <td>
 897       &nbsp;
 898     </td>
 899     <td>
 900
 901 <p>
 902 Called once every five seconds for background processing.
 903 <p>
 904 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. <dl compact><dt><b>Parameters:</b></dt><dd>
 905   <table border="0" cellspacing="2" cellpadding="0">
 906     <tr><td valign="top"></td><td valign="top"><em>curtime</em>&nbsp;</td><td>The current timer derived from time(2)</td></tr>
 907   </table>
 908 </dl>
 909
 910 <p>
 911 Definition at line <a class="el" href="modules_8cpp-source.html#l00245">245</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00245"></a>00245 { };
 912 </pre></div>
 913 <p>
 914     </td>
 915   </tr>
 916 </table>
 917 <a class="anchor" name="OnChangeHost_28userrec_20_2Auser_2C_20std_3A_3Astring_20newhost_29"></a><!-- doxytag: member="Module::OnChangeHost" ref="OnChangeHost_28userrec_20_2Auser_2C_20std_3A_3Astring_20newhost_29" args="(userrec *user, std::string newhost)" --><p>
 918 <table class="mdTable" cellpadding="2" cellspacing="0">
 919   <tr>
 920     <td class="mdRow">
 921       <table cellpadding="0" cellspacing="0" border="0">
 922         <tr>
 923           <td class="md" nowrap valign="top">void Module::OnChangeHost           </td>
 924           <td class="md" valign="top">(&nbsp;</td>
 925           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 926           <td class="mdname" nowrap> <em>user</em>, </td>
 927         </tr>
 928         <tr>
 929           <td class="md" nowrap align="right"></td>
 930           <td class="md"></td>
 931           <td class="md" nowrap><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
 932           <td class="mdname" nowrap> <em>newhost</em></td>
 933         </tr>
 934         <tr>
 935           <td class="md"></td>
 936           <td class="md">)&nbsp;</td>
 937           <td class="md" colspan="2"><code> [virtual]</code></td>
 938         </tr>
 939       </table>
 940     </td>
 941   </tr>
 942 </table>
 943 <table cellspacing="5" cellpadding="0" border="0">
 944   <tr>
 945     <td>
 946       &nbsp;
 947     </td>
 948     <td>
 949
 950 <p>
 951 Called whenever a user's hostname is changed.
 952 <p>
 953 This event triggers after the host has been set. <dl compact><dt><b>Parameters:</b></dt><dd>
 954   <table border="0" cellspacing="2" cellpadding="0">
 955     <tr><td valign="top"></td><td valign="top"><em>user</em>&nbsp;</td><td>The user whos host is being changed </td></tr>
 956     <tr><td valign="top"></td><td valign="top"><em>newhost</em>&nbsp;</td><td>The new hostname being set</td></tr>
 957   </table>
 958 </dl>
 959
 960 <p>
 961 Definition at line <a class="el" href="modules_8cpp-source.html#l00286">286</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00286"></a>00286 { };
 962 </pre></div>
 963 <p>
 964     </td>
 965   </tr>
 966 </table>
 967 <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>
 968 <table class="mdTable" cellpadding="2" cellspacing="0">
 969   <tr>
 970     <td class="mdRow">
 971       <table cellpadding="0" cellspacing="0" border="0">
 972         <tr>
 973           <td class="md" nowrap valign="top">int Module::OnChangeLocalUserGECOS           </td>
 974           <td class="md" valign="top">(&nbsp;</td>
 975           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
 976           <td class="mdname" nowrap> <em>user</em>, </td>
 977         </tr>
 978         <tr>
 979           <td class="md" nowrap align="right"></td>
 980           <td class="md"></td>
 981           <td class="md" nowrap><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
 982           <td class="mdname" nowrap> <em>newhost</em></td>
 983         </tr>
 984         <tr>
 985           <td class="md"></td>
 986           <td class="md">)&nbsp;</td>
 987           <td class="md" colspan="2"><code> [virtual]</code></td>
 988         </tr>
 989       </table>
 990     </td>
 991   </tr>
 992 </table>
 993 <table cellspacing="5" cellpadding="0" border="0">
 994   <tr>
 995     <td>
 996       &nbsp;
 997     </td>
 998     <td>
 999
1000 <p>
1001 Called whenever a change of a local users GECOS (fullname field) is attempted.
1002 <p>
1003 return 1 to deny the name change, or 0 to allow it. <dl compact><dt><b>Parameters:</b></dt><dd>
1004   <table border="0" cellspacing="2" cellpadding="0">
1005     <tr><td valign="top"></td><td valign="top"><em>user</em>&nbsp;</td><td>The user whos GECOS will be changed </td></tr>
1006     <tr><td valign="top"></td><td valign="top"><em>newhost</em>&nbsp;</td><td>The new GECOS </td></tr>
1007   </table>
1008 </dl>
1009 <dl compact><dt><b>Returns:</b></dt><dd>1 to deny the GECOS change, 0 to allow</dd></dl>
1010
1011 <p>
1012 Definition at line <a class="el" href="modules_8cpp-source.html#l00259">259</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00259"></a>00259 { <span class="keywordflow">return</span> 0; };
1013 </pre></div>
1014 <p>
1015     </td>
1016   </tr>
1017 </table>
1018 <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>
1019 <table class="mdTable" cellpadding="2" cellspacing="0">
1020   <tr>
1021     <td class="mdRow">
1022       <table cellpadding="0" cellspacing="0" border="0">
1023         <tr>
1024           <td class="md" nowrap valign="top">int Module::OnChangeLocalUserHost           </td>
1025           <td class="md" valign="top">(&nbsp;</td>
1026           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
1027           <td class="mdname" nowrap> <em>user</em>, </td>
1028         </tr>
1029         <tr>
1030           <td class="md" nowrap align="right"></td>
1031           <td class="md"></td>
1032           <td class="md" nowrap><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
1033           <td class="mdname" nowrap> <em>newhost</em></td>
1034         </tr>
1035         <tr>
1036           <td class="md"></td>
1037           <td class="md">)&nbsp;</td>
1038           <td class="md" colspan="2"><code> [virtual]</code></td>
1039         </tr>
1040       </table>
1041     </td>
1042   </tr>
1043 </table>
1044 <table cellspacing="5" cellpadding="0" border="0">
1045   <tr>
1046     <td>
1047       &nbsp;
1048     </td>
1049     <td>
1050
1051 <p>
1052 Called whenever a change of a local users displayed host is attempted.
1053 <p>
1054 Return 1 to deny the host change, or 0 to allow it. <dl compact><dt><b>Parameters:</b></dt><dd>
1055   <table border="0" cellspacing="2" cellpadding="0">
1056     <tr><td valign="top"></td><td valign="top"><em>user</em>&nbsp;</td><td>The user whos host will be changed </td></tr>
1057     <tr><td valign="top"></td><td valign="top"><em>newhost</em>&nbsp;</td><td>The new hostname </td></tr>
1058   </table>
1059 </dl>
1060 <dl compact><dt><b>Returns:</b></dt><dd>1 to deny the host change, 0 to allow</dd></dl>
1061
1062 <p>
1063 Definition at line <a class="el" href="modules_8cpp-source.html#l00258">258</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00258"></a>00258 { <span class="keywordflow">return</span> 0; };
1064 </pre></div>
1065 <p>
1066     </td>
1067   </tr>
1068 </table>
1069 <a class="anchor" name="OnChangeName_28userrec_20_2Auser_2C_20std_3A_3Astring_20gecos_29"></a><!-- doxytag: member="Module::OnChangeName" ref="OnChangeName_28userrec_20_2Auser_2C_20std_3A_3Astring_20gecos_29" args="(userrec *user, std::string gecos)" --><p>
1070 <table class="mdTable" cellpadding="2" cellspacing="0">
1071   <tr>
1072     <td class="mdRow">
1073       <table cellpadding="0" cellspacing="0" border="0">
1074         <tr>
1075           <td class="md" nowrap valign="top">void Module::OnChangeName           </td>
1076           <td class="md" valign="top">(&nbsp;</td>
1077           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
1078           <td class="mdname" nowrap> <em>user</em>, </td>
1079         </tr>
1080         <tr>
1081           <td class="md" nowrap align="right"></td>
1082           <td class="md"></td>
1083           <td class="md" nowrap><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
1084           <td class="mdname" nowrap> <em>gecos</em></td>
1085         </tr>
1086         <tr>
1087           <td class="md"></td>
1088           <td class="md">)&nbsp;</td>
1089           <td class="md" colspan="2"><code> [virtual]</code></td>
1090         </tr>
1091       </table>
1092     </td>
1093   </tr>
1094 </table>
1095 <table cellspacing="5" cellpadding="0" border="0">
1096   <tr>
1097     <td>
1098       &nbsp;
1099     </td>
1100     <td>
1101
1102 <p>
1103 Called whenever a user's GECOS (realname) is changed.
1104 <p>
1105 This event triggers after the name has been set. <dl compact><dt><b>Parameters:</b></dt><dd>
1106   <table border="0" cellspacing="2" cellpadding="0">
1107     <tr><td valign="top"></td><td valign="top"><em>user</em>&nbsp;</td><td>The user who's GECOS is being changed </td></tr>
1108     <tr><td valign="top"></td><td valign="top"><em>gecos</em>&nbsp;</td><td>The new GECOS being set on the user</td></tr>
1109   </table>
1110 </dl>
1111
1112 <p>
1113 Definition at line <a class="el" href="modules_8cpp-source.html#l00287">287</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00287"></a>00287 { };
1114 </pre></div>
1115 <p>
1116     </td>
1117   </tr>
1118 </table>
1119 <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>
1120 <table class="mdTable" cellpadding="2" cellspacing="0">
1121   <tr>
1122     <td class="mdRow">
1123       <table cellpadding="0" cellspacing="0" border="0">
1124         <tr>
1125           <td class="md" nowrap valign="top">int Module::OnCheckBan           </td>
1126           <td class="md" valign="top">(&nbsp;</td>
1127           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
1128           <td class="mdname" nowrap> <em>user</em>, </td>
1129         </tr>
1130         <tr>
1131           <td class="md" nowrap align="right"></td>
1132           <td class="md"></td>
1133           <td class="md" nowrap><a class="el" href="classchanrec.html">chanrec</a> *&nbsp;</td>
1134           <td class="mdname" nowrap> <em>chan</em></td>
1135         </tr>
1136         <tr>
1137           <td class="md"></td>
1138           <td class="md">)&nbsp;</td>
1139           <td class="md" colspan="2"><code> [virtual]</code></td>
1140         </tr>
1141       </table>
1142     </td>
1143   </tr>
1144 </table>
1145 <table cellspacing="5" cellpadding="0" border="0">
1146   <tr>
1147     <td>
1148       &nbsp;
1149     </td>
1150     <td>
1151
1152 <p>
1153 Called whenever a user joins a channel, to determine if banlist checks should go ahead or not.
1154 <p>
1155 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. <dl compact><dt><b>Parameters:</b></dt><dd>
1156   <table border="0" cellspacing="2" cellpadding="0">
1157     <tr><td valign="top"></td><td valign="top"><em>user</em>&nbsp;</td><td>The user joining the channel </td></tr>
1158     <tr><td valign="top"></td><td valign="top"><em>chan</em>&nbsp;</td><td>The channel being joined </td></tr>
1159   </table>
1160 </dl>
1161 <dl compact><dt><b>Returns:</b></dt><dd>1 to explicitly allow the join, 0 to proceed as normal</dd></dl>
1162
1163 <p>
1164 Definition at line <a class="el" href="modules_8cpp-source.html#l00256">256</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00256"></a>00256 { <span class="keywordflow">return</span> 0; };
1165 </pre></div>
1166 <p>
1167     </td>
1168   </tr>
1169 </table>
1170 <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>
1171 <table class="mdTable" cellpadding="2" cellspacing="0">
1172   <tr>
1173     <td class="mdRow">
1174       <table cellpadding="0" cellspacing="0" border="0">
1175         <tr>
1176           <td class="md" nowrap valign="top">int Module::OnCheckInvite           </td>
1177           <td class="md" valign="top">(&nbsp;</td>
1178           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
1179           <td class="mdname" nowrap> <em>user</em>, </td>
1180         </tr>
1181         <tr>
1182           <td class="md" nowrap align="right"></td>
1183           <td class="md"></td>
1184           <td class="md" nowrap><a class="el" href="classchanrec.html">chanrec</a> *&nbsp;</td>
1185           <td class="mdname" nowrap> <em>chan</em></td>
1186         </tr>
1187         <tr>
1188           <td class="md"></td>
1189           <td class="md">)&nbsp;</td>
1190           <td class="md" colspan="2"><code> [virtual]</code></td>
1191         </tr>
1192       </table>
1193     </td>
1194   </tr>
1195 </table>
1196 <table cellspacing="5" cellpadding="0" border="0">
1197   <tr>
1198     <td>
1199       &nbsp;
1200     </td>
1201     <td>
1202
1203 <p>
1204 Called whenever a user joins a channel, to determine if invite checks should go ahead or not.
1205 <p>
1206 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. <dl compact><dt><b>Parameters:</b></dt><dd>
1207   <table border="0" cellspacing="2" cellpadding="0">
1208     <tr><td valign="top"></td><td valign="top"><em>user</em>&nbsp;</td><td>The user joining the channel </td></tr>
1209     <tr><td valign="top"></td><td valign="top"><em>chan</em>&nbsp;</td><td>The channel being joined </td></tr>
1210   </table>
1211 </dl>
1212 <dl compact><dt><b>Returns:</b></dt><dd>1 to explicitly allow the join, 0 to proceed as normal</dd></dl>
1213
1214 <p>
1215 Definition at line <a class="el" href="modules_8cpp-source.html#l00253">253</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00253"></a>00253 { <span class="keywordflow">return</span> 0; };
1216 </pre></div>
1217 <p>
1218     </td>
1219   </tr>
1220 </table>
1221 <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>
1222 <table class="mdTable" cellpadding="2" cellspacing="0">
1223   <tr>
1224     <td class="mdRow">
1225       <table cellpadding="0" cellspacing="0" border="0">
1226         <tr>
1227           <td class="md" nowrap valign="top">int Module::OnCheckKey           </td>
1228           <td class="md" valign="top">(&nbsp;</td>
1229           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
1230           <td class="mdname" nowrap> <em>user</em>, </td>
1231         </tr>
1232         <tr>
1233           <td class="md" nowrap align="right"></td>
1234           <td class="md"></td>
1235           <td class="md" nowrap><a class="el" href="classchanrec.html">chanrec</a> *&nbsp;</td>
1236           <td class="mdname" nowrap> <em>chan</em>, </td>
1237         </tr>
1238         <tr>
1239           <td class="md" nowrap align="right"></td>
1240           <td class="md"></td>
1241           <td class="md" nowrap><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
1242           <td class="mdname" nowrap> <em>keygiven</em></td>
1243         </tr>
1244         <tr>
1245           <td class="md"></td>
1246           <td class="md">)&nbsp;</td>
1247           <td class="md" colspan="2"><code> [virtual]</code></td>
1248         </tr>
1249       </table>
1250     </td>
1251   </tr>
1252 </table>
1253 <table cellspacing="5" cellpadding="0" border="0">
1254   <tr>
1255     <td>
1256       &nbsp;
1257     </td>
1258     <td>
1259
1260 <p>
1261 Called whenever a user joins a channel, to determine if key checks should go ahead or not.
1262 <p>
1263 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. <dl compact><dt><b>Parameters:</b></dt><dd>
1264   <table border="0" cellspacing="2" cellpadding="0">
1265     <tr><td valign="top"></td><td valign="top"><em>user</em>&nbsp;</td><td>The user joining the channel </td></tr>
1266     <tr><td valign="top"></td><td valign="top"><em>chan</em>&nbsp;</td><td>The channel being joined </td></tr>
1267   </table>
1268 </dl>
1269 <dl compact><dt><b>Returns:</b></dt><dd>1 to explicitly allow the join, 0 to proceed as normal</dd></dl>
1270
1271 <p>
1272 Definition at line <a class="el" href="modules_8cpp-source.html#l00254">254</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00254"></a>00254 { <span class="keywordflow">return</span> 0; };
1273 </pre></div>
1274 <p>
1275     </td>
1276   </tr>
1277 </table>
1278 <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>
1279 <table class="mdTable" cellpadding="2" cellspacing="0">
1280   <tr>
1281     <td class="mdRow">
1282       <table cellpadding="0" cellspacing="0" border="0">
1283         <tr>
1284           <td class="md" nowrap valign="top">int Module::OnCheckLimit           </td>
1285           <td class="md" valign="top">(&nbsp;</td>
1286           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
1287           <td class="mdname" nowrap> <em>user</em>, </td>
1288         </tr>
1289         <tr>
1290           <td class="md" nowrap align="right"></td>
1291           <td class="md"></td>
1292           <td class="md" nowrap><a class="el" href="classchanrec.html">chanrec</a> *&nbsp;</td>
1293           <td class="mdname" nowrap> <em>chan</em></td>
1294         </tr>
1295         <tr>
1296           <td class="md"></td>
1297           <td class="md">)&nbsp;</td>
1298           <td class="md" colspan="2"><code> [virtual]</code></td>
1299         </tr>
1300       </table>
1301     </td>
1302   </tr>
1303 </table>
1304 <table cellspacing="5" cellpadding="0" border="0">
1305   <tr>
1306     <td>
1307       &nbsp;
1308     </td>
1309     <td>
1310
1311 <p>
1312 Called whenever a user joins a channel, to determine if channel limit checks should go ahead or not.
1313 <p>
1314 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. <dl compact><dt><b>Parameters:</b></dt><dd>
1315   <table border="0" cellspacing="2" cellpadding="0">
1316     <tr><td valign="top"></td><td valign="top"><em>user</em>&nbsp;</td><td>The user joining the channel </td></tr>
1317     <tr><td valign="top"></td><td valign="top"><em>chan</em>&nbsp;</td><td>The channel being joined </td></tr>
1318   </table>
1319 </dl>
1320 <dl compact><dt><b>Returns:</b></dt><dd>1 to explicitly allow the join, 0 to proceed as normal</dd></dl>
1321
1322 <p>
1323 Definition at line <a class="el" href="modules_8cpp-source.html#l00255">255</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00255"></a>00255 { <span class="keywordflow">return</span> 0; };
1324 </pre></div>
1325 <p>
1326     </td>
1327   </tr>
1328 </table>
1329 <a class="anchor" name="OnCheckReady_28userrec_20_2Auser_29"></a><!-- doxytag: member="Module::OnCheckReady" ref="OnCheckReady_28userrec_20_2Auser_29" args="(userrec *user)" --><p>
1330 <table class="mdTable" cellpadding="2" cellspacing="0">
1331   <tr>
1332     <td class="mdRow">
1333       <table cellpadding="0" cellspacing="0" border="0">
1334         <tr>
1335           <td class="md" nowrap valign="top">bool Module::OnCheckReady           </td>
1336           <td class="md" valign="top">(&nbsp;</td>
1337           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
1338           <td class="mdname1" valign="top" nowrap> <em>user</em>          </td>
1339           <td class="md" valign="top">&nbsp;)&nbsp;</td>
1340           <td class="md" nowrap><code> [virtual]</code></td>
1341         </tr>
1342       </table>
1343     </td>
1344   </tr>
1345 </table>
1346 <table cellspacing="5" cellpadding="0" border="0">
1347   <tr>
1348     <td>
1349       &nbsp;
1350     </td>
1351     <td>
1352
1353 <p>
1354 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.
1355 <p>
1356 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. <dl compact><dt><b>Parameters:</b></dt><dd>
1357   <table border="0" cellspacing="2" cellpadding="0">
1358     <tr><td valign="top"></td><td valign="top"><em>user</em>&nbsp;</td><td>The user to check </td></tr>
1359   </table>
1360 </dl>
1361 <dl compact><dt><b>Returns:</b></dt><dd>true to indicate readiness, false if otherwise</dd></dl>
1362
1363 <p>
1364 Definition at line <a class="el" href="modules_8cpp-source.html#l00248">248</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00248"></a>00248 { <span class="keywordflow">return</span> <span class="keyword">true</span>; };
1365 </pre></div>
1366 <p>
1367     </td>
1368   </tr>
1369 </table>
1370 <a class="anchor" name="OnCleanup_28int_20target_5Ftype_2C_20void_20_2Aitem_29"></a><!-- doxytag: member="Module::OnCleanup" ref="OnCleanup_28int_20target_5Ftype_2C_20void_20_2Aitem_29" args="(int target_type, void *item)" --><p>
1371 <table class="mdTable" cellpadding="2" cellspacing="0">
1372   <tr>
1373     <td class="mdRow">
1374       <table cellpadding="0" cellspacing="0" border="0">
1375         <tr>
1376           <td class="md" nowrap valign="top">void Module::OnCleanup           </td>
1377           <td class="md" valign="top">(&nbsp;</td>
1378           <td class="md" nowrap valign="top">int&nbsp;</td>
1379           <td class="mdname" nowrap> <em>target_type</em>, </td>
1380         </tr>
1381         <tr>
1382           <td class="md" nowrap align="right"></td>
1383           <td class="md"></td>
1384           <td class="md" nowrap>void *&nbsp;</td>
1385           <td class="mdname" nowrap> <em>item</em></td>
1386         </tr>
1387         <tr>
1388           <td class="md"></td>
1389           <td class="md">)&nbsp;</td>
1390           <td class="md" colspan="2"><code> [virtual]</code></td>
1391         </tr>
1392       </table>
1393     </td>
1394   </tr>
1395 </table>
1396 <table cellspacing="5" cellpadding="0" border="0">
1397   <tr>
1398     <td>
1399       &nbsp;
1400     </td>
1401     <td>
1402
1403 <p>
1404 Called before your module is unloaded to clean up Extensibles.
1405 <p>
1406 This method is called once for every user and channel on the network, so that when your module unloads it may clear up any remaining data in the form of Extensibles added using <a class="el" href="classExtensible.html#Extend_28std_3A_3Astring_20key_2C_20char_20_2Ap_29">Extensible::Extend()</a>. If the target_type variable is TYPE_USER, then void* item refers to a userrec*, otherwise it refers to a chanrec*. <dl compact><dt><b>Parameters:</b></dt><dd>
1407   <table border="0" cellspacing="2" cellpadding="0">
1408     <tr><td valign="top"></td><td valign="top"><em>target_type</em>&nbsp;</td><td>The type of item being cleaned </td></tr>
1409     <tr><td valign="top"></td><td valign="top"><em>item</em>&nbsp;</td><td>A pointer to the item's class</td></tr>
1410   </table>
1411 </dl>
1412
1413 <p>
1414 Definition at line <a class="el" href="modules_8cpp-source.html#l00298">298</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00298"></a>00298 { };
1415 </pre></div>
1416 <p>
1417     </td>
1418   </tr>
1419 </table>
1420 <a class="anchor" name="OnDecodeMetaData_28int_20target_5Ftype_2C_20void_20_2Atarget_2C_20std_3A_3Astring_20extname_2C_20std_3A_3Astring_20extdata_29"></a><!-- doxytag: member="Module::OnDecodeMetaData" ref="OnDecodeMetaData_28int_20target_5Ftype_2C_20void_20_2Atarget_2C_20std_3A_3Astring_20extname_2C_20std_3A_3Astring_20extdata_29" args="(int target_type, void *target, std::string extname, std::string extdata)" --><p>
1421 <table class="mdTable" cellpadding="2" cellspacing="0">
1422   <tr>
1423     <td class="mdRow">
1424       <table cellpadding="0" cellspacing="0" border="0">
1425         <tr>
1426           <td class="md" nowrap valign="top">void Module::OnDecodeMetaData           </td>
1427           <td class="md" valign="top">(&nbsp;</td>
1428           <td class="md" nowrap valign="top">int&nbsp;</td>
1429           <td class="mdname" nowrap> <em>target_type</em>, </td>
1430         </tr>
1431         <tr>
1432           <td class="md" nowrap align="right"></td>
1433           <td class="md"></td>
1434           <td class="md" nowrap>void *&nbsp;</td>
1435           <td class="mdname" nowrap> <em>target</em>, </td>
1436         </tr>
1437         <tr>
1438           <td class="md" nowrap align="right"></td>
1439           <td class="md"></td>
1440           <td class="md" nowrap><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
1441           <td class="mdname" nowrap> <em>extname</em>, </td>
1442         </tr>
1443         <tr>
1444           <td class="md" nowrap align="right"></td>
1445           <td class="md"></td>
1446           <td class="md" nowrap><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
1447           <td class="mdname" nowrap> <em>extdata</em></td>
1448         </tr>
1449         <tr>
1450           <td class="md"></td>
1451           <td class="md">)&nbsp;</td>
1452           <td class="md" colspan="2"><code> [virtual]</code></td>
1453         </tr>
1454       </table>
1455     </td>
1456   </tr>
1457 </table>
1458 <table cellspacing="5" cellpadding="0" border="0">
1459   <tr>
1460     <td>
1461       &nbsp;
1462     </td>
1463     <td>
1464
1465 <p>
1466 Allows module data, sent via ProtoSendMetaData, to be decoded again by a receiving module.
1467 <p>
1468 Please see src/modules/m_swhois.cpp for a working example of how to use this method call. <dl compact><dt><b>Parameters:</b></dt><dd>
1469   <table border="0" cellspacing="2" cellpadding="0">
1470     <tr><td valign="top"></td><td valign="top"><em>target_type</em>&nbsp;</td><td>The type of item to decode data for, TYPE_USER or TYPE_CHANNEL </td></tr>
1471     <tr><td valign="top"></td><td valign="top"><em>target</em>&nbsp;</td><td>The chanrec* or userrec* that data should be added to </td></tr>
1472     <tr><td valign="top"></td><td valign="top"><em>extname</em>&nbsp;</td><td>The extension name which is being sent </td></tr>
1473     <tr><td valign="top"></td><td valign="top"><em>extdata</em>&nbsp;</td><td>The extension data, encoded at the other end by an identical module through OnSyncChannelMetaData or OnSyncUserMetaData</td></tr>
1474   </table>
1475 </dl>
1476
1477 <p>
1478 Definition at line <a class="el" href="modules_8cpp-source.html#l00283">283</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00283"></a>00283 { };
1479 </pre></div>
1480 <p>
1481     </td>
1482   </tr>
1483 </table>
1484 <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>
1485 <table class="mdTable" cellpadding="2" cellspacing="0">
1486   <tr>
1487     <td class="mdRow">
1488       <table cellpadding="0" cellspacing="0" border="0">
1489         <tr>
1490           <td class="md" nowrap valign="top">int Module::OnDelBan           </td>
1491           <td class="md" valign="top">(&nbsp;</td>
1492           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
1493           <td class="mdname" nowrap> <em>source</em>, </td>
1494         </tr>
1495         <tr>
1496           <td class="md" nowrap align="right"></td>
1497           <td class="md"></td>
1498           <td class="md" nowrap><a class="el" href="classchanrec.html">chanrec</a> *&nbsp;</td>
1499           <td class="mdname" nowrap> <em>channel</em>, </td>
1500         </tr>
1501         <tr>
1502           <td class="md" nowrap align="right"></td>
1503           <td class="md"></td>
1504           <td class="md" nowrap><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
1505           <td class="mdname" nowrap> <em>banmask</em></td>
1506         </tr>
1507         <tr>
1508           <td class="md"></td>
1509           <td class="md">)&nbsp;</td>
1510           <td class="md" colspan="2"><code> [virtual]</code></td>
1511         </tr>
1512       </table>
1513     </td>
1514   </tr>
1515 </table>
1516 <table cellspacing="5" cellpadding="0" border="0">
1517   <tr>
1518     <td>
1519       &nbsp;
1520     </td>
1521     <td>
1522
1523 <p>
1524 Called whenever a ban is removed from a channel's list.
1525 <p>
1526 Return a non-zero value to 'eat' the mode change and prevent the ban from being removed. <dl compact><dt><b>Parameters:</b></dt><dd>
1527   <table border="0" cellspacing="2" cellpadding="0">
1528     <tr><td valign="top"></td><td valign="top"><em>source</em>&nbsp;</td><td>The user deleting the ban </td></tr>
1529     <tr><td valign="top"></td><td valign="top"><em>channel</em>&nbsp;</td><td>The channel the ban is being deleted from </td></tr>
1530     <tr><td valign="top"></td><td valign="top"><em>banmask</em>&nbsp;</td><td>The ban mask being deleted </td></tr>
1531   </table>
1532 </dl>
1533 <dl compact><dt><b>Returns:</b></dt><dd>1 to block the unban, 0 to continue as normal</dd></dl>
1534
1535 <p>
1536 Definition at line <a class="el" href="modules_8cpp-source.html#l00267">267</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00267"></a>00267 { <span class="keywordflow">return</span> 0; };
1537 </pre></div>
1538 <p>
1539     </td>
1540   </tr>
1541 </table>
1542 <a class="anchor" name="OnDelELine_28userrec_20_2Asource_2C_20std_3A_3Astring_20hostmask_29"></a><!-- doxytag: member="Module::OnDelELine" ref="OnDelELine_28userrec_20_2Asource_2C_20std_3A_3Astring_20hostmask_29" args="(userrec *source, std::string hostmask)" --><p>
1543 <table class="mdTable" cellpadding="2" cellspacing="0">
1544   <tr>
1545     <td class="mdRow">
1546       <table cellpadding="0" cellspacing="0" border="0">
1547         <tr>
1548           <td class="md" nowrap valign="top">void Module::OnDelELine           </td>
1549           <td class="md" valign="top">(&nbsp;</td>
1550           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
1551           <td class="mdname" nowrap> <em>source</em>, </td>
1552         </tr>
1553         <tr>
1554           <td class="md" nowrap align="right"></td>
1555           <td class="md"></td>
1556           <td class="md" nowrap><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
1557           <td class="mdname" nowrap> <em>hostmask</em></td>
1558         </tr>
1559         <tr>
1560           <td class="md"></td>
1561           <td class="md">)&nbsp;</td>
1562           <td class="md" colspan="2"><code> [virtual]</code></td>
1563         </tr>
1564       </table>
1565     </td>
1566   </tr>
1567 </table>
1568 <table cellspacing="5" cellpadding="0" border="0">
1569   <tr>
1570     <td>
1571       &nbsp;
1572     </td>
1573     <td>
1574
1575 <p>
1576 Called whenever a eline is deleted.
1577 <p>
1578 This method is triggered after the line is deleted. <dl compact><dt><b>Parameters:</b></dt><dd>
1579   <table border="0" cellspacing="2" cellpadding="0">
1580     <tr><td valign="top"></td><td valign="top"><em>source</em>&nbsp;</td><td>The user removing the line </td></tr>
1581     <tr><td valign="top"></td><td valign="top"><em>hostmask</em>&nbsp;</td><td>The hostmask to delete</td></tr>
1582   </table>
1583 </dl>
1584
1585 <p>
1586 Definition at line <a class="el" href="modules_8cpp-source.html#l00297">297</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00297"></a>00297 { };
1587 </pre></div>
1588 <p>
1589     </td>
1590   </tr>
1591 </table>
1592 <a class="anchor" name="OnDelGLine_28userrec_20_2Asource_2C_20std_3A_3Astring_20hostmask_29"></a><!-- doxytag: member="Module::OnDelGLine" ref="OnDelGLine_28userrec_20_2Asource_2C_20std_3A_3Astring_20hostmask_29" args="(userrec *source, std::string hostmask)" --><p>
1593 <table class="mdTable" cellpadding="2" cellspacing="0">
1594   <tr>
1595     <td class="mdRow">
1596       <table cellpadding="0" cellspacing="0" border="0">
1597         <tr>
1598           <td class="md" nowrap valign="top">void Module::OnDelGLine           </td>
1599           <td class="md" valign="top">(&nbsp;</td>
1600           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
1601           <td class="mdname" nowrap> <em>source</em>, </td>
1602         </tr>
1603         <tr>
1604           <td class="md" nowrap align="right"></td>
1605           <td class="md"></td>
1606           <td class="md" nowrap><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
1607           <td class="mdname" nowrap> <em>hostmask</em></td>
1608         </tr>
1609         <tr>
1610           <td class="md"></td>
1611           <td class="md">)&nbsp;</td>
1612           <td class="md" colspan="2"><code> [virtual]</code></td>
1613         </tr>
1614       </table>
1615     </td>
1616   </tr>
1617 </table>
1618 <table cellspacing="5" cellpadding="0" border="0">
1619   <tr>
1620     <td>
1621       &nbsp;
1622     </td>
1623     <td>
1624
1625 <p>
1626 Called whenever a gline is deleted.
1627 <p>
1628 This method is triggered after the line is deleted. <dl compact><dt><b>Parameters:</b></dt><dd>
1629   <table border="0" cellspacing="2" cellpadding="0">
1630     <tr><td valign="top"></td><td valign="top"><em>source</em>&nbsp;</td><td>The user removing the line </td></tr>
1631     <tr><td valign="top"></td><td valign="top"><em>hostmask</em>&nbsp;</td><td>The hostmask to delete</td></tr>
1632   </table>
1633 </dl>
1634
1635 <p>
1636 Definition at line <a class="el" href="modules_8cpp-source.html#l00293">293</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00293"></a>00293 { };
1637 </pre></div>
1638 <p>
1639     </td>
1640   </tr>
1641 </table>
1642 <a class="anchor" name="OnDelKLine_28userrec_20_2Asource_2C_20std_3A_3Astring_20hostmask_29"></a><!-- doxytag: member="Module::OnDelKLine" ref="OnDelKLine_28userrec_20_2Asource_2C_20std_3A_3Astring_20hostmask_29" args="(userrec *source, std::string hostmask)" --><p>
1643 <table class="mdTable" cellpadding="2" cellspacing="0">
1644   <tr>
1645     <td class="mdRow">
1646       <table cellpadding="0" cellspacing="0" border="0">
1647         <tr>
1648           <td class="md" nowrap valign="top">void Module::OnDelKLine           </td>
1649           <td class="md" valign="top">(&nbsp;</td>
1650           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
1651           <td class="mdname" nowrap> <em>source</em>, </td>
1652         </tr>
1653         <tr>
1654           <td class="md" nowrap align="right"></td>
1655           <td class="md"></td>
1656           <td class="md" nowrap><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
1657           <td class="mdname" nowrap> <em>hostmask</em></td>
1658         </tr>
1659         <tr>
1660           <td class="md"></td>
1661           <td class="md">)&nbsp;</td>
1662           <td class="md" colspan="2"><code> [virtual]</code></td>
1663         </tr>
1664       </table>
1665     </td>
1666   </tr>
1667 </table>
1668 <table cellspacing="5" cellpadding="0" border="0">
1669   <tr>
1670     <td>
1671       &nbsp;
1672     </td>
1673     <td>
1674
1675 <p>
1676 Called whenever a kline is deleted.
1677 <p>
1678 This method is triggered after the line is deleted. <dl compact><dt><b>Parameters:</b></dt><dd>
1679   <table border="0" cellspacing="2" cellpadding="0">
1680     <tr><td valign="top"></td><td valign="top"><em>source</em>&nbsp;</td><td>The user removing the line </td></tr>
1681     <tr><td valign="top"></td><td valign="top"><em>hostmask</em>&nbsp;</td><td>The hostmask to delete</td></tr>
1682   </table>
1683 </dl>
1684
1685 <p>
1686 Definition at line <a class="el" href="modules_8cpp-source.html#l00295">295</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00295"></a>00295 { };
1687 </pre></div>
1688 <p>
1689     </td>
1690   </tr>
1691 </table>
1692 <a class="anchor" name="OnDelQLine_28userrec_20_2Asource_2C_20std_3A_3Astring_20nickmask_29"></a><!-- doxytag: member="Module::OnDelQLine" ref="OnDelQLine_28userrec_20_2Asource_2C_20std_3A_3Astring_20nickmask_29" args="(userrec *source, std::string nickmask)" --><p>
1693 <table class="mdTable" cellpadding="2" cellspacing="0">
1694   <tr>
1695     <td class="mdRow">
1696       <table cellpadding="0" cellspacing="0" border="0">
1697         <tr>
1698           <td class="md" nowrap valign="top">void Module::OnDelQLine           </td>
1699           <td class="md" valign="top">(&nbsp;</td>
1700           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
1701           <td class="mdname" nowrap> <em>source</em>, </td>
1702         </tr>
1703         <tr>
1704           <td class="md" nowrap align="right"></td>
1705           <td class="md"></td>
1706           <td class="md" nowrap><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
1707           <td class="mdname" nowrap> <em>nickmask</em></td>
1708         </tr>
1709         <tr>
1710           <td class="md"></td>
1711           <td class="md">)&nbsp;</td>
1712           <td class="md" colspan="2"><code> [virtual]</code></td>
1713         </tr>
1714       </table>
1715     </td>
1716   </tr>
1717 </table>
1718 <table cellspacing="5" cellpadding="0" border="0">
1719   <tr>
1720     <td>
1721       &nbsp;
1722     </td>
1723     <td>
1724
1725 <p>
1726 Called whenever a qline is deleted.
1727 <p>
1728 This method is triggered after the line is deleted. <dl compact><dt><b>Parameters:</b></dt><dd>
1729   <table border="0" cellspacing="2" cellpadding="0">
1730     <tr><td valign="top"></td><td valign="top"><em>source</em>&nbsp;</td><td>The user removing the line </td></tr>
1731     <tr><td valign="top"></td><td valign="top"><em>hostmask</em>&nbsp;</td><td>The hostmask to delete</td></tr>
1732   </table>
1733 </dl>
1734
1735 <p>
1736 Definition at line <a class="el" href="modules_8cpp-source.html#l00296">296</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00296"></a>00296 { };
1737 </pre></div>
1738 <p>
1739     </td>
1740   </tr>
1741 </table>
1742 <a class="anchor" name="OnDelZLine_28userrec_20_2Asource_2C_20std_3A_3Astring_20ipmask_29"></a><!-- doxytag: member="Module::OnDelZLine" ref="OnDelZLine_28userrec_20_2Asource_2C_20std_3A_3Astring_20ipmask_29" args="(userrec *source, std::string ipmask)" --><p>
1743 <table class="mdTable" cellpadding="2" cellspacing="0">
1744   <tr>
1745     <td class="mdRow">
1746       <table cellpadding="0" cellspacing="0" border="0">
1747         <tr>
1748           <td class="md" nowrap valign="top">void Module::OnDelZLine           </td>
1749           <td class="md" valign="top">(&nbsp;</td>
1750           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
1751           <td class="mdname" nowrap> <em>source</em>, </td>
1752         </tr>
1753         <tr>
1754           <td class="md" nowrap align="right"></td>
1755           <td class="md"></td>
1756           <td class="md" nowrap><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
1757           <td class="mdname" nowrap> <em>ipmask</em></td>
1758         </tr>
1759         <tr>
1760           <td class="md"></td>
1761           <td class="md">)&nbsp;</td>
1762           <td class="md" colspan="2"><code> [virtual]</code></td>
1763         </tr>
1764       </table>
1765     </td>
1766   </tr>
1767 </table>
1768 <table cellspacing="5" cellpadding="0" border="0">
1769   <tr>
1770     <td>
1771       &nbsp;
1772     </td>
1773     <td>
1774
1775 <p>
1776 Called whenever a zline is deleted.
1777 <p>
1778 This method is triggered after the line is deleted. <dl compact><dt><b>Parameters:</b></dt><dd>
1779   <table border="0" cellspacing="2" cellpadding="0">
1780     <tr><td valign="top"></td><td valign="top"><em>source</em>&nbsp;</td><td>The user removing the line </td></tr>
1781     <tr><td valign="top"></td><td valign="top"><em>hostmask</em>&nbsp;</td><td>The hostmask to delete</td></tr>
1782   </table>
1783 </dl>
1784
1785 <p>
1786 Definition at line <a class="el" href="modules_8cpp-source.html#l00294">294</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00294"></a>00294 { };
1787 </pre></div>
1788 <p>
1789     </td>
1790   </tr>
1791 </table>
1792 <a class="anchor" name="OnEvent_28Event_20_2Aevent_29"></a><!-- doxytag: member="Module::OnEvent" ref="OnEvent_28Event_20_2Aevent_29" args="(Event *event)" --><p>
1793 <table class="mdTable" cellpadding="2" cellspacing="0">
1794   <tr>
1795     <td class="mdRow">
1796       <table cellpadding="0" cellspacing="0" border="0">
1797         <tr>
1798           <td class="md" nowrap valign="top">void Module::OnEvent           </td>
1799           <td class="md" valign="top">(&nbsp;</td>
1800           <td class="md" nowrap valign="top"><a class="el" href="classEvent.html">Event</a> *&nbsp;</td>
1801           <td class="mdname1" valign="top" nowrap> <em>event</em>          </td>
1802           <td class="md" valign="top">&nbsp;)&nbsp;</td>
1803           <td class="md" nowrap><code> [virtual]</code></td>
1804         </tr>
1805       </table>
1806     </td>
1807   </tr>
1808 </table>
1809 <table cellspacing="5" cellpadding="0" border="0">
1810   <tr>
1811     <td>
1812       &nbsp;
1813     </td>
1814     <td>
1815
1816 <p>
1817 Called whenever an <a class="el" href="classEvent.html">Event</a> class is sent to all module by another module.
1818 <p>
1819 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! <dl compact><dt><b>Parameters:</b></dt><dd>
1820   <table border="0" cellspacing="2" cellpadding="0">
1821     <tr><td valign="top"></td><td valign="top"><em>event</em>&nbsp;</td><td>The <a class="el" href="classEvent.html">Event</a> class being received</td></tr>
1822   </table>
1823 </dl>
1824
1825 <p>
1826 Definition at line <a class="el" href="modules_8cpp-source.html#l00261">261</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00261"></a>00261 { <span class="keywordflow">return</span>; };
1827 </pre></div>
1828 <p>
1829     </td>
1830   </tr>
1831 </table>
1832 <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>
1833 <table class="mdTable" cellpadding="2" cellspacing="0">
1834   <tr>
1835     <td class="mdRow">
1836       <table cellpadding="0" cellspacing="0" border="0">
1837         <tr>
1838           <td class="md" nowrap valign="top">int Module::OnExtendedMode           </td>
1839           <td class="md" valign="top">(&nbsp;</td>
1840           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
1841           <td class="mdname" nowrap> <em>user</em>, </td>
1842         </tr>
1843         <tr>
1844           <td class="md" nowrap align="right"></td>
1845           <td class="md"></td>
1846           <td class="md" nowrap>void *&nbsp;</td>
1847           <td class="mdname" nowrap> <em>target</em>, </td>
1848         </tr>
1849         <tr>
1850           <td class="md" nowrap align="right"></td>
1851           <td class="md"></td>
1852           <td class="md" nowrap>char&nbsp;</td>
1853           <td class="mdname" nowrap> <em>modechar</em>, </td>
1854         </tr>
1855         <tr>
1856           <td class="md" nowrap align="right"></td>
1857           <td class="md"></td>
1858           <td class="md" nowrap>int&nbsp;</td>
1859           <td class="mdname" nowrap> <em>type</em>, </td>
1860         </tr>
1861         <tr>
1862           <td class="md" nowrap align="right"></td>
1863           <td class="md"></td>
1864           <td class="md" nowrap>bool&nbsp;</td>
1865           <td class="mdname" nowrap> <em>mode_on</em>, </td>
1866         </tr>
1867         <tr>
1868           <td class="md" nowrap align="right"></td>
1869           <td class="md"></td>
1870           <td class="md" nowrap><a class="el" href="modules_8h.html#string_5Flist">string_list</a> &amp;&nbsp;</td>
1871           <td class="mdname" nowrap> <em>params</em></td>
1872         </tr>
1873         <tr>
1874           <td class="md"></td>
1875           <td class="md">)&nbsp;</td>
1876           <td class="md" colspan="2"><code> [virtual]</code></td>
1877         </tr>
1878       </table>
1879     </td>
1880   </tr>
1881 </table>
1882 <table cellspacing="5" cellpadding="0" border="0">
1883   <tr>
1884     <td>
1885       &nbsp;
1886     </td>
1887     <td>
1888
1889 <p>
1890 Called whenever an extended mode is to be processed.
1891 <p>
1892 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. <dl compact><dt><b>Parameters:</b></dt><dd>
1893   <table border="0" cellspacing="2" cellpadding="0">
1894     <tr><td valign="top"></td><td valign="top"><em>user</em>&nbsp;</td><td>The user issuing the mode </td></tr>
1895     <tr><td valign="top"></td><td valign="top"><em>target</em>&nbsp;</td><td>The user or channel having the mode set on them </td></tr>
1896     <tr><td valign="top"></td><td valign="top"><em>modechar</em>&nbsp;</td><td>The mode character being set </td></tr>
1897     <tr><td valign="top"></td><td valign="top"><em>type</em>&nbsp;</td><td>The type of mode (user or channel) being set </td></tr>
1898     <tr><td valign="top"></td><td valign="top"><em>mode_on</em>&nbsp;</td><td>True if the mode is being set, false if it is being unset </td></tr>
1899     <tr><td valign="top"></td><td valign="top"><em>params</em>&nbsp;</td><td>A list of parameters for any channel mode (currently supports either 0 or 1 parameters)</td></tr>
1900   </table>
1901 </dl>
1902
1903 <p>
1904 Definition at line <a class="el" href="modules_8cpp-source.html#l00229">229</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00229"></a>00229 { <span class="keywordflow">return</span> <span class="keyword">false</span>; }
1905 </pre></div>
1906 <p>
1907     </td>
1908   </tr>
1909 </table>
1910 <a class="anchor" name="OnGetServerDescription_28std_3A_3Astring_20servername_2C_20std_3A_3Astring_20_26description_29"></a><!-- doxytag: member="Module::OnGetServerDescription" ref="OnGetServerDescription_28std_3A_3Astring_20servername_2C_20std_3A_3Astring_20_26description_29" args="(std::string servername, std::string &amp;description)" --><p>
1911 <table class="mdTable" cellpadding="2" cellspacing="0">
1912   <tr>
1913     <td class="mdRow">
1914       <table cellpadding="0" cellspacing="0" border="0">
1915         <tr>
1916           <td class="md" nowrap valign="top">void Module::OnGetServerDescription           </td>
1917           <td class="md" valign="top">(&nbsp;</td>
1918           <td class="md" nowrap valign="top"><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
1919           <td class="mdname" nowrap> <em>servername</em>, </td>
1920         </tr>
1921         <tr>
1922           <td class="md" nowrap align="right"></td>
1923           <td class="md"></td>
1924           <td class="md" nowrap><a class="el" href="namespaceirc.html#string">std::string</a> &amp;&nbsp;</td>
1925           <td class="mdname" nowrap> <em>description</em></td>
1926         </tr>
1927         <tr>
1928           <td class="md"></td>
1929           <td class="md">)&nbsp;</td>
1930           <td class="md" colspan="2"><code> [virtual]</code></td>
1931         </tr>
1932       </table>
1933     </td>
1934   </tr>
1935 </table>
1936 <table cellspacing="5" cellpadding="0" border="0">
1937   <tr>
1938     <td>
1939       &nbsp;
1940     </td>
1941     <td>
1942
1943 <p>
1944 Allows modules to alter or create server descriptions Whenever a module requires a server description, for example for display in WHOIS, this function is called in all modules.
1945 <p>
1946 You may change or define the description given in <a class="el" href="namespaceirc.html#string">std::string</a> &amp;description. If you do, this description will be shown in the WHOIS fields. <dl compact><dt><b>Parameters:</b></dt><dd>
1947   <table border="0" cellspacing="2" cellpadding="0">
1948     <tr><td valign="top"></td><td valign="top"><em>servername</em>&nbsp;</td><td>The servername being searched for </td></tr>
1949     <tr><td valign="top"></td><td valign="top"><em>description</em>&nbsp;</td><td>Alterable server description for this server</td></tr>
1950   </table>
1951 </dl>
1952
1953 <p>
1954 Definition at line <a class="el" href="modules_8cpp-source.html#l00277">277</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00277"></a>00277 { };
1955 </pre></div>
1956 <p>
1957     </td>
1958   </tr>
1959 </table>
1960 <a class="anchor" name="OnGlobalConnect_28userrec_20_2Auser_29"></a><!-- doxytag: member="Module::OnGlobalConnect" ref="OnGlobalConnect_28userrec_20_2Auser_29" args="(userrec *user)" --><p>
1961 <table class="mdTable" cellpadding="2" cellspacing="0">
1962   <tr>
1963     <td class="mdRow">
1964       <table cellpadding="0" cellspacing="0" border="0">
1965         <tr>
1966           <td class="md" nowrap valign="top">void Module::OnGlobalConnect           </td>
1967           <td class="md" valign="top">(&nbsp;</td>
1968           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
1969           <td class="mdname1" valign="top" nowrap> <em>user</em>          </td>
1970           <td class="md" valign="top">&nbsp;)&nbsp;</td>
1971           <td class="md" nowrap><code> [virtual]</code></td>
1972         </tr>
1973       </table>
1974     </td>
1975   </tr>
1976 </table>
1977 <table cellspacing="5" cellpadding="0" border="0">
1978   <tr>
1979     <td>
1980       &nbsp;
1981     </td>
1982     <td>
1983
1984 <p>
1985 Called whenever a user connects, anywhere on the network.
1986 <p>
1987 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. <dl compact><dt><b>Parameters:</b></dt><dd>
1988   <table border="0" cellspacing="2" cellpadding="0">
1989     <tr><td valign="top"></td><td valign="top"><em>user</em>&nbsp;</td><td>The user who is connecting</td></tr>
1990   </table>
1991 </dl>
1992
1993 <p>
1994 Definition at line <a class="el" href="modules_8cpp-source.html#l00265">265</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00265"></a>00265 { };
1995 </pre></div>
1996 <p>
1997     </td>
1998   </tr>
1999 </table>
2000 <a class="anchor" name="OnGlobalOper_28userrec_20_2Auser_29"></a><!-- doxytag: member="Module::OnGlobalOper" ref="OnGlobalOper_28userrec_20_2Auser_29" args="(userrec *user)" --><p>
2001 <table class="mdTable" cellpadding="2" cellspacing="0">
2002   <tr>
2003     <td class="mdRow">
2004       <table cellpadding="0" cellspacing="0" border="0">
2005         <tr>
2006           <td class="md" nowrap valign="top">void Module::OnGlobalOper           </td>
2007           <td class="md" valign="top">(&nbsp;</td>
2008           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
2009           <td class="mdname1" valign="top" nowrap> <em>user</em>          </td>
2010           <td class="md" valign="top">&nbsp;)&nbsp;</td>
2011           <td class="md" nowrap><code> [virtual]</code></td>
2012         </tr>
2013       </table>
2014     </td>
2015   </tr>
2016 </table>
2017 <table cellspacing="5" cellpadding="0" border="0">
2018   <tr>
2019     <td>
2020       &nbsp;
2021     </td>
2022     <td>
2023
2024 <p>
2025 Called whenever a user is given usermode +o, anywhere on the network.
2026 <p>
2027 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. <dl compact><dt><b>Parameters:</b></dt><dd>
2028   <table border="0" cellspacing="2" cellpadding="0">
2029     <tr><td valign="top"></td><td valign="top"><em>user</em>&nbsp;</td><td>The user who is opering</td></tr>
2030   </table>
2031 </dl>
2032
2033 <p>
2034 Definition at line <a class="el" href="modules_8cpp-source.html#l00264">264</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00264"></a>00264 { };
2035 </pre></div>
2036 <p>
2037     </td>
2038   </tr>
2039 </table>
2040 <a class="anchor" name="OnInfo_28userrec_20_2Auser_29"></a><!-- doxytag: member="Module::OnInfo" ref="OnInfo_28userrec_20_2Auser_29" args="(userrec *user)" --><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::OnInfo           </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="mdname1" valign="top" nowrap> <em>user</em>          </td>
2050           <td class="md" valign="top">&nbsp;)&nbsp;</td>
2051           <td class="md" nowrap><code> [virtual]</code></td>
2052         </tr>
2053       </table>
2054     </td>
2055   </tr>
2056 </table>
2057 <table cellspacing="5" cellpadding="0" border="0">
2058   <tr>
2059     <td>
2060       &nbsp;
2061     </td>
2062     <td>
2063
2064 <p>
2065 Called whenever a user types /INFO.
2066 <p>
2067 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>
2068 &lt;nick&gt; :information here<p>
2069 <dl compact><dt><b>Parameters:</b></dt><dd>
2070   <table border="0" cellspacing="2" cellpadding="0">
2071     <tr><td valign="top"></td><td valign="top"><em>user</em>&nbsp;</td><td>The user issuing /INFO</td></tr>
2072   </table>
2073 </dl>
2074
2075 <p>
2076 Definition at line <a class="el" href="modules_8cpp-source.html#l00233">233</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00233"></a>00233 { };
2077 </pre></div>
2078 <p>
2079     </td>
2080   </tr>
2081 </table>
2082 <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>
2083 <table class="mdTable" cellpadding="2" cellspacing="0">
2084   <tr>
2085     <td class="mdRow">
2086       <table cellpadding="0" cellspacing="0" border="0">
2087         <tr>
2088           <td class="md" nowrap valign="top">int Module::OnKill           </td>
2089           <td class="md" valign="top">(&nbsp;</td>
2090           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
2091           <td class="mdname" nowrap> <em>source</em>, </td>
2092         </tr>
2093         <tr>
2094           <td class="md" nowrap align="right"></td>
2095           <td class="md"></td>
2096           <td class="md" nowrap><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
2097           <td class="mdname" nowrap> <em>dest</em>, </td>
2098         </tr>
2099         <tr>
2100           <td class="md" nowrap align="right"></td>
2101           <td class="md"></td>
2102           <td class="md" nowrap><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
2103           <td class="mdname" nowrap> <em>reason</em></td>
2104         </tr>
2105         <tr>
2106           <td class="md"></td>
2107           <td class="md">)&nbsp;</td>
2108           <td class="md" colspan="2"><code> [virtual]</code></td>
2109         </tr>
2110       </table>
2111     </td>
2112   </tr>
2113 </table>
2114 <table cellspacing="5" cellpadding="0" border="0">
2115   <tr>
2116     <td>
2117       &nbsp;
2118     </td>
2119     <td>
2120
2121 <p>
2122 Called when a client is disconnected by KILL.
2123 <p>
2124 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 or remote users. If you do so youre risking race conditions, desyncs and worse! <dl compact><dt><b>Parameters:</b></dt><dd>
2125   <table border="0" cellspacing="2" cellpadding="0">
2126     <tr><td valign="top"></td><td valign="top"><em>source</em>&nbsp;</td><td>The user sending the KILL </td></tr>
2127     <tr><td valign="top"></td><td valign="top"><em>dest</em>&nbsp;</td><td>The user being killed </td></tr>
2128     <tr><td valign="top"></td><td valign="top"><em>reason</em>&nbsp;</td><td>The kill reason </td></tr>
2129   </table>
2130 </dl>
2131 <dl compact><dt><b>Returns:</b></dt><dd>1 to prevent the kill, 0 to allow</dd></dl>
2132
2133 <p>
2134 Definition at line <a class="el" href="modules_8cpp-source.html#l00242">242</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00242"></a>00242 { <span class="keywordflow">return</span> 0; };
2135 </pre></div>
2136 <p>
2137     </td>
2138   </tr>
2139 </table>
2140 <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>
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::OnLoadModule           </td>
2147           <td class="md" valign="top">(&nbsp;</td>
2148           <td class="md" nowrap valign="top"><a class="el" href="classModule.html">Module</a> *&nbsp;</td>
2149           <td class="mdname" nowrap> <em>mod</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="namespaceirc.html#string">std::string</a>&nbsp;</td>
2155           <td class="mdname" nowrap> <em>name</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 whenever a module is loaded.
2175 <p>
2176 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). <dl compact><dt><b>Parameters:</b></dt><dd>
2177   <table border="0" cellspacing="2" cellpadding="0">
2178     <tr><td valign="top"></td><td valign="top"><em>mod</em>&nbsp;</td><td>A pointer to the new module </td></tr>
2179     <tr><td valign="top"></td><td valign="top"><em>name</em>&nbsp;</td><td>The new module's filename</td></tr>
2180   </table>
2181 </dl>
2182
2183 <p>
2184 Definition at line <a class="el" href="modules_8cpp-source.html#l00243">243</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00243"></a>00243 { };
2185 </pre></div>
2186 <p>
2187     </td>
2188   </tr>
2189 </table>
2190 <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>
2191 <table class="mdTable" cellpadding="2" cellspacing="0">
2192   <tr>
2193     <td class="mdRow">
2194       <table cellpadding="0" cellspacing="0" border="0">
2195         <tr>
2196           <td class="md" nowrap valign="top">int Module::OnLocalTopicChange           </td>
2197           <td class="md" valign="top">(&nbsp;</td>
2198           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
2199           <td class="mdname" nowrap> <em>user</em>, </td>
2200         </tr>
2201         <tr>
2202           <td class="md" nowrap align="right"></td>
2203           <td class="md"></td>
2204           <td class="md" nowrap><a class="el" href="classchanrec.html">chanrec</a> *&nbsp;</td>
2205           <td class="mdname" nowrap> <em>chan</em>, </td>
2206         </tr>
2207         <tr>
2208           <td class="md" nowrap align="right"></td>
2209           <td class="md"></td>
2210           <td class="md" nowrap><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
2211           <td class="mdname" nowrap> <em>topic</em></td>
2212         </tr>
2213         <tr>
2214           <td class="md"></td>
2215           <td class="md">)&nbsp;</td>
2216           <td class="md" colspan="2"><code> [virtual]</code></td>
2217         </tr>
2218       </table>
2219     </td>
2220   </tr>
2221 </table>
2222 <table cellspacing="5" cellpadding="0" border="0">
2223   <tr>
2224     <td>
2225       &nbsp;
2226     </td>
2227     <td>
2228
2229 <p>
2230 Called whenever a topic is changed by a local user.
2231 <p>
2232 Return 1 to deny the topic change, or 0 to allow it. <dl compact><dt><b>Parameters:</b></dt><dd>
2233   <table border="0" cellspacing="2" cellpadding="0">
2234     <tr><td valign="top"></td><td valign="top"><em>user</em>&nbsp;</td><td>The user changing the topic </td></tr>
2235     <tr><td valign="top"></td><td valign="top"><em>chan</em>&nbsp;</td><td>The channels who's topic is being changed </td></tr>
2236     <tr><td valign="top"></td><td valign="top"><em>topic</em>&nbsp;</td><td>The actual topic text </td></tr>
2237     <tr><td valign="top"></td><td valign="top"><em>1</em>&nbsp;</td><td>to block the topic change, 0 to allow</td></tr>
2238   </table>
2239 </dl>
2240
2241 <p>
2242 Definition at line <a class="el" href="modules_8cpp-source.html#l00260">260</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00260"></a>00260 { <span class="keywordflow">return</span> 0; };
2243 </pre></div>
2244 <p>
2245     </td>
2246   </tr>
2247 </table>
2248 <a class="anchor" name="OnMode_28userrec_20_2Auser_2C_20void_20_2Adest_2C_20int_20target_5Ftype_2C_20std_3A_3Astring_20text_29"></a><!-- doxytag: member="Module::OnMode" ref="OnMode_28userrec_20_2Auser_2C_20void_20_2Adest_2C_20int_20target_5Ftype_2C_20std_3A_3Astring_20text_29" args="(userrec *user, void *dest, int target_type, std::string text)" --><p>
2249 <table class="mdTable" cellpadding="2" cellspacing="0">
2250   <tr>
2251     <td class="mdRow">
2252       <table cellpadding="0" cellspacing="0" border="0">
2253         <tr>
2254           <td class="md" nowrap valign="top">void Module::OnMode           </td>
2255           <td class="md" valign="top">(&nbsp;</td>
2256           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
2257           <td class="mdname" nowrap> <em>user</em>, </td>
2258         </tr>
2259         <tr>
2260           <td class="md" nowrap align="right"></td>
2261           <td class="md"></td>
2262           <td class="md" nowrap>void *&nbsp;</td>
2263           <td class="mdname" nowrap> <em>dest</em>, </td>
2264         </tr>
2265         <tr>
2266           <td class="md" nowrap align="right"></td>
2267           <td class="md"></td>
2268           <td class="md" nowrap>int&nbsp;</td>
2269           <td class="mdname" nowrap> <em>target_type</em>, </td>
2270         </tr>
2271         <tr>
2272           <td class="md" nowrap align="right"></td>
2273           <td class="md"></td>
2274           <td class="md" nowrap><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
2275           <td class="mdname" nowrap> <em>text</em></td>
2276         </tr>
2277         <tr>
2278           <td class="md"></td>
2279           <td class="md">)&nbsp;</td>
2280           <td class="md" colspan="2"><code> [virtual]</code></td>
2281         </tr>
2282       </table>
2283     </td>
2284   </tr>
2285 </table>
2286 <table cellspacing="5" cellpadding="0" border="0">
2287   <tr>
2288     <td>
2289       &nbsp;
2290     </td>
2291     <td>
2292
2293 <p>
2294 Called after every MODE command sent from a user The dest variable contains a userrec* if target_type is TYPE_USER and a chanrec* if target_type is TYPE_CHANNEL.
2295 <p>
2296 The text variable contains the remainder of the mode string after the target, e.g. "+wsi" or "+ooo nick1 nick2 nick3". <dl compact><dt><b>Parameters:</b></dt><dd>
2297   <table border="0" cellspacing="2" cellpadding="0">
2298     <tr><td valign="top"></td><td valign="top"><em>user</em>&nbsp;</td><td>The user sending the MODEs </td></tr>
2299     <tr><td valign="top"></td><td valign="top"><em>dest</em>&nbsp;</td><td>The target of the modes (userrec* or chanrec*) </td></tr>
2300     <tr><td valign="top"></td><td valign="top"><em>target_type</em>&nbsp;</td><td>The type of target (TYPE_USER or TYPE_CHANNEL) </td></tr>
2301     <tr><td valign="top"></td><td valign="top"><em>text</em>&nbsp;</td><td>The actual modes and their parameters if any</td></tr>
2302   </table>
2303 </dl>
2304
2305 <p>
2306 Definition at line <a class="el" href="modules_8cpp-source.html#l00230">230</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00230"></a>00230 { };
2307 </pre></div>
2308 <p>
2309     </td>
2310   </tr>
2311 </table>
2312 <a class="anchor" name="OnOper_28userrec_20_2Auser_2C_20std_3A_3Astring_20opertype_29"></a><!-- doxytag: member="Module::OnOper" ref="OnOper_28userrec_20_2Auser_2C_20std_3A_3Astring_20opertype_29" args="(userrec *user, std::string opertype)" --><p>
2313 <table class="mdTable" cellpadding="2" cellspacing="0">
2314   <tr>
2315     <td class="mdRow">
2316       <table cellpadding="0" cellspacing="0" border="0">
2317         <tr>
2318           <td class="md" nowrap valign="top">void Module::OnOper           </td>
2319           <td class="md" valign="top">(&nbsp;</td>
2320           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
2321           <td class="mdname" nowrap> <em>user</em>, </td>
2322         </tr>
2323         <tr>
2324           <td class="md" nowrap align="right"></td>
2325           <td class="md"></td>
2326           <td class="md" nowrap><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
2327           <td class="mdname" nowrap> <em>opertype</em></td>
2328         </tr>
2329         <tr>
2330           <td class="md"></td>
2331           <td class="md">)&nbsp;</td>
2332           <td class="md" colspan="2"><code> [virtual]</code></td>
2333         </tr>
2334       </table>
2335     </td>
2336   </tr>
2337 </table>
2338 <table cellspacing="5" cellpadding="0" border="0">
2339   <tr>
2340     <td>
2341       &nbsp;
2342     </td>
2343     <td>
2344
2345 <p>
2346 Called whenever a user opers locally.
2347 <p>
2348 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. <dl compact><dt><b>Parameters:</b></dt><dd>
2349   <table border="0" cellspacing="2" cellpadding="0">
2350     <tr><td valign="top"></td><td valign="top"><em>user</em>&nbsp;</td><td>The user who is opering up </td></tr>
2351     <tr><td valign="top"></td><td valign="top"><em>opertype</em>&nbsp;</td><td>The opers type name</td></tr>
2352   </table>
2353 </dl>
2354
2355 <p>
2356 Definition at line <a class="el" href="modules_8cpp-source.html#l00232">232</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00232"></a>00232 { };
2357 </pre></div>
2358 <p>
2359     </td>
2360   </tr>
2361 </table>
2362 <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>
2363 <table class="mdTable" cellpadding="2" cellspacing="0">
2364   <tr>
2365     <td class="mdRow">
2366       <table cellpadding="0" cellspacing="0" border="0">
2367         <tr>
2368           <td class="md" nowrap valign="top">int Module::OnOperCompare           </td>
2369           <td class="md" valign="top">(&nbsp;</td>
2370           <td class="md" nowrap valign="top"><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
2371           <td class="mdname" nowrap> <em>password</em>, </td>
2372         </tr>
2373         <tr>
2374           <td class="md" nowrap align="right"></td>
2375           <td class="md"></td>
2376           <td class="md" nowrap><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
2377           <td class="mdname" nowrap> <em>input</em></td>
2378         </tr>
2379         <tr>
2380           <td class="md"></td>
2381           <td class="md">)&nbsp;</td>
2382           <td class="md" colspan="2"><code> [virtual]</code></td>
2383         </tr>
2384       </table>
2385     </td>
2386   </tr>
2387 </table>
2388 <table cellspacing="5" cellpadding="0" border="0">
2389   <tr>
2390     <td>
2391       &nbsp;
2392     </td>
2393     <td>
2394
2395 <p>
2396 Called whenever an oper password is to be compared to what a user has input.
2397 <p>
2398 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. <dl compact><dt><b>Parameters:</b></dt><dd>
2399   <table border="0" cellspacing="2" cellpadding="0">
2400     <tr><td valign="top"></td><td valign="top"><em>password</em>&nbsp;</td><td>The oper's password </td></tr>
2401     <tr><td valign="top"></td><td valign="top"><em>input</em>&nbsp;</td><td>The password entered </td></tr>
2402   </table>
2403 </dl>
2404 <dl compact><dt><b>Returns:</b></dt><dd>1 to match the passwords, 0 to do nothing</dd></dl>
2405
2406 <p>
2407 Definition at line <a class="el" href="modules_8cpp-source.html#l00263">263</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00263"></a>00263 { <span class="keywordflow">return</span> 0; };
2408 </pre></div>
2409 <p>
2410     </td>
2411   </tr>
2412 </table>
2413 <a class="anchor" name="OnPostLocalTopicChange_28userrec_20_2Auser_2C_20chanrec_20_2Achan_2C_20std_3A_3Astring_20topic_29"></a><!-- doxytag: member="Module::OnPostLocalTopicChange" ref="OnPostLocalTopicChange_28userrec_20_2Auser_2C_20chanrec_20_2Achan_2C_20std_3A_3Astring_20topic_29" args="(userrec *user, chanrec *chan, std::string topic)" --><p>
2414 <table class="mdTable" cellpadding="2" cellspacing="0">
2415   <tr>
2416     <td class="mdRow">
2417       <table cellpadding="0" cellspacing="0" border="0">
2418         <tr>
2419           <td class="md" nowrap valign="top">void Module::OnPostLocalTopicChange           </td>
2420           <td class="md" valign="top">(&nbsp;</td>
2421           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
2422           <td class="mdname" nowrap> <em>user</em>, </td>
2423         </tr>
2424         <tr>
2425           <td class="md" nowrap align="right"></td>
2426           <td class="md"></td>
2427           <td class="md" nowrap><a class="el" href="classchanrec.html">chanrec</a> *&nbsp;</td>
2428           <td class="mdname" nowrap> <em>chan</em>, </td>
2429         </tr>
2430         <tr>
2431           <td class="md" nowrap align="right"></td>
2432           <td class="md"></td>
2433           <td class="md" nowrap><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
2434           <td class="mdname" nowrap> <em>topic</em></td>
2435         </tr>
2436         <tr>
2437           <td class="md"></td>
2438           <td class="md">)&nbsp;</td>
2439           <td class="md" colspan="2"><code> [virtual]</code></td>
2440         </tr>
2441       </table>
2442     </td>
2443   </tr>
2444 </table>
2445 <table cellspacing="5" cellpadding="0" border="0">
2446   <tr>
2447     <td>
2448       &nbsp;
2449     </td>
2450     <td>
2451
2452 <p>
2453 Called whenever a local topic has been changed.
2454 <p>
2455 To block topic changes you must use OnLocalTopicChange instead. <dl compact><dt><b>Parameters:</b></dt><dd>
2456   <table border="0" cellspacing="2" cellpadding="0">
2457     <tr><td valign="top"></td><td valign="top"><em>user</em>&nbsp;</td><td>The user changing the topic </td></tr>
2458     <tr><td valign="top"></td><td valign="top"><em>chan</em>&nbsp;</td><td>The channels who's topic is being changed </td></tr>
2459     <tr><td valign="top"></td><td valign="top"><em>topic</em>&nbsp;</td><td>The actual topic text</td></tr>
2460   </table>
2461 </dl>
2462
2463 <p>
2464 Definition at line <a class="el" href="modules_8cpp-source.html#l00276">276</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00276"></a>00276 { };
2465 </pre></div>
2466 <p>
2467     </td>
2468   </tr>
2469 </table>
2470 <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>
2471 <table class="mdTable" cellpadding="2" cellspacing="0">
2472   <tr>
2473     <td class="mdRow">
2474       <table cellpadding="0" cellspacing="0" border="0">
2475         <tr>
2476           <td class="md" nowrap valign="top">int Module::OnPreCommand           </td>
2477           <td class="md" valign="top">(&nbsp;</td>
2478           <td class="md" nowrap valign="top"><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
2479           <td class="mdname" nowrap> <em>command</em>, </td>
2480         </tr>
2481         <tr>
2482           <td class="md" nowrap align="right"></td>
2483           <td class="md"></td>
2484           <td class="md" nowrap>char **&nbsp;</td>
2485           <td class="mdname" nowrap> <em>parameters</em>, </td>
2486         </tr>
2487         <tr>
2488           <td class="md" nowrap align="right"></td>
2489           <td class="md"></td>
2490           <td class="md" nowrap>int&nbsp;</td>
2491           <td class="mdname" nowrap> <em>pcnt</em>, </td>
2492         </tr>
2493         <tr>
2494           <td class="md" nowrap align="right"></td>
2495           <td class="md"></td>
2496           <td class="md" nowrap><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
2497           <td class="mdname" nowrap> <em>user</em></td>
2498         </tr>
2499         <tr>
2500           <td class="md"></td>
2501           <td class="md">)&nbsp;</td>
2502           <td class="md" colspan="2"><code> [virtual]</code></td>
2503         </tr>
2504       </table>
2505     </td>
2506   </tr>
2507 </table>
2508 <table cellspacing="5" cellpadding="0" border="0">
2509   <tr>
2510     <td>
2511       &nbsp;
2512     </td>
2513     <td>
2514
2515 <p>
2516 Called whenever any command is about to be executed.
2517 <p>
2518 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!) <dl compact><dt><b>Parameters:</b></dt><dd>
2519   <table border="0" cellspacing="2" cellpadding="0">
2520     <tr><td valign="top"></td><td valign="top"><em>command</em>&nbsp;</td><td>The command being executed </td></tr>
2521     <tr><td valign="top"></td><td valign="top"><em>parameters</em>&nbsp;</td><td>An array of array of characters containing the parameters for the command </td></tr>
2522     <tr><td valign="top"></td><td valign="top"><em>pcnt</em>&nbsp;</td><td>The nuimber of parameters passed to the command </td></tr>
2523     <tr><td valign="top"></td><td valign="top"><em>user</em>&nbsp;</td><td>the user issuing the command </td></tr>
2524   </table>
2525 </dl>
2526 <dl compact><dt><b>Returns:</b></dt><dd>1 to block the command, 0 to allow</dd></dl>
2527
2528 <p>
2529 Definition at line <a class="el" href="modules_8cpp-source.html#l00247">247</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00247"></a>00247 { <span class="keywordflow">return</span> 0; };
2530 </pre></div>
2531 <p>
2532     </td>
2533   </tr>
2534 </table>
2535 <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>
2536 <table class="mdTable" cellpadding="2" cellspacing="0">
2537   <tr>
2538     <td class="mdRow">
2539       <table cellpadding="0" cellspacing="0" border="0">
2540         <tr>
2541           <td class="md" nowrap valign="top">int Module::OnRawMode           </td>
2542           <td class="md" valign="top">(&nbsp;</td>
2543           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
2544           <td class="mdname" nowrap> <em>user</em>, </td>
2545         </tr>
2546         <tr>
2547           <td class="md" nowrap align="right"></td>
2548           <td class="md"></td>
2549           <td class="md" nowrap><a class="el" href="classchanrec.html">chanrec</a> *&nbsp;</td>
2550           <td class="mdname" nowrap> <em>chan</em>, </td>
2551         </tr>
2552         <tr>
2553           <td class="md" nowrap align="right"></td>
2554           <td class="md"></td>
2555           <td class="md" nowrap>char&nbsp;</td>
2556           <td class="mdname" nowrap> <em>mode</em>, </td>
2557         </tr>
2558         <tr>
2559           <td class="md" nowrap align="right"></td>
2560           <td class="md"></td>
2561           <td class="md" nowrap><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
2562           <td class="mdname" nowrap> <em>param</em>, </td>
2563         </tr>
2564         <tr>
2565           <td class="md" nowrap align="right"></td>
2566           <td class="md"></td>
2567           <td class="md" nowrap>bool&nbsp;</td>
2568           <td class="mdname" nowrap> <em>adding</em>, </td>
2569         </tr>
2570         <tr>
2571           <td class="md" nowrap align="right"></td>
2572           <td class="md"></td>
2573           <td class="md" nowrap>int&nbsp;</td>
2574           <td class="mdname" nowrap> <em>pcnt</em></td>
2575         </tr>
2576         <tr>
2577           <td class="md"></td>
2578           <td class="md">)&nbsp;</td>
2579           <td class="md" colspan="2"><code> [virtual]</code></td>
2580         </tr>
2581       </table>
2582     </td>
2583   </tr>
2584 </table>
2585 <table cellspacing="5" cellpadding="0" border="0">
2586   <tr>
2587     <td>
2588       &nbsp;
2589     </td>
2590     <td>
2591
2592 <p>
2593 Called whenever a mode character is processed.
2594 <p>
2595 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! <dl compact><dt><b>Parameters:</b></dt><dd>
2596   <table border="0" cellspacing="2" cellpadding="0">
2597     <tr><td valign="top"></td><td valign="top"><em>user</em>&nbsp;</td><td>The user who is sending the mode </td></tr>
2598     <tr><td valign="top"></td><td valign="top"><em>chan</em>&nbsp;</td><td>The channel the mode is being sent to </td></tr>
2599     <tr><td valign="top"></td><td valign="top"><em>mode</em>&nbsp;</td><td>The mode character being set </td></tr>
2600     <tr><td valign="top"></td><td valign="top"><em>param</em>&nbsp;</td><td>The parameter for the mode or an empty string </td></tr>
2601     <tr><td valign="top"></td><td valign="top"><em>adding</em>&nbsp;</td><td>true of the mode is being added, false if it is being removed </td></tr>
2602     <tr><td valign="top"></td><td valign="top"><em>pcnt</em>&nbsp;</td><td>The parameter count for the mode (0 or 1) </td></tr>
2603   </table>
2604 </dl>
2605 <dl compact><dt><b>Returns:</b></dt><dd>1 to deny the mode, 0 to allow</dd></dl>
2606
2607 <p>
2608 Definition at line <a class="el" href="modules_8cpp-source.html#l00252">252</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00252"></a>00252 { <span class="keywordflow">return</span> 0; };
2609 </pre></div>
2610 <p>
2611     </td>
2612   </tr>
2613 </table>
2614 <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>
2615 <table class="mdTable" cellpadding="2" cellspacing="0">
2616   <tr>
2617     <td class="mdRow">
2618       <table cellpadding="0" cellspacing="0" border="0">
2619         <tr>
2620           <td class="md" nowrap valign="top">void Module::OnRawSocketAccept           </td>
2621           <td class="md" valign="top">(&nbsp;</td>
2622           <td class="md" nowrap valign="top">int&nbsp;</td>
2623           <td class="mdname" nowrap> <em>fd</em>, </td>
2624         </tr>
2625         <tr>
2626           <td class="md" nowrap align="right"></td>
2627           <td class="md"></td>
2628           <td class="md" nowrap><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
2629           <td class="mdname" nowrap> <em>ip</em>, </td>
2630         </tr>
2631         <tr>
2632           <td class="md" nowrap align="right"></td>
2633           <td class="md"></td>
2634           <td class="md" nowrap>int&nbsp;</td>
2635           <td class="mdname" nowrap> <em>localport</em></td>
2636         </tr>
2637         <tr>
2638           <td class="md"></td>
2639           <td class="md">)&nbsp;</td>
2640           <td class="md" colspan="2"><code> [virtual]</code></td>
2641         </tr>
2642       </table>
2643     </td>
2644   </tr>
2645 </table>
2646 <table cellspacing="5" cellpadding="0" border="0">
2647   <tr>
2648     <td>
2649       &nbsp;
2650     </td>
2651     <td>
2652
2653 <p>
2654 Called immediately after any connection is accepted.
2655 <p>
2656 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. <dl compact><dt><b>Parameters:</b></dt><dd>
2657   <table border="0" cellspacing="2" cellpadding="0">
2658     <tr><td valign="top"></td><td valign="top"><em>fd</em>&nbsp;</td><td>The file descriptor returned from accept() </td></tr>
2659     <tr><td valign="top"></td><td valign="top"><em>ip</em>&nbsp;</td><td>The IP address of the connecting user </td></tr>
2660     <tr><td valign="top"></td><td valign="top"><em>localport</em>&nbsp;</td><td>The local port number the user connected to</td></tr>
2661   </table>
2662 </dl>
2663
2664 <p>
2665 Definition at line <a class="el" href="modules_8cpp-source.html#l00268">268</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00268"></a>00268 { };
2666 </pre></div>
2667 <p>
2668     </td>
2669   </tr>
2670 </table>
2671 <a class="anchor" name="OnRawSocketClose_28int_20fd_29"></a><!-- doxytag: member="Module::OnRawSocketClose" ref="OnRawSocketClose_28int_20fd_29" args="(int fd)" --><p>
2672 <table class="mdTable" cellpadding="2" cellspacing="0">
2673   <tr>
2674     <td class="mdRow">
2675       <table cellpadding="0" cellspacing="0" border="0">
2676         <tr>
2677           <td class="md" nowrap valign="top">void Module::OnRawSocketClose           </td>
2678           <td class="md" valign="top">(&nbsp;</td>
2679           <td class="md" nowrap valign="top">int&nbsp;</td>
2680           <td class="mdname1" valign="top" nowrap> <em>fd</em>          </td>
2681           <td class="md" valign="top">&nbsp;)&nbsp;</td>
2682           <td class="md" nowrap><code> [virtual]</code></td>
2683         </tr>
2684       </table>
2685     </td>
2686   </tr>
2687 </table>
2688 <table cellspacing="5" cellpadding="0" border="0">
2689   <tr>
2690     <td>
2691       &nbsp;
2692     </td>
2693     <td>
2694
2695 <p>
2696 Called immediately before any socket is closed.
2697 <p>
2698 When this event is called, shutdown() has not yet been called on the socket. <dl compact><dt><b>Parameters:</b></dt><dd>
2699   <table border="0" cellspacing="2" cellpadding="0">
2700     <tr><td valign="top"></td><td valign="top"><em>fd</em>&nbsp;</td><td>The file descriptor of the socket prior to close()</td></tr>
2701   </table>
2702 </dl>
2703
2704 <p>
2705 Definition at line <a class="el" href="modules_8cpp-source.html#l00270">270</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
2706 <p>
2707 Referenced by <a class="el" href="users_8cpp-source.html#l00349">kill_link()</a>, and <a class="el" href="users_8cpp-source.html#l00412">kill_link_silent()</a>.<div class="fragment"><pre class="fragment"><a name="l00270"></a>00270 { };
2708 </pre></div>
2709 <p>
2710     </td>
2711   </tr>
2712 </table>
2713 <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>
2714 <table class="mdTable" cellpadding="2" cellspacing="0">
2715   <tr>
2716     <td class="mdRow">
2717       <table cellpadding="0" cellspacing="0" border="0">
2718         <tr>
2719           <td class="md" nowrap valign="top">int Module::OnRawSocketRead           </td>
2720           <td class="md" valign="top">(&nbsp;</td>
2721           <td class="md" nowrap valign="top">int&nbsp;</td>
2722           <td class="mdname" nowrap> <em>fd</em>, </td>
2723         </tr>
2724         <tr>
2725           <td class="md" nowrap align="right"></td>
2726           <td class="md"></td>
2727           <td class="md" nowrap>char *&nbsp;</td>
2728           <td class="mdname" nowrap> <em>buffer</em>, </td>
2729         </tr>
2730         <tr>
2731           <td class="md" nowrap align="right"></td>
2732           <td class="md"></td>
2733           <td class="md" nowrap>unsigned int&nbsp;</td>
2734           <td class="mdname" nowrap> <em>count</em>, </td>
2735         </tr>
2736         <tr>
2737           <td class="md" nowrap align="right"></td>
2738           <td class="md"></td>
2739           <td class="md" nowrap>int &amp;&nbsp;</td>
2740           <td class="mdname" nowrap> <em>readresult</em></td>
2741         </tr>
2742         <tr>
2743           <td class="md"></td>
2744           <td class="md">)&nbsp;</td>
2745           <td class="md" colspan="2"><code> [virtual]</code></td>
2746         </tr>
2747       </table>
2748     </td>
2749   </tr>
2750 </table>
2751 <table cellspacing="5" cellpadding="0" border="0">
2752   <tr>
2753     <td>
2754       &nbsp;
2755     </td>
2756     <td>
2757
2758 <p>
2759 Called immediately before any read() operation on a client socket in the core.
2760 <p>
2761 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. <dl compact><dt><b>Parameters:</b></dt><dd>
2762   <table border="0" cellspacing="2" cellpadding="0">
2763     <tr><td valign="top"></td><td valign="top"><em>fd</em>&nbsp;</td><td>The file descriptor of the socket </td></tr>
2764     <tr><td valign="top"></td><td valign="top"><em>buffer</em>&nbsp;</td><td>A char* buffer being read to </td></tr>
2765     <tr><td valign="top"></td><td valign="top"><em>count</em>&nbsp;</td><td>The size of the buffer </td></tr>
2766     <tr><td valign="top"></td><td valign="top"><em>readresult</em>&nbsp;</td><td>The amount of characters read, or 0 </td></tr>
2767   </table>
2768 </dl>
2769 <dl compact><dt><b>Returns:</b></dt><dd>nonzero if the event was handled, in which case readresult must be valid on exit</dd></dl>
2770
2771 <p>
2772 Definition at line <a class="el" href="modules_8cpp-source.html#l00271">271</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00271"></a>00271 { <span class="keywordflow">return</span> 0; };
2773 </pre></div>
2774 <p>
2775     </td>
2776   </tr>
2777 </table>
2778 <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>
2779 <table class="mdTable" cellpadding="2" cellspacing="0">
2780   <tr>
2781     <td class="mdRow">
2782       <table cellpadding="0" cellspacing="0" border="0">
2783         <tr>
2784           <td class="md" nowrap valign="top">int Module::OnRawSocketWrite           </td>
2785           <td class="md" valign="top">(&nbsp;</td>
2786           <td class="md" nowrap valign="top">int&nbsp;</td>
2787           <td class="mdname" nowrap> <em>fd</em>, </td>
2788         </tr>
2789         <tr>
2790           <td class="md" nowrap align="right"></td>
2791           <td class="md"></td>
2792           <td class="md" nowrap>char *&nbsp;</td>
2793           <td class="mdname" nowrap> <em>buffer</em>, </td>
2794         </tr>
2795         <tr>
2796           <td class="md" nowrap align="right"></td>
2797           <td class="md"></td>
2798           <td class="md" nowrap>int&nbsp;</td>
2799           <td class="mdname" nowrap> <em>count</em></td>
2800         </tr>
2801         <tr>
2802           <td class="md"></td>
2803           <td class="md">)&nbsp;</td>
2804           <td class="md" colspan="2"><code> [virtual]</code></td>
2805         </tr>
2806       </table>
2807     </td>
2808   </tr>
2809 </table>
2810 <table cellspacing="5" cellpadding="0" border="0">
2811   <tr>
2812     <td>
2813       &nbsp;
2814     </td>
2815     <td>
2816
2817 <p>
2818 Called immediately before any write() operation on a user's socket in the core.
2819 <p>
2820 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(). <dl compact><dt><b>Parameters:</b></dt><dd>
2821   <table border="0" cellspacing="2" cellpadding="0">
2822     <tr><td valign="top"></td><td valign="top"><em>fd</em>&nbsp;</td><td>The file descriptor of the socket </td></tr>
2823     <tr><td valign="top"></td><td valign="top"><em>buffer</em>&nbsp;</td><td>A char* buffer being written </td></tr>
2824     <tr><td valign="top"></td><td valign="top"><em>Number</em>&nbsp;</td><td>of characters to write </td></tr>
2825   </table>
2826 </dl>
2827 <dl compact><dt><b>Returns:</b></dt><dd>Number of characters actually written or 0 if you didn't handle the operation</dd></dl>
2828
2829 <p>
2830 Definition at line <a class="el" href="modules_8cpp-source.html#l00269">269</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00269"></a>00269 { <span class="keywordflow">return</span> 0; };
2831 </pre></div>
2832 <p>
2833     </td>
2834   </tr>
2835 </table>
2836 <a class="anchor" name="OnRehash_28std_3A_3Astring_20parameter_29"></a><!-- doxytag: member="Module::OnRehash" ref="OnRehash_28std_3A_3Astring_20parameter_29" args="(std::string parameter)" --><p>
2837 <table class="mdTable" cellpadding="2" cellspacing="0">
2838   <tr>
2839     <td class="mdRow">
2840       <table cellpadding="0" cellspacing="0" border="0">
2841         <tr>
2842           <td class="md" nowrap valign="top">void Module::OnRehash           </td>
2843           <td class="md" valign="top">(&nbsp;</td>
2844           <td class="md" nowrap valign="top"><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
2845           <td class="mdname1" valign="top" nowrap> <em>parameter</em>          </td>
2846           <td class="md" valign="top">&nbsp;)&nbsp;</td>
2847           <td class="md" nowrap><code> [virtual]</code></td>
2848         </tr>
2849       </table>
2850     </td>
2851   </tr>
2852 </table>
2853 <table cellspacing="5" cellpadding="0" border="0">
2854   <tr>
2855     <td>
2856       &nbsp;
2857     </td>
2858     <td>
2859
2860 <p>
2861 Called on rehash.
2862 <p>
2863 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. If a parameter is given, the core has done nothing. The module receiving the event can decide if this parameter has any relevence to it. <dl compact><dt><b>Parameters:</b></dt><dd>
2864   <table border="0" cellspacing="2" cellpadding="0">
2865     <tr><td valign="top"></td><td valign="top"><em>parameter</em>&nbsp;</td><td>The (optional) parameter given to REHASH from the user.</td></tr>
2866   </table>
2867 </dl>
2868
2869 <p>
2870 Definition at line <a class="el" href="modules_8cpp-source.html#l00226">226</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00226"></a>00226 { }
2871 </pre></div>
2872 <p>
2873     </td>
2874   </tr>
2875 </table>
2876 <a class="anchor" name="OnRemoteKill_28userrec_20_2Asource_2C_20userrec_20_2Adest_2C_20std_3A_3Astring_20reason_29"></a><!-- doxytag: member="Module::OnRemoteKill" ref="OnRemoteKill_28userrec_20_2Asource_2C_20userrec_20_2Adest_2C_20std_3A_3Astring_20reason_29" args="(userrec *source, userrec *dest, std::string reason)" --><p>
2877 <table class="mdTable" cellpadding="2" cellspacing="0">
2878   <tr>
2879     <td class="mdRow">
2880       <table cellpadding="0" cellspacing="0" border="0">
2881         <tr>
2882           <td class="md" nowrap valign="top">void Module::OnRemoteKill           </td>
2883           <td class="md" valign="top">(&nbsp;</td>
2884           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
2885           <td class="mdname" nowrap> <em>source</em>, </td>
2886         </tr>
2887         <tr>
2888           <td class="md" nowrap align="right"></td>
2889           <td class="md"></td>
2890           <td class="md" nowrap><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
2891           <td class="mdname" nowrap> <em>dest</em>, </td>
2892         </tr>
2893         <tr>
2894           <td class="md" nowrap align="right"></td>
2895           <td class="md"></td>
2896           <td class="md" nowrap><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
2897           <td class="mdname" nowrap> <em>reason</em></td>
2898         </tr>
2899         <tr>
2900           <td class="md"></td>
2901           <td class="md">)&nbsp;</td>
2902           <td class="md" colspan="2"><code> [virtual]</code></td>
2903         </tr>
2904       </table>
2905     </td>
2906   </tr>
2907 </table>
2908 <table cellspacing="5" cellpadding="0" border="0">
2909   <tr>
2910     <td>
2911       &nbsp;
2912     </td>
2913     <td>
2914
2915 <p>
2916 Called when an oper wants to disconnect a remote user via KILL.
2917 <p>
2918 <dl compact><dt><b>Parameters:</b></dt><dd>
2919   <table border="0" cellspacing="2" cellpadding="0">
2920     <tr><td valign="top"></td><td valign="top"><em>source</em>&nbsp;</td><td>The user sending the KILL </td></tr>
2921     <tr><td valign="top"></td><td valign="top"><em>dest</em>&nbsp;</td><td>The user being killed </td></tr>
2922     <tr><td valign="top"></td><td valign="top"><em>reason</em>&nbsp;</td><td>The kill reason</td></tr>
2923   </table>
2924 </dl>
2925
2926 <p>
2927 Definition at line <a class="el" href="modules_8cpp-source.html#l00274">274</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00274"></a>00274 { };
2928 </pre></div>
2929 <p>
2930     </td>
2931   </tr>
2932 </table>
2933 <a class="anchor" name="OnRequest_28Request_20_2Arequest_29"></a><!-- doxytag: member="Module::OnRequest" ref="OnRequest_28Request_20_2Arequest_29" args="(Request *request)" --><p>
2934 <table class="mdTable" cellpadding="2" cellspacing="0">
2935   <tr>
2936     <td class="mdRow">
2937       <table cellpadding="0" cellspacing="0" border="0">
2938         <tr>
2939           <td class="md" nowrap valign="top">char * Module::OnRequest           </td>
2940           <td class="md" valign="top">(&nbsp;</td>
2941           <td class="md" nowrap valign="top"><a class="el" href="classRequest.html">Request</a> *&nbsp;</td>
2942           <td class="mdname1" valign="top" nowrap> <em>request</em>          </td>
2943           <td class="md" valign="top">&nbsp;)&nbsp;</td>
2944           <td class="md" nowrap><code> [virtual]</code></td>
2945         </tr>
2946       </table>
2947     </td>
2948   </tr>
2949 </table>
2950 <table cellspacing="5" cellpadding="0" border="0">
2951   <tr>
2952     <td>
2953       &nbsp;
2954     </td>
2955     <td>
2956
2957 <p>
2958 Called whenever a <a class="el" href="classRequest.html">Request</a> class is sent to your module by another module.
2959 <p>
2960 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). <dl compact><dt><b>Parameters:</b></dt><dd>
2961   <table border="0" cellspacing="2" cellpadding="0">
2962     <tr><td valign="top"></td><td valign="top"><em>request</em>&nbsp;</td><td>The <a class="el" href="classRequest.html">Request</a> class being received</td></tr>
2963   </table>
2964 </dl>
2965
2966 <p>
2967 Definition at line <a class="el" href="modules_8cpp-source.html#l00262">262</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
2968 <p>
2969 Referenced by <a class="el" href="modules_8cpp-source.html#l00181">Request::Send()</a>.<div class="fragment"><pre class="fragment"><a name="l00262"></a>00262 { <span class="keywordflow">return</span> NULL; };
2970 </pre></div>
2971 <p>
2972     </td>
2973   </tr>
2974 </table>
2975 <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>
2976 <table class="mdTable" cellpadding="2" cellspacing="0">
2977   <tr>
2978     <td class="mdRow">
2979       <table cellpadding="0" cellspacing="0" border="0">
2980         <tr>
2981           <td class="md" nowrap valign="top">void Module::OnSendList           </td>
2982           <td class="md" valign="top">(&nbsp;</td>
2983           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
2984           <td class="mdname" nowrap> <em>user</em>, </td>
2985         </tr>
2986         <tr>
2987           <td class="md" nowrap align="right"></td>
2988           <td class="md"></td>
2989           <td class="md" nowrap><a class="el" href="classchanrec.html">chanrec</a> *&nbsp;</td>
2990           <td class="mdname" nowrap> <em>channel</em>, </td>
2991         </tr>
2992         <tr>
2993           <td class="md" nowrap align="right"></td>
2994           <td class="md"></td>
2995           <td class="md" nowrap>char&nbsp;</td>
2996           <td class="mdname" nowrap> <em>mode</em></td>
2997         </tr>
2998         <tr>
2999           <td class="md"></td>
3000           <td class="md">)&nbsp;</td>
3001           <td class="md" colspan="2"><code> [virtual]</code></td>
3002         </tr>
3003       </table>
3004     </td>
3005   </tr>
3006 </table>
3007 <table cellspacing="5" cellpadding="0" border="0">
3008   <tr>
3009     <td>
3010       &nbsp;
3011     </td>
3012     <td>
3013
3014 <p>
3015 Called whenever a list is needed for a listmode.
3016 <p>
3017 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. <dl compact><dt><b>Parameters:</b></dt><dd>
3018   <table border="0" cellspacing="2" cellpadding="0">
3019     <tr><td valign="top"></td><td valign="top"><em>user</em>&nbsp;</td><td>The user requesting the list </td></tr>
3020     <tr><td valign="top"></td><td valign="top"><em>channel</em>&nbsp;</td><td>The channel the list is for </td></tr>
3021     <tr><td valign="top"></td><td valign="top"><em>mode</em>&nbsp;</td><td>The listmode which a list is being requested on</td></tr>
3022   </table>
3023 </dl>
3024
3025 <p>
3026 Definition at line <a class="el" href="modules_8cpp-source.html#l00246">246</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00246"></a>00246 { };
3027 </pre></div>
3028 <p>
3029     </td>
3030   </tr>
3031 </table>
3032 <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>
3033 <table class="mdTable" cellpadding="2" cellspacing="0">
3034   <tr>
3035     <td class="mdRow">
3036       <table cellpadding="0" cellspacing="0" border="0">
3037         <tr>
3038           <td class="md" nowrap valign="top">void Module::OnServerRaw           </td>
3039           <td class="md" valign="top">(&nbsp;</td>
3040           <td class="md" nowrap valign="top"><a class="el" href="namespaceirc.html#string">std::string</a> &amp;&nbsp;</td>
3041           <td class="mdname" nowrap> <em>raw</em>, </td>
3042         </tr>
3043         <tr>
3044           <td class="md" nowrap align="right"></td>
3045           <td class="md"></td>
3046           <td class="md" nowrap>bool&nbsp;</td>
3047           <td class="mdname" nowrap> <em>inbound</em>, </td>
3048         </tr>
3049         <tr>
3050           <td class="md" nowrap align="right"></td>
3051           <td class="md"></td>
3052           <td class="md" nowrap><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
3053           <td class="mdname" nowrap> <em>user</em></td>
3054         </tr>
3055         <tr>
3056           <td class="md"></td>
3057           <td class="md">)&nbsp;</td>
3058           <td class="md" colspan="2"><code> [virtual]</code></td>
3059         </tr>
3060       </table>
3061     </td>
3062   </tr>
3063 </table>
3064 <table cellspacing="5" cellpadding="0" border="0">
3065   <tr>
3066     <td>
3067       &nbsp;
3068     </td>
3069     <td>
3070
3071 <p>
3072 Called when a raw command is transmitted or received.
3073 <p>
3074 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. <dl compact><dt><b>Parameters:</b></dt><dd>
3075   <table border="0" cellspacing="2" cellpadding="0">
3076     <tr><td valign="top"></td><td valign="top"><em>raw</em>&nbsp;</td><td>The raw string in RFC1459 format </td></tr>
3077     <tr><td valign="top"></td><td valign="top"><em>inbound</em>&nbsp;</td><td>A flag to indicate wether the data is coming into the daemon or going out to the user </td></tr>
3078     <tr><td valign="top"></td><td valign="top"><em>user</em>&nbsp;</td><td>The user record sending the text, when inbound == true.</td></tr>
3079   </table>
3080 </dl>
3081
3082 <p>
3083 Definition at line <a class="el" href="modules_8cpp-source.html#l00227">227</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00227"></a>00227 { }
3084 </pre></div>
3085 <p>
3086     </td>
3087   </tr>
3088 </table>
3089 <a class="anchor" name="OnStats_28char_20symbol_29"></a><!-- doxytag: member="Module::OnStats" ref="OnStats_28char_20symbol_29" args="(char symbol)" --><p>
3090 <table class="mdTable" cellpadding="2" cellspacing="0">
3091   <tr>
3092     <td class="mdRow">
3093       <table cellpadding="0" cellspacing="0" border="0">
3094         <tr>
3095           <td class="md" nowrap valign="top">void Module::OnStats           </td>
3096           <td class="md" valign="top">(&nbsp;</td>
3097           <td class="md" nowrap valign="top">char&nbsp;</td>
3098           <td class="mdname1" valign="top" nowrap> <em>symbol</em>          </td>
3099           <td class="md" valign="top">&nbsp;)&nbsp;</td>
3100           <td class="md" nowrap><code> [virtual]</code></td>
3101         </tr>
3102       </table>
3103     </td>
3104   </tr>
3105 </table>
3106 <table cellspacing="5" cellpadding="0" border="0">
3107   <tr>
3108     <td>
3109       &nbsp;
3110     </td>
3111     <td>
3112
3113 <p>
3114 Called on all /STATS commands This method is triggered for all /STATS use, including stats symbols handled by the core.
3115 <p>
3116 <dl compact><dt><b>Parameters:</b></dt><dd>
3117   <table border="0" cellspacing="2" cellpadding="0">
3118     <tr><td valign="top"></td><td valign="top"><em>symbol</em>&nbsp;</td><td>the symbol provided to /STATS</td></tr>
3119   </table>
3120 </dl>
3121
3122 <p>
3123 Definition at line <a class="el" href="modules_8cpp-source.html#l00257">257</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00257"></a>00257 { };
3124 </pre></div>
3125 <p>
3126     </td>
3127   </tr>
3128 </table>
3129 <a class="anchor" name="OnSyncChannel_28chanrec_20_2Achan_2C_20Module_20_2Aproto_2C_20void_20_2Aopaque_29"></a><!-- doxytag: member="Module::OnSyncChannel" ref="OnSyncChannel_28chanrec_20_2Achan_2C_20Module_20_2Aproto_2C_20void_20_2Aopaque_29" args="(chanrec *chan, Module *proto, void *opaque)" --><p>
3130 <table class="mdTable" cellpadding="2" cellspacing="0">
3131   <tr>
3132     <td class="mdRow">
3133       <table cellpadding="0" cellspacing="0" border="0">
3134         <tr>
3135           <td class="md" nowrap valign="top">void Module::OnSyncChannel           </td>
3136           <td class="md" valign="top">(&nbsp;</td>
3137           <td class="md" nowrap valign="top"><a class="el" href="classchanrec.html">chanrec</a> *&nbsp;</td>
3138           <td class="mdname" nowrap> <em>chan</em>, </td>
3139         </tr>
3140         <tr>
3141           <td class="md" nowrap align="right"></td>
3142           <td class="md"></td>
3143           <td class="md" nowrap><a class="el" href="classModule.html">Module</a> *&nbsp;</td>
3144           <td class="mdname" nowrap> <em>proto</em>, </td>
3145         </tr>
3146         <tr>
3147           <td class="md" nowrap align="right"></td>
3148           <td class="md"></td>
3149           <td class="md" nowrap>void *&nbsp;</td>
3150           <td class="mdname" nowrap> <em>opaque</em></td>
3151         </tr>
3152         <tr>
3153           <td class="md"></td>
3154           <td class="md">)&nbsp;</td>
3155           <td class="md" colspan="2"><code> [virtual]</code></td>
3156         </tr>
3157       </table>
3158     </td>
3159   </tr>
3160 </table>
3161 <table cellspacing="5" cellpadding="0" border="0">
3162   <tr>
3163     <td>
3164       &nbsp;
3165     </td>
3166     <td>
3167
3168 <p>
3169 Allows modules to synchronize data which relates to channels during a netburst.
3170 <p>
3171 When this function is called, it will be called from the module which implements the linking protocol. This currently is m_spanningtree.so. A pointer to this module is given in Module* proto, so that you may call its methods such as ProtoSendMode (see below). This function will be called for every user visible on your side of the burst, allowing you to for example set modes, etc. Do not use this call to synchronize data which you have stored using class <a class="el" href="classExtensible.html">Extensible</a> -- There is a specialist function OnSyncUserMetaData and OnSyncChannelMetaData for this!<p>
3172 For a good example of how to use this function, please see src/modules/m_chanprotect.cpp<p>
3173 <dl compact><dt><b>Parameters:</b></dt><dd>
3174   <table border="0" cellspacing="2" cellpadding="0">
3175     <tr><td valign="top"></td><td valign="top"><em>chan</em>&nbsp;</td><td>The channel being syncronized </td></tr>
3176     <tr><td valign="top"></td><td valign="top"><em>proto</em>&nbsp;</td><td>A pointer to the module handling network protocol </td></tr>
3177     <tr><td valign="top"></td><td valign="top"><em>opaque</em>&nbsp;</td><td>An opaque pointer set by the protocol module, should not be modified!</td></tr>
3178   </table>
3179 </dl>
3180
3181 <p>
3182 Definition at line <a class="el" href="modules_8cpp-source.html#l00279">279</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00279"></a>00279 { };
3183 </pre></div>
3184 <p>
3185     </td>
3186   </tr>
3187 </table>
3188 <a class="anchor" name="OnSyncChannelMetaData_28chanrec_20_2Achan_2C_20Module_20_2Aproto_2C_20void_20_2Aopaque_2C_20std_3A_3Astring_20extname_29"></a><!-- doxytag: member="Module::OnSyncChannelMetaData" ref="OnSyncChannelMetaData_28chanrec_20_2Achan_2C_20Module_20_2Aproto_2C_20void_20_2Aopaque_2C_20std_3A_3Astring_20extname_29" args="(chanrec *chan, Module *proto, void *opaque, std::string extname)" --><p>
3189 <table class="mdTable" cellpadding="2" cellspacing="0">
3190   <tr>
3191     <td class="mdRow">
3192       <table cellpadding="0" cellspacing="0" border="0">
3193         <tr>
3194           <td class="md" nowrap valign="top">void Module::OnSyncChannelMetaData           </td>
3195           <td class="md" valign="top">(&nbsp;</td>
3196           <td class="md" nowrap valign="top"><a class="el" href="classchanrec.html">chanrec</a> *&nbsp;</td>
3197           <td class="mdname" nowrap> <em>chan</em>, </td>
3198         </tr>
3199         <tr>
3200           <td class="md" nowrap align="right"></td>
3201           <td class="md"></td>
3202           <td class="md" nowrap><a class="el" href="classModule.html">Module</a> *&nbsp;</td>
3203           <td class="mdname" nowrap> <em>proto</em>, </td>
3204         </tr>
3205         <tr>
3206           <td class="md" nowrap align="right"></td>
3207           <td class="md"></td>
3208           <td class="md" nowrap>void *&nbsp;</td>
3209           <td class="mdname" nowrap> <em>opaque</em>, </td>
3210         </tr>
3211         <tr>
3212           <td class="md" nowrap align="right"></td>
3213           <td class="md"></td>
3214           <td class="md" nowrap><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
3215           <td class="mdname" nowrap> <em>extname</em></td>
3216         </tr>
3217         <tr>
3218           <td class="md"></td>
3219           <td class="md">)&nbsp;</td>
3220           <td class="md" colspan="2"><code> [virtual]</code></td>
3221         </tr>
3222       </table>
3223     </td>
3224   </tr>
3225 </table>
3226 <table cellspacing="5" cellpadding="0" border="0">
3227   <tr>
3228     <td>
3229       &nbsp;
3230     </td>
3231     <td>
3232
3233 <p>
3234
3235 <p>
3236 Definition at line <a class="el" href="modules_8cpp-source.html#l00281">281</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00281"></a>00281 { };
3237 </pre></div>
3238 <p>
3239     </td>
3240   </tr>
3241 </table>
3242 <a class="anchor" name="OnSyncUser_28userrec_20_2Auser_2C_20Module_20_2Aproto_2C_20void_20_2Aopaque_29"></a><!-- doxytag: member="Module::OnSyncUser" ref="OnSyncUser_28userrec_20_2Auser_2C_20Module_20_2Aproto_2C_20void_20_2Aopaque_29" args="(userrec *user, Module *proto, void *opaque)" --><p>
3243 <table class="mdTable" cellpadding="2" cellspacing="0">
3244   <tr>
3245     <td class="mdRow">
3246       <table cellpadding="0" cellspacing="0" border="0">
3247         <tr>
3248           <td class="md" nowrap valign="top">void Module::OnSyncUser           </td>
3249           <td class="md" valign="top">(&nbsp;</td>
3250           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
3251           <td class="mdname" nowrap> <em>user</em>, </td>
3252         </tr>
3253         <tr>
3254           <td class="md" nowrap align="right"></td>
3255           <td class="md"></td>
3256           <td class="md" nowrap><a class="el" href="classModule.html">Module</a> *&nbsp;</td>
3257           <td class="mdname" nowrap> <em>proto</em>, </td>
3258         </tr>
3259         <tr>
3260           <td class="md" nowrap align="right"></td>
3261           <td class="md"></td>
3262           <td class="md" nowrap>void *&nbsp;</td>
3263           <td class="mdname" nowrap> <em>opaque</em></td>
3264         </tr>
3265         <tr>
3266           <td class="md"></td>
3267           <td class="md">)&nbsp;</td>
3268           <td class="md" colspan="2"><code> [virtual]</code></td>
3269         </tr>
3270       </table>
3271     </td>
3272   </tr>
3273 </table>
3274 <table cellspacing="5" cellpadding="0" border="0">
3275   <tr>
3276     <td>
3277       &nbsp;
3278     </td>
3279     <td>
3280
3281 <p>
3282 Allows modules to synchronize data which relates to users during a netburst.
3283 <p>
3284 When this function is called, it will be called from the module which implements the linking protocol. This currently is m_spanningtree.so. A pointer to this module is given in Module* proto, so that you may call its methods such as ProtoSendMode (see below). This function will be called for every user visible on your side of the burst, allowing you to for example set modes, etc. Do not use this call to synchronize data which you have stored using class <a class="el" href="classExtensible.html">Extensible</a> -- There is a specialist function OnSyncUserMetaData and OnSyncChannelMetaData for this! <dl compact><dt><b>Parameters:</b></dt><dd>
3285   <table border="0" cellspacing="2" cellpadding="0">
3286     <tr><td valign="top"></td><td valign="top"><em>user</em>&nbsp;</td><td>The user being syncronized </td></tr>
3287     <tr><td valign="top"></td><td valign="top"><em>proto</em>&nbsp;</td><td>A pointer to the module handling network protocol </td></tr>
3288     <tr><td valign="top"></td><td valign="top"><em>opaque</em>&nbsp;</td><td>An opaque pointer set by the protocol module, should not be modified!</td></tr>
3289   </table>
3290 </dl>
3291
3292 <p>
3293 Definition at line <a class="el" href="modules_8cpp-source.html#l00278">278</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00278"></a>00278 { };
3294 </pre></div>
3295 <p>
3296     </td>
3297   </tr>
3298 </table>
3299 <a class="anchor" name="OnSyncUserMetaData_28userrec_20_2Auser_2C_20Module_20_2Aproto_2C_20void_20_2Aopaque_2C_20std_3A_3Astring_20extname_29"></a><!-- doxytag: member="Module::OnSyncUserMetaData" ref="OnSyncUserMetaData_28userrec_20_2Auser_2C_20Module_20_2Aproto_2C_20void_20_2Aopaque_2C_20std_3A_3Astring_20extname_29" args="(userrec *user, Module *proto, void *opaque, std::string extname)" --><p>
3300 <table class="mdTable" cellpadding="2" cellspacing="0">
3301   <tr>
3302     <td class="mdRow">
3303       <table cellpadding="0" cellspacing="0" border="0">
3304         <tr>
3305           <td class="md" nowrap valign="top">void Module::OnSyncUserMetaData           </td>
3306           <td class="md" valign="top">(&nbsp;</td>
3307           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
3308           <td class="mdname" nowrap> <em>user</em>, </td>
3309         </tr>
3310         <tr>
3311           <td class="md" nowrap align="right"></td>
3312           <td class="md"></td>
3313           <td class="md" nowrap><a class="el" href="classModule.html">Module</a> *&nbsp;</td>
3314           <td class="mdname" nowrap> <em>proto</em>, </td>
3315         </tr>
3316         <tr>
3317           <td class="md" nowrap align="right"></td>
3318           <td class="md"></td>
3319           <td class="md" nowrap>void *&nbsp;</td>
3320           <td class="mdname" nowrap> <em>opaque</em>, </td>
3321         </tr>
3322         <tr>
3323           <td class="md" nowrap align="right"></td>
3324           <td class="md"></td>
3325           <td class="md" nowrap><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
3326           <td class="mdname" nowrap> <em>extname</em></td>
3327         </tr>
3328         <tr>
3329           <td class="md"></td>
3330           <td class="md">)&nbsp;</td>
3331           <td class="md" colspan="2"><code> [virtual]</code></td>
3332         </tr>
3333       </table>
3334     </td>
3335   </tr>
3336 </table>
3337 <table cellspacing="5" cellpadding="0" border="0">
3338   <tr>
3339     <td>
3340       &nbsp;
3341     </td>
3342     <td>
3343
3344 <p>
3345
3346 <p>
3347 Definition at line <a class="el" href="modules_8cpp-source.html#l00282">282</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00282"></a>00282 { };
3348 </pre></div>
3349 <p>
3350     </td>
3351   </tr>
3352 </table>
3353 <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>
3354 <table class="mdTable" cellpadding="2" cellspacing="0">
3355   <tr>
3356     <td class="mdRow">
3357       <table cellpadding="0" cellspacing="0" border="0">
3358         <tr>
3359           <td class="md" nowrap valign="top">void Module::OnUnloadModule           </td>
3360           <td class="md" valign="top">(&nbsp;</td>
3361           <td class="md" nowrap valign="top"><a class="el" href="classModule.html">Module</a> *&nbsp;</td>
3362           <td class="mdname" nowrap> <em>mod</em>, </td>
3363         </tr>
3364         <tr>
3365           <td class="md" nowrap align="right"></td>
3366           <td class="md"></td>
3367           <td class="md" nowrap><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
3368           <td class="mdname" nowrap> <em>name</em></td>
3369         </tr>
3370         <tr>
3371           <td class="md"></td>
3372           <td class="md">)&nbsp;</td>
3373           <td class="md" colspan="2"><code> [virtual]</code></td>
3374         </tr>
3375       </table>
3376     </td>
3377   </tr>
3378 </table>
3379 <table cellspacing="5" cellpadding="0" border="0">
3380   <tr>
3381     <td>
3382       &nbsp;
3383     </td>
3384     <td>
3385
3386 <p>
3387 Called whenever a module is unloaded.
3388 <p>
3389 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). <dl compact><dt><b>Parameters:</b></dt><dd>
3390   <table border="0" cellspacing="2" cellpadding="0">
3391     <tr><td valign="top"></td><td valign="top"><em>mod</em>&nbsp;</td><td>Pointer to the module being unloaded (still valid) </td></tr>
3392     <tr><td valign="top"></td><td valign="top"><em>name</em>&nbsp;</td><td>The filename of the module being unloaded</td></tr>
3393   </table>
3394 </dl>
3395
3396 <p>
3397 Definition at line <a class="el" href="modules_8cpp-source.html#l00244">244</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00244"></a>00244 { };
3398 </pre></div>
3399 <p>
3400     </td>
3401   </tr>
3402 </table>
3403 <a class="anchor" name="OnUserConnect_28userrec_20_2Auser_29"></a><!-- doxytag: member="Module::OnUserConnect" ref="OnUserConnect_28userrec_20_2Auser_29" args="(userrec *user)" --><p>
3404 <table class="mdTable" cellpadding="2" cellspacing="0">
3405   <tr>
3406     <td class="mdRow">
3407       <table cellpadding="0" cellspacing="0" border="0">
3408         <tr>
3409           <td class="md" nowrap valign="top">void Module::OnUserConnect           </td>
3410           <td class="md" valign="top">(&nbsp;</td>
3411           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
3412           <td class="mdname1" valign="top" nowrap> <em>user</em>          </td>
3413           <td class="md" valign="top">&nbsp;)&nbsp;</td>
3414           <td class="md" nowrap><code> [virtual]</code></td>
3415         </tr>
3416       </table>
3417     </td>
3418   </tr>
3419 </table>
3420 <table cellspacing="5" cellpadding="0" border="0">
3421   <tr>
3422     <td>
3423       &nbsp;
3424     </td>
3425     <td>
3426
3427 <p>
3428 Called when a user connects.
3429 <p>
3430 The details of the connecting user are available to you in the parameter userrec *user <dl compact><dt><b>Parameters:</b></dt><dd>
3431   <table border="0" cellspacing="2" cellpadding="0">
3432     <tr><td valign="top"></td><td valign="top"><em>user</em>&nbsp;</td><td>The user who is connecting</td></tr>
3433   </table>
3434 </dl>
3435
3436 <p>
3437 Definition at line <a class="el" href="modules_8cpp-source.html#l00221">221</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00221"></a>00221 { }
3438 </pre></div>
3439 <p>
3440     </td>
3441   </tr>
3442 </table>
3443 <a class="anchor" name="OnUserDisconnect_28userrec_20_2Auser_29"></a><!-- doxytag: member="Module::OnUserDisconnect" ref="OnUserDisconnect_28userrec_20_2Auser_29" args="(userrec *user)" --><p>
3444 <table class="mdTable" cellpadding="2" cellspacing="0">
3445   <tr>
3446     <td class="mdRow">
3447       <table cellpadding="0" cellspacing="0" border="0">
3448         <tr>
3449           <td class="md" nowrap valign="top">void Module::OnUserDisconnect           </td>
3450           <td class="md" valign="top">(&nbsp;</td>
3451           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
3452           <td class="mdname1" valign="top" nowrap> <em>user</em>          </td>
3453           <td class="md" valign="top">&nbsp;)&nbsp;</td>
3454           <td class="md" nowrap><code> [virtual]</code></td>
3455         </tr>
3456       </table>
3457     </td>
3458   </tr>
3459 </table>
3460 <table cellspacing="5" cellpadding="0" border="0">
3461   <tr>
3462     <td>
3463       &nbsp;
3464     </td>
3465     <td>
3466
3467 <p>
3468 Called whenever a user's socket is closed.
3469 <p>
3470 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. <dl compact><dt><b>Parameters:</b></dt><dd>
3471   <table border="0" cellspacing="2" cellpadding="0">
3472     <tr><td valign="top"></td><td valign="top"><em>user</em>&nbsp;</td><td>The user who is disconnecting</td></tr>
3473   </table>
3474 </dl>
3475
3476 <p>
3477 Definition at line <a class="el" href="modules_8cpp-source.html#l00223">223</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00223"></a>00223 { }
3478 </pre></div>
3479 <p>
3480     </td>
3481   </tr>
3482 </table>
3483 <a class="anchor" name="OnUserInvite_28userrec_20_2Asource_2C_20userrec_20_2Adest_2C_20chanrec_20_2Achannel_29"></a><!-- doxytag: member="Module::OnUserInvite" ref="OnUserInvite_28userrec_20_2Asource_2C_20userrec_20_2Adest_2C_20chanrec_20_2Achannel_29" args="(userrec *source, userrec *dest, chanrec *channel)" --><p>
3484 <table class="mdTable" cellpadding="2" cellspacing="0">
3485   <tr>
3486     <td class="mdRow">
3487       <table cellpadding="0" cellspacing="0" border="0">
3488         <tr>
3489           <td class="md" nowrap valign="top">void Module::OnUserInvite           </td>
3490           <td class="md" valign="top">(&nbsp;</td>
3491           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
3492           <td class="mdname" nowrap> <em>source</em>, </td>
3493         </tr>
3494         <tr>
3495           <td class="md" nowrap align="right"></td>
3496           <td class="md"></td>
3497           <td class="md" nowrap><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
3498           <td class="mdname" nowrap> <em>dest</em>, </td>
3499         </tr>
3500         <tr>
3501           <td class="md" nowrap align="right"></td>
3502           <td class="md"></td>
3503           <td class="md" nowrap><a class="el" href="classchanrec.html">chanrec</a> *&nbsp;</td>
3504           <td class="mdname" nowrap> <em>channel</em></td>
3505         </tr>
3506         <tr>
3507           <td class="md"></td>
3508           <td class="md">)&nbsp;</td>
3509           <td class="md" colspan="2"><code> [virtual]</code></td>
3510         </tr>
3511       </table>
3512     </td>
3513   </tr>
3514 </table>
3515 <table cellspacing="5" cellpadding="0" border="0">
3516   <tr>
3517     <td>
3518       &nbsp;
3519     </td>
3520     <td>
3521
3522 <p>
3523 Called after a user has been successfully invited to a channel.
3524 <p>
3525 You cannot prevent the invite from occuring using this function, to do that, use OnUserPreInvite instead. <dl compact><dt><b>Parameters:</b></dt><dd>
3526   <table border="0" cellspacing="2" cellpadding="0">
3527     <tr><td valign="top"></td><td valign="top"><em>source</em>&nbsp;</td><td>The user who is issuing the INVITE </td></tr>
3528     <tr><td valign="top"></td><td valign="top"><em>dest</em>&nbsp;</td><td>The user being invited </td></tr>
3529     <tr><td valign="top"></td><td valign="top"><em>channel</em>&nbsp;</td><td>The channel the user is being invited to</td></tr>
3530   </table>
3531 </dl>
3532
3533 <p>
3534 Definition at line <a class="el" href="modules_8cpp-source.html#l00275">275</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00275"></a>00275 { };
3535 </pre></div>
3536 <p>
3537     </td>
3538   </tr>
3539 </table>
3540 <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>
3541 <table class="mdTable" cellpadding="2" cellspacing="0">
3542   <tr>
3543     <td class="mdRow">
3544       <table cellpadding="0" cellspacing="0" border="0">
3545         <tr>
3546           <td class="md" nowrap valign="top">void Module::OnUserJoin           </td>
3547           <td class="md" valign="top">(&nbsp;</td>
3548           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
3549           <td class="mdname" nowrap> <em>user</em>, </td>
3550         </tr>
3551         <tr>
3552           <td class="md" nowrap align="right"></td>
3553           <td class="md"></td>
3554           <td class="md" nowrap><a class="el" href="classchanrec.html">chanrec</a> *&nbsp;</td>
3555           <td class="mdname" nowrap> <em>channel</em></td>
3556         </tr>
3557         <tr>
3558           <td class="md"></td>
3559           <td class="md">)&nbsp;</td>
3560           <td class="md" colspan="2"><code> [virtual]</code></td>
3561         </tr>
3562       </table>
3563     </td>
3564   </tr>
3565 </table>
3566 <table cellspacing="5" cellpadding="0" border="0">
3567   <tr>
3568     <td>
3569       &nbsp;
3570     </td>
3571     <td>
3572
3573 <p>
3574 Called when a user joins a channel.
3575 <p>
3576 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 <dl compact><dt><b>Parameters:</b></dt><dd>
3577   <table border="0" cellspacing="2" cellpadding="0">
3578     <tr><td valign="top"></td><td valign="top"><em>user</em>&nbsp;</td><td>The user who is joining </td></tr>
3579     <tr><td valign="top"></td><td valign="top"><em>channel</em>&nbsp;</td><td>The channel being joined</td></tr>
3580   </table>
3581 </dl>
3582
3583 <p>
3584 Definition at line <a class="el" href="modules_8cpp-source.html#l00224">224</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00224"></a>00224 { }
3585 </pre></div>
3586 <p>
3587     </td>
3588   </tr>
3589 </table>
3590 <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>
3591 <table class="mdTable" cellpadding="2" cellspacing="0">
3592   <tr>
3593     <td class="mdRow">
3594       <table cellpadding="0" cellspacing="0" border="0">
3595         <tr>
3596           <td class="md" nowrap valign="top">void Module::OnUserKick           </td>
3597           <td class="md" valign="top">(&nbsp;</td>
3598           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
3599           <td class="mdname" nowrap> <em>source</em>, </td>
3600         </tr>
3601         <tr>
3602           <td class="md" nowrap align="right"></td>
3603           <td class="md"></td>
3604           <td class="md" nowrap><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
3605           <td class="mdname" nowrap> <em>user</em>, </td>
3606         </tr>
3607         <tr>
3608           <td class="md" nowrap align="right"></td>
3609           <td class="md"></td>
3610           <td class="md" nowrap><a class="el" href="classchanrec.html">chanrec</a> *&nbsp;</td>
3611           <td class="mdname" nowrap> <em>chan</em>, </td>
3612         </tr>
3613         <tr>
3614           <td class="md" nowrap align="right"></td>
3615           <td class="md"></td>
3616           <td class="md" nowrap><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
3617           <td class="mdname" nowrap> <em>reason</em></td>
3618         </tr>
3619         <tr>
3620           <td class="md"></td>
3621           <td class="md">)&nbsp;</td>
3622           <td class="md" colspan="2"><code> [virtual]</code></td>
3623         </tr>
3624       </table>
3625     </td>
3626   </tr>
3627 </table>
3628 <table cellspacing="5" cellpadding="0" border="0">
3629   <tr>
3630     <td>
3631       &nbsp;
3632     </td>
3633     <td>
3634
3635 <p>
3636 Called whenever a user is kicked.
3637 <p>
3638 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. <dl compact><dt><b>Parameters:</b></dt><dd>
3639   <table border="0" cellspacing="2" cellpadding="0">
3640     <tr><td valign="top"></td><td valign="top"><em>source</em>&nbsp;</td><td>The user issuing the kick </td></tr>
3641     <tr><td valign="top"></td><td valign="top"><em>user</em>&nbsp;</td><td>The user being kicked </td></tr>
3642     <tr><td valign="top"></td><td valign="top"><em>chan</em>&nbsp;</td><td>The channel the user is being kicked from </td></tr>
3643     <tr><td valign="top"></td><td valign="top"><em>reason</em>&nbsp;</td><td>The kick reason</td></tr>
3644   </table>
3645 </dl>
3646
3647 <p>
3648 Definition at line <a class="el" href="modules_8cpp-source.html#l00251">251</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00251"></a>00251 { };
3649 </pre></div>
3650 <p>
3651     </td>
3652   </tr>
3653 </table>
3654 <a class="anchor" name="OnUserMessage_28userrec_20_2Auser_2C_20void_20_2Adest_2C_20int_20target_5Ftype_2C_20std_3A_3Astring_20text_29"></a><!-- doxytag: member="Module::OnUserMessage" ref="OnUserMessage_28userrec_20_2Auser_2C_20void_20_2Adest_2C_20int_20target_5Ftype_2C_20std_3A_3Astring_20text_29" args="(userrec *user, void *dest, int target_type, std::string text)" --><p>
3655 <table class="mdTable" cellpadding="2" cellspacing="0">
3656   <tr>
3657     <td class="mdRow">
3658       <table cellpadding="0" cellspacing="0" border="0">
3659         <tr>
3660           <td class="md" nowrap valign="top">void Module::OnUserMessage           </td>
3661           <td class="md" valign="top">(&nbsp;</td>
3662           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
3663           <td class="mdname" nowrap> <em>user</em>, </td>
3664         </tr>
3665         <tr>
3666           <td class="md" nowrap align="right"></td>
3667           <td class="md"></td>
3668           <td class="md" nowrap>void *&nbsp;</td>
3669           <td class="mdname" nowrap> <em>dest</em>, </td>
3670         </tr>
3671         <tr>
3672           <td class="md" nowrap align="right"></td>
3673           <td class="md"></td>
3674           <td class="md" nowrap>int&nbsp;</td>
3675           <td class="mdname" nowrap> <em>target_type</em>, </td>
3676         </tr>
3677         <tr>
3678           <td class="md" nowrap align="right"></td>
3679           <td class="md"></td>
3680           <td class="md" nowrap><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
3681           <td class="mdname" nowrap> <em>text</em></td>
3682         </tr>
3683         <tr>
3684           <td class="md"></td>
3685           <td class="md">)&nbsp;</td>
3686           <td class="md" colspan="2"><code> [virtual]</code></td>
3687         </tr>
3688       </table>
3689     </td>
3690   </tr>
3691 </table>
3692 <table cellspacing="5" cellpadding="0" border="0">
3693   <tr>
3694     <td>
3695       &nbsp;
3696     </td>
3697     <td>
3698
3699 <p>
3700 Called after any PRIVMSG sent from a user.
3701 <p>
3702 The dest variable contains a userrec* if target_type is TYPE_USER and a chanrec* if target_type is TYPE_CHANNEL. <dl compact><dt><b>Parameters:</b></dt><dd>
3703   <table border="0" cellspacing="2" cellpadding="0">
3704     <tr><td valign="top"></td><td valign="top"><em>user</em>&nbsp;</td><td>The user sending the message </td></tr>
3705     <tr><td valign="top"></td><td valign="top"><em>dest</em>&nbsp;</td><td>The target of the message </td></tr>
3706     <tr><td valign="top"></td><td valign="top"><em>target_type</em>&nbsp;</td><td>The type of target (TYPE_USER or TYPE_CHANNEL) </td></tr>
3707     <tr><td valign="top"></td><td valign="top"><em>text</em>&nbsp;</td><td>the text being sent by the user</td></tr>
3708   </table>
3709 </dl>
3710
3711 <p>
3712 Definition at line <a class="el" href="modules_8cpp-source.html#l00272">272</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00272"></a>00272 { };
3713 </pre></div>
3714 <p>
3715     </td>
3716   </tr>
3717 </table>
3718 <a class="anchor" name="OnUserNotice_28userrec_20_2Auser_2C_20void_20_2Adest_2C_20int_20target_5Ftype_2C_20std_3A_3Astring_20text_29"></a><!-- doxytag: member="Module::OnUserNotice" ref="OnUserNotice_28userrec_20_2Auser_2C_20void_20_2Adest_2C_20int_20target_5Ftype_2C_20std_3A_3Astring_20text_29" args="(userrec *user, void *dest, int target_type, std::string text)" --><p>
3719 <table class="mdTable" cellpadding="2" cellspacing="0">
3720   <tr>
3721     <td class="mdRow">
3722       <table cellpadding="0" cellspacing="0" border="0">
3723         <tr>
3724           <td class="md" nowrap valign="top">void Module::OnUserNotice           </td>
3725           <td class="md" valign="top">(&nbsp;</td>
3726           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
3727           <td class="mdname" nowrap> <em>user</em>, </td>
3728         </tr>
3729         <tr>
3730           <td class="md" nowrap align="right"></td>
3731           <td class="md"></td>
3732           <td class="md" nowrap>void *&nbsp;</td>
3733           <td class="mdname" nowrap> <em>dest</em>, </td>
3734         </tr>
3735         <tr>
3736           <td class="md" nowrap align="right"></td>
3737           <td class="md"></td>
3738           <td class="md" nowrap>int&nbsp;</td>
3739           <td class="mdname" nowrap> <em>target_type</em>, </td>
3740         </tr>
3741         <tr>
3742           <td class="md" nowrap align="right"></td>
3743           <td class="md"></td>
3744           <td class="md" nowrap><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
3745           <td class="mdname" nowrap> <em>text</em></td>
3746         </tr>
3747         <tr>
3748           <td class="md"></td>
3749           <td class="md">)&nbsp;</td>
3750           <td class="md" colspan="2"><code> [virtual]</code></td>
3751         </tr>
3752       </table>
3753     </td>
3754   </tr>
3755 </table>
3756 <table cellspacing="5" cellpadding="0" border="0">
3757   <tr>
3758     <td>
3759       &nbsp;
3760     </td>
3761     <td>
3762
3763 <p>
3764 Called after any NOTICE sent from a user.
3765 <p>
3766 The dest variable contains a userrec* if target_type is TYPE_USER and a chanrec* if target_type is TYPE_CHANNEL. <dl compact><dt><b>Parameters:</b></dt><dd>
3767   <table border="0" cellspacing="2" cellpadding="0">
3768     <tr><td valign="top"></td><td valign="top"><em>user</em>&nbsp;</td><td>The user sending the message </td></tr>
3769     <tr><td valign="top"></td><td valign="top"><em>dest</em>&nbsp;</td><td>The target of the message </td></tr>
3770     <tr><td valign="top"></td><td valign="top"><em>target_type</em>&nbsp;</td><td>The type of target (TYPE_USER or TYPE_CHANNEL) </td></tr>
3771     <tr><td valign="top"></td><td valign="top"><em>text</em>&nbsp;</td><td>the text being sent by the user</td></tr>
3772   </table>
3773 </dl>
3774
3775 <p>
3776 Definition at line <a class="el" href="modules_8cpp-source.html#l00273">273</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00273"></a>00273 { };
3777 </pre></div>
3778 <p>
3779     </td>
3780   </tr>
3781 </table>
3782 <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>
3783 <table class="mdTable" cellpadding="2" cellspacing="0">
3784   <tr>
3785     <td class="mdRow">
3786       <table cellpadding="0" cellspacing="0" border="0">
3787         <tr>
3788           <td class="md" nowrap valign="top">void Module::OnUserPart           </td>
3789           <td class="md" valign="top">(&nbsp;</td>
3790           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
3791           <td class="mdname" nowrap> <em>user</em>, </td>
3792         </tr>
3793         <tr>
3794           <td class="md" nowrap align="right"></td>
3795           <td class="md"></td>
3796           <td class="md" nowrap><a class="el" href="classchanrec.html">chanrec</a> *&nbsp;</td>
3797           <td class="mdname" nowrap> <em>channel</em></td>
3798         </tr>
3799         <tr>
3800           <td class="md"></td>
3801           <td class="md">)&nbsp;</td>
3802           <td class="md" colspan="2"><code> [virtual]</code></td>
3803         </tr>
3804       </table>
3805     </td>
3806   </tr>
3807 </table>
3808 <table cellspacing="5" cellpadding="0" border="0">
3809   <tr>
3810     <td>
3811       &nbsp;
3812     </td>
3813     <td>
3814
3815 <p>
3816 Called when a user parts a channel.
3817 <p>
3818 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 <dl compact><dt><b>Parameters:</b></dt><dd>
3819   <table border="0" cellspacing="2" cellpadding="0">
3820     <tr><td valign="top"></td><td valign="top"><em>user</em>&nbsp;</td><td>The user who is parting </td></tr>
3821     <tr><td valign="top"></td><td valign="top"><em>channel</em>&nbsp;</td><td>The channel being parted</td></tr>
3822   </table>
3823 </dl>
3824
3825 <p>
3826 Definition at line <a class="el" href="modules_8cpp-source.html#l00225">225</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00225"></a>00225 { }
3827 </pre></div>
3828 <p>
3829     </td>
3830   </tr>
3831 </table>
3832 <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>
3833 <table class="mdTable" cellpadding="2" cellspacing="0">
3834   <tr>
3835     <td class="mdRow">
3836       <table cellpadding="0" cellspacing="0" border="0">
3837         <tr>
3838           <td class="md" nowrap valign="top">void Module::OnUserPostNick           </td>
3839           <td class="md" valign="top">(&nbsp;</td>
3840           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
3841           <td class="mdname" nowrap> <em>user</em>, </td>
3842         </tr>
3843         <tr>
3844           <td class="md" nowrap align="right"></td>
3845           <td class="md"></td>
3846           <td class="md" nowrap><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
3847           <td class="mdname" nowrap> <em>oldnick</em></td>
3848         </tr>
3849         <tr>
3850           <td class="md"></td>
3851           <td class="md">)&nbsp;</td>
3852           <td class="md" colspan="2"><code> [virtual]</code></td>
3853         </tr>
3854       </table>
3855     </td>
3856   </tr>
3857 </table>
3858 <table cellspacing="5" cellpadding="0" border="0">
3859   <tr>
3860     <td>
3861       &nbsp;
3862     </td>
3863     <td>
3864
3865 <p>
3866 Called after any nickchange, local or remote.
3867 <p>
3868 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. <dl compact><dt><b>Parameters:</b></dt><dd>
3869   <table border="0" cellspacing="2" cellpadding="0">
3870     <tr><td valign="top"></td><td valign="top"><em>user</em>&nbsp;</td><td>The user changing their nick </td></tr>
3871     <tr><td valign="top"></td><td valign="top"><em>oldnick</em>&nbsp;</td><td>The old nickname of the user before the nickchange</td></tr>
3872   </table>
3873 </dl>
3874
3875 <p>
3876 Definition at line <a class="el" href="modules_8cpp-source.html#l00239">239</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00239"></a>00239 { };
3877 </pre></div>
3878 <p>
3879     </td>
3880   </tr>
3881 </table>
3882 <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>
3883 <table class="mdTable" cellpadding="2" cellspacing="0">
3884   <tr>
3885     <td class="mdRow">
3886       <table cellpadding="0" cellspacing="0" border="0">
3887         <tr>
3888           <td class="md" nowrap valign="top">int Module::OnUserPreInvite           </td>
3889           <td class="md" valign="top">(&nbsp;</td>
3890           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
3891           <td class="mdname" nowrap> <em>source</em>, </td>
3892         </tr>
3893         <tr>
3894           <td class="md" nowrap align="right"></td>
3895           <td class="md"></td>
3896           <td class="md" nowrap><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
3897           <td class="mdname" nowrap> <em>dest</em>, </td>
3898         </tr>
3899         <tr>
3900           <td class="md" nowrap align="right"></td>
3901           <td class="md"></td>
3902           <td class="md" nowrap><a class="el" href="classchanrec.html">chanrec</a> *&nbsp;</td>
3903           <td class="mdname" nowrap> <em>channel</em></td>
3904         </tr>
3905         <tr>
3906           <td class="md"></td>
3907           <td class="md">)&nbsp;</td>
3908           <td class="md" colspan="2"><code> [virtual]</code></td>
3909         </tr>
3910       </table>
3911     </td>
3912   </tr>
3913 </table>
3914 <table cellspacing="5" cellpadding="0" border="0">
3915   <tr>
3916     <td>
3917       &nbsp;
3918     </td>
3919     <td>
3920
3921 <p>
3922 Called whenever a user is about to invite another user into a channel, before any processing is done.
3923 <p>
3924 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. <dl compact><dt><b>Parameters:</b></dt><dd>
3925   <table border="0" cellspacing="2" cellpadding="0">
3926     <tr><td valign="top"></td><td valign="top"><em>source</em>&nbsp;</td><td>The user who is issuing the INVITE </td></tr>
3927     <tr><td valign="top"></td><td valign="top"><em>dest</em>&nbsp;</td><td>The user being invited </td></tr>
3928     <tr><td valign="top"></td><td valign="top"><em>channel</em>&nbsp;</td><td>The channel the user is being invited to </td></tr>
3929   </table>
3930 </dl>
3931 <dl compact><dt><b>Returns:</b></dt><dd>1 to deny the invite, 0 to allow</dd></dl>
3932
3933 <p>
3934 Definition at line <a class="el" href="modules_8cpp-source.html#l00235">235</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00235"></a>00235 { <span class="keywordflow">return</span> 0; };
3935 </pre></div>
3936 <p>
3937     </td>
3938   </tr>
3939 </table>
3940 <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>
3941 <table class="mdTable" cellpadding="2" cellspacing="0">
3942   <tr>
3943     <td class="mdRow">
3944       <table cellpadding="0" cellspacing="0" border="0">
3945         <tr>
3946           <td class="md" nowrap valign="top">int Module::OnUserPreJoin           </td>
3947           <td class="md" valign="top">(&nbsp;</td>
3948           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
3949           <td class="mdname" nowrap> <em>user</em>, </td>
3950         </tr>
3951         <tr>
3952           <td class="md" nowrap align="right"></td>
3953           <td class="md"></td>
3954           <td class="md" nowrap><a class="el" href="classchanrec.html">chanrec</a> *&nbsp;</td>
3955           <td class="mdname" nowrap> <em>chan</em>, </td>
3956         </tr>
3957         <tr>
3958           <td class="md" nowrap align="right"></td>
3959           <td class="md"></td>
3960           <td class="md" nowrap>const char *&nbsp;</td>
3961           <td class="mdname" nowrap> <em>cname</em></td>
3962         </tr>
3963         <tr>
3964           <td class="md"></td>
3965           <td class="md">)&nbsp;</td>
3966           <td class="md" colspan="2"><code> [virtual]</code></td>
3967         </tr>
3968       </table>
3969     </td>
3970   </tr>
3971 </table>
3972 <table cellspacing="5" cellpadding="0" border="0">
3973   <tr>
3974     <td>
3975       &nbsp;
3976     </td>
3977     <td>
3978
3979 <p>
3980 Called whenever a user is about to join a channel, before any processing is done.
3981 <p>
3982 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>
3983 IMPORTANT NOTE!<p>
3984 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. <dl compact><dt><b>Parameters:</b></dt><dd>
3985   <table border="0" cellspacing="2" cellpadding="0">
3986     <tr><td valign="top"></td><td valign="top"><em>user</em>&nbsp;</td><td>The user joining the channel </td></tr>
3987     <tr><td valign="top"></td><td valign="top"><em>cname</em>&nbsp;</td><td>The channel name being joined </td></tr>
3988   </table>
3989 </dl>
3990 <dl compact><dt><b>Returns:</b></dt><dd>1 To prevent the join, 0 to allow it.</dd></dl>
3991
3992 <p>
3993 Definition at line <a class="el" href="modules_8cpp-source.html#l00228">228</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00228"></a>00228 { <span class="keywordflow">return</span> 0; }
3994 </pre></div>
3995 <p>
3996     </td>
3997   </tr>
3998 </table>
3999 <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>
4000 <table class="mdTable" cellpadding="2" cellspacing="0">
4001   <tr>
4002     <td class="mdRow">
4003       <table cellpadding="0" cellspacing="0" border="0">
4004         <tr>
4005           <td class="md" nowrap valign="top">int Module::OnUserPreKick           </td>
4006           <td class="md" valign="top">(&nbsp;</td>
4007           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
4008           <td class="mdname" nowrap> <em>source</em>, </td>
4009         </tr>
4010         <tr>
4011           <td class="md" nowrap align="right"></td>
4012           <td class="md"></td>
4013           <td class="md" nowrap><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
4014           <td class="mdname" nowrap> <em>user</em>, </td>
4015         </tr>
4016         <tr>
4017           <td class="md" nowrap align="right"></td>
4018           <td class="md"></td>
4019           <td class="md" nowrap><a class="el" href="classchanrec.html">chanrec</a> *&nbsp;</td>
4020           <td class="mdname" nowrap> <em>chan</em>, </td>
4021         </tr>
4022         <tr>
4023           <td class="md" nowrap align="right"></td>
4024           <td class="md"></td>
4025           <td class="md" nowrap><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
4026           <td class="mdname" nowrap> <em>reason</em></td>
4027         </tr>
4028         <tr>
4029           <td class="md"></td>
4030           <td class="md">)&nbsp;</td>
4031           <td class="md" colspan="2"><code> [virtual]</code></td>
4032         </tr>
4033       </table>
4034     </td>
4035   </tr>
4036 </table>
4037 <table cellspacing="5" cellpadding="0" border="0">
4038   <tr>
4039     <td>
4040       &nbsp;
4041     </td>
4042     <td>
4043
4044 <p>
4045 Called whenever a user is about to be kicked.
4046 <p>
4047 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. <dl compact><dt><b>Parameters:</b></dt><dd>
4048   <table border="0" cellspacing="2" cellpadding="0">
4049     <tr><td valign="top"></td><td valign="top"><em>source</em>&nbsp;</td><td>The user issuing the kick </td></tr>
4050     <tr><td valign="top"></td><td valign="top"><em>user</em>&nbsp;</td><td>The user being kicked </td></tr>
4051     <tr><td valign="top"></td><td valign="top"><em>chan</em>&nbsp;</td><td>The channel the user is being kicked from </td></tr>
4052     <tr><td valign="top"></td><td valign="top"><em>reason</em>&nbsp;</td><td>The kick reason </td></tr>
4053   </table>
4054 </dl>
4055 <dl compact><dt><b>Returns:</b></dt><dd>1 to prevent the kick, 0 to allow it</dd></dl>
4056
4057 <p>
4058 Definition at line <a class="el" href="modules_8cpp-source.html#l00250">250</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00250"></a>00250 { <span class="keywordflow">return</span> 0; };
4059 </pre></div>
4060 <p>
4061     </td>
4062   </tr>
4063 </table>
4064 <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>
4065 <table class="mdTable" cellpadding="2" cellspacing="0">
4066   <tr>
4067     <td class="mdRow">
4068       <table cellpadding="0" cellspacing="0" border="0">
4069         <tr>
4070           <td class="md" nowrap valign="top">int Module::OnUserPreMessage           </td>
4071           <td class="md" valign="top">(&nbsp;</td>
4072           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
4073           <td class="mdname" nowrap> <em>user</em>, </td>
4074         </tr>
4075         <tr>
4076           <td class="md" nowrap align="right"></td>
4077           <td class="md"></td>
4078           <td class="md" nowrap>void *&nbsp;</td>
4079           <td class="mdname" nowrap> <em>dest</em>, </td>
4080         </tr>
4081         <tr>
4082           <td class="md" nowrap align="right"></td>
4083           <td class="md"></td>
4084           <td class="md" nowrap>int&nbsp;</td>
4085           <td class="mdname" nowrap> <em>target_type</em>, </td>
4086         </tr>
4087         <tr>
4088           <td class="md" nowrap align="right"></td>
4089           <td class="md"></td>
4090           <td class="md" nowrap><a class="el" href="namespaceirc.html#string">std::string</a> &amp;&nbsp;</td>
4091           <td class="mdname" nowrap> <em>text</em></td>
4092         </tr>
4093         <tr>
4094           <td class="md"></td>
4095           <td class="md">)&nbsp;</td>
4096           <td class="md" colspan="2"><code> [virtual]</code></td>
4097         </tr>
4098       </table>
4099     </td>
4100   </tr>
4101 </table>
4102 <table cellspacing="5" cellpadding="0" border="0">
4103   <tr>
4104     <td>
4105       &nbsp;
4106     </td>
4107     <td>
4108
4109 <p>
4110 Called whenever a user is about to PRIVMSG A user or a channel, before any processing is done.
4111 <p>
4112 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. <dl compact><dt><b>Parameters:</b></dt><dd>
4113   <table border="0" cellspacing="2" cellpadding="0">
4114     <tr><td valign="top"></td><td valign="top"><em>user</em>&nbsp;</td><td>The user sending the message </td></tr>
4115     <tr><td valign="top"></td><td valign="top"><em>dest</em>&nbsp;</td><td>The target of the message (chanrec* or userrec*) </td></tr>
4116     <tr><td valign="top"></td><td valign="top"><em>target_type</em>&nbsp;</td><td>The type of target (TYPE_USER or TYPE_CHANNEL) </td></tr>
4117     <tr><td valign="top"></td><td valign="top"><em>text</em>&nbsp;</td><td>Changeable text being sent by the user </td></tr>
4118   </table>
4119 </dl>
4120 <dl compact><dt><b>Returns:</b></dt><dd>1 to deny the NOTICE, 0 to allow it</dd></dl>
4121
4122 <p>
4123 Definition at line <a class="el" href="modules_8cpp-source.html#l00236">236</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00236"></a>00236 { <span class="keywordflow">return</span> 0; };
4124 </pre></div>
4125 <p>
4126     </td>
4127   </tr>
4128 </table>
4129 <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>
4130 <table class="mdTable" cellpadding="2" cellspacing="0">
4131   <tr>
4132     <td class="mdRow">
4133       <table cellpadding="0" cellspacing="0" border="0">
4134         <tr>
4135           <td class="md" nowrap valign="top">int Module::OnUserPreNick           </td>
4136           <td class="md" valign="top">(&nbsp;</td>
4137           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
4138           <td class="mdname" nowrap> <em>user</em>, </td>
4139         </tr>
4140         <tr>
4141           <td class="md" nowrap align="right"></td>
4142           <td class="md"></td>
4143           <td class="md" nowrap><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
4144           <td class="mdname" nowrap> <em>newnick</em></td>
4145         </tr>
4146         <tr>
4147           <td class="md"></td>
4148           <td class="md">)&nbsp;</td>
4149           <td class="md" colspan="2"><code> [virtual]</code></td>
4150         </tr>
4151       </table>
4152     </td>
4153   </tr>
4154 </table>
4155 <table cellspacing="5" cellpadding="0" border="0">
4156   <tr>
4157     <td>
4158       &nbsp;
4159     </td>
4160     <td>
4161
4162 <p>
4163 Called before any nickchange, local or remote.
4164 <p>
4165 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. <dl compact><dt><b>Parameters:</b></dt><dd>
4166   <table border="0" cellspacing="2" cellpadding="0">
4167     <tr><td valign="top"></td><td valign="top"><em>user</em>&nbsp;</td><td>The username changing their nick </td></tr>
4168     <tr><td valign="top"></td><td valign="top"><em>newnick</em>&nbsp;</td><td>Their new nickname </td></tr>
4169   </table>
4170 </dl>
4171 <dl compact><dt><b>Returns:</b></dt><dd>1 to deny the change, 0 to allow</dd></dl>
4172
4173 <p>
4174 Definition at line <a class="el" href="modules_8cpp-source.html#l00238">238</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00238"></a>00238 { <span class="keywordflow">return</span> 0; };
4175 </pre></div>
4176 <p>
4177     </td>
4178   </tr>
4179 </table>
4180 <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>
4181 <table class="mdTable" cellpadding="2" cellspacing="0">
4182   <tr>
4183     <td class="mdRow">
4184       <table cellpadding="0" cellspacing="0" border="0">
4185         <tr>
4186           <td class="md" nowrap valign="top">int Module::OnUserPreNotice           </td>
4187           <td class="md" valign="top">(&nbsp;</td>
4188           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
4189           <td class="mdname" nowrap> <em>user</em>, </td>
4190         </tr>
4191         <tr>
4192           <td class="md" nowrap align="right"></td>
4193           <td class="md"></td>
4194           <td class="md" nowrap>void *&nbsp;</td>
4195           <td class="mdname" nowrap> <em>dest</em>, </td>
4196         </tr>
4197         <tr>
4198           <td class="md" nowrap align="right"></td>
4199           <td class="md"></td>
4200           <td class="md" nowrap>int&nbsp;</td>
4201           <td class="mdname" nowrap> <em>target_type</em>, </td>
4202         </tr>
4203         <tr>
4204           <td class="md" nowrap align="right"></td>
4205           <td class="md"></td>
4206           <td class="md" nowrap><a class="el" href="namespaceirc.html#string">std::string</a> &amp;&nbsp;</td>
4207           <td class="mdname" nowrap> <em>text</em></td>
4208         </tr>
4209         <tr>
4210           <td class="md"></td>
4211           <td class="md">)&nbsp;</td>
4212           <td class="md" colspan="2"><code> [virtual]</code></td>
4213         </tr>
4214       </table>
4215     </td>
4216   </tr>
4217 </table>
4218 <table cellspacing="5" cellpadding="0" border="0">
4219   <tr>
4220     <td>
4221       &nbsp;
4222     </td>
4223     <td>
4224
4225 <p>
4226 Called whenever a user is about to NOTICE A user or a channel, before any processing is done.
4227 <p>
4228 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. <dl compact><dt><b>Parameters:</b></dt><dd>
4229   <table border="0" cellspacing="2" cellpadding="0">
4230     <tr><td valign="top"></td><td valign="top"><em>user</em>&nbsp;</td><td>The user sending the message </td></tr>
4231     <tr><td valign="top"></td><td valign="top"><em>dest</em>&nbsp;</td><td>The target of the message (chanrec* or userrec*) </td></tr>
4232     <tr><td valign="top"></td><td valign="top"><em>target_type</em>&nbsp;</td><td>The type of target (TYPE_USER or TYPE_CHANNEL) </td></tr>
4233     <tr><td valign="top"></td><td valign="top"><em>text</em>&nbsp;</td><td>Changeable text being sent by the user </td></tr>
4234   </table>
4235 </dl>
4236 <dl compact><dt><b>Returns:</b></dt><dd>1 to deny the NOTICE, 0 to allow it</dd></dl>
4237
4238 <p>
4239 Definition at line <a class="el" href="modules_8cpp-source.html#l00237">237</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00237"></a>00237 { <span class="keywordflow">return</span> 0; };
4240 </pre></div>
4241 <p>
4242     </td>
4243   </tr>
4244 </table>
4245 <a class="anchor" name="OnUserQuit_28userrec_20_2Auser_2C_20std_3A_3Astring_20message_29"></a><!-- doxytag: member="Module::OnUserQuit" ref="OnUserQuit_28userrec_20_2Auser_2C_20std_3A_3Astring_20message_29" args="(userrec *user, std::string message)" --><p>
4246 <table class="mdTable" cellpadding="2" cellspacing="0">
4247   <tr>
4248     <td class="mdRow">
4249       <table cellpadding="0" cellspacing="0" border="0">
4250         <tr>
4251           <td class="md" nowrap valign="top">void Module::OnUserQuit           </td>
4252           <td class="md" valign="top">(&nbsp;</td>
4253           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
4254           <td class="mdname" nowrap> <em>user</em>, </td>
4255         </tr>
4256         <tr>
4257           <td class="md" nowrap align="right"></td>
4258           <td class="md"></td>
4259           <td class="md" nowrap><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
4260           <td class="mdname" nowrap> <em>message</em></td>
4261         </tr>
4262         <tr>
4263           <td class="md"></td>
4264           <td class="md">)&nbsp;</td>
4265           <td class="md" colspan="2"><code> [virtual]</code></td>
4266         </tr>
4267       </table>
4268     </td>
4269   </tr>
4270 </table>
4271 <table cellspacing="5" cellpadding="0" border="0">
4272   <tr>
4273     <td>
4274       &nbsp;
4275     </td>
4276     <td>
4277
4278 <p>
4279 Called when a user quits.
4280 <p>
4281 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. <dl compact><dt><b>Parameters:</b></dt><dd>
4282   <table border="0" cellspacing="2" cellpadding="0">
4283     <tr><td valign="top"></td><td valign="top"><em>user</em>&nbsp;</td><td>The user who is quitting </td></tr>
4284     <tr><td valign="top"></td><td valign="top"><em>message</em>&nbsp;</td><td>The user's quit message</td></tr>
4285   </table>
4286 </dl>
4287
4288 <p>
4289 Definition at line <a class="el" href="modules_8cpp-source.html#l00222">222</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00222"></a>00222 { }
4290 </pre></div>
4291 <p>
4292     </td>
4293   </tr>
4294 </table>
4295 <a class="anchor" name="OnUserRegister_28userrec_20_2Auser_29"></a><!-- doxytag: member="Module::OnUserRegister" ref="OnUserRegister_28userrec_20_2Auser_29" args="(userrec *user)" --><p>
4296 <table class="mdTable" cellpadding="2" cellspacing="0">
4297   <tr>
4298     <td class="mdRow">
4299       <table cellpadding="0" cellspacing="0" border="0">
4300         <tr>
4301           <td class="md" nowrap valign="top">void Module::OnUserRegister           </td>
4302           <td class="md" valign="top">(&nbsp;</td>
4303           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
4304           <td class="mdname1" valign="top" nowrap> <em>user</em>          </td>
4305           <td class="md" valign="top">&nbsp;)&nbsp;</td>
4306           <td class="md" nowrap><code> [virtual]</code></td>
4307         </tr>
4308       </table>
4309     </td>
4310   </tr>
4311 </table>
4312 <table cellspacing="5" cellpadding="0" border="0">
4313   <tr>
4314     <td>
4315       &nbsp;
4316     </td>
4317     <td>
4318
4319 <p>
4320 Called whenever a user is about to register their connection (e.g.
4321 <p>
4322 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. <dl compact><dt><b>Parameters:</b></dt><dd>
4323   <table border="0" cellspacing="2" cellpadding="0">
4324     <tr><td valign="top"></td><td valign="top"><em>user</em>&nbsp;</td><td>The user registering</td></tr>
4325   </table>
4326 </dl>
4327
4328 <p>
4329 Definition at line <a class="el" href="modules_8cpp-source.html#l00249">249</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00249"></a>00249 { };
4330 </pre></div>
4331 <p>
4332     </td>
4333   </tr>
4334 </table>
4335 <a class="anchor" name="OnWallops_28userrec_20_2Auser_2C_20std_3A_3Astring_20text_29"></a><!-- doxytag: member="Module::OnWallops" ref="OnWallops_28userrec_20_2Auser_2C_20std_3A_3Astring_20text_29" args="(userrec *user, std::string text)" --><p>
4336 <table class="mdTable" cellpadding="2" cellspacing="0">
4337   <tr>
4338     <td class="mdRow">
4339       <table cellpadding="0" cellspacing="0" border="0">
4340         <tr>
4341           <td class="md" nowrap valign="top">void Module::OnWallops           </td>
4342           <td class="md" valign="top">(&nbsp;</td>
4343           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
4344           <td class="mdname" nowrap> <em>user</em>, </td>
4345         </tr>
4346         <tr>
4347           <td class="md" nowrap align="right"></td>
4348           <td class="md"></td>
4349           <td class="md" nowrap><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
4350           <td class="mdname" nowrap> <em>text</em></td>
4351         </tr>
4352         <tr>
4353           <td class="md"></td>
4354           <td class="md">)&nbsp;</td>
4355           <td class="md" colspan="2"><code> [virtual]</code></td>
4356         </tr>
4357       </table>
4358     </td>
4359   </tr>
4360 </table>
4361 <table cellspacing="5" cellpadding="0" border="0">
4362   <tr>
4363     <td>
4364       &nbsp;
4365     </td>
4366     <td>
4367
4368 <p>
4369 Called after every WALLOPS command.
4370 <p>
4371 <dl compact><dt><b>Parameters:</b></dt><dd>
4372   <table border="0" cellspacing="2" cellpadding="0">
4373     <tr><td valign="top"></td><td valign="top"><em>user</em>&nbsp;</td><td>The user sending the WALLOPS </td></tr>
4374     <tr><td valign="top"></td><td valign="top"><em>text</em>&nbsp;</td><td>The content of the WALLOPS message</td></tr>
4375   </table>
4376 </dl>
4377
4378 <p>
4379 Definition at line <a class="el" href="modules_8cpp-source.html#l00285">285</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00285"></a>00285 { };
4380 </pre></div>
4381 <p>
4382     </td>
4383   </tr>
4384 </table>
4385 <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>
4386 <table class="mdTable" cellpadding="2" cellspacing="0">
4387   <tr>
4388     <td class="mdRow">
4389       <table cellpadding="0" cellspacing="0" border="0">
4390         <tr>
4391           <td class="md" nowrap valign="top">void Module::OnWhois           </td>
4392           <td class="md" valign="top">(&nbsp;</td>
4393           <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
4394           <td class="mdname" nowrap> <em>source</em>, </td>
4395         </tr>
4396         <tr>
4397           <td class="md" nowrap align="right"></td>
4398           <td class="md"></td>
4399           <td class="md" nowrap><a class="el" href="classuserrec.html">userrec</a> *&nbsp;</td>
4400           <td class="mdname" nowrap> <em>dest</em></td>
4401         </tr>
4402         <tr>
4403           <td class="md"></td>
4404           <td class="md">)&nbsp;</td>
4405           <td class="md" colspan="2"><code> [virtual]</code></td>
4406         </tr>
4407       </table>
4408     </td>
4409   </tr>
4410 </table>
4411 <table cellspacing="5" cellpadding="0" border="0">
4412   <tr>
4413     <td>
4414       &nbsp;
4415     </td>
4416     <td>
4417
4418 <p>
4419 Called whenever a /WHOIS is performed on a local user.
4420 <p>
4421 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. <dl compact><dt><b>Parameters:</b></dt><dd>
4422   <table border="0" cellspacing="2" cellpadding="0">
4423     <tr><td valign="top"></td><td valign="top"><em>source</em>&nbsp;</td><td>The user issuing the WHOIS command </td></tr>
4424     <tr><td valign="top"></td><td valign="top"><em>dest</em>&nbsp;</td><td>The user who is being WHOISed</td></tr>
4425   </table>
4426 </dl>
4427
4428 <p>
4429 Definition at line <a class="el" href="modules_8cpp-source.html#l00234">234</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00234"></a>00234 { };
4430 </pre></div>
4431 <p>
4432     </td>
4433   </tr>
4434 </table>
4435 <a class="anchor" name="ProtoSendMetaData_28void_20_2Aopaque_2C_20int_20target_5Ftype_2C_20void_20_2Atarget_2C_20std_3A_3Astring_20extname_2C_20std_3A_3Astring_20extdata_29"></a><!-- doxytag: member="Module::ProtoSendMetaData" ref="ProtoSendMetaData_28void_20_2Aopaque_2C_20int_20target_5Ftype_2C_20void_20_2Atarget_2C_20std_3A_3Astring_20extname_2C_20std_3A_3Astring_20extdata_29" args="(void *opaque, int target_type, void *target, std::string extname, std::string extdata)" --><p>
4436 <table class="mdTable" cellpadding="2" cellspacing="0">
4437   <tr>
4438     <td class="mdRow">
4439       <table cellpadding="0" cellspacing="0" border="0">
4440         <tr>
4441           <td class="md" nowrap valign="top">void Module::ProtoSendMetaData           </td>
4442           <td class="md" valign="top">(&nbsp;</td>
4443           <td class="md" nowrap valign="top">void *&nbsp;</td>
4444           <td class="mdname" nowrap> <em>opaque</em>, </td>
4445         </tr>
4446         <tr>
4447           <td class="md" nowrap align="right"></td>
4448           <td class="md"></td>
4449           <td class="md" nowrap>int&nbsp;</td>
4450           <td class="mdname" nowrap> <em>target_type</em>, </td>
4451         </tr>
4452         <tr>
4453           <td class="md" nowrap align="right"></td>
4454           <td class="md"></td>
4455           <td class="md" nowrap>void *&nbsp;</td>
4456           <td class="mdname" nowrap> <em>target</em>, </td>
4457         </tr>
4458         <tr>
4459           <td class="md" nowrap align="right"></td>
4460           <td class="md"></td>
4461           <td class="md" nowrap><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
4462           <td class="mdname" nowrap> <em>extname</em>, </td>
4463         </tr>
4464         <tr>
4465           <td class="md" nowrap align="right"></td>
4466           <td class="md"></td>
4467           <td class="md" nowrap><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
4468           <td class="mdname" nowrap> <em>extdata</em></td>
4469         </tr>
4470         <tr>
4471           <td class="md"></td>
4472           <td class="md">)&nbsp;</td>
4473           <td class="md" colspan="2"><code> [virtual]</code></td>
4474         </tr>
4475       </table>
4476     </td>
4477   </tr>
4478 </table>
4479 <table cellspacing="5" cellpadding="0" border="0">
4480   <tr>
4481     <td>
4482       &nbsp;
4483     </td>
4484     <td>
4485
4486 <p>
4487 Implemented by modules which provide the ability to link servers.
4488 <p>
4489 These modules will implement this method, which allows metadata (extra data added to user and channel records using class <a class="el" href="classExtensible.html">Extensible</a>, <a class="el" href="classExtensible.html#Extend_28std_3A_3Astring_20key_2C_20char_20_2Ap_29">Extensible::Extend</a>, etc) to be sent to other servers on a netburst and decoded at the other end by the same module on a different server.<p>
4490 More documentation to follow soon. Please see src/modules/m_swhois.cpp for example of how to use this function. <dl compact><dt><b>Parameters:</b></dt><dd>
4491   <table border="0" cellspacing="2" cellpadding="0">
4492     <tr><td valign="top"></td><td valign="top"><em>opaque</em>&nbsp;</td><td>An opaque pointer set by the protocol module, should not be modified! </td></tr>
4493     <tr><td valign="top"></td><td valign="top"><em>target_type</em>&nbsp;</td><td>The type of item to decode data for, TYPE_USER or TYPE_CHANNEL </td></tr>
4494     <tr><td valign="top"></td><td valign="top"><em>target</em>&nbsp;</td><td>The chanrec* or userrec* that metadata should be sent for </td></tr>
4495     <tr><td valign="top"></td><td valign="top"><em>extname</em>&nbsp;</td><td>The extension name to send metadata for </td></tr>
4496     <tr><td valign="top"></td><td valign="top"><em>extdata</em>&nbsp;</td><td>Encoded data for this extension name, which will be encoded at the oppsite end by an identical module using OnDecodeMetaData</td></tr>
4497   </table>
4498 </dl>
4499
4500 <p>
4501 Definition at line <a class="el" href="modules_8cpp-source.html#l00284">284</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00284"></a>00284 { };
4502 </pre></div>
4503 <p>
4504     </td>
4505   </tr>
4506 </table>
4507 <a class="anchor" name="ProtoSendMode_28void_20_2Aopaque_2C_20int_20target_5Ftype_2C_20void_20_2Atarget_2C_20std_3A_3Astring_20modeline_29"></a><!-- doxytag: member="Module::ProtoSendMode" ref="ProtoSendMode_28void_20_2Aopaque_2C_20int_20target_5Ftype_2C_20void_20_2Atarget_2C_20std_3A_3Astring_20modeline_29" args="(void *opaque, int target_type, void *target, std::string modeline)" --><p>
4508 <table class="mdTable" cellpadding="2" cellspacing="0">
4509   <tr>
4510     <td class="mdRow">
4511       <table cellpadding="0" cellspacing="0" border="0">
4512         <tr>
4513           <td class="md" nowrap valign="top">void Module::ProtoSendMode           </td>
4514           <td class="md" valign="top">(&nbsp;</td>
4515           <td class="md" nowrap valign="top">void *&nbsp;</td>
4516           <td class="mdname" nowrap> <em>opaque</em>, </td>
4517         </tr>
4518         <tr>
4519           <td class="md" nowrap align="right"></td>
4520           <td class="md"></td>
4521           <td class="md" nowrap>int&nbsp;</td>
4522           <td class="mdname" nowrap> <em>target_type</em>, </td>
4523         </tr>
4524         <tr>
4525           <td class="md" nowrap align="right"></td>
4526           <td class="md"></td>
4527           <td class="md" nowrap>void *&nbsp;</td>
4528           <td class="mdname" nowrap> <em>target</em>, </td>
4529         </tr>
4530         <tr>
4531           <td class="md" nowrap align="right"></td>
4532           <td class="md"></td>
4533           <td class="md" nowrap><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
4534           <td class="mdname" nowrap> <em>modeline</em></td>
4535         </tr>
4536         <tr>
4537           <td class="md"></td>
4538           <td class="md">)&nbsp;</td>
4539           <td class="md" colspan="2"><code> [virtual]</code></td>
4540         </tr>
4541       </table>
4542     </td>
4543   </tr>
4544 </table>
4545 <table cellspacing="5" cellpadding="0" border="0">
4546   <tr>
4547     <td>
4548       &nbsp;
4549     </td>
4550     <td>
4551
4552 <p>
4553 Implemented by modules which provide the ability to link servers.
4554 <p>
4555 These modules will implement this method, which allows transparent sending of servermodes down the network link as a broadcast, without a module calling it having to know the format of the MODE command before the actual mode string.<p>
4556 More documentation to follow soon. Please see src/modules/m_chanprotect.cpp for examples of how to use this function.<p>
4557 <dl compact><dt><b>Parameters:</b></dt><dd>
4558   <table border="0" cellspacing="2" cellpadding="0">
4559     <tr><td valign="top"></td><td valign="top"><em>opaque</em>&nbsp;</td><td>An opaque pointer set by the protocol module, should not be modified! </td></tr>
4560     <tr><td valign="top"></td><td valign="top"><em>target_type</em>&nbsp;</td><td>The type of item to decode data for, TYPE_USER or TYPE_CHANNEL </td></tr>
4561     <tr><td valign="top"></td><td valign="top"><em>target</em>&nbsp;</td><td>The chanrec* or userrec* that modes should be sent for </td></tr>
4562     <tr><td valign="top"></td><td valign="top"><em>modeline</em>&nbsp;</td><td>The modes and parameters to be sent</td></tr>
4563   </table>
4564 </dl>
4565
4566 <p>
4567 Definition at line <a class="el" href="modules_8cpp-source.html#l00280">280</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00280"></a>00280 { };
4568 </pre></div>
4569 <p>
4570     </td>
4571   </tr>
4572 </table>
4573 <hr>The documentation for this class was generated from the following files:<ul>
4574 <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>
4575 <hr size="1"><address style="align: right;"><small>Generated on Mon Dec 19 18:02:16 2005 for InspIRCd by&nbsp;
4576 <a href="http://www.doxygen.org/index.html">
4577 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.4-20050815 </small></address>
4578 </body>
4579 </html>