diff options
| author | brain <brain@e03df62e-2008-0410-955e-edbf42e46eb7> | 2005-12-09 20:21:39 +0000 |
|---|---|---|
| committer | brain <brain@e03df62e-2008-0410-955e-edbf42e46eb7> | 2005-12-09 20:21:39 +0000 |
| commit | bab9f4b4bc0f6aa0e1377745fd216ef9874b3f27 (patch) | |
| tree | 816b86525dc3e6f84a81adb0c8744b4c4798e792 /docs/module-doc/classServer.html | |
| parent | a96341b150898376a1b01c7fb4519e1265c599b6 (diff) | |
Added new module docs
git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@2301 e03df62e-2008-0410-955e-edbf42e46eb7
Diffstat (limited to 'docs/module-doc/classServer.html')
| -rw-r--r-- | docs/module-doc/classServer.html | 793 |
1 files changed, 441 insertions, 352 deletions
diff --git a/docs/module-doc/classServer.html b/docs/module-doc/classServer.html index 8285fb2d6..f71644ac0 100644 --- a/docs/module-doc/classServer.html +++ b/docs/module-doc/classServer.html @@ -126,6 +126,8 @@ Inheritance diagram for Server:<p><center><img src="classServer__inherit__graph. <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classServer.html#CallCommandHandler_28std_3A_3Astring_20commandname_2C_20char_20_2A_2Aparameters_2C_20int_20pcnt_2C_20userrec_20_2Auser_29">CallCommandHandler</a> (<a class="el" href="namespaceirc.html#string">std::string</a> commandname, char **parameters, int pcnt, <a class="el" href="classuserrec.html">userrec</a> *user)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Calls the handler for a command, either implemented by the core or by another module. <a href="#CallCommandHandler_28std_3A_3Astring_20commandname_2C_20char_20_2A_2Aparameters_2C_20int_20pcnt_2C_20userrec_20_2Auser_29"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classServer.html#IsValidModuleCommand_28std_3A_3Astring_20commandname_2C_20int_20pcnt_2C_20userrec_20_2Auser_29">IsValidModuleCommand</a> (<a class="el" href="namespaceirc.html#string">std::string</a> commandname, int pcnt, <a class="el" href="classuserrec.html">userrec</a> *user)</td></tr> + <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classServer.html#ChangeHost_28userrec_20_2Auser_2C_20std_3A_3Astring_20host_29">ChangeHost</a> (<a class="el" href="classuserrec.html">userrec</a> *user, <a class="el" href="namespaceirc.html#string">std::string</a> host)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Change displayed hostname of a user. <a href="#ChangeHost_28userrec_20_2Auser_2C_20std_3A_3Astring_20host_29"></a><br></td></tr> @@ -189,6 +191,8 @@ Inheritance diagram for Server:<p><center><img src="classServer__inherit__graph. <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classServer.html#DelSocket_28InspSocket_20_2Asock_29">DelSocket</a> (<a class="el" href="classInspSocket.html">InspSocket</a> *sock)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Deletes a class derived from <a class="el" href="classInspSocket.html">InspSocket</a> from the server's socket engine. <a href="#DelSocket_28InspSocket_20_2Asock_29"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classServer.html#RehashServer_28_29">RehashServer</a> ()</td></tr> + </table> <hr><a name="_details"></a><h2>Detailed Description</h2> Allows server output and query functions This class contains methods which allow a module to query the state of the irc server, and produce output to users and other servers. @@ -197,7 +201,7 @@ All modules should instantiate at least one copy of this class, and use its memb <p> <p> -Definition at line <a class="el" href="modules_8h-source.html#l00696">696</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#l01081">1081</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.<hr><h2>Constructor & Destructor Documentation</h2> <a class="anchor" name="Server_28_29"></a><!-- doxytag: member="Server::Server" ref="Server_28_29" args="()" --><p> <table class="mdTable" cellpadding="2" cellspacing="0"> <tr> @@ -226,8 +230,8 @@ Default constructor. <p> Creates a Server object. <p> -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>.<div class="fragment"><pre class="fragment"><a name="l00368"></a>00368 { -<a name="l00369"></a>00369 } +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>.<div class="fragment"><pre class="fragment"><a name="l00395"></a>00395 { +<a name="l00396"></a>00396 } </pre></div> <p> </td> @@ -261,8 +265,8 @@ Default destructor. <p> Destroys a Server object. <p> -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>.<div class="fragment"><pre class="fragment"><a name="l00372"></a>00372 { -<a name="l00373"></a>00373 } +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>.<div class="fragment"><pre class="fragment"><a name="l00399"></a>00399 { +<a name="l00400"></a>00400 } </pre></div> <p> </td> @@ -327,11 +331,11 @@ This allows modules to add extra commands into the command table. You must place typedef void (handlerfunc) (char**, int, userrec*); ... void <a class="el" href="commands_8h.html#handle_5Fkill_28char_20_2A_2Aparameters_2C_20int_20pcnt_2C_20userrec_20_2Auser_29">handle_kill(char **parameters, int pcnt, userrec *user)</a><p> When the command is typed, the parameters will be placed into the parameters array (similar to argv) and the parameter count will be placed into pcnt (similar to argv). There will never be any less parameters than the 'minparams' value you specified when creating the command. The *user parameter is the class of the user which caused the command to trigger, who will always have the flag you specified in 'flags' when creating the initial command. For example to create an oper only command create the commands with flags='o'. The source parameter is used for resource tracking, and should contain the name of your module (with file extension) e.g. "m_blarp.so". If you place the wrong identifier here, you can cause crashes if your module is unloaded. <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00457">457</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#l00495">495</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -References <a class="el" href="modules_8h.html#createcommand_28char_20_2Acmd_2C_20handlerfunc_20f_2C_20char_20flags_2C_20int_20minparams_2C_20char_20_2Asource_29">createcommand()</a>.<div class="fragment"><pre class="fragment"><a name="l00458"></a>00458 { -<a name="l00459"></a>00459 <a class="code" href="modules_8h.html#createcommand_28char_20_2Acmd_2C_20handlerfunc_20f_2C_20char_20flags_2C_20int_20minparams_2C_20char_20_2Asource_29">createcommand</a>(cmd,f,flags,minparams,source); -<a name="l00460"></a>00460 } +References <a class="el" href="modules_8h.html#createcommand_28char_20_2Acmd_2C_20handlerfunc_20f_2C_20char_20flags_2C_20int_20minparams_2C_20char_20_2Asource_29">createcommand()</a>.<div class="fragment"><pre class="fragment"><a name="l00496"></a>00496 { +<a name="l00497"></a>00497 <a class="code" href="modules_8h.html#createcommand_28char_20_2Acmd_2C_20handlerfunc_20f_2C_20char_20flags_2C_20int_20minparams_2C_20char_20_2Asource_29">createcommand</a>(cmd,f,flags,minparams,source); +<a name="l00498"></a>00498 } </pre></div> <p> </td> @@ -387,11 +391,11 @@ Adds a E-line The E-line is enforced as soon as it is added. <p> The duration must be in seconds, however you can use the <a class="el" href="classServer.html#CalcDuration_28std_3A_3Astring_20duration_29">Server::CalcDuration</a> method to convert durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used to indicate who or what sent the data, usually this is the nickname of a person, or a server name. <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00720">720</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#l00758">758</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -References <a class="el" href="xline_8h.html#add_5Feline_28long_20duration_2C_20const_20char_20_2Asource_2C_20const_20char_20_2Areason_2C_20const_20char_20_2Ahostmask_29">add_eline()</a>.<div class="fragment"><pre class="fragment"><a name="l00721"></a>00721 { -<a name="l00722"></a>00722 <a class="code" href="xline_8h.html#add_5Feline_28long_20duration_2C_20const_20char_20_2Asource_2C_20const_20char_20_2Areason_2C_20const_20char_20_2Ahostmask_29">add_eline</a>(<a class="code" href="commands_8h.html#duration_28const_20char_20_2Astr_29">duration</a>, source.c_str(), reason.c_str(), hostmask.c_str()); -<a name="l00723"></a>00723 } +References <a class="el" href="xline_8h.html#add_5Feline_28long_20duration_2C_20const_20char_20_2Asource_2C_20const_20char_20_2Areason_2C_20const_20char_20_2Ahostmask_29">add_eline()</a>.<div class="fragment"><pre class="fragment"><a name="l00759"></a>00759 { +<a name="l00760"></a>00760 <a class="code" href="xline_8h.html#add_5Feline_28long_20duration_2C_20const_20char_20_2Asource_2C_20const_20char_20_2Areason_2C_20const_20char_20_2Ahostmask_29">add_eline</a>(<a class="code" href="commands_8h.html#duration_28const_20char_20_2Astr_29">duration</a>, source.c_str(), reason.c_str(), hostmask.c_str()); +<a name="l00761"></a>00761 } </pre></div> <p> </td> @@ -431,14 +435,14 @@ This call is used to implement modes like +q and +a. The characteristics of thes (4) The mode and its parameter are NOT stored in the channels modes structure<p> It is down to the module handling the mode to maintain state and determine what 'items' (e.g. users, or a banlist) have the mode set on them, and process the modes at the correct times, e.g. during access checks on channels, etc. When the extended mode is triggered the OnExtendedMode method will be triggered as above. Note that the target you are given will be a channel, if for example your mode is set 'on a user' (in for example +a) you must use Server::Find to locate the user the mode is operating on. Your mode handler may return 1 to handle the mode AND tell the core to display the mode change, e.g. '+aaa one two three' in the case of the mode for 'two', or it may return -1 to 'eat' the mode change, so the above example would become '+aa one three' after processing. <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00625">625</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#l00663">663</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -References <a class="el" href="modules_8cpp-source.html#l00221">DoAddExtendedMode()</a>, <a class="el" href="modules_8cpp-source.html#l00231">ModeMakeList()</a>, and <a class="el" href="modules_8h-source.html#l00031">MT_CHANNEL</a>.<div class="fragment"><pre class="fragment"><a name="l00626"></a>00626 { -<a name="l00627"></a>00627 <span class="keywordtype">bool</span> res = <a class="code" href="modules_8cpp.html#DoAddExtendedMode_28char_20modechar_2C_20int_20type_2C_20bool_20requires_5Foper_2C_20int_20params_5Fon_2C_20int_20params_5Foff_29">DoAddExtendedMode</a>(modechar,<a class="code" href="modules_8h.html#MT_5FCHANNEL">MT_CHANNEL</a>,<span class="keyword">false</span>,1,1); -<a name="l00628"></a>00628 <span class="keywordflow">if</span> (res) -<a name="l00629"></a>00629 <a class="code" href="modules_8cpp.html#ModeMakeList_28char_20modechar_29">ModeMakeList</a>(modechar); -<a name="l00630"></a>00630 <span class="keywordflow">return</span> res; -<a name="l00631"></a>00631 } +References <a class="el" href="modules_8cpp-source.html#l00221">DoAddExtendedMode()</a>, <a class="el" href="modules_8cpp-source.html#l00231">ModeMakeList()</a>, and <a class="el" href="modules_8h-source.html#l00031">MT_CHANNEL</a>.<div class="fragment"><pre class="fragment"><a name="l00664"></a>00664 { +<a name="l00665"></a>00665 <span class="keywordtype">bool</span> res = <a class="code" href="modules_8cpp.html#DoAddExtendedMode_28char_20modechar_2C_20int_20type_2C_20bool_20requires_5Foper_2C_20int_20params_5Fon_2C_20int_20params_5Foff_29">DoAddExtendedMode</a>(modechar,<a class="code" href="modules_8h.html#MT_5FCHANNEL">MT_CHANNEL</a>,<span class="keyword">false</span>,1,1); +<a name="l00666"></a>00666 <span class="keywordflow">if</span> (res) +<a name="l00667"></a>00667 <a class="code" href="modules_8cpp.html#ModeMakeList_28char_20modechar_29">ModeMakeList</a>(modechar); +<a name="l00668"></a>00668 <span class="keywordflow">return</span> res; +<a name="l00669"></a>00669 } </pre></div> <p> </td> @@ -500,34 +504,34 @@ Adds an extended mode letter which is parsed by a module. <p> This allows modules to add extra mode letters, e.g. +x for hostcloak. the "type" parameter is either MT_CHANNEL, MT_CLIENT, or MT_SERVER, to indicate wether the mode is a channel mode, a client mode, or a server mode. requires_oper is used with MT_CLIENT type modes only to indicate the mode can only be set or unset by an oper. If this is used for MT_CHANNEL type modes it is ignored. params_when_on is the number of modes to expect when the mode is turned on (for type MT_CHANNEL only), e.g. with mode +k, this would have a value of 1. the params_when_off value has a similar value to params_when_on, except it indicates the number of parameters to expect when the mode is disabled. Modes which act in a similar way to channel mode +l (e.g. require a parameter to enable, but not to disable) should use this parameter. The function returns false if the mode is unavailable, and will not attempt to allocate another character, as this will confuse users. This also means that as only one module can claim a specific mode character, the core does not need to keep track of which modules own which modes, which speeds up operation of the server. In this version, a mode can have at most one parameter, attempting to use more parameters will have undefined effects. <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00597">597</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. -<p> -References <a class="el" href="modules_8h-source.html#l00023">DEBUG</a>, <a class="el" href="modules_8cpp-source.html#l00221">DoAddExtendedMode()</a>, <a class="el" href="modules_8h-source.html#l00032">MT_CLIENT</a>, and <a class="el" href="modules_8h-source.html#l00033">MT_SERVER</a>.<div class="fragment"><pre class="fragment"><a name="l00598"></a>00598 { -<a name="l00599"></a>00599 <span class="keywordflow">if</span> (((modechar >= <span class="charliteral">'A'</span>) && (modechar <= <span class="charliteral">'Z'</span>)) || ((modechar >= <span class="charliteral">'a'</span>) && (modechar <= <span class="charliteral">'z'</span>))) -<a name="l00600"></a>00600 { -<a name="l00601"></a>00601 <span class="keywordflow">if</span> (type == <a class="code" href="modules_8h.html#MT_5FSERVER">MT_SERVER</a>) -<a name="l00602"></a>00602 { -<a name="l00603"></a>00603 log(<a class="code" href="modules_8h.html#DEBUG">DEBUG</a>,<span class="stringliteral">"*** API ERROR *** Modes of type MT_SERVER are reserved for future expansion"</span>); -<a name="l00604"></a>00604 <span class="keywordflow">return</span> <span class="keyword">false</span>; -<a name="l00605"></a>00605 } -<a name="l00606"></a>00606 <span class="keywordflow">if</span> (((params_when_on>0) || (params_when_off>0)) && (type == <a class="code" href="modules_8h.html#MT_5FCLIENT">MT_CLIENT</a>)) -<a name="l00607"></a>00607 { -<a name="l00608"></a>00608 log(<a class="code" href="modules_8h.html#DEBUG">DEBUG</a>,<span class="stringliteral">"*** API ERROR *** Parameters on MT_CLIENT modes are not supported"</span>); -<a name="l00609"></a>00609 <span class="keywordflow">return</span> <span class="keyword">false</span>; -<a name="l00610"></a>00610 } -<a name="l00611"></a>00611 <span class="keywordflow">if</span> ((params_when_on>1) || (params_when_off>1)) -<a name="l00612"></a>00612 { -<a name="l00613"></a>00613 log(<a class="code" href="modules_8h.html#DEBUG">DEBUG</a>,<span class="stringliteral">"*** API ERROR *** More than one parameter for an MT_CHANNEL mode is not yet supported"</span>); -<a name="l00614"></a>00614 <span class="keywordflow">return</span> <span class="keyword">false</span>; -<a name="l00615"></a>00615 } -<a name="l00616"></a>00616 <span class="keywordflow">return</span> <a class="code" href="modules_8cpp.html#DoAddExtendedMode_28char_20modechar_2C_20int_20type_2C_20bool_20requires_5Foper_2C_20int_20params_5Fon_2C_20int_20params_5Foff_29">DoAddExtendedMode</a>(modechar,type,requires_oper,params_when_on,params_when_off); -<a name="l00617"></a>00617 } -<a name="l00618"></a>00618 <span class="keywordflow">else</span> -<a name="l00619"></a>00619 { -<a name="l00620"></a>00620 log(<a class="code" href="modules_8h.html#DEBUG">DEBUG</a>,<span class="stringliteral">"*** API ERROR *** Muppet modechar detected."</span>); -<a name="l00621"></a>00621 } -<a name="l00622"></a>00622 <span class="keywordflow">return</span> <span class="keyword">false</span>; -<a name="l00623"></a>00623 } +Definition at line <a class="el" href="modules_8cpp-source.html#l00635">635</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +<p> +References <a class="el" href="modules_8h-source.html#l00023">DEBUG</a>, <a class="el" href="modules_8cpp-source.html#l00221">DoAddExtendedMode()</a>, <a class="el" href="modules_8h-source.html#l00032">MT_CLIENT</a>, and <a class="el" href="modules_8h-source.html#l00033">MT_SERVER</a>.<div class="fragment"><pre class="fragment"><a name="l00636"></a>00636 { +<a name="l00637"></a>00637 <span class="keywordflow">if</span> (((modechar >= <span class="charliteral">'A'</span>) && (modechar <= <span class="charliteral">'Z'</span>)) || ((modechar >= <span class="charliteral">'a'</span>) && (modechar <= <span class="charliteral">'z'</span>))) +<a name="l00638"></a>00638 { +<a name="l00639"></a>00639 <span class="keywordflow">if</span> (type == <a class="code" href="modules_8h.html#MT_5FSERVER">MT_SERVER</a>) +<a name="l00640"></a>00640 { +<a name="l00641"></a>00641 log(<a class="code" href="modules_8h.html#DEBUG">DEBUG</a>,<span class="stringliteral">"*** API ERROR *** Modes of type MT_SERVER are reserved for future expansion"</span>); +<a name="l00642"></a>00642 <span class="keywordflow">return</span> <span class="keyword">false</span>; +<a name="l00643"></a>00643 } +<a name="l00644"></a>00644 <span class="keywordflow">if</span> (((params_when_on>0) || (params_when_off>0)) && (type == <a class="code" href="modules_8h.html#MT_5FCLIENT">MT_CLIENT</a>)) +<a name="l00645"></a>00645 { +<a name="l00646"></a>00646 log(<a class="code" href="modules_8h.html#DEBUG">DEBUG</a>,<span class="stringliteral">"*** API ERROR *** Parameters on MT_CLIENT modes are not supported"</span>); +<a name="l00647"></a>00647 <span class="keywordflow">return</span> <span class="keyword">false</span>; +<a name="l00648"></a>00648 } +<a name="l00649"></a>00649 <span class="keywordflow">if</span> ((params_when_on>1) || (params_when_off>1)) +<a name="l00650"></a>00650 { +<a name="l00651"></a>00651 log(<a class="code" href="modules_8h.html#DEBUG">DEBUG</a>,<span class="stringliteral">"*** API ERROR *** More than one parameter for an MT_CHANNEL mode is not yet supported"</span>); +<a name="l00652"></a>00652 <span class="keywordflow">return</span> <span class="keyword">false</span>; +<a name="l00653"></a>00653 } +<a name="l00654"></a>00654 <span class="keywordflow">return</span> <a class="code" href="modules_8cpp.html#DoAddExtendedMode_28char_20modechar_2C_20int_20type_2C_20bool_20requires_5Foper_2C_20int_20params_5Fon_2C_20int_20params_5Foff_29">DoAddExtendedMode</a>(modechar,type,requires_oper,params_when_on,params_when_off); +<a name="l00655"></a>00655 } +<a name="l00656"></a>00656 <span class="keywordflow">else</span> +<a name="l00657"></a>00657 { +<a name="l00658"></a>00658 log(<a class="code" href="modules_8h.html#DEBUG">DEBUG</a>,<span class="stringliteral">"*** API ERROR *** Muppet modechar detected."</span>); +<a name="l00659"></a>00659 } +<a name="l00660"></a>00660 <span class="keywordflow">return</span> <span class="keyword">false</span>; +<a name="l00661"></a>00661 } </pre></div> <p> </td> @@ -583,11 +587,11 @@ Adds a G-line The G-line is propogated to all of the servers in the mesh and enf <p> The duration must be in seconds, however you can use the <a class="el" href="classServer.html#CalcDuration_28std_3A_3Astring_20duration_29">Server::CalcDuration</a> method to convert durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used to indicate who or what sent the data, usually this is the nickname of a person, or a server name. <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00700">700</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#l00738">738</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -References <a class="el" href="xline_8h.html#add_5Fgline_28long_20duration_2C_20const_20char_20_2Asource_2C_20const_20char_20_2Areason_2C_20const_20char_20_2Ahostmask_29">add_gline()</a>.<div class="fragment"><pre class="fragment"><a name="l00701"></a>00701 { -<a name="l00702"></a>00702 <a class="code" href="xline_8h.html#add_5Fgline_28long_20duration_2C_20const_20char_20_2Asource_2C_20const_20char_20_2Areason_2C_20const_20char_20_2Ahostmask_29">add_gline</a>(<a class="code" href="commands_8h.html#duration_28const_20char_20_2Astr_29">duration</a>, source.c_str(), reason.c_str(), hostmask.c_str()); -<a name="l00703"></a>00703 } +References <a class="el" href="xline_8h.html#add_5Fgline_28long_20duration_2C_20const_20char_20_2Asource_2C_20const_20char_20_2Areason_2C_20const_20char_20_2Ahostmask_29">add_gline()</a>.<div class="fragment"><pre class="fragment"><a name="l00739"></a>00739 { +<a name="l00740"></a>00740 <a class="code" href="xline_8h.html#add_5Fgline_28long_20duration_2C_20const_20char_20_2Asource_2C_20const_20char_20_2Areason_2C_20const_20char_20_2Ahostmask_29">add_gline</a>(<a class="code" href="commands_8h.html#duration_28const_20char_20_2Astr_29">duration</a>, source.c_str(), reason.c_str(), hostmask.c_str()); +<a name="l00741"></a>00741 } </pre></div> <p> </td> @@ -643,11 +647,11 @@ Adds a K-line The K-line is enforced as soon as it is added. <p> The duration must be in seconds, however you can use the <a class="el" href="classServer.html#CalcDuration_28std_3A_3Astring_20duration_29">Server::CalcDuration</a> method to convert durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used to indicate who or what sent the data, usually this is the nickname of a person, or a server name. <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00715">715</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#l00753">753</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -References <a class="el" href="xline_8h.html#add_5Fkline_28long_20duration_2C_20const_20char_20_2Asource_2C_20const_20char_20_2Areason_2C_20const_20char_20_2Ahostmask_29">add_kline()</a>.<div class="fragment"><pre class="fragment"><a name="l00716"></a>00716 { -<a name="l00717"></a>00717 <a class="code" href="xline_8h.html#add_5Fkline_28long_20duration_2C_20const_20char_20_2Asource_2C_20const_20char_20_2Areason_2C_20const_20char_20_2Ahostmask_29">add_kline</a>(<a class="code" href="commands_8h.html#duration_28const_20char_20_2Astr_29">duration</a>, source.c_str(), reason.c_str(), hostmask.c_str()); -<a name="l00718"></a>00718 } +References <a class="el" href="xline_8h.html#add_5Fkline_28long_20duration_2C_20const_20char_20_2Asource_2C_20const_20char_20_2Areason_2C_20const_20char_20_2Ahostmask_29">add_kline()</a>.<div class="fragment"><pre class="fragment"><a name="l00754"></a>00754 { +<a name="l00755"></a>00755 <a class="code" href="xline_8h.html#add_5Fkline_28long_20duration_2C_20const_20char_20_2Asource_2C_20const_20char_20_2Areason_2C_20const_20char_20_2Ahostmask_29">add_kline</a>(<a class="code" href="commands_8h.html#duration_28const_20char_20_2Astr_29">duration</a>, source.c_str(), reason.c_str(), hostmask.c_str()); +<a name="l00756"></a>00756 } </pre></div> <p> </td> @@ -703,11 +707,11 @@ Adds a Q-line The Q-line is propogated to all of the servers in the mesh and enf <p> The duration must be in seconds, however you can use the <a class="el" href="classServer.html#CalcDuration_28std_3A_3Astring_20duration_29">Server::CalcDuration</a> method to convert durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used to indicate who or what sent the data, usually this is the nickname of a person, or a server name. <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00705">705</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#l00743">743</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -References <a class="el" href="xline_8h.html#add_5Fqline_28long_20duration_2C_20const_20char_20_2Asource_2C_20const_20char_20_2Areason_2C_20const_20char_20_2Anickname_29">add_qline()</a>.<div class="fragment"><pre class="fragment"><a name="l00706"></a>00706 { -<a name="l00707"></a>00707 <a class="code" href="xline_8h.html#add_5Fqline_28long_20duration_2C_20const_20char_20_2Asource_2C_20const_20char_20_2Areason_2C_20const_20char_20_2Anickname_29">add_qline</a>(<a class="code" href="commands_8h.html#duration_28const_20char_20_2Astr_29">duration</a>, source.c_str(), reason.c_str(), nickname.c_str()); -<a name="l00708"></a>00708 } +References <a class="el" href="xline_8h.html#add_5Fqline_28long_20duration_2C_20const_20char_20_2Asource_2C_20const_20char_20_2Areason_2C_20const_20char_20_2Anickname_29">add_qline()</a>.<div class="fragment"><pre class="fragment"><a name="l00744"></a>00744 { +<a name="l00745"></a>00745 <a class="code" href="xline_8h.html#add_5Fqline_28long_20duration_2C_20const_20char_20_2Asource_2C_20const_20char_20_2Areason_2C_20const_20char_20_2Anickname_29">add_qline</a>(<a class="code" href="commands_8h.html#duration_28const_20char_20_2Astr_29">duration</a>, source.c_str(), reason.c_str(), nickname.c_str()); +<a name="l00746"></a>00746 } </pre></div> <p> </td> @@ -742,11 +746,11 @@ Adds a class derived from <a class="el" href="classInspSocket.html">InspSocket</ <p> <p> -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>. +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> -References <a class="el" href="modules_8cpp.html#module_5Fsockets">module_sockets</a>.<div class="fragment"><pre class="fragment"><a name="l00376"></a>00376 { -<a name="l00377"></a>00377 <a class="code" href="modules_8cpp.html#module_5Fsockets">module_sockets</a>.push_back(sock); -<a name="l00378"></a>00378 } +References <a class="el" href="modules_8cpp.html#module_5Fsockets">module_sockets</a>.<div class="fragment"><pre class="fragment"><a name="l00403"></a>00403 { +<a name="l00404"></a>00404 <a class="code" href="modules_8cpp.html#module_5Fsockets">module_sockets</a>.push_back(sock); +<a name="l00405"></a>00405 } </pre></div> <p> </td> @@ -802,11 +806,11 @@ Adds a Z-line The Z-line is propogated to all of the servers in the mesh and enf <p> The duration must be in seconds, however you can use the <a class="el" href="classServer.html#CalcDuration_28std_3A_3Astring_20duration_29">Server::CalcDuration</a> method to convert durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used to indicate who or what sent the data, usually this is the nickname of a person, or a server name. <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00710">710</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#l00748">748</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -References <a class="el" href="xline_8h.html#add_5Fzline_28long_20duration_2C_20const_20char_20_2Asource_2C_20const_20char_20_2Areason_2C_20const_20char_20_2Aipaddr_29">add_zline()</a>.<div class="fragment"><pre class="fragment"><a name="l00711"></a>00711 { -<a name="l00712"></a>00712 <a class="code" href="xline_8h.html#add_5Fzline_28long_20duration_2C_20const_20char_20_2Asource_2C_20const_20char_20_2Areason_2C_20const_20char_20_2Aipaddr_29">add_zline</a>(<a class="code" href="commands_8h.html#duration_28const_20char_20_2Astr_29">duration</a>, source.c_str(), reason.c_str(), ipaddr.c_str()); -<a name="l00713"></a>00713 } +References <a class="el" href="xline_8h.html#add_5Fzline_28long_20duration_2C_20const_20char_20_2Asource_2C_20const_20char_20_2Areason_2C_20const_20char_20_2Aipaddr_29">add_zline()</a>.<div class="fragment"><pre class="fragment"><a name="l00749"></a>00749 { +<a name="l00750"></a>00750 <a class="code" href="xline_8h.html#add_5Fzline_28long_20duration_2C_20const_20char_20_2Asource_2C_20const_20char_20_2Areason_2C_20const_20char_20_2Aipaddr_29">add_zline</a>(<a class="code" href="commands_8h.html#duration_28const_20char_20_2Astr_29">duration</a>, source.c_str(), reason.c_str(), ipaddr.c_str()); +<a name="l00751"></a>00751 } </pre></div> <p> </td> @@ -841,11 +845,11 @@ Calculates a duration This method will take a string containing a formatted dura <p> "1w2d") and return its value as a total number of seconds. This is the same function used internally by /GLINE etc to set the ban times. <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00750">750</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#l00788">788</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -References <a class="el" href="commands_8h.html#duration_28const_20char_20_2Astr_29">duration()</a>.<div class="fragment"><pre class="fragment"><a name="l00751"></a>00751 { -<a name="l00752"></a>00752 <span class="keywordflow">return</span> <a class="code" href="commands_8h.html#duration_28const_20char_20_2Astr_29">duration</a>(delta.c_str()); -<a name="l00753"></a>00753 } +References <a class="el" href="commands_8h.html#duration_28const_20char_20_2Astr_29">duration()</a>.<div class="fragment"><pre class="fragment"><a name="l00789"></a>00789 { +<a name="l00790"></a>00790 <span class="keywordflow">return</span> <a class="code" href="commands_8h.html#duration_28const_20char_20_2Astr_29">duration</a>(delta.c_str()); +<a name="l00791"></a>00791 } </pre></div> <p> </td> @@ -902,9 +906,9 @@ Calls the handler for a command, either implemented by the core or by another mo You can use this function to trigger other commands in the ircd, such as PRIVMSG, JOIN, KICK etc, or even as a method of callback. By defining command names that are untypeable for users on irc (e.g. those which contain a or <br> ) you may use them as callback identifiers. The first parameter to this method is the name of the command handler you wish to call, e.g. PRIVMSG. This will be a command handler previously registered by the core or wih <a class="el" href="classServer.html#AddCommand_28char_20_2Acmd_2C_20handlerfunc_20f_2C_20char_20flags_2C_20int_20minparams_2C_20char_20_2Asource_29">AddCommand()</a>. The second parameter is an array of parameters, and the third parameter is a count of parameters in the array. If you do not pass enough parameters to meet the minimum needed by the handler, the functiom will silently ignore it. The final parameter is the user executing the command handler, used for privilage checks, etc. <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00447">447</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00448"></a>00448 { -<a name="l00449"></a>00449 call_handler(commandname.c_str(),parameters,pcnt,user); -<a name="l00450"></a>00450 } +Definition at line <a class="el" href="modules_8cpp-source.html#l00480">480</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00481"></a>00481 { +<a name="l00482"></a>00482 call_handler(commandname.c_str(),parameters,pcnt,user); +<a name="l00483"></a>00483 } </pre></div> <p> </td> @@ -948,11 +952,11 @@ Change GECOS (fullname) of a user. <p> You should always call this method to change a user's GECOS rather than writing directly to the fullname member of userrec, as any change applied via this method will be propogated to any linked servers. <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00540">540</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#l00578">578</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -References <a class="el" href="message_8h.html#ChangeName_28userrec_20_2Auser_2C_20const_20char_20_2Agecos_29">ChangeName()</a>.<div class="fragment"><pre class="fragment"><a name="l00541"></a>00541 { -<a name="l00542"></a>00542 <a class="code" href="message_8h.html#ChangeName_28userrec_20_2Auser_2C_20const_20char_20_2Agecos_29">ChangeName</a>(user,gecos.c_str()); -<a name="l00543"></a>00543 } +References <a class="el" href="message_8h.html#ChangeName_28userrec_20_2Auser_2C_20const_20char_20_2Agecos_29">ChangeName()</a>.<div class="fragment"><pre class="fragment"><a name="l00579"></a>00579 { +<a name="l00580"></a>00580 <a class="code" href="message_8h.html#ChangeName_28userrec_20_2Auser_2C_20const_20char_20_2Agecos_29">ChangeName</a>(user,gecos.c_str()); +<a name="l00581"></a>00581 } </pre></div> <p> </td> @@ -996,11 +1000,11 @@ Change displayed hostname of a user. <p> You should always call this method to change a user's host rather than writing directly to the dhost member of userrec, as any change applied via this method will be propogated to any linked servers. <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00535">535</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#l00573">573</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -References <a class="el" href="message_8h.html#ChangeDisplayedHost_28userrec_20_2Auser_2C_20const_20char_20_2Ahost_29">ChangeDisplayedHost()</a>.<div class="fragment"><pre class="fragment"><a name="l00536"></a>00536 { -<a name="l00537"></a>00537 <a class="code" href="message_8h.html#ChangeDisplayedHost_28userrec_20_2Auser_2C_20const_20char_20_2Ahost_29">ChangeDisplayedHost</a>(user,host.c_str()); -<a name="l00538"></a>00538 } +References <a class="el" href="message_8h.html#ChangeDisplayedHost_28userrec_20_2Auser_2C_20const_20char_20_2Ahost_29">ChangeDisplayedHost()</a>.<div class="fragment"><pre class="fragment"><a name="l00574"></a>00574 { +<a name="l00575"></a>00575 <a class="code" href="message_8h.html#ChangeDisplayedHost_28userrec_20_2Auser_2C_20const_20char_20_2Ahost_29">ChangeDisplayedHost</a>(user,host.c_str()); +<a name="l00576"></a>00576 } </pre></div> <p> </td> @@ -1044,9 +1048,9 @@ Forces a user nickchange. <p> This command works similarly to SVSNICK, and can be used to implement Q-lines etc. If you specify an invalid nickname, the nick change will be dropped and the target user will receive the error numeric for it. <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00432">432</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00433"></a>00433 { -<a name="l00434"></a>00434 force_nickchange(user,nickname.c_str()); -<a name="l00435"></a>00435 } +Definition at line <a class="el" href="modules_8cpp-source.html#l00465">465</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00466"></a>00466 { +<a name="l00467"></a>00467 force_nickchange(user,nickname.c_str()); +<a name="l00468"></a>00468 } </pre></div> <p> </td> @@ -1090,11 +1094,11 @@ Attempts to look up a user's privilages on a channel. <p> This function will return a string containing either @, %, +, or an empty string, representing the user's privilages upon the channel you specify. <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00565">565</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#l00603">603</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -References <a class="el" href="message_8h.html#cmode_28userrec_20_2Auser_2C_20chanrec_20_2Achan_29">cmode()</a>.<div class="fragment"><pre class="fragment"><a name="l00566"></a>00566 { -<a name="l00567"></a>00567 <span class="keywordflow">return</span> <a class="code" href="message_8h.html#cmode_28userrec_20_2Auser_2C_20chanrec_20_2Achan_29">cmode</a>(User,Chan); -<a name="l00568"></a>00568 } +References <a class="el" href="message_8h.html#cmode_28userrec_20_2Auser_2C_20chanrec_20_2Achan_29">cmode()</a>.<div class="fragment"><pre class="fragment"><a name="l00604"></a>00604 { +<a name="l00605"></a>00605 <span class="keywordflow">return</span> <a class="code" href="message_8h.html#cmode_28userrec_20_2Auser_2C_20chanrec_20_2Achan_29">cmode</a>(User,Chan); +<a name="l00606"></a>00606 } </pre></div> <p> </td> @@ -1138,11 +1142,11 @@ Returns true if two users share a common channel. <p> This method is used internally by the NICK and QUIT commands, and the <a class="el" href="classServer.html#SendCommon_28userrec_20_2AUser_2C_20std_3A_3Astring_20text_2C_20bool_20IncludeSender_29">Server::SendCommon</a> method. <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00513">513</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#l00551">551</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -References <a class="el" href="message_8h.html#common_5Fchannels_28userrec_20_2Au_2C_20userrec_20_2Au_32_29">common_channels()</a>.<div class="fragment"><pre class="fragment"><a name="l00514"></a>00514 { -<a name="l00515"></a>00515 <span class="keywordflow">return</span> (<a class="code" href="message_8h.html#common_5Fchannels_28userrec_20_2Au_2C_20userrec_20_2Au_32_29">common_channels</a>(u1,u2) != 0); -<a name="l00516"></a>00516 } +References <a class="el" href="message_8h.html#common_5Fchannels_28userrec_20_2Au_2C_20userrec_20_2Au_32_29">common_channels()</a>.<div class="fragment"><pre class="fragment"><a name="l00552"></a>00552 { +<a name="l00553"></a>00553 <span class="keywordflow">return</span> (<a class="code" href="message_8h.html#common_5Fchannels_28userrec_20_2Au_2C_20userrec_20_2Au_32_29">common_channels</a>(u1,u2) != 0); +<a name="l00554"></a>00554 } </pre></div> <p> </td> @@ -1177,9 +1181,9 @@ Returns a count of the number of users on a channel. <p> This will NEVER be 0, as if the chanrec exists, it will have at least one user in the channel. <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00633">633</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00634"></a>00634 { -<a name="l00635"></a>00635 <span class="keywordflow">return</span> usercount(c); -<a name="l00636"></a>00636 } +Definition at line <a class="el" href="modules_8cpp-source.html#l00671">671</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00672"></a>00672 { +<a name="l00673"></a>00673 <span class="keywordflow">return</span> usercount(c); +<a name="l00674"></a>00674 } </pre></div> <p> </td> @@ -1214,11 +1218,11 @@ Deletes a local E-Line. <p> <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00745">745</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#l00783">783</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -References <a class="el" href="xline_8h.html#del_5Feline_28const_20char_20_2Ahostmask_29">del_eline()</a>.<div class="fragment"><pre class="fragment"><a name="l00746"></a>00746 { -<a name="l00747"></a>00747 <span class="keywordflow">return</span> <a class="code" href="xline_8h.html#del_5Feline_28const_20char_20_2Ahostmask_29">del_eline</a>(hostmask.c_str()); -<a name="l00748"></a>00748 } +References <a class="el" href="xline_8h.html#del_5Feline_28const_20char_20_2Ahostmask_29">del_eline()</a>.<div class="fragment"><pre class="fragment"><a name="l00784"></a>00784 { +<a name="l00785"></a>00785 <span class="keywordflow">return</span> <a class="code" href="xline_8h.html#del_5Feline_28const_20char_20_2Ahostmask_29">del_eline</a>(hostmask.c_str()); +<a name="l00786"></a>00786 } </pre></div> <p> </td> @@ -1253,11 +1257,11 @@ Deletes a G-Line from all servers on the mesh. <p> <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00725">725</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#l00763">763</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -References <a class="el" href="xline_8h.html#del_5Fgline_28const_20char_20_2Ahostmask_29">del_gline()</a>.<div class="fragment"><pre class="fragment"><a name="l00726"></a>00726 { -<a name="l00727"></a>00727 <span class="keywordflow">return</span> <a class="code" href="xline_8h.html#del_5Fgline_28const_20char_20_2Ahostmask_29">del_gline</a>(hostmask.c_str()); -<a name="l00728"></a>00728 } +References <a class="el" href="xline_8h.html#del_5Fgline_28const_20char_20_2Ahostmask_29">del_gline()</a>.<div class="fragment"><pre class="fragment"><a name="l00764"></a>00764 { +<a name="l00765"></a>00765 <span class="keywordflow">return</span> <a class="code" href="xline_8h.html#del_5Fgline_28const_20char_20_2Ahostmask_29">del_gline</a>(hostmask.c_str()); +<a name="l00766"></a>00766 } </pre></div> <p> </td> @@ -1292,11 +1296,11 @@ Deletes a local K-Line. <p> <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00740">740</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#l00778">778</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -References <a class="el" href="xline_8h.html#del_5Fkline_28const_20char_20_2Ahostmask_29">del_kline()</a>.<div class="fragment"><pre class="fragment"><a name="l00741"></a>00741 { -<a name="l00742"></a>00742 <span class="keywordflow">return</span> <a class="code" href="xline_8h.html#del_5Fkline_28const_20char_20_2Ahostmask_29">del_kline</a>(hostmask.c_str()); -<a name="l00743"></a>00743 } +References <a class="el" href="xline_8h.html#del_5Fkline_28const_20char_20_2Ahostmask_29">del_kline()</a>.<div class="fragment"><pre class="fragment"><a name="l00779"></a>00779 { +<a name="l00780"></a>00780 <span class="keywordflow">return</span> <a class="code" href="xline_8h.html#del_5Fkline_28const_20char_20_2Ahostmask_29">del_kline</a>(hostmask.c_str()); +<a name="l00781"></a>00781 } </pre></div> <p> </td> @@ -1331,11 +1335,11 @@ Deletes a Q-Line from all servers on the mesh. <p> <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00730">730</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#l00768">768</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -References <a class="el" href="xline_8h.html#del_5Fqline_28const_20char_20_2Anickname_29">del_qline()</a>.<div class="fragment"><pre class="fragment"><a name="l00731"></a>00731 { -<a name="l00732"></a>00732 <span class="keywordflow">return</span> <a class="code" href="xline_8h.html#del_5Fqline_28const_20char_20_2Anickname_29">del_qline</a>(nickname.c_str()); -<a name="l00733"></a>00733 } +References <a class="el" href="xline_8h.html#del_5Fqline_28const_20char_20_2Anickname_29">del_qline()</a>.<div class="fragment"><pre class="fragment"><a name="l00769"></a>00769 { +<a name="l00770"></a>00770 <span class="keywordflow">return</span> <a class="code" href="xline_8h.html#del_5Fqline_28const_20char_20_2Anickname_29">del_qline</a>(nickname.c_str()); +<a name="l00771"></a>00771 } </pre></div> <p> </td> @@ -1370,18 +1374,18 @@ Deletes a class derived from <a class="el" href="classInspSocket.html">InspSocke <p> <p> -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>. +Definition at line <a class="el" href="modules_8cpp-source.html#l00413">413</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -References <a class="el" href="modules_8cpp.html#module_5Fsockets">module_sockets</a>.<div class="fragment"><pre class="fragment"><a name="l00381"></a>00381 { -<a name="l00382"></a>00382 <span class="keywordflow">for</span> (std::vector<InspSocket*>::iterator a = <a class="code" href="modules_8cpp.html#module_5Fsockets">module_sockets</a>.begin(); a < <a class="code" href="modules_8cpp.html#module_5Fsockets">module_sockets</a>.end(); a++) -<a name="l00383"></a>00383 { -<a name="l00384"></a>00384 <span class="keywordflow">if</span> (*a == sock) -<a name="l00385"></a>00385 { -<a name="l00386"></a>00386 <a class="code" href="modules_8cpp.html#module_5Fsockets">module_sockets</a>.erase(a); -<a name="l00387"></a>00387 <span class="keywordflow">return</span>; -<a name="l00388"></a>00388 } -<a name="l00389"></a>00389 } -<a name="l00390"></a>00390 } +References <a class="el" href="modules_8cpp.html#module_5Fsockets">module_sockets</a>.<div class="fragment"><pre class="fragment"><a name="l00414"></a>00414 { +<a name="l00415"></a>00415 <span class="keywordflow">for</span> (std::vector<InspSocket*>::iterator a = <a class="code" href="modules_8cpp.html#module_5Fsockets">module_sockets</a>.begin(); a < <a class="code" href="modules_8cpp.html#module_5Fsockets">module_sockets</a>.end(); a++) +<a name="l00416"></a>00416 { +<a name="l00417"></a>00417 <span class="keywordflow">if</span> (*a == sock) +<a name="l00418"></a>00418 { +<a name="l00419"></a>00419 <a class="code" href="modules_8cpp.html#module_5Fsockets">module_sockets</a>.erase(a); +<a name="l00420"></a>00420 <span class="keywordflow">return</span>; +<a name="l00421"></a>00421 } +<a name="l00422"></a>00422 } +<a name="l00423"></a>00423 } </pre></div> <p> </td> @@ -1416,11 +1420,11 @@ Deletes a Z-Line from all servers on the mesh. <p> <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00735">735</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#l00773">773</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -References <a class="el" href="xline_8h.html#del_5Fzline_28const_20char_20_2Aipaddr_29">del_zline()</a>.<div class="fragment"><pre class="fragment"><a name="l00736"></a>00736 { -<a name="l00737"></a>00737 <span class="keywordflow">return</span> <a class="code" href="xline_8h.html#del_5Fzline_28const_20char_20_2Aipaddr_29">del_zline</a>(ipaddr.c_str()); -<a name="l00738"></a>00738 } +References <a class="el" href="xline_8h.html#del_5Fzline_28const_20char_20_2Aipaddr_29">del_zline()</a>.<div class="fragment"><pre class="fragment"><a name="l00774"></a>00774 { +<a name="l00775"></a>00775 <span class="keywordflow">return</span> <a class="code" href="xline_8h.html#del_5Fzline_28const_20char_20_2Aipaddr_29">del_zline</a>(ipaddr.c_str()); +<a name="l00776"></a>00776 } </pre></div> <p> </td> @@ -1455,9 +1459,9 @@ Attempts to look up a channel and return a pointer to it. <p> This function will return NULL if the channel does not exist. <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00560">560</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00561"></a>00561 { -<a name="l00562"></a>00562 <span class="keywordflow">return</span> FindChan(channel.c_str()); -<a name="l00563"></a>00563 } +Definition at line <a class="el" href="modules_8cpp-source.html#l00598">598</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00599"></a>00599 { +<a name="l00600"></a>00600 <span class="keywordflow">return</span> FindChan(channel.c_str()); +<a name="l00601"></a>00601 } </pre></div> <p> </td> @@ -1492,9 +1496,9 @@ Attempts to look up a nick using the file descriptor associated with that nick. <p> This function will return NULL if the file descriptor is not associated with a valid user. <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00555">555</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00556"></a>00556 { -<a name="l00557"></a>00557 <span class="keywordflow">return</span> (socket < 65536 ? fd_ref_table[socket] : NULL); -<a name="l00558"></a>00558 } +Definition at line <a class="el" href="modules_8cpp-source.html#l00593">593</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00594"></a>00594 { +<a name="l00595"></a>00595 <span class="keywordflow">return</span> (socket < 65536 ? fd_ref_table[socket] : NULL); +<a name="l00596"></a>00596 } </pre></div> <p> </td> @@ -1529,18 +1533,18 @@ This function finds a module by name. <p> You must provide the filename of the module. If the module cannot be found (is not loaded) the function will return NULL. <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00784">784</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. -<p> -References <a class="el" href="modules_8cpp-source.html#l00994">MODCOUNT</a>, <a class="el" href="channels_8cpp.html#module_5Fnames">module_names</a>, and <a class="el" href="channels_8cpp.html#modules">modules</a>.<div class="fragment"><pre class="fragment"><a name="l00785"></a>00785 { -<a name="l00786"></a>00786 <span class="keywordflow">for</span> (<span class="keywordtype">int</span> i = 0; i <= <a class="code" href="channels_8cpp.html#MODCOUNT">MODCOUNT</a>; i++) -<a name="l00787"></a>00787 { -<a name="l00788"></a>00788 <span class="keywordflow">if</span> (module_names[i] == name) -<a name="l00789"></a>00789 { -<a name="l00790"></a>00790 <span class="keywordflow">return</span> <a class="code" href="channels_8cpp.html#modules">modules</a>[i]; -<a name="l00791"></a>00791 } -<a name="l00792"></a>00792 } -<a name="l00793"></a>00793 <span class="keywordflow">return</span> NULL; -<a name="l00794"></a>00794 } +Definition at line <a class="el" href="modules_8cpp-source.html#l00822">822</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +<p> +References <a class="el" href="modules_8cpp-source.html#l01032">MODCOUNT</a>, <a class="el" href="channels_8cpp.html#module_5Fnames">module_names</a>, and <a class="el" href="channels_8cpp.html#modules">modules</a>.<div class="fragment"><pre class="fragment"><a name="l00823"></a>00823 { +<a name="l00824"></a>00824 <span class="keywordflow">for</span> (<span class="keywordtype">int</span> i = 0; i <= <a class="code" href="channels_8cpp.html#MODCOUNT">MODCOUNT</a>; i++) +<a name="l00825"></a>00825 { +<a name="l00826"></a>00826 <span class="keywordflow">if</span> (module_names[i] == name) +<a name="l00827"></a>00827 { +<a name="l00828"></a>00828 <span class="keywordflow">return</span> <a class="code" href="channels_8cpp.html#modules">modules</a>[i]; +<a name="l00829"></a>00829 } +<a name="l00830"></a>00830 } +<a name="l00831"></a>00831 <span class="keywordflow">return</span> NULL; +<a name="l00832"></a>00832 } </pre></div> <p> </td> @@ -1575,9 +1579,9 @@ Attempts to look up a nick and return a pointer to it. <p> This function will return NULL if the nick does not exist. <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00550">550</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00551"></a>00551 { -<a name="l00552"></a>00552 <span class="keywordflow">return</span> Find(nick); -<a name="l00553"></a>00553 } +Definition at line <a class="el" href="modules_8cpp-source.html#l00588">588</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00589"></a>00589 { +<a name="l00590"></a>00590 <span class="keywordflow">return</span> Find(nick); +<a name="l00591"></a>00591 } </pre></div> <p> </td> @@ -1611,9 +1615,9 @@ Returns the information of the server as returned by the /ADMIN command. <p> See the <a class="el" href="classAdmin.html">Admin</a> class for further information of the return value. The members <a class="el" href="classAdmin.html#Nick">Admin::Nick</a>, <a class="el" href="classAdmin.html#Email">Admin::Email</a> and <a class="el" href="classAdmin.html#Name">Admin::Name</a> contain the information for the server where the module is loaded. <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00590">590</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00591"></a>00591 { -<a name="l00592"></a>00592 <span class="keywordflow">return</span> <a class="code" href="classAdmin.html">Admin</a>(getadminname(),getadminemail(),getadminnick()); -<a name="l00593"></a>00593 } +Definition at line <a class="el" href="modules_8cpp-source.html#l00628">628</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00629"></a>00629 { +<a name="l00630"></a>00630 <span class="keywordflow">return</span> <a class="code" href="classAdmin.html">Admin</a>(getadminname(),getadminemail(),getadminnick()); +<a name="l00631"></a>00631 } </pre></div> <p> </td> @@ -1647,9 +1651,9 @@ Returns the network name, global to all linked servers. <p> <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00580">580</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00581"></a>00581 { -<a name="l00582"></a>00582 <span class="keywordflow">return</span> getnetworkname(); -<a name="l00583"></a>00583 } +Definition at line <a class="el" href="modules_8cpp-source.html#l00618">618</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00619"></a>00619 { +<a name="l00620"></a>00620 <span class="keywordflow">return</span> getnetworkname(); +<a name="l00621"></a>00621 } </pre></div> <p> </td> @@ -1683,9 +1687,9 @@ Returns the server description string of the local server. <p> <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00585">585</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00586"></a>00586 { -<a name="l00587"></a>00587 <span class="keywordflow">return</span> getserverdesc(); -<a name="l00588"></a>00588 } +Definition at line <a class="el" href="modules_8cpp-source.html#l00623">623</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00624"></a>00624 { +<a name="l00625"></a>00625 <span class="keywordflow">return</span> getserverdesc(); +<a name="l00626"></a>00626 } </pre></div> <p> </td> @@ -1719,9 +1723,9 @@ Returns the server name of the server where the module is loaded. <p> <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00575">575</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00576"></a>00576 { -<a name="l00577"></a>00577 <span class="keywordflow">return</span> getservername(); -<a name="l00578"></a>00578 } +Definition at line <a class="el" href="modules_8cpp-source.html#l00613">613</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00614"></a>00614 { +<a name="l00615"></a>00615 <span class="keywordflow">return</span> getservername(); +<a name="l00616"></a>00616 } </pre></div> <p> </td> @@ -1756,19 +1760,19 @@ Fetches the userlist of a channel. <p> This function must be here and not a member of userrec or chanrec due to include constraints. <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00420">420</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. -<p> -References <a class="el" href="channels_8cpp-source.html#l00215">chanrec::GetUsers()</a>, and <a class="el" href="channels_8cpp.html#list_5BMAXBUF_5D">list</a>.<div class="fragment"><pre class="fragment"><a name="l00421"></a>00421 { -<a name="l00422"></a>00422 <a class="code" href="modules_8h.html#chanuserlist">chanuserlist</a> userl; -<a name="l00423"></a>00423 userl.clear(); -<a name="l00424"></a>00424 std::vector<char*> *<a class="code" href="channels_8cpp.html#list_5BMAXBUF_5D">list</a> = chan-><a class="code" href="classchanrec.html#GetUsers_28_29">GetUsers</a>(); -<a name="l00425"></a>00425 <span class="keywordflow">for</span> (std::vector<char*>::iterator i = list->begin(); i != list->end(); i++) -<a name="l00426"></a>00426 { -<a name="l00427"></a>00427 <span class="keywordtype">char</span>* o = *i; -<a name="l00428"></a>00428 userl.push_back((<a class="code" href="classuserrec.html">userrec</a>*)o); -<a name="l00429"></a>00429 } -<a name="l00430"></a>00430 <span class="keywordflow">return</span> userl; -<a name="l00431"></a>00431 } +Definition at line <a class="el" href="modules_8cpp-source.html#l00453">453</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +<p> +References <a class="el" href="channels_8cpp-source.html#l00215">chanrec::GetUsers()</a>, and <a class="el" href="channels_8cpp.html#list_5BMAXBUF_5D">list</a>.<div class="fragment"><pre class="fragment"><a name="l00454"></a>00454 { +<a name="l00455"></a>00455 <a class="code" href="modules_8h.html#chanuserlist">chanuserlist</a> userl; +<a name="l00456"></a>00456 userl.clear(); +<a name="l00457"></a>00457 std::vector<char*> *<a class="code" href="channels_8cpp.html#list_5BMAXBUF_5D">list</a> = chan-><a class="code" href="classchanrec.html#GetUsers_28_29">GetUsers</a>(); +<a name="l00458"></a>00458 <span class="keywordflow">for</span> (std::vector<char*>::iterator i = list->begin(); i != list->end(); i++) +<a name="l00459"></a>00459 { +<a name="l00460"></a>00460 <span class="keywordtype">char</span>* o = *i; +<a name="l00461"></a>00461 userl.push_back((<a class="code" href="classuserrec.html">userrec</a>*)o); +<a name="l00462"></a>00462 } +<a name="l00463"></a>00463 <span class="keywordflow">return</span> userl; +<a name="l00464"></a>00464 } </pre></div> <p> </td> @@ -1803,11 +1807,11 @@ Returns true if a nick is valid. <p> Nicks for unregistered connections will return false. <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00545">545</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#l00583">583</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -References <a class="el" href="message_8h.html#isnick_28const_20char_20_2An_29">isnick()</a>.<div class="fragment"><pre class="fragment"><a name="l00546"></a>00546 { -<a name="l00547"></a>00547 <span class="keywordflow">return</span> (<a class="code" href="message_8h.html#isnick_28const_20char_20_2An_29">isnick</a>(nick.c_str()) != 0); -<a name="l00548"></a>00548 } +References <a class="el" href="message_8h.html#isnick_28const_20char_20_2An_29">isnick()</a>.<div class="fragment"><pre class="fragment"><a name="l00584"></a>00584 { +<a name="l00585"></a>00585 <span class="keywordflow">return</span> (<a class="code" href="message_8h.html#isnick_28const_20char_20_2An_29">isnick</a>(nick.c_str()) != 0); +<a name="l00586"></a>00586 } </pre></div> <p> </td> @@ -1851,11 +1855,11 @@ Checks if a user is on a channel. <p> This function will return true or false to indicate if user 'User' is on channel 'Chan'. <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00570">570</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#l00608">608</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -References <a class="el" href="message_8h.html#has_5Fchannel_28userrec_20_2Au_2C_20chanrec_20_2Ac_29">has_channel()</a>.<div class="fragment"><pre class="fragment"><a name="l00571"></a>00571 { -<a name="l00572"></a>00572 <span class="keywordflow">return</span> <a class="code" href="message_8h.html#has_5Fchannel_28userrec_20_2Au_2C_20chanrec_20_2Ac_29">has_channel</a>(User,Chan); -<a name="l00573"></a>00573 } +References <a class="el" href="message_8h.html#has_5Fchannel_28userrec_20_2Au_2C_20chanrec_20_2Ac_29">has_channel()</a>.<div class="fragment"><pre class="fragment"><a name="l00609"></a>00609 { +<a name="l00610"></a>00610 <span class="keywordflow">return</span> <a class="code" href="message_8h.html#has_5Fchannel_28userrec_20_2Au_2C_20chanrec_20_2Ac_29">has_channel</a>(User,Chan); +<a name="l00611"></a>00611 } </pre></div> <p> </td> @@ -1890,11 +1894,11 @@ Returns true if the servername you give is ulined. <p> ULined servers have extra privilages. They are allowed to change nicknames on remote servers, change modes of clients which are on remote servers and set modes of channels where there are no channel operators for that channel on the ulined server, amongst other things. Ulined server data is also broadcast across the mesh at all times as opposed to selectively messaged in the case of normal servers, as many ulined server types (such as services) do not support meshed links and must operate in this manner. <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00442">442</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#l00475">475</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -References <a class="el" href="commands_8h.html#is_5Fuline_28const_20char_20_2Aserver_29">is_uline()</a>.<div class="fragment"><pre class="fragment"><a name="l00443"></a>00443 { -<a name="l00444"></a>00444 <span class="keywordflow">return</span> <a class="code" href="commands_8h.html#is_5Fuline_28const_20char_20_2Aserver_29">is_uline</a>(server.c_str()); -<a name="l00445"></a>00445 } +References <a class="el" href="commands_8h.html#is_5Fuline_28const_20char_20_2Aserver_29">is_uline()</a>.<div class="fragment"><pre class="fragment"><a name="l00476"></a>00476 { +<a name="l00477"></a>00477 <span class="keywordflow">return</span> <a class="code" href="commands_8h.html#is_5Fuline_28const_20char_20_2Aserver_29">is_uline</a>(server.c_str()); +<a name="l00478"></a>00478 } </pre></div> <p> </td> @@ -1929,33 +1933,83 @@ Returns true if a nick!ident string is correctly formatted, false if otherwise. <p> <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00755">755</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00756"></a>00756 { -<a name="l00757"></a>00757 <span class="keyword">const</span> <span class="keywordtype">char</span>* dest = mask.c_str(); -<a name="l00758"></a>00758 <span class="keywordflow">if</span> (strchr(dest,<span class="charliteral">'!'</span>)==0) -<a name="l00759"></a>00759 <span class="keywordflow">return</span> <span class="keyword">false</span>; -<a name="l00760"></a>00760 <span class="keywordflow">if</span> (strchr(dest,<span class="charliteral">'@'</span>)==0) -<a name="l00761"></a>00761 <span class="keywordflow">return</span> <span class="keyword">false</span>; -<a name="l00762"></a>00762 <span class="keywordflow">for</span> (<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> i = 0; i < strlen(dest); i++) -<a name="l00763"></a>00763 <span class="keywordflow">if</span> (dest[i] < 32) -<a name="l00764"></a>00764 <span class="keywordflow">return</span> <span class="keyword">false</span>; -<a name="l00765"></a>00765 <span class="keywordflow">for</span> (<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> i = 0; i < strlen(dest); i++) -<a name="l00766"></a>00766 <span class="keywordflow">if</span> (dest[i] > 126) -<a name="l00767"></a>00767 <span class="keywordflow">return</span> <span class="keyword">false</span>; -<a name="l00768"></a>00768 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> c = 0; -<a name="l00769"></a>00769 <span class="keywordflow">for</span> (<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> i = 0; i < strlen(dest); i++) -<a name="l00770"></a>00770 <span class="keywordflow">if</span> (dest[i] == <span class="charliteral">'!'</span>) -<a name="l00771"></a>00771 c++; -<a name="l00772"></a>00772 <span class="keywordflow">if</span> (c>1) -<a name="l00773"></a>00773 <span class="keywordflow">return</span> <span class="keyword">false</span>; -<a name="l00774"></a>00774 c = 0; -<a name="l00775"></a>00775 <span class="keywordflow">for</span> (<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> i = 0; i < strlen(dest); i++) -<a name="l00776"></a>00776 <span class="keywordflow">if</span> (dest[i] == <span class="charliteral">'@'</span>) -<a name="l00777"></a>00777 c++; -<a name="l00778"></a>00778 <span class="keywordflow">if</span> (c>1) -<a name="l00779"></a>00779 <span class="keywordflow">return</span> <span class="keyword">false</span>; -<a name="l00780"></a>00780 -<a name="l00781"></a>00781 <span class="keywordflow">return</span> <span class="keyword">true</span>; -<a name="l00782"></a>00782 } +Definition at line <a class="el" href="modules_8cpp-source.html#l00793">793</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00794"></a>00794 { +<a name="l00795"></a>00795 <span class="keyword">const</span> <span class="keywordtype">char</span>* dest = mask.c_str(); +<a name="l00796"></a>00796 <span class="keywordflow">if</span> (strchr(dest,<span class="charliteral">'!'</span>)==0) +<a name="l00797"></a>00797 <span class="keywordflow">return</span> <span class="keyword">false</span>; +<a name="l00798"></a>00798 <span class="keywordflow">if</span> (strchr(dest,<span class="charliteral">'@'</span>)==0) +<a name="l00799"></a>00799 <span class="keywordflow">return</span> <span class="keyword">false</span>; +<a name="l00800"></a>00800 <span class="keywordflow">for</span> (<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> i = 0; i < strlen(dest); i++) +<a name="l00801"></a>00801 <span class="keywordflow">if</span> (dest[i] < 32) +<a name="l00802"></a>00802 <span class="keywordflow">return</span> <span class="keyword">false</span>; +<a name="l00803"></a>00803 <span class="keywordflow">for</span> (<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> i = 0; i < strlen(dest); i++) +<a name="l00804"></a>00804 <span class="keywordflow">if</span> (dest[i] > 126) +<a name="l00805"></a>00805 <span class="keywordflow">return</span> <span class="keyword">false</span>; +<a name="l00806"></a>00806 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> c = 0; +<a name="l00807"></a>00807 <span class="keywordflow">for</span> (<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> i = 0; i < strlen(dest); i++) +<a name="l00808"></a>00808 <span class="keywordflow">if</span> (dest[i] == <span class="charliteral">'!'</span>) +<a name="l00809"></a>00809 c++; +<a name="l00810"></a>00810 <span class="keywordflow">if</span> (c>1) +<a name="l00811"></a>00811 <span class="keywordflow">return</span> <span class="keyword">false</span>; +<a name="l00812"></a>00812 c = 0; +<a name="l00813"></a>00813 <span class="keywordflow">for</span> (<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> i = 0; i < strlen(dest); i++) +<a name="l00814"></a>00814 <span class="keywordflow">if</span> (dest[i] == <span class="charliteral">'@'</span>) +<a name="l00815"></a>00815 c++; +<a name="l00816"></a>00816 <span class="keywordflow">if</span> (c>1) +<a name="l00817"></a>00817 <span class="keywordflow">return</span> <span class="keyword">false</span>; +<a name="l00818"></a>00818 +<a name="l00819"></a>00819 <span class="keywordflow">return</span> <span class="keyword">true</span>; +<a name="l00820"></a>00820 } +</pre></div> +<p> + </td> + </tr> +</table> +<a class="anchor" name="IsValidModuleCommand_28std_3A_3Astring_20commandname_2C_20int_20pcnt_2C_20userrec_20_2Auser_29"></a><!-- doxytag: member="Server::IsValidModuleCommand" ref="IsValidModuleCommand_28std_3A_3Astring_20commandname_2C_20int_20pcnt_2C_20userrec_20_2Auser_29" args="(std::string commandname, int pcnt, userrec *user)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">bool Server::IsValidModuleCommand </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="namespaceirc.html#string">std::string</a> </td> + <td class="mdname" nowrap> <em>commandname</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>int </td> + <td class="mdname" nowrap> <em>pcnt</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap><a class="el" href="classuserrec.html">userrec</a> * </td> + <td class="mdname" nowrap> <em>user</em></td> + </tr> + <tr> + <td class="md"></td> + <td class="md">) </td> + <td class="md" colspan="2"><code> [virtual]</code></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> + +<p> +Definition at line <a class="el" href="modules_8cpp-source.html#l00485">485</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00486"></a>00486 { +<a name="l00487"></a>00487 <span class="keywordflow">return</span> is_valid_cmd(commandname.c_str(), pcnt, user); +<a name="l00488"></a>00488 } </pre></div> <p> </td> @@ -2005,9 +2059,9 @@ Forces a user to join a channel. <p> This is similar to svsjoin and can be used to implement redirection, etc. On success, the return value is a valid pointer to a chanrec* of the channel the user was joined to. On failure, the result is NULL. <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00410">410</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00411"></a>00411 { -<a name="l00412"></a>00412 <span class="keywordflow">return</span> add_channel(user,cname.c_str(),key.c_str(),<span class="keyword">false</span>); -<a name="l00413"></a>00413 } +Definition at line <a class="el" href="modules_8cpp-source.html#l00443">443</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00444"></a>00444 { +<a name="l00445"></a>00445 <span class="keywordflow">return</span> add_channel(user,cname.c_str(),key.c_str(),<span class="keyword">false</span>); +<a name="l00446"></a>00446 } </pre></div> <p> </td> @@ -2051,9 +2105,9 @@ Writes a log string. <p> This method writes a line of text to the log. If the level given is lower than the level given in the configuration, this command has no effect. <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00452">452</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00453"></a>00453 { -<a name="l00454"></a>00454 log(level,<span class="stringliteral">"%s"</span>,s.c_str()); -<a name="l00455"></a>00455 } +Definition at line <a class="el" href="modules_8cpp-source.html#l00490">490</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00491"></a>00491 { +<a name="l00492"></a>00492 log(level,<span class="stringliteral">"%s"</span>,s.c_str()); +<a name="l00493"></a>00493 } </pre></div> <p> </td> @@ -2097,12 +2151,12 @@ Matches text against a glob pattern. <p> Uses the ircd's internal matching function to match string against a globbing pattern, e.g. *!*@*.com Returns true if the literal successfully matches the pattern, false if otherwise. <p> -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>.<div class="fragment"><pre class="fragment"><a name="l00398"></a>00398 { -<a name="l00399"></a>00399 <span class="keywordtype">char</span> literal[MAXBUF],pattern[MAXBUF]; -<a name="l00400"></a>00400 strlcpy(literal,sliteral.c_str(),MAXBUF); -<a name="l00401"></a>00401 strlcpy(pattern,spattern.c_str(),MAXBUF); -<a name="l00402"></a>00402 <span class="keywordflow">return</span> match(literal,pattern); -<a name="l00403"></a>00403 } +Definition at line <a class="el" href="modules_8cpp-source.html#l00430">430</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00431"></a>00431 { +<a name="l00432"></a>00432 <span class="keywordtype">char</span> literal[MAXBUF],pattern[MAXBUF]; +<a name="l00433"></a>00433 strlcpy(literal,sliteral.c_str(),MAXBUF); +<a name="l00434"></a>00434 strlcpy(pattern,spattern.c_str(),MAXBUF); +<a name="l00435"></a>00435 <span class="keywordflow">return</span> match(literal,pattern); +<a name="l00436"></a>00436 } </pre></div> <p> </td> @@ -2152,9 +2206,9 @@ Forces a user to part a channel. <p> This is similar to svspart and can be used to implement redirection, etc. Although the return value of this function is a pointer to a channel record, the returned data is undefined and should not be read or written to. This behaviour may be changed in a future version. <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00415">415</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00416"></a>00416 { -<a name="l00417"></a>00417 <span class="keywordflow">return</span> del_channel(user,cname.c_str(),reason.c_str(),<span class="keyword">false</span>); -<a name="l00418"></a>00418 } +Definition at line <a class="el" href="modules_8cpp-source.html#l00448">448</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00449"></a>00449 { +<a name="l00450"></a>00450 <span class="keywordflow">return</span> del_channel(user,cname.c_str(),reason.c_str(),<span class="keyword">false</span>); +<a name="l00451"></a>00451 } </pre></div> <p> </td> @@ -2204,36 +2258,36 @@ This user takes one user, and switches their file descriptor with another user, <p> The user in 'alive' is booted off the server with the given message. The user referred to by 'zombie' should have previously been locked with Server::ZombifyUser, otherwise stale sockets and file descriptor leaks can occur. After this call, the pointer to alive will be invalid, and the pointer to zombie will be equivalent in effect to the old pointer to alive. <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00670">670</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. -<p> -References <a class="el" href="channels_8h-source.html#l00252">ucrec::channel</a>, <a class="el" href="users_8h-source.html#l00146">userrec::chans</a>, <a class="el" href="users_8cpp-source.html#l00228">userrec::ClearBuffer()</a>, <a class="el" href="connection_8h-source.html#l00042">connection::fd</a>, <a class="el" href="modules_8h-source.html#l00100">FD_MAGIC_NUMBER</a>, <a class="el" href="connection_8h-source.html#l00046">connection::host</a>, <a class="el" href="users_8h-source.html#l00126">userrec::ident</a>, <a class="el" href="channels_8h-source.html#l00106">chanrec::name</a>, <a class="el" href="users_8h-source.html#l00121">userrec::nick</a>, <a class="el" href="channels_8h-source.html#l00131">chanrec::setby</a>, <a class="el" href="channels_8h-source.html#l00120">chanrec::topic</a>, and <a class="el" href="channels_8h-source.html#l00127">chanrec::topicset</a>.<div class="fragment"><pre class="fragment"><a name="l00671"></a>00671 { -<a name="l00672"></a>00672 zombie-><a class="code" href="classconnection.html#fd">fd</a> = alive-><a class="code" href="classconnection.html#fd">fd</a>; -<a name="l00673"></a>00673 alive-><a class="code" href="classconnection.html#fd">fd</a> = <a class="code" href="modules_8h.html#FD_5FMAGIC_5FNUMBER">FD_MAGIC_NUMBER</a>; -<a name="l00674"></a>00674 alive-><a class="code" href="classuserrec.html#ClearBuffer_28_29">ClearBuffer</a>(); -<a name="l00675"></a>00675 Write(zombie-><a class="code" href="classconnection.html#fd">fd</a>,<span class="stringliteral">":%s!%s@%s NICK %s"</span>,alive-><a class="code" href="classuserrec.html#nick_5BNICKMAX_5D">nick</a>,alive-><a class="code" href="classuserrec.html#ident_5BIDENTMAX_2B_32_5D">ident</a>,alive-><a class="code" href="classconnection.html#host_5B_31_36_30_5D">host</a>,zombie-><a class="code" href="classuserrec.html#nick_5BNICKMAX_5D">nick</a>); -<a name="l00676"></a>00676 kill_link(alive,message.c_str()); -<a name="l00677"></a>00677 <a class="code" href="modules_8cpp.html#fd_5Fref_5Ftable_5B_36_35_35_33_36_5D">fd_ref_table</a>[zombie-><a class="code" href="classconnection.html#fd">fd</a>] = zombie; -<a name="l00678"></a>00678 <span class="keywordflow">for</span> (<span class="keywordtype">int</span> i = 0; i != MAXCHANS; i++) -<a name="l00679"></a>00679 { -<a name="l00680"></a>00680 <span class="keywordflow">if</span> (zombie-><a class="code" href="classuserrec.html#chans_5BMAXCHANS_5D">chans</a>[i].<a class="code" href="classucrec.html#channel">channel</a> != NULL) -<a name="l00681"></a>00681 { -<a name="l00682"></a>00682 <span class="keywordflow">if</span> (zombie-><a class="code" href="classuserrec.html#chans_5BMAXCHANS_5D">chans</a>[i].<a class="code" href="classucrec.html#channel">channel</a>-><a class="code" href="classchanrec.html#name_5BCHANMAX_5D">name</a>) -<a name="l00683"></a>00683 { -<a name="l00684"></a>00684 <a class="code" href="classchanrec.html">chanrec</a>* Ptr = zombie-><a class="code" href="classuserrec.html#chans_5BMAXCHANS_5D">chans</a>[i].<a class="code" href="classucrec.html#channel">channel</a>; -<a name="l00685"></a>00685 WriteFrom(zombie-><a class="code" href="classconnection.html#fd">fd</a>,zombie,<span class="stringliteral">"JOIN %s"</span>,Ptr-><a class="code" href="classchanrec.html#name_5BCHANMAX_5D">name</a>); -<a name="l00686"></a>00686 <span class="keywordflow">if</span> (Ptr-><a class="code" href="classchanrec.html#topicset">topicset</a>) -<a name="l00687"></a>00687 { -<a name="l00688"></a>00688 WriteServ(zombie-><a class="code" href="classconnection.html#fd">fd</a>,<span class="stringliteral">"332 %s %s :%s"</span>, zombie-><a class="code" href="classuserrec.html#nick_5BNICKMAX_5D">nick</a>, Ptr-><a class="code" href="classchanrec.html#name_5BCHANMAX_5D">name</a>, Ptr-><a class="code" href="classchanrec.html#topic_5BMAXBUF_5D">topic</a>); -<a name="l00689"></a>00689 WriteServ(zombie-><a class="code" href="classconnection.html#fd">fd</a>,<span class="stringliteral">"333 %s %s %s %d"</span>, zombie-><a class="code" href="classuserrec.html#nick_5BNICKMAX_5D">nick</a>, Ptr-><a class="code" href="classchanrec.html#name_5BCHANMAX_5D">name</a>, Ptr-><a class="code" href="classchanrec.html#setby_5BNICKMAX_5D">setby</a>, Ptr-><a class="code" href="classchanrec.html#topicset">topicset</a>); -<a name="l00690"></a>00690 } -<a name="l00691"></a>00691 userlist(zombie,Ptr); -<a name="l00692"></a>00692 WriteServ(zombie-><a class="code" href="classconnection.html#fd">fd</a>,<span class="stringliteral">"366 %s %s :End of /NAMES list."</span>, zombie-><a class="code" href="classuserrec.html#nick_5BNICKMAX_5D">nick</a>, Ptr-><a class="code" href="classchanrec.html#name_5BCHANMAX_5D">name</a>); -<a name="l00693"></a>00693 -<a name="l00694"></a>00694 } -<a name="l00695"></a>00695 } -<a name="l00696"></a>00696 } -<a name="l00697"></a>00697 <span class="keywordflow">return</span> <span class="keyword">true</span>; -<a name="l00698"></a>00698 } +Definition at line <a class="el" href="modules_8cpp-source.html#l00708">708</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +<p> +References <a class="el" href="channels_8h-source.html#l00252">ucrec::channel</a>, <a class="el" href="users_8h-source.html#l00149">userrec::chans</a>, <a class="el" href="users_8cpp-source.html#l00239">userrec::ClearBuffer()</a>, <a class="el" href="connection_8h-source.html#l00042">connection::fd</a>, <a class="el" href="modules_8h-source.html#l00101">FD_MAGIC_NUMBER</a>, <a class="el" href="connection_8h-source.html#l00046">connection::host</a>, <a class="el" href="users_8h-source.html#l00129">userrec::ident</a>, <a class="el" href="channels_8h-source.html#l00106">chanrec::name</a>, <a class="el" href="users_8h-source.html#l00124">userrec::nick</a>, <a class="el" href="channels_8h-source.html#l00131">chanrec::setby</a>, <a class="el" href="channels_8h-source.html#l00120">chanrec::topic</a>, and <a class="el" href="channels_8h-source.html#l00127">chanrec::topicset</a>.<div class="fragment"><pre class="fragment"><a name="l00709"></a>00709 { +<a name="l00710"></a>00710 zombie-><a class="code" href="classconnection.html#fd">fd</a> = alive-><a class="code" href="classconnection.html#fd">fd</a>; +<a name="l00711"></a>00711 alive-><a class="code" href="classconnection.html#fd">fd</a> = <a class="code" href="modules_8h.html#FD_5FMAGIC_5FNUMBER">FD_MAGIC_NUMBER</a>; +<a name="l00712"></a>00712 alive-><a class="code" href="classuserrec.html#ClearBuffer_28_29">ClearBuffer</a>(); +<a name="l00713"></a>00713 Write(zombie-><a class="code" href="classconnection.html#fd">fd</a>,<span class="stringliteral">":%s!%s@%s NICK %s"</span>,alive-><a class="code" href="classuserrec.html#nick_5BNICKMAX_5D">nick</a>,alive-><a class="code" href="classuserrec.html#ident_5BIDENTMAX_2B_32_5D">ident</a>,alive-><a class="code" href="classconnection.html#host_5B_31_36_30_5D">host</a>,zombie-><a class="code" href="classuserrec.html#nick_5BNICKMAX_5D">nick</a>); +<a name="l00714"></a>00714 kill_link(alive,message.c_str()); +<a name="l00715"></a>00715 <a class="code" href="modules_8cpp.html#fd_5Fref_5Ftable_5B_36_35_35_33_36_5D">fd_ref_table</a>[zombie-><a class="code" href="classconnection.html#fd">fd</a>] = zombie; +<a name="l00716"></a>00716 <span class="keywordflow">for</span> (<span class="keywordtype">int</span> i = 0; i != MAXCHANS; i++) +<a name="l00717"></a>00717 { +<a name="l00718"></a>00718 <span class="keywordflow">if</span> (zombie-><a class="code" href="classuserrec.html#chans_5BMAXCHANS_5D">chans</a>[i].<a class="code" href="classucrec.html#channel">channel</a> != NULL) +<a name="l00719"></a>00719 { +<a name="l00720"></a>00720 <span class="keywordflow">if</span> (zombie-><a class="code" href="classuserrec.html#chans_5BMAXCHANS_5D">chans</a>[i].<a class="code" href="classucrec.html#channel">channel</a>-><a class="code" href="classchanrec.html#name_5BCHANMAX_5D">name</a>) +<a name="l00721"></a>00721 { +<a name="l00722"></a>00722 <a class="code" href="classchanrec.html">chanrec</a>* Ptr = zombie-><a class="code" href="classuserrec.html#chans_5BMAXCHANS_5D">chans</a>[i].<a class="code" href="classucrec.html#channel">channel</a>; +<a name="l00723"></a>00723 WriteFrom(zombie-><a class="code" href="classconnection.html#fd">fd</a>,zombie,<span class="stringliteral">"JOIN %s"</span>,Ptr-><a class="code" href="classchanrec.html#name_5BCHANMAX_5D">name</a>); +<a name="l00724"></a>00724 <span class="keywordflow">if</span> (Ptr-><a class="code" href="classchanrec.html#topicset">topicset</a>) +<a name="l00725"></a>00725 { +<a name="l00726"></a>00726 WriteServ(zombie-><a class="code" href="classconnection.html#fd">fd</a>,<span class="stringliteral">"332 %s %s :%s"</span>, zombie-><a class="code" href="classuserrec.html#nick_5BNICKMAX_5D">nick</a>, Ptr-><a class="code" href="classchanrec.html#name_5BCHANMAX_5D">name</a>, Ptr-><a class="code" href="classchanrec.html#topic_5BMAXBUF_5D">topic</a>); +<a name="l00727"></a>00727 WriteServ(zombie-><a class="code" href="classconnection.html#fd">fd</a>,<span class="stringliteral">"333 %s %s %s %d"</span>, zombie-><a class="code" href="classuserrec.html#nick_5BNICKMAX_5D">nick</a>, Ptr-><a class="code" href="classchanrec.html#name_5BCHANMAX_5D">name</a>, Ptr-><a class="code" href="classchanrec.html#setby_5BNICKMAX_5D">setby</a>, Ptr-><a class="code" href="classchanrec.html#topicset">topicset</a>); +<a name="l00728"></a>00728 } +<a name="l00729"></a>00729 userlist(zombie,Ptr); +<a name="l00730"></a>00730 WriteServ(zombie-><a class="code" href="classconnection.html#fd">fd</a>,<span class="stringliteral">"366 %s %s :End of /NAMES list."</span>, zombie-><a class="code" href="classuserrec.html#nick_5BNICKMAX_5D">nick</a>, Ptr-><a class="code" href="classchanrec.html#name_5BCHANMAX_5D">name</a>); +<a name="l00731"></a>00731 +<a name="l00732"></a>00732 } +<a name="l00733"></a>00733 } +<a name="l00734"></a>00734 } +<a name="l00735"></a>00735 <span class="keywordflow">return</span> <span class="keyword">true</span>; +<a name="l00736"></a>00736 } </pre></div> <p> </td> @@ -2279,9 +2333,44 @@ To the user, it will appear as if they typed /QUIT themselves, except for the fa WARNING!<p> Once you call this function, userrec* user will immediately become INVALID. You MUST NOT write to, or read from this pointer after calling the QuitUser method UNDER ANY CIRCUMSTANCES! The best course of action after calling this method is to immediately bail from your handler. <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00437">437</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00438"></a>00438 { -<a name="l00439"></a>00439 kill_link(user,reason.c_str()); -<a name="l00440"></a>00440 } +Definition at line <a class="el" href="modules_8cpp-source.html#l00470">470</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00471"></a>00471 { +<a name="l00472"></a>00472 kill_link(user,reason.c_str()); +<a name="l00473"></a>00473 } +</pre></div> +<p> + </td> + </tr> +</table> +<a class="anchor" name="RehashServer_28_29"></a><!-- doxytag: member="Server::RehashServer" ref="RehashServer_28_29" args="()" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">void Server::RehashServer </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </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> + +<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>.<div class="fragment"><pre class="fragment"><a name="l00408"></a>00408 { +<a name="l00409"></a>00409 WriteOpers(<span class="stringliteral">"*** Rehashing config file"</span>); +<a name="l00410"></a>00410 ReadConfig(<span class="keyword">false</span>,NULL); +<a name="l00411"></a>00411 } </pre></div> <p> </td> @@ -2325,9 +2414,9 @@ Sends a line of text down a TCP/IP socket. <p> This method writes a line of text to an established socket, cutting it to 510 characters plus a carriage return and linefeed if required. <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00467">467</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00468"></a>00468 { -<a name="l00469"></a>00469 Write(Socket,<span class="stringliteral">"%s"</span>,s.c_str()); -<a name="l00470"></a>00470 } +Definition at line <a class="el" href="modules_8cpp-source.html#l00505">505</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00506"></a>00506 { +<a name="l00507"></a>00507 Write(Socket,<span class="stringliteral">"%s"</span>,s.c_str()); +<a name="l00508"></a>00508 } </pre></div> <p> </td> @@ -2383,16 +2472,16 @@ Sends text from a user to a channel (mulicast). <p> This method writes a line of text to a channel, with the given user's nick/ident /host combination prepended, as used in PRIVMSG etc commands (see RFC 1459). If the IncludeSender flag is set, then the text is also sent back to the user from which it originated, as seen in MODE (see RFC 1459). <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00501">501</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00502"></a>00502 { -<a name="l00503"></a>00503 <span class="keywordflow">if</span> (IncludeSender) -<a name="l00504"></a>00504 { -<a name="l00505"></a>00505 WriteChannel(Channel,User,<span class="stringliteral">"%s"</span>,s.c_str()); -<a name="l00506"></a>00506 } -<a name="l00507"></a>00507 <span class="keywordflow">else</span> -<a name="l00508"></a>00508 { -<a name="l00509"></a>00509 ChanExceptSender(Channel,User,<span class="stringliteral">"%s"</span>,s.c_str()); -<a name="l00510"></a>00510 } -<a name="l00511"></a>00511 } +Definition at line <a class="el" href="modules_8cpp-source.html#l00539">539</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00540"></a>00540 { +<a name="l00541"></a>00541 <span class="keywordflow">if</span> (IncludeSender) +<a name="l00542"></a>00542 { +<a name="l00543"></a>00543 WriteChannel(Channel,User,<span class="stringliteral">"%s"</span>,s.c_str()); +<a name="l00544"></a>00544 } +<a name="l00545"></a>00545 <span class="keywordflow">else</span> +<a name="l00546"></a>00546 { +<a name="l00547"></a>00547 ChanExceptSender(Channel,User,<span class="stringliteral">"%s"</span>,s.c_str()); +<a name="l00548"></a>00548 } +<a name="l00549"></a>00549 } </pre></div> <p> </td> @@ -2442,9 +2531,9 @@ Writes text to a channel, but from a server, including all. <p> This can be used to send server notices to a group of users. <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00496">496</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00497"></a>00497 { -<a name="l00498"></a>00498 WriteChannelWithServ((<span class="keywordtype">char</span>*)ServName.c_str(), Channel, <span class="stringliteral">"%s"</span>, text.c_str()); -<a name="l00499"></a>00499 } +Definition at line <a class="el" href="modules_8cpp-source.html#l00534">534</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00535"></a>00535 { +<a name="l00536"></a>00536 WriteChannelWithServ((<span class="keywordtype">char</span>*)ServName.c_str(), Channel, <span class="stringliteral">"%s"</span>, text.c_str()); +<a name="l00537"></a>00537 } </pre></div> <p> </td> @@ -2494,16 +2583,16 @@ Sends text from a user to one or more channels (mulicast). <p> This method writes a line of text to all users which share a common channel with a given user, with the user's nick/ident/host combination prepended, as used in PRIVMSG etc commands (see RFC 1459). If the IncludeSender flag is set, then the text is also sent back to the user from which it originated, as seen in NICK (see RFC 1459). Otherwise, it is only sent to the other recipients, as seen in QUIT. <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00518">518</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00519"></a>00519 { -<a name="l00520"></a>00520 <span class="keywordflow">if</span> (IncludeSender) -<a name="l00521"></a>00521 { -<a name="l00522"></a>00522 WriteCommon(User,<span class="stringliteral">"%s"</span>,text.c_str()); -<a name="l00523"></a>00523 } -<a name="l00524"></a>00524 <span class="keywordflow">else</span> -<a name="l00525"></a>00525 { -<a name="l00526"></a>00526 WriteCommonExcept(User,<span class="stringliteral">"%s"</span>,text.c_str()); -<a name="l00527"></a>00527 } -<a name="l00528"></a>00528 } +Definition at line <a class="el" href="modules_8cpp-source.html#l00556">556</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00557"></a>00557 { +<a name="l00558"></a>00558 <span class="keywordflow">if</span> (IncludeSender) +<a name="l00559"></a>00559 { +<a name="l00560"></a>00560 WriteCommon(User,<span class="stringliteral">"%s"</span>,text.c_str()); +<a name="l00561"></a>00561 } +<a name="l00562"></a>00562 <span class="keywordflow">else</span> +<a name="l00563"></a>00563 { +<a name="l00564"></a>00564 WriteCommonExcept(User,<span class="stringliteral">"%s"</span>,text.c_str()); +<a name="l00565"></a>00565 } +<a name="l00566"></a>00566 } </pre></div> <p> </td> @@ -2553,9 +2642,9 @@ Sends text from a user to a socket. <p> This method writes a line of text to an established socket, with the given user's nick/ident /host combination prepended, as used in PRIVSG etc commands (see RFC 1459) <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00477">477</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00478"></a>00478 { -<a name="l00479"></a>00479 WriteFrom(Socket,User,<span class="stringliteral">"%s"</span>,s.c_str()); -<a name="l00480"></a>00480 } +Definition at line <a class="el" href="modules_8cpp-source.html#l00515">515</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00516"></a>00516 { +<a name="l00517"></a>00517 WriteFrom(Socket,User,<span class="stringliteral">"%s"</span>,s.c_str()); +<a name="l00518"></a>00518 } </pre></div> <p> </td> @@ -2612,11 +2701,11 @@ modes[2] = user->nick;<p> Srv->SendMode(modes,3,user);<p> The modes will originate from the server where the command was issued, however responses (e.g. numerics) will be sent to the user you provide as the third parameter. You must be sure to get the number of parameters correct in the pcnt parameter otherwise you could leave your server in an unstable state! <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00462">462</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#l00500">500</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -References <a class="el" href="mode_8h.html#server_5Fmode_28char_20_2A_2Aparameters_2C_20int_20pcnt_2C_20userrec_20_2Auser_29">server_mode()</a>.<div class="fragment"><pre class="fragment"><a name="l00463"></a>00463 { -<a name="l00464"></a>00464 <a class="code" href="mode_8h.html#server_5Fmode_28char_20_2A_2Aparameters_2C_20int_20pcnt_2C_20userrec_20_2Auser_29">server_mode</a>(parameters,pcnt,user); -<a name="l00465"></a>00465 } +References <a class="el" href="mode_8h.html#server_5Fmode_28char_20_2A_2Aparameters_2C_20int_20pcnt_2C_20userrec_20_2Auser_29">server_mode()</a>.<div class="fragment"><pre class="fragment"><a name="l00501"></a>00501 { +<a name="l00502"></a>00502 <a class="code" href="mode_8h.html#server_5Fmode_28char_20_2A_2Aparameters_2C_20int_20pcnt_2C_20userrec_20_2Auser_29">server_mode</a>(parameters,pcnt,user); +<a name="l00503"></a>00503 } </pre></div> <p> </td> @@ -2651,9 +2740,9 @@ Sends text to all opers. <p> This method sends a server notice to all opers with the usermode +s. <p> -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>.<div class="fragment"><pre class="fragment"><a name="l00393"></a>00393 { -<a name="l00394"></a>00394 WriteOpers(<span class="stringliteral">"%s"</span>,s.c_str()); -<a name="l00395"></a>00395 } +Definition at line <a class="el" href="modules_8cpp-source.html#l00425">425</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00426"></a>00426 { +<a name="l00427"></a>00427 WriteOpers(<span class="stringliteral">"%s"</span>,s.c_str()); +<a name="l00428"></a>00428 } </pre></div> <p> </td> @@ -2697,9 +2786,9 @@ Sends text from the server to a socket. <p> This method writes a line of text to an established socket, with the servername prepended as used by numerics (see RFC 1459) <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00472">472</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00473"></a>00473 { -<a name="l00474"></a>00474 WriteServ(Socket,<span class="stringliteral">"%s"</span>,s.c_str()); -<a name="l00475"></a>00475 } +Definition at line <a class="el" href="modules_8cpp-source.html#l00510">510</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00511"></a>00511 { +<a name="l00512"></a>00512 WriteServ(Socket,<span class="stringliteral">"%s"</span>,s.c_str()); +<a name="l00513"></a>00513 } </pre></div> <p> </td> @@ -2753,20 +2842,20 @@ The format will become:<p> :localserver TEXT<p> Which is useful for numerics and server notices to single users, etc. <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00482">482</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. -<p> -References <a class="el" href="connection_8h-source.html#l00042">connection::fd</a>.<div class="fragment"><pre class="fragment"><a name="l00483"></a>00483 { -<a name="l00484"></a>00484 <span class="keywordflow">if</span> (!Source) -<a name="l00485"></a>00485 { -<a name="l00486"></a>00486 <span class="comment">// if source is NULL, then the message originates from the local server</span> -<a name="l00487"></a>00487 Write(Dest-><a class="code" href="classconnection.html#fd">fd</a>,<span class="stringliteral">":%s %s"</span>,this->GetServerName().c_str(),s.c_str()); -<a name="l00488"></a>00488 } -<a name="l00489"></a>00489 <span class="keywordflow">else</span> -<a name="l00490"></a>00490 { -<a name="l00491"></a>00491 <span class="comment">// otherwise it comes from the user specified</span> -<a name="l00492"></a>00492 WriteTo(Source,Dest,<span class="stringliteral">"%s"</span>,s.c_str()); -<a name="l00493"></a>00493 } -<a name="l00494"></a>00494 } +Definition at line <a class="el" href="modules_8cpp-source.html#l00520">520</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +<p> +References <a class="el" href="connection_8h-source.html#l00042">connection::fd</a>.<div class="fragment"><pre class="fragment"><a name="l00521"></a>00521 { +<a name="l00522"></a>00522 <span class="keywordflow">if</span> (!Source) +<a name="l00523"></a>00523 { +<a name="l00524"></a>00524 <span class="comment">// if source is NULL, then the message originates from the local server</span> +<a name="l00525"></a>00525 Write(Dest-><a class="code" href="classconnection.html#fd">fd</a>,<span class="stringliteral">":%s %s"</span>,this->GetServerName().c_str(),s.c_str()); +<a name="l00526"></a>00526 } +<a name="l00527"></a>00527 <span class="keywordflow">else</span> +<a name="l00528"></a>00528 { +<a name="l00529"></a>00529 <span class="comment">// otherwise it comes from the user specified</span> +<a name="l00530"></a>00530 WriteTo(Source,Dest,<span class="stringliteral">"%s"</span>,s.c_str()); +<a name="l00531"></a>00531 } +<a name="l00532"></a>00532 } </pre></div> <p> </td> @@ -2818,9 +2907,9 @@ These can be RFC specified modes such as +i, or module provided modes, including Serv->SendToModeMask("xi", WM_OR, "m00");<p> Then the text 'm00' will be sent to all users with EITHER mode x or i. Conversely if you used WM_AND, the user must have both modes set to receive the message. <p> -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>.<div class="fragment"><pre class="fragment"><a name="l00406"></a>00406 { -<a name="l00407"></a>00407 WriteMode(modes.c_str(),flags,<span class="stringliteral">"%s"</span>,text.c_str()); -<a name="l00408"></a>00408 } +Definition at line <a class="el" href="modules_8cpp-source.html#l00438">438</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00439"></a>00439 { +<a name="l00440"></a>00440 WriteMode(modes.c_str(),flags,<span class="stringliteral">"%s"</span>,text.c_str()); +<a name="l00441"></a>00441 } </pre></div> <p> </td> @@ -2864,9 +2953,9 @@ Sends a WALLOPS message. <p> This method writes a WALLOPS message to all users with the +w flag, originating from the specified user. <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00530">530</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00531"></a>00531 { -<a name="l00532"></a>00532 WriteWallOps(User,<span class="keyword">false</span>,<span class="stringliteral">"%s"</span>,text.c_str()); -<a name="l00533"></a>00533 } +Definition at line <a class="el" href="modules_8cpp-source.html#l00568">568</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00569"></a>00569 { +<a name="l00570"></a>00570 WriteWallOps(User,<span class="keyword">false</span>,<span class="stringliteral">"%s"</span>,text.c_str()); +<a name="l00571"></a>00571 } </pre></div> <p> </td> @@ -2910,37 +2999,37 @@ Remove a user's connection to the irc server, but leave their client in existenc <p> When you call this function, the user's file descriptor will be replaced with the value of FD_MAGIC_NUMBER and their old file descriptor will be closed. This idle client will remain until it is restored with a valid file descriptor, or is removed from IRC by an operator After this call, the pointer to user will be invalid. <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00639">639</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. -<p> -References <a class="el" href="users_8cpp-source.html#l00228">userrec::ClearBuffer()</a>, <a class="el" href="modules_8h-source.html#l00023">DEBUG</a>, <a class="el" href="connection_8h-source.html#l00042">connection::fd</a>, <a class="el" href="modules_8h-source.html#l00100">FD_MAGIC_NUMBER</a>, <a class="el" href="connection_8h-source.html#l00046">connection::host</a>, and <a class="el" href="users_8h-source.html#l00126">userrec::ident</a>.<div class="fragment"><pre class="fragment"><a name="l00640"></a>00640 { -<a name="l00641"></a>00641 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> old_fd = user-><a class="code" href="classconnection.html#fd">fd</a>; -<a name="l00642"></a>00642 user-><a class="code" href="classconnection.html#fd">fd</a> = <a class="code" href="modules_8h.html#FD_5FMAGIC_5FNUMBER">FD_MAGIC_NUMBER</a>; -<a name="l00643"></a>00643 user-><a class="code" href="classuserrec.html#ClearBuffer_28_29">ClearBuffer</a>(); -<a name="l00644"></a>00644 Write(old_fd,<span class="stringliteral">"ERROR :Closing link (%s@%s) [%s]"</span>,user-><a class="code" href="classuserrec.html#ident_5BIDENTMAX_2B_32_5D">ident</a>,user-><a class="code" href="classconnection.html#host_5B_31_36_30_5D">host</a>,message.c_str()); -<a name="l00645"></a>00645 <span class="preprocessor">#ifdef USE_KQUEUE</span> -<a name="l00646"></a>00646 <span class="preprocessor"></span> <span class="keyword">struct </span>kevent ke; -<a name="l00647"></a>00647 EV_SET(&ke, old_fd, EVFILT_READ, EV_DELETE, 0, 0, NULL); -<a name="l00648"></a>00648 <span class="keywordtype">int</span> i = kevent(kq, &ke, 1, 0, 0, NULL); -<a name="l00649"></a>00649 <span class="keywordflow">if</span> (i == -1) -<a name="l00650"></a>00650 { -<a name="l00651"></a>00651 log(<a class="code" href="modules_8h.html#DEBUG">DEBUG</a>,<span class="stringliteral">"kqueue: Failed to remove user from queue!"</span>); -<a name="l00652"></a>00652 } -<a name="l00653"></a>00653 <span class="preprocessor">#endif</span> -<a name="l00654"></a>00654 <span class="preprocessor"></span><span class="preprocessor">#ifdef USE_EPOLL</span> -<a name="l00655"></a>00655 <span class="preprocessor"></span> <span class="keyword">struct </span>epoll_event ev; -<a name="l00656"></a>00656 ev.events = EPOLLIN | EPOLLET; -<a name="l00657"></a>00657 ev.data.fd = old_fd; -<a name="l00658"></a>00658 <span class="keywordtype">int</span> i = epoll_ctl(ep, EPOLL_CTL_DEL, old_fd, &ev); -<a name="l00659"></a>00659 <span class="keywordflow">if</span> (i < 0) -<a name="l00660"></a>00660 { -<a name="l00661"></a>00661 log(<a class="code" href="modules_8h.html#DEBUG">DEBUG</a>,<span class="stringliteral">"epoll: List deletion failure!"</span>); -<a name="l00662"></a>00662 } -<a name="l00663"></a>00663 <span class="preprocessor">#endif</span> -<a name="l00664"></a>00664 <span class="preprocessor"></span> -<a name="l00665"></a>00665 shutdown(old_fd,2); -<a name="l00666"></a>00666 close(old_fd); -<a name="l00667"></a>00667 <span class="keywordflow">return</span> <span class="keyword">true</span>; -<a name="l00668"></a>00668 } +Definition at line <a class="el" href="modules_8cpp-source.html#l00677">677</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +<p> +References <a class="el" href="users_8cpp-source.html#l00239">userrec::ClearBuffer()</a>, <a class="el" href="modules_8h-source.html#l00023">DEBUG</a>, <a class="el" href="connection_8h-source.html#l00042">connection::fd</a>, <a class="el" href="modules_8h-source.html#l00101">FD_MAGIC_NUMBER</a>, <a class="el" href="connection_8h-source.html#l00046">connection::host</a>, and <a class="el" href="users_8h-source.html#l00129">userrec::ident</a>.<div class="fragment"><pre class="fragment"><a name="l00678"></a>00678 { +<a name="l00679"></a>00679 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> old_fd = user-><a class="code" href="classconnection.html#fd">fd</a>; +<a name="l00680"></a>00680 user-><a class="code" href="classconnection.html#fd">fd</a> = <a class="code" href="modules_8h.html#FD_5FMAGIC_5FNUMBER">FD_MAGIC_NUMBER</a>; +<a name="l00681"></a>00681 user-><a class="code" href="classuserrec.html#ClearBuffer_28_29">ClearBuffer</a>(); +<a name="l00682"></a>00682 Write(old_fd,<span class="stringliteral">"ERROR :Closing link (%s@%s) [%s]"</span>,user-><a class="code" href="classuserrec.html#ident_5BIDENTMAX_2B_32_5D">ident</a>,user-><a class="code" href="classconnection.html#host_5B_31_36_30_5D">host</a>,message.c_str()); +<a name="l00683"></a>00683 <span class="preprocessor">#ifdef USE_KQUEUE</span> +<a name="l00684"></a>00684 <span class="preprocessor"></span> <span class="keyword">struct </span>kevent ke; +<a name="l00685"></a>00685 EV_SET(&ke, old_fd, EVFILT_READ, EV_DELETE, 0, 0, NULL); +<a name="l00686"></a>00686 <span class="keywordtype">int</span> i = kevent(kq, &ke, 1, 0, 0, NULL); +<a name="l00687"></a>00687 <span class="keywordflow">if</span> (i == -1) +<a name="l00688"></a>00688 { +<a name="l00689"></a>00689 log(<a class="code" href="modules_8h.html#DEBUG">DEBUG</a>,<span class="stringliteral">"kqueue: Failed to remove user from queue!"</span>); +<a name="l00690"></a>00690 } +<a name="l00691"></a>00691 <span class="preprocessor">#endif</span> +<a name="l00692"></a>00692 <span class="preprocessor"></span><span class="preprocessor">#ifdef USE_EPOLL</span> +<a name="l00693"></a>00693 <span class="preprocessor"></span> <span class="keyword">struct </span>epoll_event ev; +<a name="l00694"></a>00694 ev.events = EPOLLIN | EPOLLET; +<a name="l00695"></a>00695 ev.data.fd = old_fd; +<a name="l00696"></a>00696 <span class="keywordtype">int</span> i = epoll_ctl(ep, EPOLL_CTL_DEL, old_fd, &ev); +<a name="l00697"></a>00697 <span class="keywordflow">if</span> (i < 0) +<a name="l00698"></a>00698 { +<a name="l00699"></a>00699 log(<a class="code" href="modules_8h.html#DEBUG">DEBUG</a>,<span class="stringliteral">"epoll: List deletion failure!"</span>); +<a name="l00700"></a>00700 } +<a name="l00701"></a>00701 <span class="preprocessor">#endif</span> +<a name="l00702"></a>00702 <span class="preprocessor"></span> +<a name="l00703"></a>00703 shutdown(old_fd,2); +<a name="l00704"></a>00704 close(old_fd); +<a name="l00705"></a>00705 <span class="keywordflow">return</span> <span class="keyword">true</span>; +<a name="l00706"></a>00706 } </pre></div> <p> </td> @@ -2948,7 +3037,7 @@ References <a class="el" href="users_8cpp-source.html#l00228">userrec::ClearBuff </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 Sun Nov 27 01:43:26 2005 for InspIRCd by +<hr size="1"><address style="align: right;"><small>Generated on Fri Dec 9 20:20:13 2005 for InspIRCd by <a href="http://www.doxygen.org/index.html"> <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.4-20050815 </small></address> </body> |