diff options
Diffstat (limited to 'docs/module-doc/classModule.html')
| -rw-r--r-- | docs/module-doc/classModule.html | 537 |
1 files changed, 328 insertions, 209 deletions
diff --git a/docs/module-doc/classModule.html b/docs/module-doc/classModule.html index 03900e9e5..6062b0714 100644 --- a/docs/module-doc/classModule.html +++ b/docs/module-doc/classModule.html @@ -30,123 +30,132 @@ Inherits <a class="el" href="classclassbase.html">classbase</a>. <tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a4">OnUserQuit</a> (<a class="el" href="classuserrec.html">userrec</a> *user)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Called when a user quits. </em> <a href="#a4"></a><em><br><br></td></tr> -<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a5">OnUserJoin</a> (<a class="el" href="classuserrec.html">userrec</a> *user, <a class="el" href="classchanrec.html">chanrec</a> *channel)</td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a5">OnUserDisconnect</a> (<a class="el" href="classuserrec.html">userrec</a> *user)</td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Called when a user joins a channel. </em> <a href="#a5"></a><em><br><br></td></tr> -<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a6">OnUserPart</a> (<a class="el" href="classuserrec.html">userrec</a> *user, <a class="el" href="classchanrec.html">chanrec</a> *channel)</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Called whenever a user's socket is closed. </em> <a href="#a5"></a><em><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a6">OnUserJoin</a> (<a class="el" href="classuserrec.html">userrec</a> *user, <a class="el" href="classchanrec.html">chanrec</a> *channel)</td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Called when a user parts a channel. </em> <a href="#a6"></a><em><br><br></td></tr> -<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a7">OnPacketTransmit</a> (std::string &data, std::string serv)</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Called when a user joins a channel. </em> <a href="#a6"></a><em><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a7">OnUserPart</a> (<a class="el" href="classuserrec.html">userrec</a> *user, <a class="el" href="classchanrec.html">chanrec</a> *channel)</td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Called before a packet is transmitted across the irc network between two irc servers. </em> <a href="#a7"></a><em><br><br></td></tr> -<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a8">OnPacketReceive</a> (std::string &data, std::string serv)</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Called when a user parts a channel. </em> <a href="#a7"></a><em><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a8">OnPacketTransmit</a> (std::string &data, std::string serv)</td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Called after a packet is received from another irc server. </em> <a href="#a8"></a><em><br><br></td></tr> -<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a9">OnRehash</a> ()</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Called before a packet is transmitted across the irc network between two irc servers. </em> <a href="#a8"></a><em><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a9">OnPacketReceive</a> (std::string &data, std::string serv)</td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Called on rehash. </em> <a href="#a9"></a><em><br><br></td></tr> -<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a10">OnServerRaw</a> (std::string &raw, bool inbound, <a class="el" href="classuserrec.html">userrec</a> *user)</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Called after a packet is received from another irc server. </em> <a href="#a9"></a><em><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a10">OnRehash</a> ()</td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Called when a raw command is transmitted or received. </em> <a href="#a10"></a><em><br><br></td></tr> -<tr><td class="memItemLeft" nowrap align=right valign=top>virtual int </td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a11">OnExtendedMode</a> (<a class="el" href="classuserrec.html">userrec</a> *user, void *target, char modechar, int type, bool mode_on, <a class="el" href="modules_8h.html#a32">string_list</a> &params)</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Called on rehash. </em> <a href="#a10"></a><em><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a11">OnServerRaw</a> (std::string &raw, bool inbound, <a class="el" href="classuserrec.html">userrec</a> *user)</td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Called whenever an extended mode is to be processed. </em> <a href="#a11"></a><em><br><br></td></tr> -<tr><td class="memItemLeft" nowrap align=right valign=top>virtual int </td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a12">OnUserPreJoin</a> (<a class="el" href="classuserrec.html">userrec</a> *user, <a class="el" href="classchanrec.html">chanrec</a> *chan, const char *cname)</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Called when a raw command is transmitted or received. </em> <a href="#a11"></a><em><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual int </td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a12">OnExtendedMode</a> (<a class="el" href="classuserrec.html">userrec</a> *user, void *target, char modechar, int type, bool mode_on, <a class="el" href="modules_8h.html#a32">string_list</a> &params)</td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Called whenever a user is about to join a channel, before any processing is done. </em> <a href="#a12"></a><em><br><br></td></tr> -<tr><td class="memItemLeft" nowrap align=right valign=top>virtual int </td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a13">OnUserPreKick</a> (<a class="el" href="classuserrec.html">userrec</a> *source, <a class="el" href="classuserrec.html">userrec</a> *user, <a class="el" href="classchanrec.html">chanrec</a> *chan, std::string reason)</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Called whenever an extended mode is to be processed. </em> <a href="#a12"></a><em><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual int </td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a13">OnUserPreJoin</a> (<a class="el" href="classuserrec.html">userrec</a> *user, <a class="el" href="classchanrec.html">chanrec</a> *chan, const char *cname)</td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Called whenever a user is about to be kicked. </em> <a href="#a13"></a><em><br><br></td></tr> -<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a14">OnUserKick</a> (<a class="el" href="classuserrec.html">userrec</a> *source, <a class="el" href="classuserrec.html">userrec</a> *user, <a class="el" href="classchanrec.html">chanrec</a> *chan, std::string reason)</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Called whenever a user is about to join a channel, before any processing is done. </em> <a href="#a13"></a><em><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual int </td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a14">OnUserPreKick</a> (<a class="el" href="classuserrec.html">userrec</a> *source, <a class="el" href="classuserrec.html">userrec</a> *user, <a class="el" href="classchanrec.html">chanrec</a> *chan, std::string reason)</td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Called whenever a user is kicked. </em> <a href="#a14"></a><em><br><br></td></tr> -<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a15">OnOper</a> (<a class="el" href="classuserrec.html">userrec</a> *user)</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Called whenever a user is about to be kicked. </em> <a href="#a14"></a><em><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a15">OnUserKick</a> (<a class="el" href="classuserrec.html">userrec</a> *source, <a class="el" href="classuserrec.html">userrec</a> *user, <a class="el" href="classchanrec.html">chanrec</a> *chan, std::string reason)</td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Called whenever a user opers locally. </em> <a href="#a15"></a><em><br><br></td></tr> -<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a16">OnInfo</a> (<a class="el" href="classuserrec.html">userrec</a> *user)</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Called whenever a user is kicked. </em> <a href="#a15"></a><em><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a16">OnOper</a> (<a class="el" href="classuserrec.html">userrec</a> *user)</td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Called whenever a user types /INFO. </em> <a href="#a16"></a><em><br><br></td></tr> -<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a17">OnWhois</a> (<a class="el" href="classuserrec.html">userrec</a> *source, <a class="el" href="classuserrec.html">userrec</a> *dest)</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Called whenever a user opers locally. </em> <a href="#a16"></a><em><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a17">OnInfo</a> (<a class="el" href="classuserrec.html">userrec</a> *user)</td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Called whenever a /WHOIS is performed on a local user. </em> <a href="#a17"></a><em><br><br></td></tr> -<tr><td class="memItemLeft" nowrap align=right valign=top>virtual int </td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a18">OnUserPreInvite</a> (<a class="el" href="classuserrec.html">userrec</a> *source, <a class="el" href="classuserrec.html">userrec</a> *dest, <a class="el" href="classchanrec.html">chanrec</a> *channel)</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Called whenever a user types /INFO. </em> <a href="#a17"></a><em><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a18">OnWhois</a> (<a class="el" href="classuserrec.html">userrec</a> *source, <a class="el" href="classuserrec.html">userrec</a> *dest)</td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Called whenever a user is about to invite another user into a channel, before any processing is done. </em> <a href="#a18"></a><em><br><br></td></tr> -<tr><td class="memItemLeft" nowrap align=right valign=top>virtual int </td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a19">OnUserPreMessage</a> (<a class="el" href="classuserrec.html">userrec</a> *user, void *dest, int target_type, std::string &text)</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Called whenever a /WHOIS is performed on a local user. </em> <a href="#a18"></a><em><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual int </td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a19">OnUserPreInvite</a> (<a class="el" href="classuserrec.html">userrec</a> *source, <a class="el" href="classuserrec.html">userrec</a> *dest, <a class="el" href="classchanrec.html">chanrec</a> *channel)</td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Called whenever a user is about to PRIVMSG A user or a channel, before any processing is done. </em> <a href="#a19"></a><em><br><br></td></tr> -<tr><td class="memItemLeft" nowrap align=right valign=top>virtual int </td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a20">OnUserPreNotice</a> (<a class="el" href="classuserrec.html">userrec</a> *user, void *dest, int target_type, std::string &text)</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Called whenever a user is about to invite another user into a channel, before any processing is done. </em> <a href="#a19"></a><em><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual int </td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a20">OnUserPreMessage</a> (<a class="el" href="classuserrec.html">userrec</a> *user, void *dest, int target_type, std::string &text)</td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Called whenever a user is about to NOTICE A user or a channel, before any processing is done. </em> <a href="#a20"></a><em><br><br></td></tr> -<tr><td class="memItemLeft" nowrap align=right valign=top>virtual int </td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a21">OnUserPreNick</a> (<a class="el" href="classuserrec.html">userrec</a> *user, std::string newnick)</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Called whenever a user is about to PRIVMSG A user or a channel, before any processing is done. </em> <a href="#a20"></a><em><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual int </td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a21">OnUserPreNotice</a> (<a class="el" href="classuserrec.html">userrec</a> *user, void *dest, int target_type, std::string &text)</td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Called before any nickchange, local or remote. </em> <a href="#a21"></a><em><br><br></td></tr> -<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a22">OnUserPostNick</a> (<a class="el" href="classuserrec.html">userrec</a> *user, std::string oldnick)</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Called whenever a user is about to NOTICE A user or a channel, before any processing is done. </em> <a href="#a21"></a><em><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual int </td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a22">OnUserPreNick</a> (<a class="el" href="classuserrec.html">userrec</a> *user, std::string newnick)</td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Called after any nickchange, local or remote. </em> <a href="#a22"></a><em><br><br></td></tr> -<tr><td class="memItemLeft" nowrap align=right valign=top>virtual int </td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a23">OnAccessCheck</a> (<a class="el" href="classuserrec.html">userrec</a> *source, <a class="el" href="classuserrec.html">userrec</a> *dest, <a class="el" href="classchanrec.html">chanrec</a> *channel, int access_type)</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Called before any nickchange, local or remote. </em> <a href="#a22"></a><em><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a23">OnUserPostNick</a> (<a class="el" href="classuserrec.html">userrec</a> *user, std::string oldnick)</td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Called before an action which requires a channel privilage check. </em> <a href="#a23"></a><em><br><br></td></tr> -<tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="modules_8h.html#a32">string_list</a> </td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a24">OnUserSync</a> (<a class="el" href="classuserrec.html">userrec</a> *user)</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Called after any nickchange, local or remote. </em> <a href="#a23"></a><em><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual int </td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a24">OnAccessCheck</a> (<a class="el" href="classuserrec.html">userrec</a> *source, <a class="el" href="classuserrec.html">userrec</a> *dest, <a class="el" href="classchanrec.html">chanrec</a> *channel, int access_type)</td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Called during a netburst to sync user data. </em> <a href="#a24"></a><em><br><br></td></tr> -<tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="modules_8h.html#a32">string_list</a> </td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a25">OnChannelSync</a> (<a class="el" href="classchanrec.html">chanrec</a> *chan)</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Called before an action which requires a channel privilage check. </em> <a href="#a24"></a><em><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="modules_8h.html#a32">string_list</a> </td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a25">OnUserSync</a> (<a class="el" href="classuserrec.html">userrec</a> *user)</td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Called during a netburst to sync channel data. </em> <a href="#a25"></a><em><br><br></td></tr> -<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a26">On005Numeric</a> (std::string &output)</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Called during a netburst to sync user data. </em> <a href="#a25"></a><em><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="modules_8h.html#a32">string_list</a> </td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a26">OnChannelSync</a> (<a class="el" href="classchanrec.html">chanrec</a> *chan)</td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Called when a 005 numeric is about to be output. </em> <a href="#a26"></a><em><br><br></td></tr> -<tr><td class="memItemLeft" nowrap align=right valign=top>virtual int </td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a27">OnKill</a> (<a class="el" href="classuserrec.html">userrec</a> *source, <a class="el" href="classuserrec.html">userrec</a> *dest, std::string reason)</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Called during a netburst to sync channel data. </em> <a href="#a26"></a><em><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a27">On005Numeric</a> (std::string &output)</td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Called when a client is disconnected by KILL. </em> <a href="#a27"></a><em><br><br></td></tr> -<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a28">OnLoadModule</a> (<a class="el" href="classModule.html">Module</a> *mod, std::string name)</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Called when a 005 numeric is about to be output. </em> <a href="#a27"></a><em><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual int </td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a28">OnKill</a> (<a class="el" href="classuserrec.html">userrec</a> *source, <a class="el" href="classuserrec.html">userrec</a> *dest, std::string reason)</td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Called whenever a module is loaded. </em> <a href="#a28"></a><em><br><br></td></tr> -<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a29">OnBackgroundTimer</a> (time_t curtime)</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Called when a client is disconnected by KILL. </em> <a href="#a28"></a><em><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a29">OnLoadModule</a> (<a class="el" href="classModule.html">Module</a> *mod, std::string name)</td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Called once every five seconds for background processing. </em> <a href="#a29"></a><em><br><br></td></tr> -<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a30">OnSendList</a> (<a class="el" href="classuserrec.html">userrec</a> *user, <a class="el" href="classchanrec.html">chanrec</a> *channel, char mode)</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Called whenever a module is loaded. </em> <a href="#a29"></a><em><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a30">OnBackgroundTimer</a> (time_t curtime)</td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Called whenever a list is needed for a listmode. </em> <a href="#a30"></a><em><br><br></td></tr> -<tr><td class="memItemLeft" nowrap align=right valign=top>virtual int </td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a31">OnPreCommand</a> (std::string command, char **parameters, int pcnt, <a class="el" href="classuserrec.html">userrec</a> *user)</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Called once every five seconds for background processing. </em> <a href="#a30"></a><em><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a31">OnSendList</a> (<a class="el" href="classuserrec.html">userrec</a> *user, <a class="el" href="classchanrec.html">chanrec</a> *channel, char mode)</td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Called whenever any command is about to be executed. </em> <a href="#a31"></a><em><br><br></td></tr> -<tr><td class="memItemLeft" nowrap align=right valign=top>virtual bool </td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a32">OnCheckReady</a> (<a class="el" href="classuserrec.html">userrec</a> *user)</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Called whenever a list is needed for a listmode. </em> <a href="#a31"></a><em><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual int </td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a32">OnPreCommand</a> (std::string command, char **parameters, int pcnt, <a class="el" href="classuserrec.html">userrec</a> *user)</td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Called to check if a user who is connecting can now be allowed to register If any modules return false for this function, the user is held in the waiting state until all modules return true. </em> <a href="#a32"></a><em><br><br></td></tr> -<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a33">OnUserRegister</a> (<a class="el" href="classuserrec.html">userrec</a> *user)</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Called whenever any command is about to be executed. </em> <a href="#a32"></a><em><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual bool </td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a33">OnCheckReady</a> (<a class="el" href="classuserrec.html">userrec</a> *user)</td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Called whenever a user is about to register their connection (e.g. </em> <a href="#a33"></a><em><br><br></td></tr> -<tr><td class="memItemLeft" nowrap align=right valign=top>virtual int </td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a34">OnRawMode</a> (<a class="el" href="classuserrec.html">userrec</a> *user, <a class="el" href="classchanrec.html">chanrec</a> *chan, char mode, std::string param, bool adding, int pcnt)</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Called to check if a user who is connecting can now be allowed to register If any modules return false for this function, the user is held in the waiting state until all modules return true. </em> <a href="#a33"></a><em><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a34">OnUserRegister</a> (<a class="el" href="classuserrec.html">userrec</a> *user)</td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Called whenever a mode character is processed. </em> <a href="#a34"></a><em><br><br></td></tr> -<tr><td class="memItemLeft" nowrap align=right valign=top>virtual int </td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a35">OnCheckInvite</a> (<a class="el" href="classuserrec.html">userrec</a> *user, <a class="el" href="classchanrec.html">chanrec</a> *chan)</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Called whenever a user is about to register their connection (e.g. </em> <a href="#a34"></a><em><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual int </td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a35">OnRawMode</a> (<a class="el" href="classuserrec.html">userrec</a> *user, <a class="el" href="classchanrec.html">chanrec</a> *chan, char mode, std::string param, bool adding, int pcnt)</td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Called whenever a user joins a channel, to determine if invite checks should go ahead or not. </em> <a href="#a35"></a><em><br><br></td></tr> -<tr><td class="memItemLeft" nowrap align=right valign=top>virtual int </td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a36">OnCheckKey</a> (<a class="el" href="classuserrec.html">userrec</a> *user, <a class="el" href="classchanrec.html">chanrec</a> *chan, std::string keygiven)</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Called whenever a mode character is processed. </em> <a href="#a35"></a><em><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual int </td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a36">OnCheckInvite</a> (<a class="el" href="classuserrec.html">userrec</a> *user, <a class="el" href="classchanrec.html">chanrec</a> *chan)</td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Called whenever a user joins a channel, to determine if key checks should go ahead or not. </em> <a href="#a36"></a><em><br><br></td></tr> -<tr><td class="memItemLeft" nowrap align=right valign=top>virtual int </td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a37">OnCheckLimit</a> (<a class="el" href="classuserrec.html">userrec</a> *user, <a class="el" href="classchanrec.html">chanrec</a> *chan)</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Called whenever a user joins a channel, to determine if invite checks should go ahead or not. </em> <a href="#a36"></a><em><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual int </td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a37">OnCheckKey</a> (<a class="el" href="classuserrec.html">userrec</a> *user, <a class="el" href="classchanrec.html">chanrec</a> *chan, std::string keygiven)</td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Called whenever a user joins a channel, to determine if channel limit checks should go ahead or not. </em> <a href="#a37"></a><em><br><br></td></tr> -<tr><td class="memItemLeft" nowrap align=right valign=top>virtual int </td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a38">OnCheckBan</a> (<a class="el" href="classuserrec.html">userrec</a> *user, <a class="el" href="classchanrec.html">chanrec</a> *chan)</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Called whenever a user joins a channel, to determine if key checks should go ahead or not. </em> <a href="#a37"></a><em><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual int </td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a38">OnCheckLimit</a> (<a class="el" href="classuserrec.html">userrec</a> *user, <a class="el" href="classchanrec.html">chanrec</a> *chan)</td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Called whenever a user joins a channel, to determine if banlist checks should go ahead or not. </em> <a href="#a38"></a><em><br><br></td></tr> -<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a39">OnStats</a> (char symbol)</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Called whenever a user joins a channel, to determine if channel limit checks should go ahead or not. </em> <a href="#a38"></a><em><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual int </td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a39">OnCheckBan</a> (<a class="el" href="classuserrec.html">userrec</a> *user, <a class="el" href="classchanrec.html">chanrec</a> *chan)</td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Called on all /STATS commands This method is triggered for all /STATS use, including stats symbols handled by the core. </em> <a href="#a39"></a><em><br><br></td></tr> -<tr><td class="memItemLeft" nowrap align=right valign=top>virtual int </td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a40">OnChangeLocalUserHost</a> (<a class="el" href="classuserrec.html">userrec</a> *user, std::string newhost)</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Called whenever a user joins a channel, to determine if banlist checks should go ahead or not. </em> <a href="#a39"></a><em><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a40">OnStats</a> (char symbol)</td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Called whenever a change of a local users displayed host is attempted. </em> <a href="#a40"></a><em><br><br></td></tr> -<tr><td class="memItemLeft" nowrap align=right valign=top>virtual int </td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a41">OnChangeLocalUserGECOS</a> (<a class="el" href="classuserrec.html">userrec</a> *user, std::string newhost)</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Called on all /STATS commands This method is triggered for all /STATS use, including stats symbols handled by the core. </em> <a href="#a40"></a><em><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual int </td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a41">OnChangeLocalUserHost</a> (<a class="el" href="classuserrec.html">userrec</a> *user, std::string newhost)</td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Called whenever a change of a local users GECOS (fullname field) is attempted. </em> <a href="#a41"></a><em><br><br></td></tr> -<tr><td class="memItemLeft" nowrap align=right valign=top>virtual int </td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a42">OnLocalTopicChange</a> (<a class="el" href="classuserrec.html">userrec</a> *user, <a class="el" href="classchanrec.html">chanrec</a> *chan, std::string topic)</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Called whenever a change of a local users displayed host is attempted. </em> <a href="#a41"></a><em><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual int </td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a42">OnChangeLocalUserGECOS</a> (<a class="el" href="classuserrec.html">userrec</a> *user, std::string newhost)</td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Called whenever a topic is changed by a local user. </em> <a href="#a42"></a><em><br><br></td></tr> -<tr><td class="memItemLeft" nowrap align=right valign=top>virtual int </td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a43">OnMeshToken</a> (char token, <a class="el" href="modules_8h.html#a32">string_list</a> params, <a class="el" href="classserverrec.html">serverrec</a> *source, <a class="el" href="classserverrec.html">serverrec</a> *reply, std::string tcp_host, std::string ipaddr, int port)</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Called whenever a change of a local users GECOS (fullname field) is attempted. </em> <a href="#a42"></a><em><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual int </td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a43">OnLocalTopicChange</a> (<a class="el" href="classuserrec.html">userrec</a> *user, <a class="el" href="classchanrec.html">chanrec</a> *chan, std::string topic)</td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Called whenever an unknown token is received in a server to server link. </em> <a href="#a43"></a><em><br><br></td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Called whenever a topic is changed by a local user. </em> <a href="#a43"></a><em><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual int </td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a44">OnMeshToken</a> (char token, <a class="el" href="modules_8h.html#a32">string_list</a> params, <a class="el" href="classserverrec.html">serverrec</a> *source, <a class="el" href="classserverrec.html">serverrec</a> *reply, std::string tcp_host, std::string ipaddr, int port)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Called whenever an unknown token is received in a server to server link. </em> <a href="#a44"></a><em><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a45">OnEvent</a> (<a class="el" href="classEvent.html">Event</a> *event)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Called whenever an <a class="el" href="classEvent.html">Event</a> class is sent to all module by another module. </em> <a href="#a45"></a><em><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual char * </td><td class="memItemRight" valign=bottom><a class="el" href="classModule.html#a46">OnRequest</a> (<a class="el" href="classRequest.html">Request</a> *request)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Called whenever a <a class="el" href="classRequest.html">Request</a> class is sent to your module by another module. </em> <a href="#a46"></a><em><br><br></td></tr> </table> <hr><a name="_details"></a><h2>Detailed Description</h2> Base class for all InspIRCd modules This class is the base class for InspIRCd modules. @@ -155,7 +164,7 @@ All modules must inherit from this class, its methods will be called when irc se <p> <p> -Definition at line <a class="el" href="modules_8h-source.html#l00135">135</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.<hr><h2>Constructor & Destructor Documentation</h2> +Definition at line <a class="el" href="modules_8h-source.html#l00233">233</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.<hr><h2>Constructor & Destructor Documentation</h2> <a name="a0" doxytag="Module::Module"></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> @@ -185,9 +194,9 @@ Default constructor creates a module class. <p> <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00306">306</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +Definition at line <a class="el" href="modules_8cpp-source.html#l00361">361</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00306 { } +<div class="fragment"><pre>00361 { } </pre></div> </td> </tr> </table> @@ -220,9 +229,9 @@ Default destructor destroys a module class. <p> <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00307">307</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +Definition at line <a class="el" href="modules_8cpp-source.html#l00362">362</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00307 { } +<div class="fragment"><pre>00362 { } </pre></div> </td> </tr> </table> @@ -256,15 +265,15 @@ Returns the version number of a Module. <p> The method should return a <a class="el" href="classVersion.html">Version</a> object with its version information assigned via <a class="el" href="classVersion.html#a0">Version::Version</a> <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00318">318</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +Definition at line <a class="el" href="modules_8cpp-source.html#l00374">374</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> References <a class="el" href="modules_8h-source.html#l00054">VF_VENDOR</a>. <p> -<div class="fragment"><pre>00318 { <span class="keywordflow">return</span> <a class="code" href="classVersion.html">Version</a>(1,0,0,0,VF_VENDOR); } +<div class="fragment"><pre>00374 { <span class="keywordflow">return</span> <a class="code" href="classVersion.html">Version</a>(1,0,0,0,VF_VENDOR); } </pre></div> </td> </tr> </table> -<a name="a26" doxytag="Module::On005Numeric"></a><p> +<a name="a27" doxytag="Module::On005Numeric"></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> @@ -294,13 +303,13 @@ Called when a 005 numeric is about to be output. <p> The module should modify the 005 numeric if needed to indicate its features. <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00330">330</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +Definition at line <a class="el" href="modules_8cpp-source.html#l00386">386</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00330 { }; +<div class="fragment"><pre>00386 { }; </pre></div> </td> </tr> </table> -<a name="a23" doxytag="Module::OnAccessCheck"></a><p> +<a name="a24" doxytag="Module::OnAccessCheck"></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> @@ -363,15 +372,15 @@ This function is called before many functions which check a users status on a ch <br> 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). <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00327">327</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +Definition at line <a class="el" href="modules_8cpp-source.html#l00383">383</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> References <a class="el" href="modules_8h-source.html#l00037">ACR_DEFAULT</a>. <p> -<div class="fragment"><pre>00327 { <span class="keywordflow">return</span> <a class="code" href="modules_8h.html#a8">ACR_DEFAULT</a>; }; +<div class="fragment"><pre>00383 { <span class="keywordflow">return</span> <a class="code" href="modules_8h.html#a8">ACR_DEFAULT</a>; }; </pre></div> </td> </tr> </table> -<a name="a29" doxytag="Module::OnBackgroundTimer"></a><p> +<a name="a30" doxytag="Module::OnBackgroundTimer"></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> @@ -401,13 +410,13 @@ Called once every five seconds for background processing. <p> 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. <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00333">333</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +Definition at line <a class="el" href="modules_8cpp-source.html#l00389">389</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00333 { }; +<div class="fragment"><pre>00389 { }; </pre></div> </td> </tr> </table> -<a name="a41" doxytag="Module::OnChangeLocalUserGECOS"></a><p> +<a name="a42" doxytag="Module::OnChangeLocalUserGECOS"></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> @@ -446,13 +455,13 @@ Called whenever a change of a local users GECOS (fullname field) is attempted. <p> return 1 to deny the name change, or 0 to allow it. <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00347">347</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +Definition at line <a class="el" href="modules_8cpp-source.html#l00403">403</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00347 { <span class="keywordflow">return</span> 0; }; +<div class="fragment"><pre>00403 { <span class="keywordflow">return</span> 0; }; </pre></div> </td> </tr> </table> -<a name="a40" doxytag="Module::OnChangeLocalUserHost"></a><p> +<a name="a41" doxytag="Module::OnChangeLocalUserHost"></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> @@ -491,13 +500,13 @@ Called whenever a change of a local users displayed host is attempted. <p> Return 1 to deny the host change, or 0 to allow it. <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00346">346</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +Definition at line <a class="el" href="modules_8cpp-source.html#l00402">402</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00346 { <span class="keywordflow">return</span> 0; }; +<div class="fragment"><pre>00402 { <span class="keywordflow">return</span> 0; }; </pre></div> </td> </tr> </table> -<a name="a25" doxytag="Module::OnChannelSync"></a><p> +<a name="a26" doxytag="Module::OnChannelSync"></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> @@ -527,15 +536,15 @@ Called during a netburst to sync channel data. <p> This is called during the netburst on a per-channel basis. You should use this call to up any special channel-related things which are implemented by your module, e.g. sending listmodes. You may return multiple commands in the string_list. <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00329">329</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +Definition at line <a class="el" href="modules_8cpp-source.html#l00385">385</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> References <a class="el" href="modules_8h-source.html#l00068">string_list</a>. <p> -<div class="fragment"><pre>00329 { <a class="code" href="modules_8h.html#a32">string_list</a> empty; <span class="keywordflow">return</span> empty; } +<div class="fragment"><pre>00385 { <a class="code" href="modules_8h.html#a32">string_list</a> empty; <span class="keywordflow">return</span> empty; } </pre></div> </td> </tr> </table> -<a name="a38" doxytag="Module::OnCheckBan"></a><p> +<a name="a39" doxytag="Module::OnCheckBan"></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> @@ -574,13 +583,13 @@ Called whenever a user joins a channel, to determine if banlist checks should go <p> 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. <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00344">344</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +Definition at line <a class="el" href="modules_8cpp-source.html#l00400">400</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00344 { <span class="keywordflow">return</span> 0; }; +<div class="fragment"><pre>00400 { <span class="keywordflow">return</span> 0; }; </pre></div> </td> </tr> </table> -<a name="a35" doxytag="Module::OnCheckInvite"></a><p> +<a name="a36" doxytag="Module::OnCheckInvite"></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> @@ -619,13 +628,13 @@ Called whenever a user joins a channel, to determine if invite checks should go <p> 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. <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00341">341</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +Definition at line <a class="el" href="modules_8cpp-source.html#l00397">397</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00341 { <span class="keywordflow">return</span> 0; }; +<div class="fragment"><pre>00397 { <span class="keywordflow">return</span> 0; }; </pre></div> </td> </tr> </table> -<a name="a36" doxytag="Module::OnCheckKey"></a><p> +<a name="a37" doxytag="Module::OnCheckKey"></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> @@ -670,13 +679,13 @@ Called whenever a user joins a channel, to determine if key checks should go ahe <p> 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. <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00342">342</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +Definition at line <a class="el" href="modules_8cpp-source.html#l00398">398</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00342 { <span class="keywordflow">return</span> 0; }; +<div class="fragment"><pre>00398 { <span class="keywordflow">return</span> 0; }; </pre></div> </td> </tr> </table> -<a name="a37" doxytag="Module::OnCheckLimit"></a><p> +<a name="a38" doxytag="Module::OnCheckLimit"></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> @@ -715,13 +724,13 @@ Called whenever a user joins a channel, to determine if channel limit checks sho <p> 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. <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00343">343</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +Definition at line <a class="el" href="modules_8cpp-source.html#l00399">399</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00343 { <span class="keywordflow">return</span> 0; }; +<div class="fragment"><pre>00399 { <span class="keywordflow">return</span> 0; }; </pre></div> </td> </tr> </table> -<a name="a32" doxytag="Module::OnCheckReady"></a><p> +<a name="a33" doxytag="Module::OnCheckReady"></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> @@ -751,13 +760,49 @@ Called to check if a user who is connecting can now be allowed to register If an <p> 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. <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00336">336</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +Definition at line <a class="el" href="modules_8cpp-source.html#l00392">392</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00336 { <span class="keywordflow">return</span> <span class="keyword">true</span>; }; +<div class="fragment"><pre>00392 { <span class="keywordflow">return</span> <span class="keyword">true</span>; }; </pre></div> </td> </tr> </table> -<a name="a11" doxytag="Module::OnExtendedMode"></a><p> +<a name="a45" doxytag="Module::OnEvent"></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void Module::OnEvent </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="classEvent.html">Event</a> * </td> + <td class="mdname1" valign="top" nowrap> <em>event</em> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap><code> [virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Called whenever an <a class="el" href="classEvent.html">Event</a> class is sent to all module by another module. +<p> +Please see the documentation of <a class="el" href="classEvent.html#a4">Event::Send()</a> for further information. The <a class="el" href="classEvent.html">Event</a> sent can always be assumed to be non-NULL, you should *always* check the value of <a class="el" href="classEvent.html#a3">Event::GetEventID()</a> before doing anything to the event data, and you should *not* change the event data in any way! +<p> +Definition at line <a class="el" href="modules_8cpp-source.html#l00406">406</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +<p> +<div class="fragment"><pre>00406 { <span class="keywordflow">return</span>; }; +</pre></div> </td> + </tr> +</table> +<a name="a12" doxytag="Module::OnExtendedMode"></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> @@ -820,13 +865,13 @@ Called whenever an extended mode is to be processed. <p> The type parameter is MT_SERVER, MT_CLIENT or MT_CHANNEL, dependent on where the mode is being changed. mode_on is set when the mode is being set, in which case params contains a list of parameters for the mode as strings. If mode_on is false, the mode is being removed, and parameters may contain the parameters for the mode, dependent on wether they were defined when a mode handler was set up with <a class="el" href="classServer.html#a21">Server::AddExtendedMode</a> If the mode is a channel mode, target is a chanrec*, and if it is a user mode, target is a userrec*. You must cast this value yourself to make use of it. <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00317">317</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +Definition at line <a class="el" href="modules_8cpp-source.html#l00373">373</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00317 { <span class="keywordflow">return</span> <span class="keyword">false</span>; } +<div class="fragment"><pre>00373 { <span class="keywordflow">return</span> <span class="keyword">false</span>; } </pre></div> </td> </tr> </table> -<a name="a16" doxytag="Module::OnInfo"></a><p> +<a name="a17" doxytag="Module::OnInfo"></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> @@ -857,13 +902,13 @@ Called whenever a user types /INFO. 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> <nick> :information here <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00320">320</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +Definition at line <a class="el" href="modules_8cpp-source.html#l00376">376</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00320 { }; +<div class="fragment"><pre>00376 { }; </pre></div> </td> </tr> </table> -<a name="a27" doxytag="Module::OnKill"></a><p> +<a name="a28" doxytag="Module::OnKill"></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> @@ -908,13 +953,13 @@ Called when a client is disconnected by KILL. <p> If a client is killed by a server, e.g. a nickname collision or protocol error, source is NULL. Return 1 from this function to prevent the kill, and 0 from this function to allow it as normal. If you prevent the kill no output will be sent to the client, it is down to your module to generate this information. NOTE: It is NOT advisable to stop kills which originate from servers. If you do so youre risking race conditions, desyncs and worse! <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00331">331</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +Definition at line <a class="el" href="modules_8cpp-source.html#l00387">387</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00331 { <span class="keywordflow">return</span> 0; }; +<div class="fragment"><pre>00387 { <span class="keywordflow">return</span> 0; }; </pre></div> </td> </tr> </table> -<a name="a28" doxytag="Module::OnLoadModule"></a><p> +<a name="a29" doxytag="Module::OnLoadModule"></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> @@ -953,13 +998,13 @@ Called whenever a module is loaded. <p> 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). <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00332">332</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +Definition at line <a class="el" href="modules_8cpp-source.html#l00388">388</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00332 { }; +<div class="fragment"><pre>00388 { }; </pre></div> </td> </tr> </table> -<a name="a42" doxytag="Module::OnLocalTopicChange"></a><p> +<a name="a43" doxytag="Module::OnLocalTopicChange"></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> @@ -1004,13 +1049,13 @@ Called whenever a topic is changed by a local user. <p> Return 1 to deny the topic change, or 0 to allow it. <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00348">348</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +Definition at line <a class="el" href="modules_8cpp-source.html#l00404">404</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00348 { <span class="keywordflow">return</span> 0; }; +<div class="fragment"><pre>00404 { <span class="keywordflow">return</span> 0; }; </pre></div> </td> </tr> </table> -<a name="a43" doxytag="Module::OnMeshToken"></a><p> +<a name="a44" doxytag="Module::OnMeshToken"></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> @@ -1079,13 +1124,13 @@ Called whenever an unknown token is received in a server to server link. <p> The token value is the unknown token -- please check that no other modules are using the token that you use. Returning 1 supresses the 'unknown token type' error which is usually sent to all opers with +s. The params list is a list of parameters, and if any parameters start with a colon (:) it is treated as the whole of the last parameter, identical to how RFC messages are handled. source is the sender of the message, and reply is what should be replied to for a unicast message. Note that there are not many messages in the mesh protocol which require unicast messaging. tcp_host is the server name as a string, ipaddr is its ip address in dotted decimal notation and port is the port number it is using. <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00349">349</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +Definition at line <a class="el" href="modules_8cpp-source.html#l00405">405</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00349 { <span class="keywordflow">return</span> 0; }; +<div class="fragment"><pre>00405 { <span class="keywordflow">return</span> 0; }; </pre></div> </td> </tr> </table> -<a name="a15" doxytag="Module::OnOper"></a><p> +<a name="a16" doxytag="Module::OnOper"></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> @@ -1115,13 +1160,13 @@ Called whenever a user opers locally. <p> 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. <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00319">319</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +Definition at line <a class="el" href="modules_8cpp-source.html#l00375">375</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00319 { }; +<div class="fragment"><pre>00375 { }; </pre></div> </td> </tr> </table> -<a name="a8" doxytag="Module::OnPacketReceive"></a><p> +<a name="a9" doxytag="Module::OnPacketReceive"></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> @@ -1160,13 +1205,13 @@ Called after a packet is received from another irc server. <p> This allows you to easily represent it in the correct ways to implement encryption, compression, digital signatures and anything else you may want to add. This should be regarded as a pre-processor and will be called immediately after the packet is received but before any other operations with the core of the ircd. <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00313">313</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +Definition at line <a class="el" href="modules_8cpp-source.html#l00369">369</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00313 { } +<div class="fragment"><pre>00369 { } </pre></div> </td> </tr> </table> -<a name="a7" doxytag="Module::OnPacketTransmit"></a><p> +<a name="a8" doxytag="Module::OnPacketTransmit"></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> @@ -1205,13 +1250,13 @@ Called before a packet is transmitted across the irc network between two irc ser <p> This allows you to easily represent it in the correct ways to implement encryption, compression, digital signatures and anything else you may want to add. This should be regarded as a pre-processor and will be called before ANY other operations within the ircd core program. <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00312">312</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +Definition at line <a class="el" href="modules_8cpp-source.html#l00368">368</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00312 { } +<div class="fragment"><pre>00368 { } </pre></div> </td> </tr> </table> -<a name="a31" doxytag="Module::OnPreCommand"></a><p> +<a name="a32" doxytag="Module::OnPreCommand"></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> @@ -1262,13 +1307,13 @@ Called whenever any command is about to be executed. <p> This event occurs for all registered commands, wether they are registered in the core, or another module, but it will not occur for invalid commands (e.g. ones which do not exist within the command table). By returning 1 from this method you may prevent the command being executed. If you do this, no output is created by the core, and it is down to your module to produce any output neccessary. Note that unless you return 1, you should not destroy any structures (e.g. by using <a class="el" href="classServer.html#a29">Server::QuitUser</a>) otherwise when the command's handler function executes after your method returns, it will be passed an invalid pointer to the user object and crash!) <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00335">335</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +Definition at line <a class="el" href="modules_8cpp-source.html#l00391">391</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00335 { <span class="keywordflow">return</span> 0; }; +<div class="fragment"><pre>00391 { <span class="keywordflow">return</span> 0; }; </pre></div> </td> </tr> </table> -<a name="a34" doxytag="Module::OnRawMode"></a><p> +<a name="a35" doxytag="Module::OnRawMode"></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> @@ -1331,13 +1376,13 @@ Called whenever a mode character is processed. <p> 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! <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00340">340</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +Definition at line <a class="el" href="modules_8cpp-source.html#l00396">396</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00340 { <span class="keywordflow">return</span> 0; }; +<div class="fragment"><pre>00396 { <span class="keywordflow">return</span> 0; }; </pre></div> </td> </tr> </table> -<a name="a9" doxytag="Module::OnRehash"></a><p> +<a name="a10" doxytag="Module::OnRehash"></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> @@ -1366,13 +1411,51 @@ Called on rehash. <p> 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. <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00314">314</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +Definition at line <a class="el" href="modules_8cpp-source.html#l00370">370</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +<p> +<div class="fragment"><pre>00370 { } +</pre></div> </td> + </tr> +</table> +<a name="a46" doxytag="Module::OnRequest"></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> char * Module::OnRequest </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="classRequest.html">Request</a> * </td> + <td class="mdname1" valign="top" nowrap> <em>request</em> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap><code> [virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Called whenever a <a class="el" href="classRequest.html">Request</a> class is sent to your module by another module. <p> -<div class="fragment"><pre>00314 { } +Please see the documentation of <a class="el" href="classRequest.html#a4">Request::Send()</a> for further information. The <a class="el" href="classRequest.html">Request</a> sent can always be assumed to be non-NULL, you should not change the request object or its data. Your method may return arbitary data in the char* result which the requesting module may be able to use for pre-determined purposes (e.g. the results of an SQL query, etc). +<p> +Definition at line <a class="el" href="modules_8cpp-source.html#l00407">407</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +<p> +Referenced by <a class="el" href="modules_8cpp-source.html#l00325">Request::Send()</a>. +<p> +<div class="fragment"><pre>00407 { <span class="keywordflow">return</span> NULL; }; </pre></div> </td> </tr> </table> -<a name="a30" doxytag="Module::OnSendList"></a><p> +<a name="a31" doxytag="Module::OnSendList"></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> @@ -1417,13 +1500,13 @@ Called whenever a list is needed for a listmode. <p> 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. <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00334">334</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +Definition at line <a class="el" href="modules_8cpp-source.html#l00390">390</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00334 { }; +<div class="fragment"><pre>00390 { }; </pre></div> </td> </tr> </table> -<a name="a10" doxytag="Module::OnServerRaw"></a><p> +<a name="a11" doxytag="Module::OnServerRaw"></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> @@ -1468,13 +1551,13 @@ Called when a raw command is transmitted or received. <p> 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. <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00315">315</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +Definition at line <a class="el" href="modules_8cpp-source.html#l00371">371</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00315 { } +<div class="fragment"><pre>00371 { } </pre></div> </td> </tr> </table> -<a name="a39" doxytag="Module::OnStats"></a><p> +<a name="a40" doxytag="Module::OnStats"></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> @@ -1504,9 +1587,9 @@ Called on all /STATS commands This method is triggered for all /STATS use, inclu <p> <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00345">345</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +Definition at line <a class="el" href="modules_8cpp-source.html#l00401">401</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00345 { }; +<div class="fragment"><pre>00401 { }; </pre></div> </td> </tr> </table> @@ -1540,13 +1623,49 @@ Called when a user connects. <p> The details of the connecting user are available to you in the parameter userrec *user <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00308">308</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +Definition at line <a class="el" href="modules_8cpp-source.html#l00363">363</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +<p> +<div class="fragment"><pre>00363 { } +</pre></div> </td> + </tr> +</table> +<a name="a5" doxytag="Module::OnUserDisconnect"></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void Module::OnUserDisconnect </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> * </td> + <td class="mdname1" valign="top" nowrap> <em>user</em> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap><code> [virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Called whenever a user's socket is closed. +<p> +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. +<p> +Definition at line <a class="el" href="modules_8cpp-source.html#l00365">365</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00308 { } +<div class="fragment"><pre>00365 { } </pre></div> </td> </tr> </table> -<a name="a5" doxytag="Module::OnUserJoin"></a><p> +<a name="a6" doxytag="Module::OnUserJoin"></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> @@ -1585,13 +1704,13 @@ Called when a user joins a channel. <p> 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 <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00310">310</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +Definition at line <a class="el" href="modules_8cpp-source.html#l00366">366</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00310 { } +<div class="fragment"><pre>00366 { } </pre></div> </td> </tr> </table> -<a name="a14" doxytag="Module::OnUserKick"></a><p> +<a name="a15" doxytag="Module::OnUserKick"></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> @@ -1640,15 +1759,15 @@ Definition at line <a class="el" href="modules_8cpp-source.html#l00310">310</a> <p> Called whenever a user is kicked. <p> -If this method is called, the kick is already underway and cannot be prevented, so to prevent a kick, please use <a class="el" href="classModule.html#a13">Module::OnUserPreKick</a> instead of this method. +If this method is called, the kick is already underway and cannot be prevented, so to prevent a kick, please use <a class="el" href="classModule.html#a14">Module::OnUserPreKick</a> instead of this method. <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00339">339</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +Definition at line <a class="el" href="modules_8cpp-source.html#l00395">395</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00339 { }; +<div class="fragment"><pre>00395 { }; </pre></div> </td> </tr> </table> -<a name="a6" doxytag="Module::OnUserPart"></a><p> +<a name="a7" doxytag="Module::OnUserPart"></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> @@ -1687,13 +1806,13 @@ Called when a user parts a channel. <p> 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 <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00311">311</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +Definition at line <a class="el" href="modules_8cpp-source.html#l00367">367</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00311 { } +<div class="fragment"><pre>00367 { } </pre></div> </td> </tr> </table> -<a name="a22" doxytag="Module::OnUserPostNick"></a><p> +<a name="a23" doxytag="Module::OnUserPostNick"></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> @@ -1732,13 +1851,13 @@ Called after any nickchange, local or remote. <p> 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->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. <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00326">326</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +Definition at line <a class="el" href="modules_8cpp-source.html#l00382">382</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00326 { }; +<div class="fragment"><pre>00382 { }; </pre></div> </td> </tr> </table> -<a name="a18" doxytag="Module::OnUserPreInvite"></a><p> +<a name="a19" doxytag="Module::OnUserPreInvite"></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> @@ -1783,13 +1902,13 @@ Called whenever a user is about to invite another user into a channel, before an <p> 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. <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00322">322</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +Definition at line <a class="el" href="modules_8cpp-source.html#l00378">378</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00322 { <span class="keywordflow">return</span> 0; }; +<div class="fragment"><pre>00378 { <span class="keywordflow">return</span> 0; }; </pre></div> </td> </tr> </table> -<a name="a12" doxytag="Module::OnUserPreJoin"></a><p> +<a name="a13" doxytag="Module::OnUserPreJoin"></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> @@ -1836,13 +1955,13 @@ Returning a value of 1 from this function stops the process immediately, causing IMPORTANT NOTE!<p> 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. <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00316">316</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +Definition at line <a class="el" href="modules_8cpp-source.html#l00372">372</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00316 { <span class="keywordflow">return</span> 0; } +<div class="fragment"><pre>00372 { <span class="keywordflow">return</span> 0; } </pre></div> </td> </tr> </table> -<a name="a13" doxytag="Module::OnUserPreKick"></a><p> +<a name="a14" doxytag="Module::OnUserPreKick"></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> @@ -1893,13 +2012,13 @@ Called whenever a user is about to be kicked. <p> 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. <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00338">338</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +Definition at line <a class="el" href="modules_8cpp-source.html#l00394">394</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00338 { <span class="keywordflow">return</span> 0; }; +<div class="fragment"><pre>00394 { <span class="keywordflow">return</span> 0; }; </pre></div> </td> </tr> </table> -<a name="a19" doxytag="Module::OnUserPreMessage"></a><p> +<a name="a20" doxytag="Module::OnUserPreMessage"></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> @@ -1950,13 +2069,13 @@ Called whenever a user is about to PRIVMSG A user or a channel, before any proce <p> 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. <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00323">323</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +Definition at line <a class="el" href="modules_8cpp-source.html#l00379">379</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00323 { <span class="keywordflow">return</span> 0; }; +<div class="fragment"><pre>00379 { <span class="keywordflow">return</span> 0; }; </pre></div> </td> </tr> </table> -<a name="a21" doxytag="Module::OnUserPreNick"></a><p> +<a name="a22" doxytag="Module::OnUserPreNick"></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> @@ -1995,13 +2114,13 @@ Called before any nickchange, local or remote. <p> 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->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. <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00325">325</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +Definition at line <a class="el" href="modules_8cpp-source.html#l00381">381</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00325 { <span class="keywordflow">return</span> 0; }; +<div class="fragment"><pre>00381 { <span class="keywordflow">return</span> 0; }; </pre></div> </td> </tr> </table> -<a name="a20" doxytag="Module::OnUserPreNotice"></a><p> +<a name="a21" doxytag="Module::OnUserPreNotice"></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> @@ -2052,9 +2171,9 @@ Called whenever a user is about to NOTICE A user or a channel, before any proces <p> 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. <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00324">324</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +Definition at line <a class="el" href="modules_8cpp-source.html#l00380">380</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00324 { <span class="keywordflow">return</span> 0; }; +<div class="fragment"><pre>00380 { <span class="keywordflow">return</span> 0; }; </pre></div> </td> </tr> </table> @@ -2086,15 +2205,15 @@ Definition at line <a class="el" href="modules_8cpp-source.html#l00324">324</a> <p> Called when a user quits. <p> -The details of the exiting user are available to you in the parameter userrec *user +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. <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00309">309</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +Definition at line <a class="el" href="modules_8cpp-source.html#l00364">364</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00309 { } +<div class="fragment"><pre>00364 { } </pre></div> </td> </tr> </table> -<a name="a33" doxytag="Module::OnUserRegister"></a><p> +<a name="a34" doxytag="Module::OnUserRegister"></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> @@ -2124,13 +2243,13 @@ Called whenever a user is about to register their connection (e.g. <p> 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. <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00337">337</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +Definition at line <a class="el" href="modules_8cpp-source.html#l00393">393</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00337 { }; +<div class="fragment"><pre>00393 { }; </pre></div> </td> </tr> </table> -<a name="a24" doxytag="Module::OnUserSync"></a><p> +<a name="a25" doxytag="Module::OnUserSync"></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> @@ -2160,15 +2279,15 @@ Called during a netburst to sync user data. <p> This is called during the netburst on a per-user basis. You should use this call to up any special user-related things which are implemented by your module, e.g. sending listmodes. You may return multiple commands in the string_list. <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00328">328</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +Definition at line <a class="el" href="modules_8cpp-source.html#l00384">384</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> References <a class="el" href="modules_8h-source.html#l00068">string_list</a>. <p> -<div class="fragment"><pre>00328 { <a class="code" href="modules_8h.html#a32">string_list</a> empty; <span class="keywordflow">return</span> empty; } +<div class="fragment"><pre>00384 { <a class="code" href="modules_8h.html#a32">string_list</a> empty; <span class="keywordflow">return</span> empty; } </pre></div> </td> </tr> </table> -<a name="a17" doxytag="Module::OnWhois"></a><p> +<a name="a18" doxytag="Module::OnWhois"></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> @@ -2207,15 +2326,15 @@ Called whenever a /WHOIS is performed on a local user. <p> 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. <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00321">321</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +Definition at line <a class="el" href="modules_8cpp-source.html#l00377">377</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00321 { }; +<div class="fragment"><pre>00377 { }; </pre></div> </td> </tr> </table> <hr>The documentation for this class was generated from the following files:<ul> <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> -<hr size="1"><address style="align: right;"><small>Generated on Sat Apr 16 18:57:20 2005 for InspIRCd by +<hr size="1"><address style="align: right;"><small>Generated on Wed Apr 20 15:47:06 2005 for InspIRCd by <a href="http://www.doxygen.org/index.html"> <img src="doxygen.png" alt="doxygen" align="middle" border=0 > </a>1.3.3 </small></address> |