diff options
Diffstat (limited to 'docs/module-doc/classModule.html')
| -rw-r--r-- | docs/module-doc/classModule.html | 166 |
1 files changed, 124 insertions, 42 deletions
diff --git a/docs/module-doc/classModule.html b/docs/module-doc/classModule.html index cd2fe531f..078603f8a 100644 --- a/docs/module-doc/classModule.html +++ b/docs/module-doc/classModule.html @@ -62,6 +62,10 @@ Inheritance diagram for Module:<p><center><img src="classModule__inherit__graph. <tr><td> </td><td><font size=-1><em>Called before any nickchange, local or remote.</em> <a href="#a18"></a><em></em></font><br><br></td></tr> <tr><td nowrap align=right valign=top>virtual int </td><td valign=bottom><a class="el" href="classModule.html#a19">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> </td><td><font size=-1><em>Called before an action which requires a channel privilage check.</em> <a href="#a19"></a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual <a class="el" href="modules_8h.html#a23">string_list</a> </td><td valign=bottom><a class="el" href="classModule.html#a20">OnUserSync</a> (<a class="el" href="classuserrec.html">userrec</a> *user)</td></tr> +<tr><td> </td><td><font size=-1><em>Called during a netburst to sync user data.</em> <a href="#a20"></a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual <a class="el" href="modules_8h.html#a23">string_list</a> </td><td valign=bottom><a class="el" href="classModule.html#a21">OnChannelSync</a> (<a class="el" href="classchanrec.html">chanrec</a> *chan)</td></tr> +<tr><td> </td><td><font size=-1><em>Called during a netburst to sync channel data.</em> <a href="#a21"></a><em></em></font><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. @@ -70,7 +74,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#l00112">112</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#l00116">116</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 width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> @@ -100,9 +104,9 @@ Default constructor creates a module class. <p> <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00139">139</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#l00285">285</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00139 { } +<div class="fragment"><pre>00285 { } </pre></div> </td> </tr> </table> @@ -135,9 +139,9 @@ Default destructor destroys a module class. <p> <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00140">140</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#l00286">286</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00140 { } +<div class="fragment"><pre>00286 { } </pre></div> </td> </tr> </table> @@ -171,9 +175,9 @@ 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#l00151">151</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#l00297">297</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00151 { <span class="keywordflow">return</span> <a class="code" href="classVersion.html">Version</a>(1,0,0,0); } +<div class="fragment"><pre>00297 { <span class="keywordflow">return</span> <a class="code" href="classVersion.html">Version</a>(1,0,0,0); } </pre></div> </td> </tr> </table> @@ -227,6 +231,7 @@ Definition at line <a class="el" href="modules_8cpp-source.html#l00151">151</a> Called before an action which requires a channel privilage check. <p> 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> +<br> AC_KICK (0) - A user is being kicked<br> AC_DEOP (1) - a user is being deopped<br> AC_OP (2) - a user is being opped<br> @@ -236,13 +241,52 @@ This function is called before many functions which check a users status on a ch AC_DEHALFOP (6) - a user is being dehalfopped<br> AC_INVITE (7) - a user is being invited<br> AC_GENERAL_MODE (8) - a user channel mode is being changed<br> +<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#l00158">158</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#l00304">304</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> References <a class="el" href="modules_8h-source.html#l00027">ACR_DEFAULT</a>. <p> -<div class="fragment"><pre>00158 { <span class="keywordflow">return</span> <a class="code" href="modules_8h.html#a8">ACR_DEFAULT</a>; }; +<div class="fragment"><pre>00304 { <span class="keywordflow">return</span> <a class="code" href="modules_8h.html#a8">ACR_DEFAULT</a>; }; +</pre></div> </td> + </tr> +</table> +<a name="a21" doxytag="Module::OnChannelSync"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> <a class="el" href="modules_8h.html#a23">string_list</a> Module::OnChannelSync </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="classchanrec.html">chanrec</a> * </td> + <td class="mdname1" valign="top" nowrap> <em>chan</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 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#l00306">306</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +<p> +References <a class="el" href="modules_8h-source.html#l00051">string_list</a>. +<p> +<div class="fragment"><pre>00306 { <a class="code" href="modules_8h.html#a23">string_list</a> empty; <span class="keywordflow">return</span> empty; } </pre></div> </td> </tr> </table> @@ -309,9 +353,9 @@ 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#l00150">150</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#l00296">296</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00150 { <span class="keywordflow">return</span> <span class="keyword">false</span>; } +<div class="fragment"><pre>00296 { <span class="keywordflow">return</span> <span class="keyword">false</span>; } </pre></div> </td> </tr> </table> @@ -346,9 +390,9 @@ 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> :information here <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00153">153</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#l00299">299</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00153 { }; +<div class="fragment"><pre>00299 { }; </pre></div> </td> </tr> </table> @@ -382,9 +426,9 @@ 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#l00152">152</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#l00298">298</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00152 { }; +<div class="fragment"><pre>00298 { }; </pre></div> </td> </tr> </table> @@ -418,9 +462,9 @@ Called after a packet is received from another irc server. <p> The packet is represented as a char*, as it should be regarded as a buffer, and not a string. 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#l00146">146</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#l00292">292</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00146 { } +<div class="fragment"><pre>00292 { } </pre></div> </td> </tr> </table> @@ -454,9 +498,9 @@ Called before a packet is transmitted across the irc network between two irc ser <p> The packet is represented as a char*, as it should be regarded as a buffer, and not a string. 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#l00145">145</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#l00291">291</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00145 { } +<div class="fragment"><pre>00291 { } </pre></div> </td> </tr> </table> @@ -489,9 +533,9 @@ 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#l00147">147</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#l00293">293</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00147 { } +<div class="fragment"><pre>00293 { } </pre></div> </td> </tr> </table> @@ -540,9 +584,9 @@ 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#l00148">148</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#l00294">294</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00148 { } +<div class="fragment"><pre>00294 { } </pre></div> </td> </tr> </table> @@ -576,9 +620,9 @@ 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#l00141">141</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#l00287">287</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00141 { } +<div class="fragment"><pre>00287 { } </pre></div> </td> </tr> </table> @@ -621,9 +665,9 @@ 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#l00143">143</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#l00289">289</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00143 { } +<div class="fragment"><pre>00289 { } </pre></div> </td> </tr> </table> @@ -666,9 +710,9 @@ 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#l00144">144</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#l00290">290</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00144 { } +<div class="fragment"><pre>00290 { } </pre></div> </td> </tr> </table> @@ -719,9 +763,9 @@ Returning any nonzero value from this function stops the process immediately, ca 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#l00149">149</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#l00295">295</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00149 { <span class="keywordflow">return</span> 0; } +<div class="fragment"><pre>00295 { <span class="keywordflow">return</span> 0; } </pre></div> </td> </tr> </table> @@ -776,9 +820,9 @@ 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#l00155">155</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#l00301">301</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00155 { <span class="keywordflow">return</span> 0; }; +<div class="fragment"><pre>00301 { <span class="keywordflow">return</span> 0; }; </pre></div> </td> </tr> </table> @@ -821,9 +865,9 @@ 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#l00157">157</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#l00303">303</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00157 { <span class="keywordflow">return</span> 0; }; +<div class="fragment"><pre>00303 { <span class="keywordflow">return</span> 0; }; </pre></div> </td> </tr> </table> @@ -878,9 +922,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. <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00156">156</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#l00302">302</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00156 { <span class="keywordflow">return</span> 0; }; +<div class="fragment"><pre>00302 { <span class="keywordflow">return</span> 0; }; </pre></div> </td> </tr> </table> @@ -914,9 +958,47 @@ Called when a user quits. <p> The details of the exiting user are available to you in the parameter userrec *user <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00142">142</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#l00288">288</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +<p> +<div class="fragment"><pre>00288 { } +</pre></div> </td> + </tr> +</table> +<a name="a20" doxytag="Module::OnUserSync"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> <a class="el" href="modules_8h.html#a23">string_list</a> Module::OnUserSync </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 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#l00305">305</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +<p> +References <a class="el" href="modules_8h-source.html#l00051">string_list</a>. <p> -<div class="fragment"><pre>00142 { } +<div class="fragment"><pre>00305 { <a class="code" href="modules_8h.html#a23">string_list</a> empty; <span class="keywordflow">return</span> empty; } </pre></div> </td> </tr> </table> @@ -959,15 +1041,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#l00154">154</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#l00300">300</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00154 { }; +<div class="fragment"><pre>00300 { }; </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><address style="align: right;"><small>Generated on Sat May 1 13:39:22 2004 for InspIRCd by +<hr><address style="align: right;"><small>Generated on Sat May 1 17:50:31 2004 for InspIRCd by <a href="http://www.doxygen.org/index.html"> <img src="doxygen.png" alt="doxygen" align="middle" border=0 width=110 height=53></a>1.3-rc3 </small></address> |