diff options
Diffstat (limited to 'docs/module-doc/classServer.html')
| -rw-r--r-- | docs/module-doc/classServer.html | 412 |
1 files changed, 232 insertions, 180 deletions
diff --git a/docs/module-doc/classServer.html b/docs/module-doc/classServer.html index 73835e18e..b0f90ba36 100644 --- a/docs/module-doc/classServer.html +++ b/docs/module-doc/classServer.html @@ -86,6 +86,8 @@ Inheritance diagram for Server:<p><center><img src="classServer__inherit__graph. <tr><td> </td><td><font size=-1><em>Change displayed hostname of a user.</em> <a href="#a30"></a><em></em></font><br><br></td></tr> <tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classServer.html#a31">ChangeGECOS</a> (<a class="el" href="classuserrec.html">userrec</a> *user, std::string gecos)</td></tr> <tr><td> </td><td><font size=-1><em>Change GECOS (fullname) of a user.</em> <a href="#a31"></a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual bool </td><td valign=bottom><a class="el" href="classServer.html#a32">IsUlined</a> (std::string server)</td></tr> +<tr><td> </td><td><font size=-1><em>Returns true if the servername you give is ulined.</em> <a href="#a32"></a><em></em></font><br><br></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. @@ -94,7 +96,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#l00241">241</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#l00250">250</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.<hr><h2>Constructor & Destructor Documentation</h2> <a name="a0" doxytag="Server::Server"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> @@ -124,10 +126,10 @@ Default constructor. <p> Creates a Server object. <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00133">133</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#l00135">135</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00134 { -00135 } +<div class="fragment"><pre>00136 { +00137 } </pre></div> </td> </tr> </table> @@ -160,10 +162,10 @@ Default destructor. <p> Destroys a Server object. <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00137">137</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#l00139">139</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00138 { -00139 } +<div class="fragment"><pre>00140 { +00141 } </pre></div> </td> </tr> </table> @@ -218,16 +220,16 @@ Definition at line <a class="el" href="modules_8cpp-source.html#l00137">137</a> Adds a command to the command table. <p> This allows modules to add extra commands into the command table. You must place a function within your module which is is of type handlerfunc:<p> -typedef void (handlerfunc) (char**, int, userrec*); ... void handle_kill(char **parameters, int pcnt, userrec *user)<p> +typedef void (handlerfunc) (char**, int, userrec*); ... void <a class="el" href="commands_8h.html#a5">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'. <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00190">190</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#l00197">197</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> References <a class="el" href="modules_8h.html#a13">createcommand()</a>. <p> -<div class="fragment"><pre>00191 { -00192 <a class="code" href="modules_8h.html#a13">createcommand</a>(cmd,f,flags,minparams); -00193 } +<div class="fragment"><pre>00198 { +00199 <a class="code" href="modules_8h.html#a13">createcommand</a>(cmd,f,flags,minparams); +00200 } </pre></div> </td> </tr> </table> @@ -288,28 +290,28 @@ Adds an extended mode letter which is parsed by a module This allows modules to <p> +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#l00310">310</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. -<p> -References <a class="el" href="modules_8cpp-source.html#l00092">DoAddExtendedMode()</a>, <a class="el" href="modules_8h-source.html#l00018">MT_CLIENT</a>, and <a class="el" href="modules_8h-source.html#l00019">MT_SERVER</a>. -<p> -<div class="fragment"><pre>00311 { -00312 <span class="keywordflow">if</span> (type == <a class="code" href="modules_8h.html#a7">MT_SERVER</a>) -00313 { -00314 log(DEBUG,<span class="stringliteral">"*** API ERROR *** Modes of type MT_SERVER are reserved for future expansion"</span>); -00315 <span class="keywordflow">return</span> <span class="keyword">false</span>; -00316 } -00317 <span class="keywordflow">if</span> (((params_when_on>0) || (params_when_off>0)) && (type == <a class="code" href="modules_8h.html#a6">MT_CLIENT</a>)) -00318 { -00319 log(DEBUG,<span class="stringliteral">"*** API ERROR *** Parameters on MT_CLIENT modes are not supported"</span>); -00320 <span class="keywordflow">return</span> <span class="keyword">false</span>; -00321 } -00322 <span class="keywordflow">if</span> ((params_when_on>1) || (params_when_off>1)) -00323 { -00324 log(DEBUG,<span class="stringliteral">"*** API ERROR *** More than one parameter for an MT_CHANNEL mode is not yet supported"</span>); -00325 <span class="keywordflow">return</span> <span class="keyword">false</span>; -00326 } -00327 <span class="keywordflow">return</span> <a class="code" href="modules_8cpp.html#a8">DoAddExtendedMode</a>(modechar,type,requires_oper,params_when_on,params_when_off); -00328 } +Definition at line <a class="el" href="modules_8cpp-source.html#l00317">317</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +<p> +References <a class="el" href="modules_8cpp-source.html#l00093">DoAddExtendedMode()</a>, <a class="el" href="modules_8h-source.html#l00018">MT_CLIENT</a>, and <a class="el" href="modules_8h-source.html#l00019">MT_SERVER</a>. +<p> +<div class="fragment"><pre>00318 { +00319 <span class="keywordflow">if</span> (type == <a class="code" href="modules_8h.html#a7">MT_SERVER</a>) +00320 { +00321 log(DEBUG,<span class="stringliteral">"*** API ERROR *** Modes of type MT_SERVER are reserved for future expansion"</span>); +00322 <span class="keywordflow">return</span> <span class="keyword">false</span>; +00323 } +00324 <span class="keywordflow">if</span> (((params_when_on>0) || (params_when_off>0)) && (type == <a class="code" href="modules_8h.html#a6">MT_CLIENT</a>)) +00325 { +00326 log(DEBUG,<span class="stringliteral">"*** API ERROR *** Parameters on MT_CLIENT modes are not supported"</span>); +00327 <span class="keywordflow">return</span> <span class="keyword">false</span>; +00328 } +00329 <span class="keywordflow">if</span> ((params_when_on>1) || (params_when_off>1)) +00330 { +00331 log(DEBUG,<span class="stringliteral">"*** API ERROR *** More than one parameter for an MT_CHANNEL mode is not yet supported"</span>); +00332 <span class="keywordflow">return</span> <span class="keyword">false</span>; +00333 } +00334 <span class="keywordflow">return</span> <a class="code" href="modules_8cpp.html#a8">DoAddExtendedMode</a>(modechar,type,requires_oper,params_when_on,params_when_off); +00335 } </pre></div> </td> </tr> </table> @@ -365,11 +367,11 @@ 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#a21">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#l00180">180</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#l00187">187</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00181 { -00182 call_handler(commandname.c_str(),parameters,pcnt,user); -00183 } +<div class="fragment"><pre>00188 { +00189 call_handler(commandname.c_str(),parameters,pcnt,user); +00190 } </pre></div> </td> </tr> </table> @@ -412,11 +414,13 @@ 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#l00268">268</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#l00275">275</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +<p> +References <a class="el" href="message_8h.html#a10">ChangeName()</a>. <p> -<div class="fragment"><pre>00269 { -00270 ChangeName(user,gecos.c_str()); -00271 } +<div class="fragment"><pre>00276 { +00277 <a class="code" href="message_8h.html#a10">ChangeName</a>(user,gecos.c_str()); +00278 } </pre></div> </td> </tr> </table> @@ -459,11 +463,13 @@ 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#l00263">263</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#l00270">270</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +<p> +References <a class="el" href="message_8h.html#a11">ChangeDisplayedHost()</a>. <p> -<div class="fragment"><pre>00264 { -00265 ChangeDisplayedHost(user,host.c_str()); -00266 } +<div class="fragment"><pre>00271 { +00272 <a class="code" href="message_8h.html#a11">ChangeDisplayedHost</a>(user,host.c_str()); +00273 } </pre></div> </td> </tr> </table> @@ -506,11 +512,11 @@ 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#l00169">169</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#l00171">171</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00170 { -00171 force_nickchange(user,nickname.c_str()); -00172 } +<div class="fragment"><pre>00172 { +00173 force_nickchange(user,nickname.c_str()); +00174 } </pre></div> </td> </tr> </table> @@ -553,11 +559,13 @@ 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#l00288">288</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +Definition at line <a class="el" href="modules_8cpp-source.html#l00295">295</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00289 { -00290 <span class="keywordflow">return</span> cmode(User,Chan); -00291 } +References <a class="el" href="message_8h.html#a14">cmode()</a>. +<p> +<div class="fragment"><pre>00296 { +00297 <span class="keywordflow">return</span> <a class="code" href="message_8h.html#a14">cmode</a>(User,Chan); +00298 } </pre></div> </td> </tr> </table> @@ -600,11 +608,13 @@ 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#a10">Server::SendCommon</a> method. <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00241">241</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +Definition at line <a class="el" href="modules_8cpp-source.html#l00248">248</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +<p> +References <a class="el" href="message_8h.html#a0">common_channels()</a>. <p> -<div class="fragment"><pre>00242 { -00243 <span class="keywordflow">return</span> (common_channels(u1,u2) != 0); -00244 } +<div class="fragment"><pre>00249 { +00250 <span class="keywordflow">return</span> (<a class="code" href="message_8h.html#a0">common_channels</a>(u1,u2) != 0); +00251 } </pre></div> </td> </tr> </table> @@ -638,11 +648,11 @@ 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#l00330">330</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +Definition at line <a class="el" href="modules_8cpp-source.html#l00337">337</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00331 { -00332 <span class="keywordflow">return</span> usercount(c); -00333 } +<div class="fragment"><pre>00338 { +00339 <span class="keywordflow">return</span> usercount(c); +00340 } </pre></div> </td> </tr> </table> @@ -676,11 +686,11 @@ 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#l00283">283</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +Definition at line <a class="el" href="modules_8cpp-source.html#l00290">290</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00284 { -00285 <span class="keywordflow">return</span> FindChan(channel.c_str()); -00286 } +<div class="fragment"><pre>00291 { +00292 <span class="keywordflow">return</span> FindChan(channel.c_str()); +00293 } </pre></div> </td> </tr> </table> @@ -714,11 +724,11 @@ 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#l00278">278</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +Definition at line <a class="el" href="modules_8cpp-source.html#l00285">285</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00279 { -00280 <span class="keywordflow">return</span> Find(nick); -00281 } +<div class="fragment"><pre>00286 { +00287 <span class="keywordflow">return</span> Find(nick); +00288 } </pre></div> </td> </tr> </table> @@ -751,11 +761,11 @@ 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#m2">Admin::Nick</a>, <a class="el" href="classAdmin.html#m1">Admin::Email</a> and <a class="el" href="classAdmin.html#m0">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#l00303">303</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#l00310">310</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00304 { -00305 <span class="keywordflow">return</span> <a class="code" href="classAdmin.html">Admin</a>(getadminname(),getadminemail(),getadminnick()); -00306 } +<div class="fragment"><pre>00311 { +00312 <span class="keywordflow">return</span> <a class="code" href="classAdmin.html">Admin</a>(getadminname(),getadminemail(),getadminnick()); +00313 } </pre></div> </td> </tr> </table> @@ -788,11 +798,11 @@ Returns the network name, global to all linked servers. <p> <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00298">298</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +Definition at line <a class="el" href="modules_8cpp-source.html#l00305">305</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00299 { -00300 <span class="keywordflow">return</span> getnetworkname(); -00301 } +<div class="fragment"><pre>00306 { +00307 <span class="keywordflow">return</span> getnetworkname(); +00308 } </pre></div> </td> </tr> </table> @@ -825,11 +835,11 @@ 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#l00293">293</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +Definition at line <a class="el" href="modules_8cpp-source.html#l00300">300</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00294 { -00295 <span class="keywordflow">return</span> getservername(); -00296 } +<div class="fragment"><pre>00301 { +00302 <span class="keywordflow">return</span> getservername(); +00303 } </pre></div> </td> </tr> </table> @@ -863,11 +873,53 @@ 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#l00273">273</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#l00280">280</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +<p> +References <a class="el" href="message_8h.html#a13">isnick()</a>. +<p> +<div class="fragment"><pre>00281 { +00282 <span class="keywordflow">return</span> (<a class="code" href="message_8h.html#a13">isnick</a>(nick.c_str()) != 0); +00283 } +</pre></div> </td> + </tr> +</table> +<a name="a32" doxytag="Server::IsUlined"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> bool Server::IsUlined </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">std::string </td> + <td class="mdname1" valign="top" nowrap> <em>server</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +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#l00182">182</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +<p> +References <a class="el" href="commands_8h.html#a70">is_uline()</a>. <p> -<div class="fragment"><pre>00274 { -00275 <span class="keywordflow">return</span> (isnick(nick.c_str()) != 0); -00276 } +<div class="fragment"><pre>00183 { +00184 <span class="keywordflow">return</span> <a class="code" href="commands_8h.html#a70">is_uline</a>(server.c_str()); +00185 } </pre></div> </td> </tr> </table> @@ -916,11 +968,11 @@ 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#l00159">159</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#l00161">161</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00160 { -00161 <span class="keywordflow">return</span> add_channel(user,cname.c_str(),key.c_str(),<span class="keyword">true</span>); -00162 } +<div class="fragment"><pre>00162 { +00163 <span class="keywordflow">return</span> add_channel(user,cname.c_str(),key.c_str(),<span class="keyword">true</span>); +00164 } </pre></div> </td> </tr> </table> @@ -963,11 +1015,11 @@ 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#l00185">185</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#l00192">192</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00186 { -00187 log(level,<span class="stringliteral">"%s"</span>,s.c_str()); -00188 } +<div class="fragment"><pre>00193 { +00194 log(level,<span class="stringliteral">"%s"</span>,s.c_str()); +00195 } </pre></div> </td> </tr> </table> @@ -1010,14 +1062,14 @@ 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#l00146">146</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +Definition at line <a class="el" href="modules_8cpp-source.html#l00148">148</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00147 { -00148 <span class="keywordtype">char</span> literal[MAXBUF],pattern[MAXBUF]; -00149 strncpy(literal,sliteral.c_str(),MAXBUF); -00150 strncpy(pattern,spattern.c_str(),MAXBUF); -00151 <span class="keywordflow">return</span> match(literal,pattern); -00152 } +<div class="fragment"><pre>00149 { +00150 <span class="keywordtype">char</span> literal[MAXBUF],pattern[MAXBUF]; +00151 strncpy(literal,sliteral.c_str(),MAXBUF); +00152 strncpy(pattern,spattern.c_str(),MAXBUF); +00153 <span class="keywordflow">return</span> match(literal,pattern); +00154 } </pre></div> </td> </tr> </table> @@ -1066,11 +1118,11 @@ 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#l00164">164</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#l00166">166</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00165 { -00166 <span class="keywordflow">return</span> del_channel(user,cname.c_str(),reason.c_str(),<span class="keyword">false</span>); -00167 } +<div class="fragment"><pre>00167 { +00168 <span class="keywordflow">return</span> del_channel(user,cname.c_str(),reason.c_str(),<span class="keyword">false</span>); +00169 } </pre></div> </td> </tr> </table> @@ -1115,14 +1167,14 @@ 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#l00174">174</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#l00176">176</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -References <a class="el" href="users_8h-source.html#l00091">userrec::nick</a>. +References <a class="el" href="users_8h-source.html#l00091">userrec::nick</a>, and <a class="el" href="message_8h.html#a19">send_network_quit()</a>. <p> -<div class="fragment"><pre>00175 { -00176 send_network_quit(user-><a class="code" href="classuserrec.html#m0">nick</a>,reason.c_str()); -00177 kill_link(user,reason.c_str()); -00178 } +<div class="fragment"><pre>00177 { +00178 <a class="code" href="message_8h.html#a19">send_network_quit</a>(user-><a class="code" href="classuserrec.html#m0">nick</a>,reason.c_str()); +00179 kill_link(user,reason.c_str()); +00180 } </pre></div> </td> </tr> </table> @@ -1165,11 +1217,11 @@ 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#l00200">200</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#l00207">207</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00201 { -00202 Write(Socket,<span class="stringliteral">"%s"</span>,s.c_str()); -00203 } +<div class="fragment"><pre>00208 { +00209 Write(Socket,<span class="stringliteral">"%s"</span>,s.c_str()); +00210 } </pre></div> </td> </tr> </table> @@ -1224,18 +1276,18 @@ 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#l00229">229</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. -<p> -<div class="fragment"><pre>00230 { -00231 <span class="keywordflow">if</span> (IncludeSender) -00232 { -00233 WriteChannel(Channel,User,<span class="stringliteral">"%s"</span>,s.c_str()); -00234 } -00235 <span class="keywordflow">else</span> -00236 { -00237 ChanExceptSender(Channel,User,<span class="stringliteral">"%s"</span>,s.c_str()); -00238 } -00239 } +Definition at line <a class="el" href="modules_8cpp-source.html#l00236">236</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +<p> +<div class="fragment"><pre>00237 { +00238 <span class="keywordflow">if</span> (IncludeSender) +00239 { +00240 WriteChannel(Channel,User,<span class="stringliteral">"%s"</span>,s.c_str()); +00241 } +00242 <span class="keywordflow">else</span> +00243 { +00244 ChanExceptSender(Channel,User,<span class="stringliteral">"%s"</span>,s.c_str()); +00245 } +00246 } </pre></div> </td> </tr> </table> @@ -1284,18 +1336,18 @@ 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#l00246">246</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. -<p> -<div class="fragment"><pre>00247 { -00248 <span class="keywordflow">if</span> (IncludeSender) -00249 { -00250 WriteCommon(User,<span class="stringliteral">"%s"</span>,text.c_str()); -00251 } -00252 <span class="keywordflow">else</span> -00253 { -00254 WriteCommonExcept(User,<span class="stringliteral">"%s"</span>,text.c_str()); -00255 } -00256 } +Definition at line <a class="el" href="modules_8cpp-source.html#l00253">253</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +<p> +<div class="fragment"><pre>00254 { +00255 <span class="keywordflow">if</span> (IncludeSender) +00256 { +00257 WriteCommon(User,<span class="stringliteral">"%s"</span>,text.c_str()); +00258 } +00259 <span class="keywordflow">else</span> +00260 { +00261 WriteCommonExcept(User,<span class="stringliteral">"%s"</span>,text.c_str()); +00262 } +00263 } </pre></div> </td> </tr> </table> @@ -1344,11 +1396,11 @@ 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#l00210">210</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#l00217">217</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00211 { -00212 WriteFrom(Socket,User,<span class="stringliteral">"%s"</span>,s.c_str()); -00213 } +<div class="fragment"><pre>00218 { +00219 WriteFrom(Socket,User,<span class="stringliteral">"%s"</span>,s.c_str()); +00220 } </pre></div> </td> </tr> </table> @@ -1404,13 +1456,13 @@ 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#l00195">195</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#l00202">202</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> References <a class="el" href="modules_8h.html#a14">server_mode()</a>. <p> -<div class="fragment"><pre>00196 { -00197 <a class="code" href="modules_8h.html#a14">server_mode</a>(parameters,pcnt,user); -00198 } +<div class="fragment"><pre>00203 { +00204 <a class="code" href="modules_8h.html#a14">server_mode</a>(parameters,pcnt,user); +00205 } </pre></div> </td> </tr> </table> @@ -1444,11 +1496,11 @@ 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#l00141">141</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +Definition at line <a class="el" href="modules_8cpp-source.html#l00143">143</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00142 { -00143 WriteOpers(<span class="stringliteral">"%s"</span>,s.c_str()); -00144 } +<div class="fragment"><pre>00144 { +00145 WriteOpers(<span class="stringliteral">"%s"</span>,s.c_str()); +00146 } </pre></div> </td> </tr> </table> @@ -1491,11 +1543,11 @@ 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#l00205">205</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#l00212">212</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00206 { -00207 WriteServ(Socket,<span class="stringliteral">"%s"</span>,s.c_str()); -00208 } +<div class="fragment"><pre>00213 { +00214 WriteServ(Socket,<span class="stringliteral">"%s"</span>,s.c_str()); +00215 } </pre></div> </td> </tr> </table> @@ -1548,22 +1600,22 @@ 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#l00215">215</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. -<p> -References <a class="el" href="connection_8h-source.html#l00165">connection::fd</a>. -<p> -<div class="fragment"><pre>00216 { -00217 <span class="keywordflow">if</span> (!Source) -00218 { -00219 <span class="comment">// if source is NULL, then the message originates from the local server</span> -00220 Write(Dest-><a class="code" href="classconnection.html#m0">fd</a>,<span class="stringliteral">":%s %s"</span>,this->GetServerName().c_str(),s.c_str()); -00221 } -00222 <span class="keywordflow">else</span> -00223 { -00224 <span class="comment">// otherwise it comes from the user specified</span> -00225 WriteTo(Source,Dest,<span class="stringliteral">"%s"</span>,s.c_str()); -00226 } -00227 } +Definition at line <a class="el" href="modules_8cpp-source.html#l00222">222</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +<p> +References <a class="el" href="connection_8h-source.html#l00166">connection::fd</a>. +<p> +<div class="fragment"><pre>00223 { +00224 <span class="keywordflow">if</span> (!Source) +00225 { +00226 <span class="comment">// if source is NULL, then the message originates from the local server</span> +00227 Write(Dest-><a class="code" href="classconnection.html#m0">fd</a>,<span class="stringliteral">":%s %s"</span>,this->GetServerName().c_str(),s.c_str()); +00228 } +00229 <span class="keywordflow">else</span> +00230 { +00231 <span class="comment">// otherwise it comes from the user specified</span> +00232 WriteTo(Source,Dest,<span class="stringliteral">"%s"</span>,s.c_str()); +00233 } +00234 } </pre></div> </td> </tr> </table> @@ -1614,11 +1666,11 @@ 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#l00154">154</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +Definition at line <a class="el" href="modules_8cpp-source.html#l00156">156</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00155 { -00156 WriteMode(modes.c_str(),flags,<span class="stringliteral">"%s"</span>,text.c_str()); -00157 } +<div class="fragment"><pre>00157 { +00158 WriteMode(modes.c_str(),flags,<span class="stringliteral">"%s"</span>,text.c_str()); +00159 } </pre></div> </td> </tr> </table> @@ -1661,17 +1713,17 @@ 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#l00258">258</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#l00265">265</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00259 { -00260 WriteWallOps(User,<span class="keyword">false</span>,<span class="stringliteral">"%s"</span>,text.c_str()); -00261 } +<div class="fragment"><pre>00266 { +00267 WriteWallOps(User,<span class="keyword">false</span>,<span class="stringliteral">"%s"</span>,text.c_str()); +00268 } </pre></div> </td> </tr> </table> <hr>The documentation for this class was generated from the following files:<ul> <li><a class="el" href="modules_8h-source.html">modules.h</a><li><a class="el" href="modules_8cpp-source.html">modules.cpp</a></ul> -<hr><address style="align: right;"><small>Generated on Mon Apr 19 02:34:49 2004 for InspIRCd by +<hr><address style="align: right;"><small>Generated on Sun Apr 25 00:24:29 2004 for InspIRCd by <a href="http://www.doxygen.org/index.html"> <img src="doxygen.png" alt="doxygen" align="middle" border=0 width=110 height=53></a>1.3-rc3 </small></address> |